Class: ParticleSystem2DSimulationSystem

Steps every ParticleSystem2DComponent once per rendered frame (smooth at any refresh rate, unlike the fixed-step Update phase), after TransformSystem so emitters see this frame's world transform. Runs in PreRender, so it's also what plays an effect in the editor's edit mode — but only for the entities under SetPreview's roots (Unity previews the selected effect).

The Engine hands it this frame's deltas (SetFrame): game-scaled while the game runs, nothing while paused (a Step runs one fixed step), real time for the editor preview.

It owns ParticleSystem2DComponent.dirty: a changed field may be a sub-emitter trigger, so the parent / child links are rebuilt then (and on reparenting).

Extends

• System

Constructors

Constructor

new ParticleSystem2DSimulationSystem(): ParticleSystem2DSimulationSystem;

Returns

ParticleSystem2DSimulationSystem

Inherited from

System.constructor

Properties

Property	Modifier	Type	Default value	Inherited from
enabled	public	boolean	true	System.enabled
parallel	public	boolean	false	System.parallel

Methods

GetName()

GetName(): string;

Returns

string

Overrides

System.GetName

---

GetOrder()

GetOrder(): SystemOrder;

Ordered: emitters read this frame's world transforms.

Returns

SystemOrder

---

GetPhase()

GetPhase(): SystemPhase;

Returns

SystemPhase

Overrides

System.GetPhase

---

GetPreviewSpeed()

GetPreviewSpeed(): number;

Returns

number

---

OnClose()

OnClose(): void;

Returns

void

Inherited from

System.OnClose

---

OnInit()

OnInit(_engine): void;

Parameters

Parameter	Type
_engine	IEngine

Returns

void

Inherited from

System.OnInit

---

OnRender()

OnRender(scene, _renderer): void;

Parameters

Parameter	Type
scene	Scene
_renderer	IRenderer

Returns

void

Overrides

System.OnRender

---

OnRendererChanged()

OnRendererChanged(_renderer): void;

Parameters

Parameter	Type
_renderer	IRenderer

Returns

void

Inherited from

System.OnRendererChanged

---

OnStart()

OnStart(scene, _renderer): void;

Parameters

Parameter	Type
scene	Scene
_renderer	IRenderer

Returns

void

Overrides

System.OnStart

---

OnStop()

OnStop(_scene): void;

Parameters

Parameter	Type
_scene	Scene

Returns

void

Overrides

System.OnStop

---

OnUpdate()

OnUpdate(_scene, _dt): void | Promise<void>;

Parameters

Parameter	Type
_scene	Scene
_dt	number

Returns

void | Promise<void>

Inherited from

System.OnUpdate

---

SetFrame()

SetFrame(
   dt, 
   unscaledDt, 
   simulating
): void;

dt: game time this frame (time-scaled; 0 while paused). unscaledDt: real time, or one fixed step on a paused Step. simulating: the game runs (not the editor's edit mode).

Parameters

Parameter	Type
dt	number
unscaledDt	number
simulating	boolean

Returns

void

---

SetPreview()

SetPreview(roots, speed?): void;

Edit mode: these entities' particle systems (and their descendants') play, at speed. Anything leaving the preview is cleared.

Parameters

Parameter	Type	Default value
roots	readonly number[] | null	undefined
speed	number	1

Returns

void