Live mixin
Re-runs a node's Node.build on every reload, and grants keep.
Without this, a body is built once and never picks up an edit. With it, every reload re-runs the body, and keep names the values that carry across.
Properties
- activity ↔ Activity
-
What this node takes part in: ticking, rendering, and hearing input.
Defaults to Activity.all.
getter/setter pairinherited
-
ancestors
→ Iterable<
Node> -
This node's ancestors in the tree.
no setterinherited
-
children
→ Iterable<
Node> -
This node's direct children.
no setterinherited
-
descendants
→ Iterable<
Node> -
This node's descendants in depth-first preorder.
no setterinherited
- enabled ↔ bool
-
Whether this node ticks, renders, and hears input, all three.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasParent → bool
-
True if this node has a non-null parent.
no setterinherited
- isMounted → bool
-
True while this node is part of a mounted tree.
no setterinherited
- isRemoving → bool
-
True while this node awaits removal at the next flush.
no setterinherited
- onMount → Signal0
-
Emitted when this node is added to a scene.
finalinherited
-
onSceneResize
→ Signal1<
Vector2> -
Emitted when the scene resizes, and once at mount.
finalinherited
- onUnmount → Signal0
-
Emitted when this node is removed from a scene.
finalinherited
- parent → Node?
-
The parent that owns this node, or null when it is parentless.
no setterinherited
- priority ↔ int
-
This node's order in updating and rendering in its parent. Defaults to 0.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scene
→ Scene<
Node> -
This node's owning scene. Only valid while isMounted.
no setterinherited
Methods
-
add<
T extends Node> (T node) → T -
Adds
nodeto this node. The node is returned.inherited -
addAll(
Iterable< Node> nodes) → void -
Adds all
nodesto this node.inherited -
attach(
Node node) → void -
Adds this node to the target
node.inherited -
build(
) → void -
Declares this node's children and behavior.
inherited
-
contains(
Node other) → bool -
Checks if this node contains the
othernode in its tree.inherited -
containsPoint(
Vector2 point) → bool -
Whether this node's hit area contains
point.inherited -
cycles(
Node node) → bool -
True if
nodeis (or soon will be) an ancestor of this node.inherited -
debugDraw(
DebugDraw draw) → void -
Draws to the debug overlay every frame, in the same space as
draw.inherited -
debugRender(
Canvas canvas) → void -
Renders the debug overlay for this node and its children to
canvas.inherited -
debugRenderSelf(
Canvas canvas) → void -
Runs this node's debugDraw callbacks, in the same space as renderSelf.
inherited
-
detach(
) → bool -
Removes this node from its parent, or from the parent it is on its way to.
inherited
-
disable(
) → void -
Disables this node, so it stops updating, rendering and answering.
inherited
-
draw(
Draw draw) → void -
Draws to
canvasevery frame, in this node's own coordinate space.inherited -
enable(
) → void -
Enables this node, so it resumes updating, rendering and answering.
inherited
-
hitTest(
Vector2 point) → Iterable< Node> -
Finds every node in this subtree whose hit area contains
point, per containsPoint, topmost first. A node hearing no input hides its whole subtree.inherited -
keep<
T> (Symbol name, T create(), {Object? id, List< Object?> keys = const [], void dispose(T value)?}) → T -
Keeps whatever
createreturns alive across build passes, undername. -
mount(
) → Scene< T> -
Available on T, provided by the Mount extension
Mounts this node as the root of a new Scene and returns it. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
owns(
Node other) → bool -
Checks if this node owns the
othernode.inherited -
provide<
T> (T value) → void -
Provides
valueas this node's instance ofT, overwriting any value previously provided forT.inherited -
query<
T extends Node> () → Iterable< T> -
This node's direct children of type
T, in priority order.inherited -
read<
T> () → T -
As readOrNull, but throws a StateError when nothing provided
T.inherited -
readOrNull<
T> () → T? -
Reads the nearest instance of
Tprovided by this node or an ancestor, checking this node first. Returns null if none was provided.inherited -
remove(
Node node) → bool -
Removes the child
node.inherited -
removeAll(
) → void -
Removes all children.
inherited
-
render(
Canvas canvas) → void -
Renders this node and its children to
canvas.inherited -
renderChildren(
Canvas canvas) → void -
Renders this node's enabled children to
canvas, in priority order.inherited -
renderSelf(
Canvas canvas) → void -
Runs this node's draw callbacks.
inherited
-
tick(
Tick tick) → void -
Calls
tickwith the elapsed seconds on every frame.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
trash(
Cleanup cleanup) → void -
Defers
cleanupuntil this build stops being current.inherited -
traverse(
{bool prune(Node node)?}) → Iterable< Node> -
This node and its subtree, in postorder: every child before its parent,
and children in reverse priority order.
inherited
-
update(
double dt) → void -
Updates this node and its children by
dtseconds.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited