Class default`Abstract`

Hierarchy

default<IslandModifierType, IslandModifierInstance, [default]>
- default
  - default

Index

Constructors

Properties

id imagePath? random weight

Methods

getRandom initialize instantiate uninitialize

Constructors

constructor

new default(id: OverrunWithCreature, random?: RandomInstance | RandomReference): default
Parameters
- id: OverrunWithCreature
- random: RandomInstance | RandomReference = RandomInstance.Seeded
Returns default
Inherited from default.constructor
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:106

Properties

`Readonly` id

id: OverrunWithCreature

`Optional` `Readonly` imagePath

imagePath?: string

A replacement image to use. Used in modding.

`Readonly` random

random: RandomInstance | RandomReference = RandomInstance.Seeded

`Readonly` weight

weight: number

How often this modifier should be chosen compared to the others

Methods

`Protected` getRandom

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

`Abstract` initialize

initialize(instance: IslandModifierInstance, ...args: [default]): undefined | IslandModifierInstance
Parameters
- instance: IslandModifierInstance
- Rest ...args: [default]
Returns undefined | IslandModifierInstance
Inherited from default.initialize
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:113

instantiate

instantiate(id: OverrunWithCreature, island: default): IslandModifierInstance
Parameters
- id: OverrunWithCreature
- island: default
Returns IslandModifierInstance
Overrides default.instantiate
- Defined in src/game/game/options/modifiers/island/IslandModifier.ts:72

uninitialize

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

Generated using TypeDoc