Interface: ISystem

Properties

Property	Type
enabled	boolean
parallel	boolean

Methods

GetName()

GetName(): string;

Returns

string

---

GetOrder()?

optional GetOrder(): SystemOrder;

Within its phase the scheduler runs systems in registration order, except where these constraints say otherwise (Engine/SystemOrder.ts).

Returns

SystemOrder

---

GetPhase()

GetPhase(): SystemPhase;

Returns

SystemPhase

---

GetWrites()?

optional GetWrites(): readonly string[];

Component fields written on entities the system doesn't own — 'MMPX.Transform.scaleX', or 'MMPX.Transform' for every field. Two systems in a phase sharing one with no order between them get a warning at registration.

Returns

readonly string[]

---

OnClose()

OnClose(): void;

Returns

void

---

OnInit()

OnInit(engine): void;

Parameters

Parameter	Type
engine	IEngine

Returns

void

---

OnRender()

OnRender(scene, renderer): void | Promise<void>;

Parameters

Parameter	Type
scene	Scene
renderer	IRenderer

Returns

void | Promise<void>

---

OnRendererChanged()

OnRendererChanged(renderer): void;

Parameters

Parameter	Type
renderer	IRenderer

Returns

void

---

OnStart()

OnStart(scene, renderer): void;

Parameters

Parameter	Type
scene	Scene
renderer	IRenderer

Returns

void

---

OnStop()

OnStop(scene): void;

Parameters

Parameter	Type
scene	Scene

Returns

void

---

OnUpdate()

OnUpdate(scene, dt): void | Promise<void>;

Parameters

Parameter	Type
scene	Scene
dt	number

Returns

void | Promise<void>