mirror of
https://github.com/flame-engine/flame.git
synced 2025-11-03 20:36:31 +08:00
68 lines
3.1 KiB
Dart
68 lines
3.1 KiB
Dart
import 'dart:ui';
|
|
|
|
import 'package:flutter/painting.dart';
|
|
|
|
import '../extensions/vector2.dart';
|
|
import '../game.dart';
|
|
|
|
/// This represents a Component for your game.
|
|
///
|
|
/// Components can be bullets flying on the screen, a spaceship or your player's fighter.
|
|
/// Anything that either renders or updates can be added to the list on [BaseGame]. It will deal with calling those methods for you.
|
|
/// Components also have other methods that can help you out if you want to override them.
|
|
abstract class Component {
|
|
/// Whether this component has been loaded yet. If not loaded, [BaseGame] will not try to render it.
|
|
///
|
|
/// Sprite based components can use this to let [BaseGame] know not to try to render when the [Sprite] has not been loaded yet.
|
|
/// Note that for a more consistent experience, you can pre-load all your assets beforehand with Flame.images.loadAll.
|
|
bool loaded = true;
|
|
|
|
/// Whether this component is HUD object or not.
|
|
///
|
|
/// HUD objects ignore the [BaseGame.camera] when rendered (so their position coordinates are considered relative to the device screen).
|
|
bool isHud = false;
|
|
|
|
/// Render priority of this component. This allows you to control the order in which your components are rendered.
|
|
///
|
|
/// Components are always updated and rendered in the order defined by what this number is when the component is added to the game.
|
|
/// The smaller the priority, the sooner your component will be updated/rendered.
|
|
/// It can be any integer (negative, zero, or positive).
|
|
/// If two components share the same priority, they will probably be drawn in the order they were added.
|
|
final int priority;
|
|
|
|
/// Whether this component should be removed or not.
|
|
///
|
|
/// It will be checked once per component per tick, and if it is true, [BaseGame] will remove it.
|
|
bool shouldRemove = false;
|
|
|
|
Component({this.priority = 0});
|
|
|
|
/// This method is called periodically by the game engine to request that your component updates itself.
|
|
///
|
|
/// The time [t] in seconds (with microseconds precision provided by Flutter) since the last update cycle.
|
|
/// This time can vary according to hardware capacity, so make sure to update your state considering this.
|
|
/// All components on [BaseGame] are always updated by the same amount. The time each one takes to update adds up to the next update cycle.
|
|
void update(double dt) {}
|
|
|
|
/// Renders this component on the provided Canvas [c].
|
|
void render(Canvas c) {}
|
|
|
|
/// It receives the new game size.
|
|
/// Executed right after the component is attached to a game and right before [onMount] is called
|
|
///
|
|
/// Use [Resizable] to save the gameSize in a component.
|
|
void onGameResize(Vector2 gameSize) {}
|
|
|
|
/// Remove the component from the game it is added to in the next tick
|
|
void remove() => shouldRemove = true;
|
|
|
|
/// Called when the component has been added and prepared by the game instance.
|
|
///
|
|
/// This can be used to make initializations on your component as, when this method is called,
|
|
/// things like [onGameResize] are already set and usable.
|
|
void onMount() {}
|
|
|
|
/// Called right before the component is removed from the game
|
|
void onRemove() {}
|
|
}
|