Hierarchy

  • StatChangeTimerFactory

Constructors

Methods

  • Returns

    The amount the stat will be changed when the change timer completes.

    Returns undefined | number

  • Returns

    The amount the change timer will be reduced by every tick.

    Returns undefined | number

  • Returns

    The next change timer. This value is what the changeTimer will be reset to every time it reaches 0. If the next change timer is less than or equal to 0, upon reaching 0, the change timer will be removed from the stat.

    Returns number

  • Returns

    Whether this change timer's application is overridable through the statTimerWillChange event.

    Returns boolean

  • Parameters

    • amount: number = 1

      The amount the stat will be changed when the change timer completes. Defaults to 1.

    Returns StatChangeTimerFactory

  • Parameters

    • nextTimer: number

      The next change timer. This value is what the changeTimer will be reset to every time it reaches 0. If the next change timer is less than or equal to 0, upon reaching 0, the change timer will be removed from the stat.

    Returns StatChangeTimerFactory

  • Sets the next change timer to -1, which will cause the change timer to be removed from the stat when the timer reaches 0.

    Returns StatChangeTimerFactory

  • Parameters

    • overridable: boolean = true

      Whether this change timer's application is overridable through the statTimerWillChange event.

    Returns StatChangeTimerFactory

Generated using TypeDoc