TransformSyncSystem<T extends App<T>> class

Inheritance

Constructors

TransformSyncSystem(T app, {bool populateDefaults = true})

Properties

app → T
finalinherited
backend UnhingedBackend
Shorthand for App.backend.
no setterinherited
draw Drawers<T>
Shorthand for App.draw.
no setterinherited
eventHistory List<Event<T>>
no setterinherited
eventHistoryRetention double?
How long (in sim-scaled seconds) to retain events before pruning. Null = keep forever.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
id int
Per-type unique identifier, auto-assigned in the constructor.
no setterinherited
input InputSystem<T>
Shorthand for App.input.
no setterinherited
isActive bool
Whether this object is currently active.
no setterinherited
isAdded bool
no setterinherited
isClonable bool
Check this before calling clone: if (obj.isClonable) obj.clone();
no setterinherited
isClone bool
Whether this object is a clone of another.
getter/setter pairinherited
isCloned bool
Whether this object has been cloned at least once.
getter/setter pairinherited
isCloning bool
Whether this object is currently mid-clone.
getter/setter pairinherited
isDisabled bool
Whether this object is currently disabled.
no setterinherited
isOriginal bool
Whether this object is an original (not a clone).
no setterinherited
isRemoved bool
Whether this object has been removed.
getter/setter pairinherited
name String
Human-readable name, defaults to <runtimeType>_<id>.
getter/setter pairinherited
namedId String
Per-type unique String identifier, auto-assigned in the constructor. Defaults to <runtimeType>_<id>.
no setterinherited
parent ECSBase<T>?
The parent object in the ECS tree, if any.
getter/setter pairinherited
persistentId String
getter/setter pairinherited
persistentTypeId String
no setteroverride
populateDefaults bool
getter/setter pairinherited
renderer Renderer<T>
Shorthand for App.renderer.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scene Scene<T>
Shorthand for App.currentScene.
no setterinherited
sceneBounds Bounds
no setterinherited
sceneHeight double
no setterinherited
sceneSize Vector2D
no setterinherited
sceneWidth double
no setterinherited
screenHeight double
Shorthand for App's height.
no setterinherited
screenSize Vector2D
Shorthand for App.screenSize.
no setterinherited
screenWidth double
Shorthand for App's width.
no setterinherited
self SceneSystem<T>
This object cast to T.
no setterinherited
time AppTime<T>
Shorthand for App.time.
no setterinherited

Methods

bookmarkState(String name) AnySceneSystemSnapshot<T>
inherited
callback(void callback()) → void
inherited
captureSnapshot() AnySceneSystemSnapshot<T>
inherited
captureSnapshotAs<X extends S>() → X
inherited
clearEventHistory() → void
Clears history of recorded events.
inherited
clone<X extends E>([SceneSystemCloner<T>? cloner]) → X
Produces a clone of this object.
inherited
cloneInto<X extends E>(X target, [SceneSystemCloner<T>? cloner]) → X
inherited
createClone(SceneSystem<T> newInstance, [SceneSystemCloner<T>? cloner]) SceneSystem<T>
Override to customize how state is copied into newInstance.
inherited
createInstance() TransformSyncSystem<T>
Override to provide a fresh uninitialized instance of this type.
override
createSnapshot() TransformSyncSystemSnapshot<T>
override
decVar<V extends num>(VarKey<V> key, [V? amount]) → V
inherited
dispatch(Event<T> event, {EventScope scope = .local}) → void
Dispatches an event immediately and synchronously, bypassing the central event queue.
inherited
emit(Event<T> event, {EventScope scope = .local}) → void
Queues an event into the central application event queue for asynchronous processing.
inherited
getAncestors() Iterable<ECSBase<T>>
Returns every ancestor of this component, from immediate parent up to the root.
inherited
getClones() Iterable<SceneSystem<T>>
Returns all clones produced from this object.
inherited
getDepth() int
Returns the depth/level in the hierarchy.
inherited
getOrSetVar<V>(VarKey<V> key, V fallback) → V
inherited
getParentAs<P extends ECSBase<T>>() → P?
Returns parent cast to P, or null if the cast would fail.
inherited
getPath() List<ECSBase<T>>
Returns the path from the root down to this one, inclusive.
inherited
getPersistableData({bool force = false}) MapData
inherited
getRecordedEvents({double? duration, ECSBase<T>? origin, bool filter(Event<T> event)?}) List<Event<T>>
Events dispatched within the last duration sim-scaled seconds, optionally filtered to a specific origin.
inherited
getVar<V>(VarKey<V> key) → V?
inherited
getVarSafe<V>(VarKey<V> key, V fallback) → V
inherited
hasParentOf<P extends ECSBase<T>>() bool
Whether parent is of type P.
inherited
hasVar(VarKey key) bool
inherited
incVar<V extends num>(VarKey<V> key, [V? amount]) → V
inherited
listenHandleInput(void fn(SceneSystem<T> self)) SceneSystem<T>
Registers fn to be called during the input handling phase.
inherited
listenOnActivate(void fn(SceneSystem<T> self)) SceneSystem<T>
Registers fn to be called whenever the active state changes.
inherited
listenOnAdd(void fn(SceneSystem<T> self, ECSBase<T> parent)) SceneSystem<T>
Registers fn as an add listener.
inherited
listenOnAfterAdd(void fn(SceneSystem<T> self, ECSBase<T> parent)) SceneSystem<T>
Registers fn as an after-add listener.
inherited
listenOnAfterClone(void fn(SceneSystem<T> copy, [SceneSystemCloner<T>? cloner])) SceneSystem<T>
Registers fn as an after-clone listener.
inherited
listenOnAfterRemove(void fn(SceneSystem<T> self)) SceneSystem<T>
Registers fn as an after-remove listener.
inherited
listenOnBeforeAdd(bool fn(SceneSystem<T> self, ECSBase<T> parent)) SceneSystem<T>
Registers fn as a before-add listener.
inherited
listenOnBeforeClone(bool fn(SceneSystem<T> copy, [SceneSystemCloner<T>? cloner])) SceneSystem<T>
Registers fn as a before-clone listener.
inherited
listenOnBeforeEvent(bool fn(SceneSystem<T> self, Event<T> event)) SceneSystem<T>
Registers fn as a before-event listener.
inherited
listenOnBeforeEventRecorded(bool fn(SceneSystem<T> self, Event<T> event)) SceneSystem<T>
Registers fn as a before-event-record listener.
inherited
listenOnBeforeRemove(bool fn(SceneSystem<T> self)) SceneSystem<T>
Registers fn as a before-remove listener.
inherited
listenOnBeforeStorePersistable(bool fn(SceneSystem<T> self)) SceneSystem<T>
Registers fn as a before-persistence listener.
inherited
listenOnBeginFrame(void fn(SceneSystem<T> self, double dt)) SceneSystem<T>
Registers fn to be called at the start of each frame.
inherited
listenOnClone(void fn(SceneSystem<T> copy, [SceneSystemCloner<T>? cloner])) SceneSystem<T>
Registers fn as a clone listener.
inherited
listenOnDispose(void fn(SceneSystem<T> self)) SceneSystem<T>
Registers fn to be called at the disposal of the owned ECS object.
inherited
listenOnEndFrame(void fn(SceneSystem<T> self, double dt)) SceneSystem<T>
Registers fn to be called at the end of each frame.
inherited
listenOnEvent(void fn(SceneSystem<T> self, Event<T> event)) SceneSystem<T>
Registers fn to be called for every incoming event.
inherited
listenOnEventRecorded(void fn(SceneSystem<T> self, Event<T> event)) SceneSystem<T>
Registers fn to be called for every event recorded.
inherited
listenOnPostDraw(void fn(SceneSystem<T> self, double dt)) SceneSystem<T>
Registers fn to be called after the draw phase each frame.
inherited
listenOnPostUpdate(void fn(SceneSystem<T> self, double dt)) SceneSystem<T>
Registers fn to be called after the update phase each frame.
inherited
listenOnPreDraw(void fn(SceneSystem<T> self, double dt)) SceneSystem<T>
Registers fn to be called before the draw phase each frame.
inherited
listenOnPreUpdate(void fn(SceneSystem<T> self, double dt)) SceneSystem<T>
Registers fn to be called before the update phase each frame.
inherited
listenOnRemove(void fn(SceneSystem<T> self)) SceneSystem<T>
Registers fn as a remove listener.
inherited
listenOnStorePersistable(MapData fn(SceneSystem<T> self, MapData data)) SceneSystem<T>
Registers fn as an store persistable listener.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onActivate() → void
Override to react when the active state changes.
inherited
onAdd(ECSBase<T> parent) → void
Override to react when the add is about to complete.
inherited
onAfterAdd(ECSBase<T> parent) → void
Override to react after the add has completed.
inherited
onAfterClone(SceneSystem<T> copy, [SceneSystemCloner<T>? cloner]) → void
Override to react after cloning has completed.
inherited
onAfterRemove() → void
Override to react after removal has completed.
inherited
onBeforeAdd(ECSBase<T> parent) bool
Override to cancel the add from within the class.
inherited
onBeforeClone(SceneSystem<T> copy, [SceneSystemCloner<T>? cloner]) bool
Override to cancel cloning from within the class.
inherited
onBeforeEvent(Event<T> event) bool
Override to cancel an event handling from within the class.
inherited
onBeforeEventRecorded(Event<T> event) bool
Override to cancel an event handling from within the class.
inherited
onBeforeRemove() bool
Override to cancel removal from within the class.
inherited
onBeforeStorePersistable() bool
Override to cancel the persistence from within the class.
inherited
onBeginFrame(double dt) → void
Override to react at the start of each frame.
inherited
onClone(SceneSystem<T> copy, [SceneSystemCloner<T>? cloner]) → void
Override to react when cloning is about to complete.
inherited
onCloned(SceneSystem<T> original) → void
Called on the copy after cloning completes, with a reference to original.
inherited
onDispose() → void
Override to react at the disposal.
inherited
onEndFrame(double dt) → void
Override to react at the end of each frame.
inherited
onEvent(Event<T> event) → void
Override to handle incoming events within the class.
inherited
onEventRecorded(Event<T> event) → void
Override to handle incoming events within the class.
inherited
onInput() → void
Override to handle input within the class.
inherited
onPostDraw(double dt) → void
Override to react after the draw phase each frame.
inherited
onPostUpdate(double dt) → void
Override to react after the update phase each frame.
inherited
onPreDraw(double dt) → void
Override to react before the draw phase each frame.
inherited
onPreUpdate(double dt) → void
Override to react before the update phase each frame.
override
onRemove() → void
Override to react when removal is about to complete.
inherited
onRestorePersistableData(MapTraversable data, {String? id}) → void
Override to react during the restoration of persistable data.
inherited
onSelf(void fn(SceneSystem<T> self)) SceneSystem<T>
Calls fn with self and returns self, for fluent chaining.
inherited
onStorePersistable(MapData data) MapData
Override to react when the persistence is about to complete.
inherited
persistAutoLoad({int? slot}) → void
inherited
persistAutoSave({required double interval, required int slots}) AnySceneSystemSnapshot<T>?
inherited
replayRecordedEvents({double? fromTime, ECSBase<T>? origin, bool filter(Event<T> event)?}) → void
Re-dispatches events from fromTime sim-scaled seconds ago to now.
inherited
restoreBookmarkedState(String name, {SnapshotMissingPolicy onMissing = .skip, SnapshotExtraPolicy onExtra = .keep}) → void
inherited
restorePersistableData(MapTraversable data, {String? id}) → void
inherited
restoreSnapshot(covariant AnySceneSystemSnapshot<T> snapshot) → void
inherited
run(Task<T> task) → void
inherited
setActive(bool active) SceneSystem<T>
Sets the active state to active and fires the activation hook.
inherited
setVar<V>(VarKey<V> key, V value) SceneSystem<T>
inherited
storePersistable() MapData?
inherited
task(Task<T> task) → void
inherited
toggleActive() SceneSystem<T>
Toggles the active state and fires the activation hook.
inherited
toString() String
A string representation of this object.
inherited
uniqKey(String key) String
Returns a key namespaced to this object's namedId.
inherited
whenClone(SceneSystem<T> fn(SceneSystem<T> newInstance, [SceneSystemCloner<T>? cloner])) SceneSystem<T>
Registers fn as the clone factory, replacing the default clone behavior.
inherited
whenCloned(SceneSystem<T> fn(SceneSystem<T> self, SceneSystem<T> copy)) SceneSystem<T>
Registers fn to run after the clone is produced.
inherited
whenCreateInstance(SceneSystem<T> fn(SceneSystem<T> self)) SceneSystem<T>
Registers fn as the instance factory used during cloning.
inherited

Operators

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

Constants

typeId → const String