Class GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>`Abstract`

Type Parameters

ID extends number
INSTANCE_ARGS extends any[] = []
DATA = any

Hierarchy

Host<IGameplayModifierInstanceEvents>
- GameplayModifierInstance

Index

Constructors

Properties

args event id options random

Methods

addOptions clearData getData getDefaultTitle getTitle initialize? setData setOptions setTitle uninitialize?

Constructors

constructor

new GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>(id: ID, random: Random<IRandomGenerator<any>>, ...args: INSTANCE_ARGS): GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
Type Parameters
- ID extends number
- INSTANCE_ARGS extends any[] = []
- DATA = any
Parameters
- id: ID
- random: Random<IRandomGenerator<any>>
- Rest ...args: INSTANCE_ARGS
Returns GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
Overrides EventEmitter.Host<IGameplayModifierInstanceEvents>.constructor
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:35

Properties

`Protected` `Readonly` args

args: INSTANCE_ARGS

`Readonly` event

event: IEventEmitter<GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>, IGameplayModifierInstanceEvents>

`Readonly` id

id: ID

options

options: IGameOptionsPartial = {}

`Readonly` random

random: Random<IRandomGenerator<any>>

Methods

addOptions

addOptions(options: IGameOptionsPartial): GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
Parameters
- options: IGameOptionsPartial
Returns GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:48

clearData

clearData(): GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
Returns GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:81

getData

getData(): undefined | DATA
Returns undefined | DATA
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:67

`Protected` `Abstract` getDefaultTitle

getDefaultTitle(): default
Returns default
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:60

getTitle

getTitle(): default
Returns default
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:55

`Optional` initialize

initialize(): void
Returns void
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:86

setData

setData(data?: DATA): GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
Parameters
- Optional data: DATA
Returns GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:71

setOptions

setOptions(options: IGameOptionsPartial): GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
Parameters
- options: IGameOptionsPartial
Returns GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:42

setTitle

setTitle(initializer: ((defaultTitle: default) => default)): GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
Parameters
- initializer: ((defaultTitle: default) => default)
  - - (defaultTitle: default): default
    - Parameters
      
      defaultTitle: default
      
      Returns default
Returns GameplayModifierInstance<ID, INSTANCE_ARGS, DATA>
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:62

`Optional` uninitialize

uninitialize(): void
Returns void
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:87

Generated using TypeDoc