ParticleSystem
Defined in: particles/src/ParticleSystem.ts:6
System that drives all ParticleEmitterComponents each frame.
Extends
Section titled “Extends”System
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ParticleSystem():
ParticleSystem
Returns
Section titled “Returns”ParticleSystem
Inherited from
Section titled “Inherited from”System.constructor
Properties
Section titled “Properties”context
Section titled “context”
protectedcontext:EngineContext
Defined in: core/dist/index.d.ts:1016
Reference to the engine context, set on registration.
Inherited from
Section titled “Inherited from”System.context
enabled
Section titled “enabled”enabled:
boolean
Defined in: core/dist/index.d.ts:1014
Whether this system is active.
Inherited from
Section titled “Inherited from”System.enabled
readonlyphase:Update=Phase.Update
Defined in: particles/src/ParticleSystem.ts:7
The phase this system runs in.
Overrides
Section titled “Overrides”System.phase
priority
Section titled “priority”
readonlypriority:0=0
Defined in: particles/src/ParticleSystem.ts:8
Execution priority within the phase. Lower = earlier. Default: 0.
Overrides
Section titled “Overrides”System.priority
Methods
Section titled “Methods”_setContext()
Section titled “_setContext()”_setContext(
context):void
Defined in: core/dist/index.d.ts:1022
Internal
Set the engine context. Called by Engine during startup.
Parameters
Section titled “Parameters”context
Section titled “context”EngineContext
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”System._setContext
onRegister()
Section titled “onRegister()”onRegister(
context):void
Defined in: particles/src/ParticleSystem.ts:12
Called once when the system is registered with the engine.
Parameters
Section titled “Parameters”context
Section titled “context”EngineContext
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”System.onRegister
onUnregister()?
Section titled “onUnregister()?”
optionalonUnregister():void
Defined in: core/dist/index.d.ts:1030
Called when the system is removed.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”System.onUnregister
update()
Section titled “update()”update(
dt):void
Defined in: particles/src/ParticleSystem.ts:18
Called every frame (or every fixed step for FixedUpdate).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”System.update
protecteduse<T>(key):T
Defined in: core/dist/index.d.ts:1024
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
Inherited from
Section titled “Inherited from”System.use