Class Timer

constructor

• new Timer(options?: TimerOptions): Timer

  Parameters

  • options: TimerOptions = {}

  Returns Timer

duration

mode

paused

speed

completed

• completed(): boolean

  Returns boolean

cycleEnded

• cycleEnded(): boolean

  Returns boolean

cyclesCompleted

• cyclesCompleted(): number

  Returns number

cyclesCompletedThisFrame

• cyclesCompletedThisFrame(): number

  Returns number

cycleStarted

• cycleStarted(): boolean

  Returns boolean

elapsed

• elapsed(): number

  Returns number

pause

• pause(): void

  Returns void

play

• play(): void

  Returns void

playbackChanged

• playbackChanged(): boolean

  Returns boolean

progress

• progress(): number

  Returns number

requestPlayback

• requestPlayback(): void

  Returns void

reset

• reset(): void

  Returns void

seek

• seek(timestamp: number): void

  Parameters

  • timestamp: number

  Returns void

start

• start(): void

  Returns void

stop

• stop(): void

  Returns void

update

• update(dt: number): void

  Parameters

  • dt: number

  Returns void

Staticclone

• clone(target: Timer): Timer

  Parameters

  • target: Timer

  Returns Timer

Staticcopy

• copy(source: Timer, target?: Timer): Timer

  Parameters

  • source: Timer
  • target: Timer = ...

  Returns Timer

Staticdeserialize

• deserialize(value: TimerSerial, out?: Timer): Timer

  Parameters

  • value: TimerSerial
  • Optionalout: Timer = ...

  Returns Timer

Staticserialize

• serialize(
      value: Timer,
  ): {
      duration: number;
      elapsedCount: number;
      elapsedTime: number;
      endTicks: number;
      finished: boolean;
      mode: number;
      paused: boolean;
      playbackRequested: boolean;
      playbackResolved: boolean;
      speed: number;
      startTicks: number;
  }

  Parameters

  • value: Timer

  Returns {
      duration: number;
      elapsedCount: number;
      elapsedTime: number;
      endTicks: number;
      finished: boolean;
      mode: number;
      paused: boolean;
      playbackRequested: boolean;
      playbackResolved: boolean;
      speed: number;
      startTicks: number;
  }

StaticvalidateSerial

• validateSerial(value: TimerSerial): value is TimerSerial

  Parameters

  • value: TimerSerial

  Returns value is TimerSerial