Class GameTimer

Frame-rate independent game timer. Useful for countdowns, cooldowns, wave timers, etc. Update with delta (ms) each frame.

Index

Constructors

Accessors

isComplete isPaused isRunning progress ratio timeRemaining

Methods

extend onComplete onTick pause reset resume setDuration start stop update countdown repeating

Constructors

constructor

new GameTimer(durationMs: number): GameTimer
Parameters
- durationMs: number
Returns GameTimer
- Defined in packages/clik-engine/src/utils/GameTimer.ts:14

Accessors

isComplete

get isComplete(): boolean
Returns boolean
- Defined in packages/clik-engine/src/utils/GameTimer.ts:72

isPaused

get isPaused(): boolean
Returns boolean
- Defined in packages/clik-engine/src/utils/GameTimer.ts:71

isRunning

get isRunning(): boolean
Returns boolean
- Defined in packages/clik-engine/src/utils/GameTimer.ts:70

progress

get progress(): number
0 = just started, 1 = complete

Returns number
- Defined in packages/clik-engine/src/utils/GameTimer.ts:79

ratio

get ratio(): number
1 = just started, 0 = complete

Returns number
- Defined in packages/clik-engine/src/utils/GameTimer.ts:76

timeRemaining

get timeRemaining(): number
Returns number
- Defined in packages/clik-engine/src/utils/GameTimer.ts:73

Methods

extend

extend(ms: number): this
Add time to the timer
Parameters
- ms: number
Returns this
- Defined in packages/clik-engine/src/utils/GameTimer.ts:88

onComplete

onComplete(callback: () => void): this
Parameters
- callback: () => void
Returns this
- Defined in packages/clik-engine/src/utils/GameTimer.ts:60

onTick

onTick(callback: (remaining: number, ratio: number) => void): this
Parameters
- callback: (remaining: number, ratio: number) => void
Returns this
- Defined in packages/clik-engine/src/utils/GameTimer.ts:65

pause

pause(): this
Returns this
- Defined in packages/clik-engine/src/utils/GameTimer.ts:31

reset

reset(): this
Returns this
- Defined in packages/clik-engine/src/utils/GameTimer.ts:41

resume

resume(): this
Returns this
- Defined in packages/clik-engine/src/utils/GameTimer.ts:36

setDuration

setDuration(ms: number): this
Change the duration
Parameters
- ms: number
Returns this
- Defined in packages/clik-engine/src/utils/GameTimer.ts:82

start

start(): this
Returns this
- Defined in packages/clik-engine/src/utils/GameTimer.ts:19

stop

stop(): this
Returns this
- Defined in packages/clik-engine/src/utils/GameTimer.ts:26

update

update(delta: number): void
Update each frame with delta in ms
Parameters
- delta: number
Returns void
- Defined in packages/clik-engine/src/utils/GameTimer.ts:47

`Static`countdown

countdown(
    seconds: number,
    onTick: (secsLeft: number) => void,
    onComplete: () => void,
): GameTimer
Create a countdown that fires onTick every second
Parameters
- seconds: number
- onTick: (secsLeft: number) => void
- onComplete: () => void
Returns GameTimer
- Defined in packages/clik-engine/src/utils/GameTimer.ts:104

`Static`repeating

repeating(durationMs: number, onComplete: () => void): GameTimer
Create a repeating timer
Parameters
- durationMs: number
- onComplete: () => void
Returns GameTimer
- Defined in packages/clik-engine/src/utils/GameTimer.ts:94