Class MilestoneModifierInstance<DATA>

Type Parameters

DATA = any

Hierarchy

GameplayModifierInstance<Milestone, [default?], DATA>
- MilestoneModifierInstance

Index

Constructors

Properties

args id options random

Accessors

Methods

addOptions clearData getData getDefaultTitle getTitle isEnabledForPlayer setData setOptions setTitle

Constructors

constructor

new MilestoneModifierInstance<DATA>(id: Milestone, random: Random<IRandomGenerator<any>>, ...args: [default<number>?]): MilestoneModifierInstance<DATA>
Type Parameters
- DATA = any
Parameters
- id: Milestone
- random: Random<IRandomGenerator<any>>
- Rest ...args: [default<number>?]
Returns MilestoneModifierInstance<DATA>
Inherited from GameplayModifierInstance.constructor
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:25

Properties

`Protected` `Readonly` args

args: [default<number>?]

`Readonly` id

options

options: IGameOptionsPartial = {}

`Readonly` random

random: Random<IRandomGenerator<any>>

Accessors

`Protected` player

get player(): undefined | default<number>
Returns undefined | default<number>
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:52

Methods

addOptions

addOptions(options: IGameOptionsPartial): MilestoneModifierInstance<DATA>
Parameters
- options: IGameOptionsPartial
Returns MilestoneModifierInstance<DATA>
Inherited from GameplayModifierInstance.addOptions
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:36

clearData

clearData(): MilestoneModifierInstance<DATA>
Returns MilestoneModifierInstance<DATA>
Inherited from GameplayModifierInstance.clearData
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:68

getData

getData(): undefined | DATA
Returns undefined | DATA
Inherited from GameplayModifierInstance.getData
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:54

`Protected` getDefaultTitle

getDefaultTitle(): default
Returns default
Overrides GameplayModifierInstance.getDefaultTitle
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:61

getTitle

getTitle(): default
Returns default
Inherited from GameplayModifierInstance.getTitle
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:42

isEnabledForPlayer

isEnabledForPlayer(entity: default<unknown, number, unknown, unknown>): boolean
Parameters
- entity: default<unknown, number, unknown, unknown>
Returns boolean
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:56

setData

setData(data?: DATA): MilestoneModifierInstance<DATA>
Parameters
- Optional data: DATA
Returns MilestoneModifierInstance<DATA>
Inherited from GameplayModifierInstance.setData
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:58

setOptions

setOptions(options: IGameOptionsPartial): MilestoneModifierInstance<DATA>
Parameters
- options: IGameOptionsPartial
Returns MilestoneModifierInstance<DATA>
Inherited from GameplayModifierInstance.setOptions
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:31

setTitle

setTitle(initializer: ((defaultTitle: default) => default)): MilestoneModifierInstance<DATA>
Parameters
- initializer: ((defaultTitle: default) => default)
  - - (defaultTitle: default): default
    - Parameters
      
      defaultTitle: default
      
      Returns default
Returns MilestoneModifierInstance<DATA>
Inherited from GameplayModifierInstance.setTitle
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:49

Generated using TypeDoc