GameObjectPrototype

Updatables provide the proper way to manage objects that update their state every tick. Updatables may not be notified every tick, if there are too many, to avoid user interface freezes. Legacy variant of IUpdatable.

Hierarchy

• Updatable
  • GameObjectPrototype

Index

Properties

• _handle
• init
• loaded
• noupdate
• remove

Methods

• update

Properties

optional_handle

since: 3.1.1b127

_handle?: UpdatableHandle

Inherited from Updatable._handle

By default, recurring schedule is set to 1 and performs indefinitely.

optionalinit

init?: (...args: any) => void

Function that is called when a new instance of GameObject is created, the engine passes all the arguments of GameObject.deploy function to this function.

---

Type declaration

• • (...args: any): void

  • Parameters

    • rest...args: any

    Returns void

optionalloaded

loaded?: () => void

Function that is called when a GameObject is loaded.

---

Type declaration

• • (): void

  • Returns void

optionalnoupdate

noupdate?: boolean

Inherited from Updatable.noupdate

Determines can updatable be updated by calling update, useful when is needed to temporary freeze ticking logic.

optionalremove

remove?: boolean

Inherited from Updatable.remove

Once true, the object will be removed from updatables list and will no longer receive update calls.

Methods

update

• update(): void

• Inherited from Updatable.update

  Called every tick to execute pending updates.

  ---

  Returns void