Class: MaskSystem

For each MaskComponent host, push SetNodeMask(source, inverted) onto every descendant. Runs in the Render phase after the drawable systems so the mask source's resource is guaranteed to be attached. Per-host bookkeeping lets us roll back when maskSource/inverted changes or the component is removed.

Extends

• System

Constructors

Constructor

new MaskSystem(): MaskSystem;

Returns

MaskSystem

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: a mask source's drawable is attached before it's looked up.

Returns

SystemOrder

---

GetPhase()

GetPhase(): SystemPhase;

Returns

SystemPhase

Overrides

System.GetPhase

---

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

Overrides

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