pixi-reels

FakeTicker

pixi-reels


pixi-reels / testing / FakeTicker

Class: FakeTicker

Defined in: testing/FakeTicker.ts:23

Minimal drop-in replacement for PIXI.Ticker for tests.

Exposes the exact surface pixi-reels uses internally (add, remove, deltaMS) plus a manual tick(deltaMs) method so tests can advance time deterministically without depending on requestAnimationFrame.

const ticker = new FakeTicker();
const reelSet = new ReelSetBuilder()
  .ticker(ticker as unknown as PIXI.Ticker)
  ...
  .build();

ticker.tick(16);  // advance one frame
ticker.tickFor(500);  // advance 500ms in 16ms frames

Constructors#

Constructor#

new FakeTicker(): FakeTicker;

Returns#

FakeTicker

Properties#

PropertyModifierTypeDefault valueDefined in
deltaMSpublicnumber16testing/FakeTicker.ts:24
deltaTimepublicnumber1testing/FakeTicker.ts:25
elapsedMSpublicnumber0testing/FakeTicker.ts:26
FPSpublicnumber60testing/FakeTicker.ts:30
lastTimepublicnumber0testing/FakeTicker.ts:27
maxFPSpublicnumber0testing/FakeTicker.ts:32
minFPSpublicnumber10testing/FakeTicker.ts:31
speedpublicnumber1testing/FakeTicker.ts:28
startedpublicbooleanfalsetesting/FakeTicker.ts:29

Accessors#

listenerCount#

Get Signature#

get listenerCount(): number;

Defined in: testing/FakeTicker.ts:92

Returns

number

Methods#

add()#

add(fn: TickerCallback): this;

Defined in: testing/FakeTicker.ts:36

Parameters#

ParameterType
fnTickerCallback

Returns#

this


addOnce()#

addOnce(fn: TickerCallback): this;

Defined in: testing/FakeTicker.ts:41

Parameters#

ParameterType
fnTickerCallback

Returns#

this


destroy()#

destroy(): void;

Defined in: testing/FakeTicker.ts:65

Returns#

void


remove()#

remove(fn: TickerCallback): this;

Defined in: testing/FakeTicker.ts:49

Parameters#

ParameterType
fnTickerCallback

Returns#

this


start()#

start(): this;

Defined in: testing/FakeTicker.ts:55

Returns#

this


stop()#

stop(): this;

Defined in: testing/FakeTicker.ts:60

Returns#

this


tick()#

tick(deltaMs?: number): void;

Defined in: testing/FakeTicker.ts:71

Manually advance time by deltaMs milliseconds and fire all listeners.

Parameters#

ParameterTypeDefault value
deltaMsnumber16

Returns#

void


tickFor()#

tickFor(totalMs: number, stepMs?: number): void;

Defined in: testing/FakeTicker.ts:83

Advance time by totalMs, chopped into stepMs frames.

Parameters#

ParameterTypeDefault value
totalMsnumberundefined
stepMsnumber16

Returns#

void