Class TimedEvent

constructor

• new TimedEvent(interval, repeat, action): TimedEvent

• Create a TimedEvent that can be scheduled to run in the future.

  Parameters

  • interval: number

    The time between event executions, in seconds

  • repeat: boolean

    Should this event repeat?

  • action: (() => void)

    The action to perform when time is up

    • • (): void

      • Returns void

  Returns TimedEvent

cancelled

add

• add(elapsed): void

• Act as if an additional elapsedMs have transpired.

  Adding a large number (more than the internal msUntilNext) will not cause the event to fire twice. It also will not cause the event to fire immediately... the event will be run on the next iteration of the render loop.

  Parameters

  • elapsed: number

    How many more seconds have transpired. Can be negative to delay when the next timer event happens.

  Returns void

advance

• advance(elapsedMs): boolean

• On a clock tick, we check if this event should run, and if so, run the event. Note that an event may run more than once, if it loops. However, if this is a looping event, and elapsedMs is greater tha the period of the timer, it will not run multiple times.

  Warning: This should only be called by Stage. You probably want to call add() instead.

  Parameters

  • elapsedMs: number

    The milliseconds that have transpired

  Returns boolean

  true if this event has not run for the last time yet (either because it didn't run, or because it did, but it's a repeat event)