Class Timer

Represents a timer, which must be updated manually with gdjs.Timer.updateTime.

Index

Constructors

Methods

getName getNetworkSyncData getTime isPaused reset setPaused setTime updateFromNetworkSyncData updateTime

Constructors

constructor

new Timer(name): Timer
Parameters
- name: string
  The name of the timer.
Returns Timer
- Defined in GDJS/Runtime/timer.ts:18

Methods

getName

getName(): string
Get the name of the timer

Returns string
The name of the timer
- Defined in GDJS/Runtime/timer.ts:26

getNetworkSyncData

getNetworkSyncData(): TimerNetworkSyncData
Returns TimerNetworkSyncData
- Defined in GDJS/Runtime/timer.ts:78

getTime

getTime(): number
Get the time of the timer, in milliseconds.

Returns number
The time of the timer, in milliseconds.
- Defined in GDJS/Runtime/timer.ts:34

isPaused

isPaused(): boolean
Check if the timer is paused.

Returns boolean
- Defined in GDJS/Runtime/timer.ts:74

reset

reset(): void
Reset the time to zero.

Returns void
- Defined in GDJS/Runtime/timer.ts:59

setPaused

setPaused(enable): void
Set if the timer is paused.
Parameters
- enable: boolean
  true to pause the timer, false otherwise.
Returns void
- Defined in GDJS/Runtime/timer.ts:67

setTime

setTime(time): void
Change the time.
Parameters
- time: number
  The new time, in milliseconds.
Returns void
- Defined in GDJS/Runtime/timer.ts:52

updateFromNetworkSyncData

updateFromNetworkSyncData(syncData): void
Parameters
- syncData: TimerNetworkSyncData
Returns void
- Defined in GDJS/Runtime/timer.ts:85

updateTime

updateTime(time): void
Notify the timer that some time has passed.
Parameters
- time: number
  The elapsed time, in milliseconds.
Returns void
- Defined in GDJS/Runtime/timer.ts:42