Class Clock

Handles time management for the game.

Hierarchy (View Summary)

Clock
- VirtualClock

Index

Constructors

Methods

getDelta getElapsed getFrameRate start update deserialize getDelta getElapsed getFrameRate serialize start update

Constructors

constructor

new Clock(): Clock
Returns Clock

Methods

getDelta

getDelta(): number
Returns number
- Defined in packages/time/src/clock.js:42

getElapsed

getElapsed(): number
Returns number
- Defined in packages/time/src/clock.js:35

getFrameRate

getFrameRate(): number
Returns number
- Defined in packages/time/src/clock.js:49

start

start(): void
Returns void
- Defined in packages/time/src/clock.js:28

update

update(accumulate?: number): number
Parameters
- accumulate: number = ...
Returns number
- Defined in packages/time/src/clock.js:57

`Static`deserialize

deserialize(value: ClockSerial, out?: Clock): Clock
Parameters
- value: ClockSerial
- Optionalout: Clock = ...
Returns Clock
- Defined in packages/time/src/clock.js:127

`Static`getDelta

getDelta(clock: Clock): number
Gets the time between two frames/ticks clock.
Parameters
- clock: Clock
Returns number
- Defined in packages/time/src/clock.js:85

`Static`getElapsed

getElapsed(clock: Clock): number
Gets the elapsed time of the clock.
Parameters
- clock: Clock
Returns number
- Defined in packages/time/src/clock.js:76

`Static`getFrameRate

getFrameRate(clock: Clock): number
Gets the frameRate of the clock.
Parameters
- clock: Clock
Returns number
- Defined in packages/time/src/clock.js:94

`Static`serialize

serialize(value: Clock): { delta: number; elapsed: number; lastTick: number }
Parameters
- value: Clock
Returns { delta: number; elapsed: number; lastTick: number }
- Defined in packages/time/src/clock.js:115

`Static`start

start(clock: Clock): void
Starts the clock.
Parameters
- clock: Clock
Returns void
- Defined in packages/time/src/clock.js:66

`Static`update

update(clock: Clock, accumulate?: number): number
Updates the clock.
Parameters
- clock: Clock
- Optionalaccumulate: number = ...
Returns number
- Defined in packages/time/src/clock.js:104