Interface IStatDescription

Hierarchy

IStatDescription

Index

Properties

gainMultiplier?

Methods

gain? getGainChanceOffset?

Properties

`Optional` gainMultiplier

gainMultiplier?: number

A multiplier for stat gain

Methods

`Optional` gain

gain(human: default<number>, gainAmount: number): boolean
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<number>
  
  The human that "gains" stat
- gainAmount: number
  
  The amount to gain. This will usually be 1. You should respect this if possible.
Returns boolean
- Defined in src/game/game/entity/StatDescriptions.ts:37

`Optional` getGainChanceOffset

getGainChanceOffset(human: default<number>, defaultGainChanceOffset: number): number
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
- human: default<number>
- defaultGainChanceOffset: number
Returns number
- Defined in src/game/game/entity/StatDescriptions.ts:44

Generated using TypeDoc