Class default

Hierarchy

default
- default

Index

Constructors

Properties

id imagePath? random weight

Methods

getRandom initialize instantiate uninitialize

Constructors

constructor

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

Properties

`Readonly` id

`Optional` `Readonly` imagePath

imagePath?: string

A replacement image to use. Used in modding.

`Readonly` random

random: RandomInstance | RandomReference = RandomInstance.Seeded

`Readonly` weight

weight: 0.15 = 0.15

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

initialize

initialize(instance: ChallengeModifierInstance): ChallengeModifierInstance
Parameters
- instance: ChallengeModifierInstance
Returns ChallengeModifierInstance
Overrides default.initialize
- Defined in src/game/game/options/modifiers/challenge/modifiers/BiomeVolcanic.ts:19

instantiate

instantiate(id: Challenge): ChallengeModifierInstance
Parameters
- id: Challenge
Returns ChallengeModifierInstance
Inherited from default.instantiate
- Defined in src/game/game/options/modifiers/challenge/ChallengeModifier.ts:53

uninitialize

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

Generated using TypeDoc