Class Timer

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

Hierarchy

Timer

Index

Constructors

constructor

Methods

Constructors

constructor

new Timer(name: string): Timer

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

Methods

getName

getName(): string

- Defined in GDJS/Runtime/timer.ts:26
Get the name of the timer

Returns string
The name of the timer

getNetworkSyncData

getNetworkSyncData(): TimerNetworkSyncData

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

getTime

getTime(): number

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

Returns number
The time of the timer, in milliseconds.

isPaused

isPaused(): boolean

- Defined in GDJS/Runtime/timer.ts:74
Check if the timer is paused.

Returns boolean

reset

reset(): void

- Defined in GDJS/Runtime/timer.ts:59
Reset the time to zero.

Returns void

setPaused

setPaused(enable: boolean): void

- Defined in GDJS/Runtime/timer.ts:67
Set if the timer is paused.

Parameters
- enable: boolean
  
  true to pause the timer, false otherwise.
Returns void

setTime

setTime(time: number): void

- Defined in GDJS/Runtime/timer.ts:52
Change the time.

Parameters
- time: number
  
  The new time, in milliseconds.
Returns void

updateFromNetworkSyncData

updateFromNetworkSyncData(syncData: TimerNetworkSyncData): void

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

updateTime

updateTime(time: number): void

- Defined in GDJS/Runtime/timer.ts:42
Notify the timer that some time has passed.

Parameters
- time: number
  
  The elapsed time, in milliseconds.
Returns void

Generated using TypeDoc