Documentation / @debuffjp/core / Hooks

Class: Hooks

Defined in: hooks.ts:37

Typed lifecycle hooks on game.hooks. Each method registers a listener and returns an unsubscribe function.

Order within a step: beforeUpdate → camera → scene.update → afterUpdate. Order within a frame: clear → beforeRender → scene.render → afterRender. beforeRender/afterRender draw in logical units; afterRender starts from a clean transform. Steps skipped by freeze() fire no update hooks.

Constructors

Constructor

new Hooks(): Hooks

Returns

Hooks

Methods

afterRender()

afterRender(fn): Unsubscribe

Defined in: hooks.ts:60

Parameters

fn

(draw, alpha) => void

Returns

Unsubscribe

---

afterUpdate()

afterUpdate(fn): Unsubscribe

Defined in: hooks.ts:52

Parameters

fn

(dt) => void

Returns

Unsubscribe

---

beforeRender()

beforeRender(fn): Unsubscribe

Defined in: hooks.ts:56

Parameters

fn

(draw, alpha) => void

Returns

Unsubscribe

---

beforeUpdate()

beforeUpdate(fn): Unsubscribe

Defined in: hooks.ts:48

Parameters

fn

(dt) => void

Returns

Unsubscribe

---

counts()

counts(): Record<HookName, number>

Defined in: hooks.ts:79

Number of listeners per hook, for inspection.

Returns

Record<HookName, number>

---

emit()

emit<K>(name, ...args): void

Defined in: hooks.ts:86

Internal

Called by Game.

Type Parameters

K

K extends keyof HookArgs

Parameters

name

K

args

...HookArgs[K]

Returns

void

---

error()

error(fn): Unsubscribe

Defined in: hooks.ts:69

The game loop stopped on an error (see game.lastError).

Parameters

fn

(error, context) => void

Returns

Unsubscribe

---

gameEvent()

gameEvent(fn): Unsubscribe

Defined in: hooks.ts:74

The game called game.emit(name, detail).

Parameters

fn

(name, detail) => void

Returns

Unsubscribe

---

sceneChange()

sceneChange(fn): Unsubscribe

Defined in: hooks.ts:64

Parameters

fn

(next, previous) => void

Returns

Unsubscribe