Scenes

A scene is a tree of nodes. Any node can be mounted as the root of a Scene. Scene wraps the tree with a size and offers methods to manipulate the entire tree effectively.

final game = GameNode();
final scene = game.mount(); // Ready to go!

Flutter Usage#

SceneWidget embeds a scene in Flutter. Flutter's engine will then automatically drive updating and rendering.

final widget = SceneWidget(scene);

The scene owns whether it runs, not the widget. Pause it directly, from anywhere, and the widget follows:

scene.pause();
scene.resume();
scene.paused; // Whether it is frozen.

Flutter can also stop the loop on its own account: a scene inside hidden UI has its tickers disabled, and stops drawing without being paused.

Lineage

Much of the Flutter integration is thanks to existing code from Flame.

SceneWidget also owns the scene it is given, destroying it when the widget leaves the tree or is handed a different scene.

Manual Usage#

Scenes can also be driven completely manually. In fact, this is how much of Ignis is tested internally.

scene.update(1 / 60); // Manual update at 60 FPS.
scene.render(canvas); // Manual render (e.g. to a `PictureRecorder`).
scene.destroy(); // All done, thanks.