Class Timer

The Excalibur timer hooks into the internal timer and fires callbacks, after a certain interval, optionally repeating.

Hierarchy

  • Timer

Constructors

constructor

Properties

id interval maxNumberOfRepeats random randomRange repeats scene

Accessors

complete isRunning timeElapsedTowardNextAction timeToNextAction timesRepeated

Methods

cancel getTimeRunning off on pause reset resume start stop update

Constructors

constructor

Properties

id

id: number = 0

interval

interval: number = 10

maxNumberOfRepeats

maxNumberOfRepeats: number = -1

random

random: Random

randomRange

randomRange: [number, number] = ...

repeats

repeats: boolean = false

scene

scene: Scene<unknown> = null

Accessors

complete

  • get complete(): boolean

  • Returns boolean

isRunning

  • get isRunning(): boolean

  • Returns boolean

timeElapsedTowardNextAction

  • get timeElapsedTowardNextAction(): number

  • Returns

    milliseconds elapsed toward the next action

    Returns number

timeToNextAction

  • get timeToNextAction(): number

  • Returns

    milliseconds until the next action callback, if complete will return 0

    Returns number

timesRepeated

  • get timesRepeated(): number

  • Returns number

Methods

cancel

  • Cancels the timer, preventing any further executions.

    Returns void

getTimeRunning

  • Returns number

off

  • Removes a callback from the callback list to be fired after the interval is complete.

    Parameters

    • fcn: (() => void)

      The callback to be removed from the callback list, to be fired after the interval is complete.

        • (): void

        • Returns void

    Returns void

on

  • Adds a new callback to be fired after the interval is complete

    Parameters

    • fcn: (() => void)

      The callback to be added to the callback list, to be fired after the interval is complete.

        • (): void

        • Returns void

    Returns void

pause

  • Pauses the timer, time will no longer increment towards the next call

    Returns Timer

reset

  • Resets the timer so that it can be reused, and optionally reconfigure the timers interval.

    Warning** you may need to call timer.start() again if the timer had completed

    Parameters

    • Optional newInterval: number

      If specified, sets a new non-negative interval in milliseconds to refire the callback

    • Optional newNumberOfRepeats: number

      If specified, sets a new non-negative upper limit to the number of time this timer executes

    Returns void

resume

  • Resumes the timer, time will now increment towards the next call.

    Returns Timer

start

  • Starts the timer, if the timer was complete it will restart the timer and reset the elapsed time counter

    Returns Timer

stop

  • Stops the timer and resets the elapsed time counter towards the next action invocation

    Returns Timer

update

  • Updates the timer after a certain number of milliseconds have elapsed. This is used internally by the engine.

    Parameters

    • delta: number

      Number of elapsed milliseconds since the last update.

    Returns void

Settings

Member Visibility

Theme