RouterComponent class

RouterComponent handles transitions between multiple pages of a game.

The term page is used descriptively here: it is any full-screen (or partial-screen) component. For example: a starting page, a settings page, the main game world page, and so on. A page can also be any individual piece of UI, such as a confirmation dialog box, or a user inventory pop-up.

The router doesn't handle the pages directly -- instead, it operates a stack of Routes. Each route, in turn, manages a single page component. However, routes are lazy: they will only build their pages when they become active.

Internally, the router maintains a stack of Routes. In the beginning, the stack will contain the initialRoute. New routes can be added via the pushNamed method, and removed with pop. However, the stack must be kept non-empty: it is an error to attempt to remove the only remaining route from the stack.

Routes that are on the stack are mounted as components. When a route is popped, it is removed from the stack and unmounted. Routes can be either transparent or opaque. An opaque route prevents all routes below it from rendering, and also stops pointer events. In addition, routes are able to stop or slow down time for the pages that they control, or to apply visual effects (via decorators) to those pages.

Inheritance

Constructors

RouterComponent({required String initialRoute, required Map<String, Route> routes, Map<String, RouteFactory>? routeFactories, RouteFactory? onUnknownRoute, ComponentKey? key})

Properties

children → ComponentSet
The children components of this component.
no setterinherited
currentRoute → Route
Returns the route that is currently at the top of the stack.
no setter
debugColor ↔ Color
The color that the debug output should be rendered with.
getter/setter pairinherited
debugCoordinatesPrecision ↔ int?
How many decimal digits to print when displaying coordinates in the debug mode. Setting this to null will suppress all coordinates from the output.
getter/setter pairinherited
debugMode ↔ bool
Returns whether this Component is in debug mode or not. When a child is added to the Component it gets the same debugMode as its parent has when it is prepared.
getter/setter pairinherited
debugPaint → Paint
The debugColor represented as a Paint object.
no setterinherited
debugTextPaint → TextPaint
Returns a TextPaint object with the debugColor set as color for the text.
no setterinherited
hasChildren → bool
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
initialRoute → String
Route that will be placed on the stack in the beginning.
final
isLoaded → bool
Whether this component has completed its onLoad step.
no setterinherited
isLoading → bool
Whether the component is currently executing its onLoad step.
no setterinherited
isMounted → bool
Whether this component is currently added to a component tree.
no setterinherited
isMounting → bool
no setterinherited
isRemoved → bool
Whether the component has been removed. Originally this flag is false, but it becomes true after the component was mounted and then removed from its parent. The flag becomes false again when the component is mounted to a new parent.
no setterinherited
isRemoving → bool
Whether the component is scheduled to be removed.
no setterinherited
key → ComponentKey?
A key that can be used to identify this component in the tree.
finalinherited
loaded → Future<void>
A future that completes when this component finishes loading.
no setterinherited
mounted → Future<void>
A future that will complete once the component is mounted on its parent.
no setterinherited
onUnknownRoute → RouteFactory?
Function that will be called to resolve any route names that couldn't be resolved via _routes or _routeFactories. Unlike with routeFactories, the route returned by this function will not be cached.
final
parent ↔ Component?
Who owns this component in the component tree.
getter/setter pairinherited
previousRoute → Route?
Returns the route that is below the current topmost route, if it exists.
no setter
priority ↔ int
Render priority of this component. This allows you to control the order in which your components are rendered.
getter/setter pairinherited
removed → Future<void>
A future that completes when this component is removed from its parent.
no setterinherited
routes → Map<String, Route>
The map of all routes known to the Router, each route will have a unique name. This map is initialized in the constructor; in addition, any routes produced by the _routeFactories will also be cached here.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stack → List<Route>
no setter

Methods

add(Component component) → FutureOr<void>
Schedules component to be added as a child to this component.
inherited
addAll(Iterable<Component> components) → Future<void>
A convenience method to add multiple children at once.
inherited
addToParent(Component parent) → FutureOr<void>
Adds this component as a child of parent (see add for details).
inherited
ancestors({bool includeSelf = false}) → Iterable<Component>
An iterator producing this component's parent, then its parent's parent, then the great-grand-parent, and so on, until it reaches a component without a parent.
inherited
componentsAtLocation<T>(T locationContext, List<T>? nestedContexts, T? transformContext(CoordinateTransform, T), bool checkContains(Component, T)) → Iterable<Component>
This is a generic implementation of componentsAtPoint; refer to those docs for context.
inherited
componentsAtPoint(Vector2 point, [List<Vector2>? nestedPoints]) → Iterable<Component>
An iterable of descendant components intersecting the given point. The point is in the local coordinate space.
inherited
contains(Component c) → bool
Whether the children list contains the given component.
inherited
containsLocalPoint(Vector2 point) → bool
Checks whether the point is within this component's bounds.
inherited
containsPoint(Vector2 point) → bool
Same as containsLocalPoint, but for a "global" point.
inherited
createComponentSet() → ComponentSet
This method creates the children container for the current component. Override this method if you need to have a custom ComponentSet within a particular class.
inherited
descendants({bool includeSelf = false, bool reversed = false}) → Iterable<Component>
Recursively enumerates all nested children.
inherited
findGame() → FlameGame<World>?
Fetches the nearest FlameGame ancestor to the component.
inherited
findParent<T extends Component>({bool includeSelf = false}) → T?
Returns the closest parent further up the hierarchy that satisfies type=T, or null if no such parent can be found.
inherited
findRootGame() → FlameGame<World>?
Fetches the root FlameGame ancestor to the component.
inherited
firstChild<T extends Component>() → T?
Returns the first child that matches the given type T, or null if there are no such children.
inherited
handleLifecycleEventAdd(Component parent) → LifecycleEventStatus
inherited
handleLifecycleEventMove(Component newParent) → LifecycleEventStatus
inherited
handleLifecycleEventRemove(Component parent) → LifecycleEventStatus
inherited
handleResize(Vector2 size) → void
inherited
lastChild<T extends Component>() → T?
Returns the last child that matches the given type T, or null if there are no such children.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onChildrenChanged(Component child, ChildrenChangeType type) → void
This method will be invoked from lifecycle if child has been added to or removed from its parent children list.
inherited
onGameResize(Vector2 size) → void
Called whenever the size of the top-level Canvas changes.
inherited
onLoad() → FutureOr<void>
Late initialization method for Component.
inherited
onMount() → void
Called when the component is added to its parent.
override
onParentResize(Vector2 maxSize) → void
Called whenever the parent of this component changes size; and also once before onMount.
inherited
onRemove() → void
Called right before the component is removed from the game.
inherited
pop() → void
Removes the topmost route from the stack, and also removes it as a child of the Router.
popRoute(Route route) → void
Removes routes from the stack until route is removed. This is equivalent to pop if route is currently on top of the stack.
popUntilNamed(String name) → void
Removes routes from the top of the stack until reaches the route with the given name.
propagateToChildren<T extends Component>(bool handler(T), {bool includeSelf = false}) → bool
This method first calls the passed handler on the leaves in the tree, the children without any children of their own. Then it continues through all other children. The propagation continues until the handler returns false, which means "do not continue", or when the handler has been called with all children.
inherited
pushAndWait<T>(ValueRoute<T> route) → Future<T>
Puts route on top of the stack and waits until that route is popped.
pushNamed(String name, {bool replace = false}) → void
Puts the route name on top of the navigation stack.
pushOverlay(String name) → void
Puts the overlay route name on top of the navigation stack.
pushReplacement(Route route, {String? name}) → void
Pops the current route and puts a new route on top of the navigation stack.
pushReplacementNamed(String name) → void
Pops the current route and places the route with name on top of the navigation stack.
pushReplacementOverlay(String name) → void
Pops the current route and puts the overlay route name on top of the navigation stack.
pushRoute(Route route, {String? name, bool replace = false}) → void
Puts a new route on top of the navigation stack.
remove(Component component) → void
Removes a component from the component tree.
inherited
removeAll(Iterable<Component> components) → void
Removes all the children in the list and calls onRemove for all of them and their children.
inherited
removeFromParent() → void
Remove the component from its parent in the next tick.
inherited
removeWhere(bool test(Component component)) → void
Removes all the children for which the test function returns true.
inherited
render(Canvas canvas) → void
inherited
renderDebugMode(Canvas canvas) → void
inherited
renderTree(Canvas canvas) → void
inherited
setLoaded() → void
Used by the FlameGame to set the loaded state of the component, since the game isn't going through the whole normal component life cycle.
inherited
setMounted() → void
Used by the FlameGame to set the mounted state of the component, since the game isn't going through the whole normal component life cycle.
inherited
setRemoved() → void
Used by the FlameGame to set the removed state of the component, since the game isn't going through the whole normal component life cycle.
inherited
toString() → String
A string representation of this object.
inherited
update(double dt) → void
This method is called periodically by the game engine to request that your component updates itself.
inherited
updateTree(double dt) → void
This method traverses the component tree and calls update on all its children according to their priority order, relative to the priority of the direct siblings, not the children or the ancestors.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited