TickerRef

pixi-wheels

pixi-wheels / index / TickerRef

Class: TickerRef

Defined in: utils/TickerRef.ts:19

Safe wrapper around PixiJS Ticker subscriptions.

A dangling ticker.add() callback is the classic slot-client leak: the wheel is removed from the stage, the ticker keeps calling into it. Every callback registered through a TickerRef is removed on destroy().

const ref = new TickerRef(app.ticker);
ref.add((ticker) => ring.update(ticker));
ref.destroy(); // all callbacks removed

Implements#

• Disposable

Constructors#

Constructor#

new TickerRef(_ticker: Ticker): TickerRef;

Defined in: utils/TickerRef.ts:23

Parameters#

Returns#

TickerRef

Accessors#

isDestroyed#

Get Signature#

get isDestroyed(): boolean;

Defined in: utils/TickerRef.ts:25

Returns

boolean

Implementation of#

Disposable.isDestroyed

Methods#

add()#

add(fn: TickerCallback): void;

Defined in: utils/TickerRef.ts:29

Parameters#

Returns#

void

destroy()#

destroy(): void;

Defined in: utils/TickerRef.ts:43

Returns#

void

Implementation of#

Disposable.destroy

remove()#

remove(fn: TickerCallback): void;

Defined in: utils/TickerRef.ts:35

Parameters#

Returns#

void