Class: ScriptSystem

Drives the Script lifecycle in Unity's order: OnAttach (Awake) once the entity is first active and fully built; OnEnable / OnDisable the moment a script starts / stops running (enabled and the entity active in the hierarchy); OnStart before its first OnUpdate, once every pending OnEnable has run; OnUpdate every tick while running; OnDisable then OnDestroy on remove. Immediate paths: the script's enabled setter and Scene.OnActiveRefreshed (SetActive, reparenting, loads, spawns). Each tick also re-checks every script, for changes that bypass both (an active field written directly). Catches throws per hook so a misbehaving script doesn't take down its neighbours.

Extends

• System

Implements

• ScriptLifecycle

Constructors

Constructor

new ScriptSystem(): ScriptSystem;

Returns

ScriptSystem

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

---

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 | Promise<void>;

Parameters

Parameter	Type
_scene	Scene
_renderer	IRenderer

Returns

void | Promise<void>

Inherited from

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;

Every call into script code is timed as Scripts for the stats overlay (one section per pass or event, not per script).

Parameters

Parameter	Type
scene	Scene
dt	number

Returns

void

Overrides

System.OnUpdate

---

RefreshScript()

RefreshScript(script): void;

A script's enabled changed — OnEnable / OnDisable now, unless mid-build (the load's own refresh covers it) or outside a run.

Parameters

Parameter	Type
script	Script

Returns

void

Implementation of

ScriptLifecycle.RefreshScript

---

RunFrame()

RunFrame(dt): void;

OnFrameUpdate pass — the Engine calls it once per rendered frame while the game runs.

Parameters

Parameter	Type
dt	number

Returns

void

---

RunLate()

RunLate(dt): void;

OnLateUpdate pass — ScriptLateUpdateSystem calls it in PostUpdate, after every Update-phase system. Running state is this tick's, from OnUpdate's pass.

Parameters

Parameter	Type
dt	number

Returns

void