Class TestClock

The TestClock is meant for debugging interactions in excalibur that require precise timing to replicate or test

Hierarchy

Clock
- TestClock

Index

Constructors

Properties

fpsSampler tick

Methods

elapsed isRunning now run schedule setFatalExceptionHandler start step stop toStandardClock toTestClock update

Constructors

constructor

new TestClock(options: ClockOptions & TestClockOptions): TestClock
Parameters
- options: ClockOptions & TestClockOptions
Returns TestClock
Overrides Clock.constructor
- Defined in Util/Clock.ts:232

Properties

fpsSampler

fpsSampler: FpsSampler

`Protected` tick

tick: ((elapsedMs: number) => any)

Type declaration

- (elapsedMs: number): any
- Parameters
  - elapsedMs: number
  Returns any

Methods

elapsed

elapsed(): number
Get the elapsed time for the last completed frame

Returns number
Inherited from Clock.elapsed
- Defined in Util/Clock.ts:55

isRunning

isRunning(): boolean
Returns if the clock is currently running

Returns boolean
Overrides Clock.isRunning
- Defined in Util/Clock.ts:246

now

now(): number
Get the current time in milliseconds

Returns number
Overrides Clock.now
- Defined in Util/Clock.ts:242

run

run(numberOfSteps: number, overrideUpdateMs?: number): void
Run a number of steps that tick the clock, optionally specify an elapsed time in milliseconds
Parameters
- numberOfSteps: number
- Optional overrideUpdateMs: number
Returns void
- Defined in Util/Clock.ts:278

schedule

schedule(cb: (() => any), timeoutMs?: number): void
Schedule a callback to fire given a timeout in milliseconds using the excalibur Clock

This is useful to use over the built in browser setTimeout because callbacks will be tied to the excalibur update clock, instead of browser time, this means that callbacks wont fire if the game is stopped or paused.
Parameters
- cb: (() => any)
  
  callback to fire
  - - (): any
    - Returns any
- timeoutMs: number = 0
  
  Optionally specify a timeout in milliseconds from now, default is 0ms which means the next possible tick
Returns void
Inherited from Clock.schedule
- Defined in Util/Clock.ts:95

setFatalExceptionHandler

setFatalExceptionHandler(handler: ((e: unknown) => any)): void
Parameters
- handler: ((e: unknown) => any)
  - - (e: unknown): any
    - Parameters
      
      e: unknown
      
      Returns any
Returns void
Inherited from Clock.setFatalExceptionHandler
- Defined in Util/Clock.ts:81

start

start(): void
Start the clock, it will then periodically call the tick(elapsedMilliseconds) since the last tick

Returns void
Overrides Clock.start
- Defined in Util/Clock.ts:249

step

step(overrideUpdateMs?: number): void
Manually step the clock forward 1 tick, optionally specify an elapsed time in milliseconds
Parameters
- Optional overrideUpdateMs: number
Returns void
- Defined in Util/Clock.ts:260

stop

stop(): void
Stop the clock, tick() is no longer called

Returns void
Overrides Clock.stop
- Defined in Util/Clock.ts:252

toStandardClock

toStandardClock(): StandardClock
Returns StandardClock
Inherited from Clock.toStandardClock
- Defined in Util/Clock.ts:74

toTestClock

toTestClock(): TestClock
Returns TestClock
Inherited from Clock.toTestClock
- Defined in Util/Clock.ts:66

`Protected` update

update(overrideUpdateMs?: number): void
Parameters
- Optional overrideUpdateMs: number
Returns void
Inherited from Clock.update
- Defined in Util/Clock.ts:111