pixi-wheels

FakeTicker

pixi-wheels


pixi-wheels / testing / FakeTicker

Class: FakeTicker

Defined in: testing/FakeTicker.ts:17

Minimal drop-in for PIXI.Ticker in tests. Exposes the surface the engine uses (add, remove, deltaMS) plus tick(ms) and tickFor(ms) to advance time by hand, so a whole spin runs in a unit test with no requestAnimationFrame and no wall clock.

const ticker = new FakeTicker();
const wheel = new WheelBuilder().ticker(ticker as unknown as Ticker)...build();
ticker.tickFor(5000); // five seconds, in 16 ms frames

Constructors#

Constructor#

new FakeTicker(): FakeTicker;

Returns#

FakeTicker

Properties#

PropertyModifierTypeDefault valueDefined in
deltaMSpublicnumber16testing/FakeTicker.ts:18
deltaTimepublicnumber1testing/FakeTicker.ts:19
elapsedMSpublicnumber0testing/FakeTicker.ts:20
FPSpublicnumber60testing/FakeTicker.ts:24
lastTimepublicnumber0testing/FakeTicker.ts:21
maxFPSpublicnumber0testing/FakeTicker.ts:26
minFPSpublicnumber10testing/FakeTicker.ts:25
speedpublicnumber1testing/FakeTicker.ts:22
startedpublicbooleanfalsetesting/FakeTicker.ts:23

Accessors#

listenerCount#

Get Signature#

get listenerCount(): number;

Defined in: testing/FakeTicker.ts:83

Returns

number

Methods#

add()#

add(fn: TickerCallback): this;

Defined in: testing/FakeTicker.ts:30

Parameters#

ParameterType
fnTickerCallback

Returns#

this


addOnce()#

addOnce(fn: TickerCallback): this;

Defined in: testing/FakeTicker.ts:35

Parameters#

ParameterType
fnTickerCallback

Returns#

this


destroy()#

destroy(): void;

Defined in: testing/FakeTicker.ts:59

Returns#

void


remove()#

remove(fn: TickerCallback): this;

Defined in: testing/FakeTicker.ts:43

Parameters#

ParameterType
fnTickerCallback

Returns#

this


start()#

start(): this;

Defined in: testing/FakeTicker.ts:49

Returns#

this


stop()#

stop(): this;

Defined in: testing/FakeTicker.ts:54

Returns#

this


tick()#

tick(deltaMs?: number): void;

Defined in: testing/FakeTicker.ts:65

Advance by deltaMs and fire every listener once.

Parameters#

ParameterTypeDefault value
deltaMsnumber16

Returns#

void


tickFor()#

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

Defined in: testing/FakeTicker.ts:74

Advance totalMs in stepMs frames.

Parameters#

ParameterTypeDefault value
totalMsnumberundefined
stepMsnumber16

Returns#

void