Class: ToggleSystem

Drives ToggleComponent / ToggleGroupComponent. PreRender, once per rendered frame.

Every frame (edit mode too): the checkmark entity is active exactly while isOn, and a Button beside the toggle takes its interactable. While the game runs: a tap flips isOn (a tap that dragged doesn't — it was a scroll); any change of isOn, tap or code, fires ToggleChanged, and in a group turns the others off and fires ToggleGroupChanged. A group without allowSwitchOff keeps one toggle on: the on one can't be tapped off, and on entering play a group with none on turns its first on.

Extends

• BoundComponentSystem<ToggleComponent, BoundToggle>

Constructors

Constructor

new ToggleSystem(): ToggleSystem;

Returns

ToggleSystem

Inherited from

BoundComponentSystem<ToggleComponent, BoundToggle>.constructor

Properties

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

Methods

GetName()

GetName(): string;

Returns

string

Overrides

BoundComponentSystem.GetName

---

GetOrder()

GetOrder(): SystemOrder;

Returns

SystemOrder

---

GetPhase()

GetPhase(): SystemPhase;

Returns

SystemPhase

Overrides

BoundComponentSystem.GetPhase

---

OnClose()

OnClose(): void;

Returns

void

Inherited from

BoundComponentSystem.OnClose

---

OnInit()

OnInit(engine): void;

Parameters

Parameter	Type
engine	IEngine

Returns

void

Inherited from

BoundComponentSystem.OnInit

---

OnRender()

OnRender(scene, _renderer): void;

Parameters

Parameter	Type
scene	Scene
_renderer	IRenderer

Returns

void

Overrides

BoundComponentSystem.OnRender

---

OnRendererChanged()

OnRendererChanged(_renderer): void;

Parameters

Parameter	Type
_renderer	IRenderer

Returns

void

Inherited from

BoundComponentSystem.OnRendererChanged

---

OnStart()

OnStart(scene, renderer): void;

Parameters

Parameter	Type
scene	Scene
renderer	IRenderer

Returns

void

Overrides

BoundComponentSystem.OnStart

---

OnStop()

OnStop(_scene): void;

Parameters

Parameter	Type
_scene	Scene

Returns

void

Inherited from

BoundComponentSystem.OnStop

---

OnUpdate()

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

Parameters

Parameter	Type
_scene	Scene
_dt	number

Returns

void | Promise<void>

Inherited from

BoundComponentSystem.OnUpdate