mirror of
https://github.com/flame-engine/flame.git
synced 2025-11-01 19:12:31 +08:00
composed component docs (#58)
* composed-component-docs * undo mistakes * typos
This commit is contained in:
@ -57,6 +57,38 @@ If you have a spritesheet, you can use the `sequenced` constructor, identical to
|
||||
|
||||
If you are not using `BaseGame`, don't forget this component needs to be update'd even if static, because the animation object needs to be ticked to move the frames.
|
||||
|
||||
|
||||
## Composed component
|
||||
|
||||
A mixin that helps you to make a `Component` wraps other components. It is useful to group visual components through a hierarchy. When implemented, makes every item in its `components` collection field be updated and rendered with the same conditions.
|
||||
|
||||
Example of usage, where visibility of two components are handled by a wrapper:
|
||||
|
||||
```dart
|
||||
class GameOverPanel extends PositionComponent with Resizable, ComposedComponent {
|
||||
bool visible = false;
|
||||
|
||||
GameOverText gameOverText;
|
||||
GameOverButton gameOverButton;
|
||||
|
||||
GameOverPanel(Image spriteImage) : super() {
|
||||
gameOverText = GameOverText(spriteImage); // GameOverText is a Component
|
||||
gameOverButton = GameOverButton(spriteImage); // GameOverRestart is a SpriteComponent
|
||||
|
||||
components..add(gameOverText)..add(gameOverButton);
|
||||
}
|
||||
|
||||
@override
|
||||
void render(Canvas canvas) {
|
||||
if (visible) {
|
||||
super.render(canvas);
|
||||
} // If not, neither of its `components` will be rendered
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Parallax Component
|
||||
|
||||
This Component can be used to render pretty backgrounds, by drawing several transparent images on top of each other, each dislocated by a tiny amount.
|
||||
|
||||
@ -2,12 +2,36 @@ import 'dart:ui';
|
||||
|
||||
import 'package:flame/components/component.dart';
|
||||
import 'package:flame/components/resizable.dart';
|
||||
import 'package:flame/game.dart';
|
||||
import 'package:ordered_set/comparing.dart';
|
||||
import 'package:ordered_set/ordered_set.dart';
|
||||
|
||||
/// A component that lets your component be composed by others
|
||||
/// It resembles [BaseGame]. It has an [components] property and an [add] method
|
||||
/// A mixin that helps you to make a `Component` wraps other components. It is useful to group visual components through a hierarchy. When implemented, makes every item in its `components` collection field be updated and rendered with the same conditions.
|
||||
///
|
||||
/// Example of usage, where visibility of two components are handled by a wrapper:
|
||||
///
|
||||
/// ```dart
|
||||
/// class GameOverPanel extends PositionComponent with Resizable, ComposedComponent {
|
||||
/// bool visible = false;
|
||||
///
|
||||
/// GameOverText gameOverText;
|
||||
/// GameOverButton gameOverButton;
|
||||
///
|
||||
/// GameOverPanel(Image spriteImage) : super() {
|
||||
/// gameOverText = GameOverText(spriteImage); // GameOverText is a Component
|
||||
/// gameOverButton = GameOverButton(spriteImage); // GameOverRestart is a SpriteComponent
|
||||
///
|
||||
/// components..add(gameOverText)..add(gameOverButton);
|
||||
/// }
|
||||
///
|
||||
/// @override
|
||||
/// void render(Canvas canvas) {
|
||||
/// if (visible) {
|
||||
/// super.render(canvas);
|
||||
/// } // If not, neither of its `components` will be rendered
|
||||
/// }
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
mixin ComposedComponent on Component {
|
||||
OrderedSet<Component> components =
|
||||
OrderedSet(Comparing.on((c) => c.priority()));
|
||||
|
||||
Reference in New Issue
Block a user