Interface IStatDescription

Hierarchy

  • IStatDescription

Properties

gainMultiplier?

Methods

gain? getGainChanceOffset?

Properties

Optional gainMultiplier

gainMultiplier?: number

A multiplier for stat gain

Methods

Optional gain

  • When a human "gains" stat (ie from skill use), if this method is defined, it will be called.

    Returns

    Whether the stat was truly gained

    Note: When implementing this, it is recommended to use

    Parameters

    • human: default<unknown, number, NPC | Player>

      The human that "gains" stat

    • gainAmount: number

      The amount to gain. This will usually be 1. You should respect this if possible.

    • Optional sourceSkill: SkillType

      The skill that caused this stat gain, if any.

    Returns boolean

Optional getGainChanceOffset

  • When a human performs an action that has a chance of raising a stat, the chance is 1 / getGainChanceOffset()

    When getGainChanceOffset is not implemented, the stat max will be used instead. When the stat is not an IStatMax, the current value will be used instead.

    Parameters

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc