ProcessSystem
Defined in: ProcessSystem.ts:36
Built-in system that ticks the "frame"-clock processes of all
ProcessComponents on entities in non-paused scenes, plus the frame-clock
entries of the engine-global and scene-bound process pools.
ProcessSystem holds all four engine-level pools — engine-global and
scene-bound, one of each per clock. ProcessFixedUpdateSystem advances the
two fixed-clock pools and every "fixed"-clock entity process.
Runs at Phase.Update with priority 500, ensuring tweened values are fresh before ComponentUpdateSystem (priority 1000) reads them.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ProcessSystem():
ProcessSystem
Returns
Section titled “Returns”ProcessSystem
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”context
Section titled “context”
protectedcontext:EngineContext
Defined in: System.ts:22
Reference to the engine context, set on registration.
Inherited from
Section titled “Inherited from”enabled
Section titled “enabled”enabled:
boolean=true
Defined in: System.ts:19
Whether this system is active.
Inherited from
Section titled “Inherited from”
readonlyphase:Update=Phase.Update
Defined in: ProcessSystem.ts:37
The phase this system runs in.
Overrides
Section titled “Overrides”priority
Section titled “priority”
readonlypriority:500=500
Defined in: ProcessSystem.ts:38
Execution priority within the phase. Lower = earlier. Default: 0.
Overrides
Section titled “Overrides”timeScale
Section titled “timeScale”timeScale:
number=1
Defined in: ProcessSystem.ts:41
Global time scale multiplier. Stacks multiplicatively with per-scene timeScale.
Methods
Section titled “Methods”_setContext()
Section titled “_setContext()”_setContext(
context):void
Defined in: System.ts:31
Internal
Set the engine context. Called by SystemScheduler when the system is registered.
Parameters
Section titled “Parameters”context
Section titled “context”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_tickFixedGlobal()
Section titled “_tickFixedGlobal()”_tickFixedGlobal(
dt):void
Defined in: ProcessSystem.ts:186
Internal
Advance the engine-global fixed-clock pool by one fixed step. dt arrives
already scaled.
Called by ProcessFixedUpdateSystem.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
_tickFixedScene()
Section titled “_tickFixedScene()”_tickFixedScene(
scene,dt):void
Defined in: ProcessSystem.ts:195
Internal
Advance one scene’s fixed-clock pool by one fixed step. dt arrives
already scaled.
Called by ProcessFixedUpdateSystem.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
add(
process,options?):Process
Defined in: ProcessSystem.ts:96
Add an engine-global process. Ticked under the global timeScale only;
NOT gated by per-scene pause or scaled by per-scene timeScale. Use this
for cross-scene effects (e.g. screen-scope filter fades on app.stage)
or processes that have no owning scene.
options.clock picks the clock that advances the process (default
"frame", rendered-frame time; see ProcessClock). "fixed" advances it
on the fixed timestep through ProcessFixedUpdateSystem.
Parameters
Section titled “Parameters”process
Section titled “process”options?
Section titled “options?”clock?
Section titled “clock?”Returns
Section titled “Returns”addForScene()
Section titled “addForScene()”addForScene(
scene,process,options?):Process
Defined in: ProcessSystem.ts:116
Add a process bound to a specific scene’s lifecycle. Ticked only while
the scene is active (not paused) and scaled by the scene’s timeScale,
exactly like an entity-owned ProcessComponent. Use this for layer or
scene-scope effect fades that should pause with the scene.
options.clock picks the clock that advances the process (default
"frame", rendered-frame time; see ProcessClock). "fixed" advances it
on the fixed timestep through ProcessFixedUpdateSystem. The pool pauses
with its scene and follows the scene’s scale on either clock.
Parameters
Section titled “Parameters”process
Section titled “process”options?
Section titled “options?”clock?
Section titled “clock?”Returns
Section titled “Returns”cancel()
Section titled “cancel()”cancel(
tag?):void
Defined in: ProcessSystem.ts:133
Cancel engine-global processes on both clocks, optionally by tag.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
cancelForScene()
Section titled “cancelForScene()”cancelForScene(
scene,tag?):void
Defined in: ProcessSystem.ts:139
Cancel every scene-bound process for scene on both clocks, optionally by tag.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
onRegister()
Section titled “onRegister()”onRegister(
context):void
Defined in: ProcessSystem.ts:51
Called once when the system is registered with the engine.
Parameters
Section titled “Parameters”context
Section titled “context”Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”onUnregister()
Section titled “onUnregister()”onUnregister():
void
Defined in: ProcessSystem.ts:66
Called when the system is removed.
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”update()
Section titled “update()”update(
dt):void
Defined in: ProcessSystem.ts:144
Called every frame (or every fixed step for FixedUpdate).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”
protecteduse<T>(key):T
Defined in: System.ts:36
Resolve a service by key, cached after first lookup.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”ServiceKey<T>
Returns
Section titled “Returns”T