Interface IStatEvents

Hierarchy

Methods

statBonusChanged statChanged statMaxChanged statTimerChanged statTimerRemoved statTimerWillChange

Methods

statBonusChanged

  • Called when a stat changes, for any reason

    Parameters

    • stat: IStat

      An IStat object, the stat that was affected

    • Optional oldValue: number

      The value that the stat changed from

    • Optional info: IStatChangeInfo<any>

      An IStatChangeInfo object describing why the change occurred. It will always be passed with a reason

    Returns void

statChanged

  • Called when a stat changes, for any reason

    Parameters

    • stat: IStat

      An IStat object, the stat that was affected

    • oldValue: number

      The value that the stat changed from

    • info: IStatChangeInfo<any>

      An IStatChangeInfo object describing why the change occurred. It will always be passed with a reason

    Returns void

statMaxChanged

  • Called when a stat's max value changes, for any reason

    Parameters

    • stat: IStatMax

      An IStat object, the stat that was affected

    • Optional oldValue: number

      The value that the stat changed from

    • Optional info: IStatChangeInfo<any>

      An IStatChangeInfo object describing why the change occurred. It will always be passed with a reason

    Returns void

statTimerChanged

  • Called when a stat timer changes

    Parameters

    • stat: IStat

      An IStat object, the stat that was affected

    • Optional oldValue: number

      The value that the stat changed from

    Returns void

statTimerRemoved

  • Called when a stat timer is removed

    Parameters

    • stat: IStat

      An IStat object, the stat that was affected

    Returns any

statTimerWillChange

  • Called when a stat timer will change

    Returns

    false to cancel the stat timer change, undefined otherwise.

    Parameters

    • stat: IStat

      An IStat object, the stat that will be affected

    • changeFactory: StatChangeTimerFactory

      An object for manipulating how the new stat change timer will be set

    Returns undefined | false

Settings

Member Visibility

Theme

Generated using TypeDoc