TickerRef

pixi-reels

pixi-reels / index / TickerRef

Class: TickerRef

Defined in: utils/TickerRef.ts:21

Safe wrapper around PixiJS Ticker subscriptions.

Solves the #1 memory leak in the original library: dangling ticker callbacks. When destroy() is called, ALL registered callbacks are automatically removed from the ticker.

Usage:

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

Implements#

• Disposable

Constructors#

Constructor#

new TickerRef(_ticker: Ticker): TickerRef;

Defined in: utils/TickerRef.ts:25

Parameters#

Returns#

TickerRef

Accessors#

isDestroyed#

Get Signature#

get isDestroyed(): boolean;

Defined in: utils/TickerRef.ts:27

Returns

boolean

Implementation of#

Disposable.isDestroyed

Methods#

add()#

add(fn: TickerCallback): void;

Defined in: utils/TickerRef.ts:31

Parameters#

Returns#

void

destroy()#

destroy(): void;

Defined in: utils/TickerRef.ts:45

Returns#

void

Implementation of#

Disposable.destroy

remove()#

remove(fn: TickerCallback): void;

Defined in: utils/TickerRef.ts:37

Parameters#

Returns#

void