Abstract Class: Script

Base for user scripts. Each subclass is registered as a script component and ScriptSystem drives the lifecycle, in Unity's order. A script is running while it's enabled and its entity is active in the hierarchy: OnAttach (Unity's Awake) → OnEnable → OnStart (before its first OnUpdate) → per fixed tick: OnUpdate, then OnLateUpdate after every Update-phase system → per rendered frame: OnFrameUpdate.

• OnAttach runs once, the first time the entity is active — even if the script itself is disabled — and after a scene load / prefab spawn has finished, so saved field values and the entity's other components are there. An entity that starts inactive gets it on activation.
• OnEnable / OnDisable run the moment it starts / stops running (SetActive, reparenting, enabled, a scene load or prefab spawn), and OnDisable runs before OnDestroy.
• OnDestroy runs only for a script that got OnAttach. Only during a run (Play / a build), never in the editor's edit mode. Event hooks on the entity's own events: pointer (needs Interaction or Button; events bubble, so a parent's scripts hear its children's), OnClick (Button), OnInput* (InputField), OnToggle* / OnSliderChanged / OnPageChanged, OnParentChanged, OnParticleSystemStopped / OnParticleCollision (a particle system on the entity), and the 2D physics hooks — OnCollision2D / OnTrigger2D (a collider on the entity, or one of its Rigidbody2D's), OnJointBreak2D. Schedule* / OnGlobal helpers auto-bind this and auto-cancel on destroy.

Extends

• Component

Constructors

Constructor

new Script(): Script;

enabled is a plain field on Component. On a script, switching it calls OnEnable / OnDisable right away (Unity), so it becomes an accessor on the instance. Defined here, after Component's field initializer; subclasses mustn't redeclare enabled.

Returns

Script

Overrides

Component.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from
dirty	public	boolean	true	-	Component.dirty
enabled	public	boolean	true	-	Component.enabled
entity	public	Entity	undefined	Set by ScriptSystem on attach — read-only from user code.	-
scene	public	Scene	undefined	-	-

Methods

EmitGlobal()

EmitGlobal<T>(name, payload?): void;

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
name	string
payload?	T

Returns

void

---

OffAllGlobal()

OffAllGlobal(): void;

Returns

void

---

OffGlobal()

OffGlobal<T>(name, listener?): void;

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
name	string
listener?	(payload) => void

Returns

void

---

OnAttach()

OnAttach(): void;

Returns

void

---

OnceGlobal()

OnceGlobal<T>(name, listener): EventUnsubscribe;

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
name	string
listener	(this, payload) => void

Returns

EventUnsubscribe

---

OnClick()

OnClick(_e): void;

A Button on this entity was clicked (honours interactable, unlike OnPointerTap).

Parameters

Parameter	Type
_e	PointerEntityEvent

Returns

void

---

OnCollisionEnter2D()

OnCollisionEnter2D(_collision): void;

2D physics, after the physics step (Unity's). Enter / Exit once per touching pair, Stay each step in between. Collisions get this side's Collision2D, triggers the other collider.

Parameters

Parameter	Type
_collision	Collision2D

Returns

void

---

OnCollisionExit2D()

OnCollisionExit2D(_collision): void;

Parameters

Parameter	Type
_collision	Collision2D

Returns

void

---

OnCollisionStay2D()

OnCollisionStay2D(_collision): void;

Parameters

Parameter	Type
_collision	Collision2D

Returns

void

---

OnDestroy()

OnDestroy(): void;

Returns

void

---

OnDisable()

OnDisable(): void;

Returns

void

---

OnEnable()

OnEnable(): void;

Returns

void

---

OnFrameUpdate()

OnFrameUpdate(_dt): void;

Once per rendered frame with that frame's time-scaled dt (variable) — visual smoothing on displays faster than the fixed step. Not called while the game is paused.

Parameters

Parameter	Type
_dt	number

Returns

void

---

OnGlobal()

OnGlobal<T>(name, listener): EventUnsubscribe;

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
name	string
listener	(this, payload) => void

Returns

EventUnsubscribe

---

OnInputChanged()

OnInputChanged(_text): void;

Parameters

Parameter	Type
_text	string

Returns

void

---

OnInputEndEdit()

OnInputEndEdit(_text): void;

Parameters

Parameter	Type
_text	string

Returns

void

---

OnInputFocus()

OnInputFocus(_text): void;

An InputField on this entity: focused, edited (each change), submitted (Enter), edit ended.

Parameters

Parameter	Type
_text	string

Returns

void

---

OnInputSubmit()

OnInputSubmit(_text): void;

Parameters

Parameter	Type
_text	string

Returns

void

---

OnJointBreak2D()

OnJointBreak2D(_info): void;

A joint on this entity broke (its breakForce / breakTorque was exceeded) and was disabled.

Parameters

Parameter	Type
_info	JointBreak2D

Returns

void

---

OnLateUpdate()

OnLateUpdate(_dt): void;

Same tick, after every Update-phase system (animation, tweens, scheduled callbacks, buttons) — follow cameras, react to animated values.

Parameters

Parameter	Type
_dt	number

Returns

void

---

OnPageChanged()

OnPageChanged(_page): void;

Parameters

Parameter	Type
_page	number

Returns

void

---

OnParentChanged()

OnParentChanged(_oldParent, _newParent): void;

Parameters

Parameter	Type
_oldParent	Entity | null
_newParent	Entity | null

Returns

void

---

OnParticleCollision()

OnParticleCollision(_hit): void;

One of this entity's particles hit a collision plane (sendCollisionEvents on); world position.

Parameters

Parameter	Type
_hit	{ x: number; y: number; }
_hit.x	number
_hit.y	number

Returns

void

---

OnParticleSystemStopped()

OnParticleSystemStopped(_system): void;

This entity's particle system stopped emitting and its last particle is gone.

Parameters

Parameter	Type
_system	ParticleSystem2DComponent

Returns

void

---

OnPointerDown()

OnPointerDown(_e): void;

Parameters

Parameter	Type
_e	PointerEntityEvent

Returns

void

---

OnPointerEnter()

OnPointerEnter(_e): void;

Parameters

Parameter	Type
_e	PointerEntityEvent

Returns

void

---

OnPointerLeave()

OnPointerLeave(_e): void;

Parameters

Parameter	Type
_e	PointerEntityEvent

Returns

void

---

OnPointerMove()

OnPointerMove(_e): void;

Parameters

Parameter	Type
_e	PointerEntityEvent

Returns

void

---

OnPointerTap()

OnPointerTap(_e): void;

Parameters

Parameter	Type
_e	PointerEntityEvent

Returns

void

---

OnPointerUp()

OnPointerUp(_e): void;

Parameters

Parameter	Type
_e	PointerEntityEvent

Returns

void

---

OnSliderChanged()

OnSliderChanged(_value): void;

Parameters

Parameter	Type
_value	number

Returns

void

---

OnStart()

OnStart(): void;

Returns

void

---

OnToggleChanged()

OnToggleChanged(_isOn): void;

UI controls on this entity: a Toggle flipped, a ToggleGroup's on toggle changed (null = none on), a Slider's value changed, a PageView settled on a page.

Parameters

Parameter	Type
_isOn	boolean

Returns

void

---

OnToggleGroupChanged()

OnToggleGroupChanged(_on): void;

Parameters

Parameter	Type
_on	Entity | null

Returns

void

---

OnTransitionHidden()

OnTransitionHidden(): void;

Returns

void

---

OnTransitionShown()

OnTransitionShown(): void;

A UITransition on this entity finished showing / hiding.

Returns

void

---

OnTriggerEnter2D()

OnTriggerEnter2D(_other): void;

Parameters

Parameter	Type
_other	Collider2DComponent

Returns

void

---

OnTriggerExit2D()

OnTriggerExit2D(_other): void;

Parameters

Parameter	Type
_other	Collider2DComponent

Returns

void

---

OnTriggerStay2D()

OnTriggerStay2D(_other): void;

Parameters

Parameter	Type
_other	Collider2DComponent

Returns

void

---

OnUpdate()

OnUpdate(_dt): void;

Fixed step (Engine TPS, 60 by default), time-scaled — gameplay logic.

Parameters

Parameter	Type
_dt	number

Returns

void

---

Schedule()

Schedule(
   callback, 
   interval, 
   repeat?, 
   delay?
): number;

repeat = -1 for infinite. delay defaults to interval.

Parameters

Parameter	Type	Default value
callback	(this) => void	undefined
interval	number	undefined
repeat	number	-1
delay?	number	undefined

Returns

number

---

ScheduleNextFrame()

ScheduleNextFrame(callback): number;

Parameters

Parameter	Type
callback	(this) => void

Returns

number

---

ScheduleOnce()

ScheduleOnce(callback, delay): number;

Parameters

Parameter	Type
callback	(this) => void
delay	number

Returns

number

---

Unschedule()

Unschedule(handle): void;

Parameters

Parameter	Type
handle	number

Returns

void

---

UnscheduleAll()

UnscheduleAll(): void;

Returns

void