Class IslandModifierInstance

Hierarchy

GameplayModifierInstance<IslandModifierType>
- IslandModifierInstance

Index

Constructors

Properties

Methods

addChallenge addOptions clearData getData getDefaultTitle getIslandNameDescriptor getTitle getTooltip setChallenge setData setIslandNameDescriptor setOptions setTitle

Constructors

constructor

new IslandModifierInstance(id: OverrunWithCreature, random: Random<IRandomGenerator<any>>, ...args: []): IslandModifierInstance
Parameters
- id: OverrunWithCreature
- random: Random<IRandomGenerator<any>>
- Rest ...args: []
Returns IslandModifierInstance
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.

Methods

addChallenge

addChallenge(challenge: number): IslandModifierInstance
Parameters
- challenge: number
Returns IslandModifierInstance
- Defined in src/game/game/options/modifiers/island/IslandModifier.ts:36

addOptions

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

clearData

clearData(): IslandModifierInstance
Returns IslandModifierInstance
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/island/IslandModifier.ts:45

getIslandNameDescriptor

getIslandNameDescriptor(version: IslandName): default
Parameters
- version: IslandName
Returns default
- Defined in src/game/game/options/modifiers/island/IslandModifier.ts:50

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/island/IslandModifier.ts:41

setChallenge

setChallenge(challenge: number): IslandModifierInstance
Parameters
- challenge: number
Returns IslandModifierInstance
- Defined in src/game/game/options/modifiers/island/IslandModifier.ts:31

setData

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

setIslandNameDescriptor

setIslandNameDescriptor(initializer: ((defaultTitle: default, version: IslandName) => default)): IslandModifierInstance
Parameters
- initializer: ((defaultTitle: default, version: IslandName) => default)
  - - (defaultTitle: default, version: IslandName): default
    - Parameters
      
      defaultTitle: default
      
      version: IslandName
      
      Returns default
Returns IslandModifierInstance
- Defined in src/game/game/options/modifiers/island/IslandModifier.ts:58

setOptions

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

setTitle

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

Class IslandModifierInstance

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

id: OverrunWithCreature

random: Random<IRandomGenerator<any>>

Rest ...args: []

Returns IslandModifierInstance

Properties

Protected Readonly args

challenge

Readonly id

options

Readonly random

Methods

addChallenge

Parameters

challenge: number

Returns IslandModifierInstance

addOptions

Parameters

options: IGameOptionsPartial

Returns IslandModifierInstance

clearData

Returns IslandModifierInstance

getData

Returns any

Protected getDefaultTitle

Returns default

getIslandNameDescriptor

Parameters

version: IslandName

Returns default

getTitle

Returns default

getTooltip

Parameters

tooltip: default

Returns default

setChallenge

Parameters

challenge: number

Returns IslandModifierInstance

setData

Parameters

Optional data: any

Returns IslandModifierInstance

setIslandNameDescriptor

Parameters

initializer: ((defaultTitle: default, version: IslandName) => default)

Parameters

defaultTitle: default

version: IslandName

Returns default

Returns IslandModifierInstance

setOptions

Parameters

options: IGameOptionsPartial

Returns IslandModifierInstance

setTitle

Parameters

initializer: ((defaultTitle: default) => default)

Parameters

defaultTitle: default

Returns default

Returns IslandModifierInstance

Settings

Member Visibility

Theme

`Rest` ...args: []

`Protected` `Readonly` args

`Readonly` id

`Readonly` random

`Protected` getDefaultTitle

`Optional` data: any