Class default<ID, INSTANCE, INSTANCE_ARGS>`Abstract`

Type Parameters

ID extends number
INSTANCE extends GameplayModifierInstance<ID, any[]> = GameplayModifierInstance<ID, any[]>
INSTANCE_ARGS extends any[] = []

Hierarchy

default
- default
- default
- default

Implements

IHasImagePath

Index

Constructors

Properties

id imagePath? random

Methods

getRandom initialize instantiate uninitialize

Constructors

constructor

new default<ID, INSTANCE, INSTANCE_ARGS>(id: ID, random?: RandomInstance | RandomReference): default<ID, INSTANCE, INSTANCE_ARGS>
Type Parameters
- ID extends number
- INSTANCE extends GameplayModifierInstance<ID, any[], any, INSTANCE> = GameplayModifierInstance<ID, any[], any>
- INSTANCE_ARGS extends any[] = []
Parameters
- id: ID
- random: RandomInstance | RandomReference = RandomInstance.Seeded
Returns default<ID, INSTANCE, INSTANCE_ARGS>
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:106

Properties

`Readonly` id

id: ID

`Optional` `Readonly` imagePath

imagePath?: string

A replacement image to use. Used in modding.

`Readonly` random

random: RandomInstance | RandomReference = RandomInstance.Seeded

Methods

`Protected` getRandom

getRandom(): Random<LegacySeededGenerator | PCGSeededGenerator>
Returns Random<LegacySeededGenerator | PCGSeededGenerator>
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:117

`Abstract` initialize

initialize(instance: INSTANCE, ...args: INSTANCE_ARGS): undefined | INSTANCE
Parameters
- instance: INSTANCE
- Rest ...args: INSTANCE_ARGS
Returns undefined | INSTANCE
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:113

`Abstract` instantiate

instantiate(type: ID, ...args: INSTANCE_ARGS): undefined | INSTANCE
Parameters
- type: ID
- Rest ...args: INSTANCE_ARGS
Returns undefined | INSTANCE
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:111

uninitialize

uninitialize(instance: INSTANCE): void
Parameters
- instance: INSTANCE
Returns void
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:115

Generated using TypeDoc