Class ChallengeModifierInstance

Hierarchy

GameplayModifierInstance<Challenge>
- ChallengeModifierInstance

Index

Constructors

Properties

args challenge id options random

Methods

addChallenge addOptions clearData getData getDefaultTitle getTitle getTooltip setChallenge setData setOptions setTitle

Constructors

constructor

new ChallengeModifierInstance(id: Challenge, random: Random<IRandomGenerator<any>>, ...args: []): ChallengeModifierInstance
Parameters
- id: Challenge
- random: Random<IRandomGenerator<any>>
- Rest ...args: []
Returns ChallengeModifierInstance
Inherited from GameplayModifierInstance.constructor
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:25

Properties

`Protected` `Readonly` args

args: []

challenge

challenge: number = 0

How much "challenge" this modifier adds (or subtracts!). Defaults to 0. Added to the result of apply.

`Readonly` id

options

options: IGameOptionsPartial = {}

`Readonly` random

random: Random<IRandomGenerator<any>>

Methods

addChallenge

addChallenge(challenge: number): ChallengeModifierInstance
Parameters
- challenge: number
Returns ChallengeModifierInstance
- Defined in src/game/game/options/modifiers/challenge/ChallengeModifier.ts:29

addOptions

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

clearData

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

getData

getData(): any
Returns any
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/challenge/ChallengeModifier.ts:39

getTitle

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

getTooltip

getTooltip(tooltip: default): default
Parameters
- tooltip: default
Returns default
- Defined in src/game/game/options/modifiers/challenge/ChallengeModifier.ts:34

setChallenge

setChallenge(challenge: number): ChallengeModifierInstance
Parameters
- challenge: number
Returns ChallengeModifierInstance
- Defined in src/game/game/options/modifiers/challenge/ChallengeModifier.ts:24

setData

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

setOptions

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

setTitle

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

Generated using TypeDoc