Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: TimerAction

[12:7] extends: FxObj

Wraps FXGL's TimerAction, the handle returned by Timer.runOnceAfter and Timer.runAtInterval. TimerAction is constructed internally by the Timer service; Aussom users only interact with it through existing wrappers. The pause / resume / expire / isExpired / isPaused controls are exposed here.

Methods

  • TimerAction ()

    Empty default constructor; populated by Timer factory methods.

  • pause ()

    Pauses the timer. Update ticks no longer advance the scheduled firing.

    • @r this object
  • resume ()

    Resumes a paused timer.

    • @r this object
  • expire ()

    Marks the timer as expired. The scheduled callback will not run again.

    • @r this object
  • isExpired ()

    Returns whether the timer has expired.

    • @r A bool.
  • isPaused ()

    Returns whether the timer is paused.

    • @r A bool.