Class Time

constructor

• new Time(): Time

• Returns Time

Static Readonly game

addTimer

• addTimer(_timer): number

• This method is called internally by Time and Timer and must not be called otherwise

  Parameters

  • _timer: Timer

  Returns number

clearAllTimers

• clearAllTimers(): void

• Stops and deletes all Timers attached. Should be called before this Time-object leaves scope

  Returns void

delay

• delay(_lapse): Promise<void>

• Returns a Promise to be resolved after the time given. To be used with async/await

  Parameters

  • _lapse: number

  Returns Promise<void>

deleteTimer

• deleteTimer(_id): void

• Deletes the timer with the id given by this time object

  Parameters

  • _id: number

  Returns void

deleteTimerByItsInternalId

• deleteTimerByItsInternalId(_id): void

• Deletes Timer found using the internal id of the connected interval-object

  Parameters

  • _id: number

  Returns void

get

• get(): number

• Retrieves the current scaled timestamp of this instance in milliseconds

  Returns number

getElapsedSincePreviousCall

• getElapsedSincePreviousCall(): number

• Retrieves the scaled time in milliseconds passed since the last call to this method Automatically reset at every call to set(...) and setScale(...)

  Returns number

getOffset

• getOffset(): number

• Retrieves the offset of this time

  Returns number

getRemainder

• getRemainder(_to): number

• Returns the remaining time to the given point of time

  Parameters

  • _to: number

  Returns number

getScale

• getScale(): number

• Retrieves the current scaling of this time

  Returns number

getTimer

• getTimer(_id): Timer

• Returns a reference to the timer with the given id or null if not found.

  Parameters

  • _id: number

  Returns Timer

getTimers

• getTimers(): Timers

• Returns a copy of the list of timers currently installed on this time object

  Returns Timers

hasTimers

• hasTimers(): boolean

• Returns true if there are Timers installed to this

  Returns boolean

set

• set(_time?): void

• (Re-) Sets the timestamp of this instance

  Parameters

  • _time: number = 0

    The timestamp to represent the current time (default 0.0)

  Returns void

setScale

• setScale(_scale?): void

• Sets the scaling of this time, allowing for slowmotion (<1) or fastforward (>1)

  Parameters

  • _scale: number = 1.0

    The desired scaling (default 1.0)

  Returns void

setTimer

• setTimer(_lapse, _count, _handler, ..._arguments): number

• Installs a timer at this time object

  Parameters

  • _lapse: number

    The object-time to elapse between the calls to _callback
  • _count: number

    The number of calls desired, 0 = Infinite
  • _handler: TimerHandler

    The function to call each the given lapse has elapsed
  • Rest ..._arguments: Object[]

    Additional parameters to pass to callback function

  Returns number

Static getUnits

• getUnits(_milliseconds): TimeUnits

• Returns representions of the time given in milliseconds in various formats defined in TimeUnits

  Parameters

  • _milliseconds: number

  Returns TimeUnits