Interface IStatusDescription

Hierarchy

IStatusDescription

Properties

applicability

applicability: StatusApplicability

`Optional` effects

effects?: SupplierOr<undefined | StatusEffectList, [default, StatusEffectList]>

`Optional` highlight

highlight?: SupplierOr<undefined | IHighlight, [default]>

`Optional` icon

icon?: SupplierOr<undefined | IStatusIconDescription, [default]>

`Optional` interval

interval?: SupplierOr<undefined | number, [default]>

`Optional` levelledDictionary

levelledDictionary?: default

`Optional` listedLevels

listedLevels?: number[]

An optional list of status effect levels that will be displayed in the StatusInspection for inspecting the status type itself

`Optional` particles

particles?: SupplierOr<undefined | StatusParticle, [default, StatusParticleEvent?]>

`Optional` relevantStat

relevantStat?: Stat

`Optional` renderer

renderer?: SupplierOr<undefined | default, [default]>

`Optional` sound

sound?: SfxType | Record<number, SfxType>

`Optional` threatLevel

threatLevel?: StatusThreatLevel | Record<number, StatusThreatLevel>

Methods

`Optional` getDamageRange

getDamageRange(status: default): undefined | IRange
This function is not used automatically by Status, and must be implemented via a custom onTick handler
Parameters
- status: default
Returns undefined | IRange
- Defined in src/game/game/entity/status/IStatus.ts:51

`Optional` getLevel

getLevel(status: default, entityStatusLevel: number): undefined | number
Parameters
- status: default
- entityStatusLevel: number
Returns undefined | number
- Defined in src/game/game/entity/status/IStatus.ts:55

`Optional` getPassChance

getPassChance(status: default): undefined | number
This function is not used automatically by Status, and must be implemented via a custom shouldPass handler
Parameters
- status: default
Returns undefined | number
- Defined in src/game/game/entity/status/IStatus.ts:53

`Optional` isActive

isActive(status: default): undefined | boolean
Parameters
- status: default
Returns undefined | boolean
- Defined in src/game/game/entity/status/IStatus.ts:56

`Optional` onAdd

onAdd(status: default): any
Parameters
- status: default
Returns any
- Defined in src/game/game/entity/status/IStatus.ts:58

`Optional` onPassed

onPassed(status: default, oldLevel: number): any
Parameters
- status: default
- oldLevel: number
Returns any
- Defined in src/game/game/entity/status/IStatus.ts:62

`Optional` onRemove

onRemove(status: default, oldLevel: number, reason: StatusChangeReason): any
Parameters
- status: default
- oldLevel: number
- reason: StatusChangeReason
Returns any
- Defined in src/game/game/entity/status/IStatus.ts:60

`Optional` onTick

onTick(status: default, options: IGameOptionsStatus): any
Parameters
- status: default
- options: IGameOptionsStatus
Returns any
- Defined in src/game/game/entity/status/IStatus.ts:59

`Optional` onTreated

onTreated(status: default, oldLevel: number): any
Parameters
- status: default
- oldLevel: number
Returns any
- Defined in src/game/game/entity/status/IStatus.ts:61

`Optional` shouldPass

shouldPass(status: default): undefined | boolean
Parameters
- status: default
Returns undefined | boolean
- Defined in src/game/game/entity/status/IStatus.ts:57

Generated using TypeDoc