Hud

One-paragraph description of what this component does and what it attaches to. Mention any required sibling components (e.g. Model, Transform).

Public fields

• exampleNumber: number — what it controls, units, valid range.
• exampleString: string — what it controls.
• exampleBool: boolean — what it controls.

Methods

• :methodName(arg) — what it does and when to call it.

Lifecycle

• awake() — same-frame attach hook. What initial state this component sets up.
• start() — first-frame-after-awake hook. Cross-component setup that needs the other components on the entity to have finished awake.
• update(dt) — per-frame while the gameplay clock runs. What this component does each tick.
• onDestroy() — cleanup performed on detach / entity despawn.

See man components for the full hook list (onEnable, fixedUpdate, onPropertyChanged, etc.) and the timing details.

Usage

entity(id).component.add("Hud", { exampleNumber = 1.0 })
entity(id).component.get("Hud"):methodName("foo")