Class default

Hierarchy

default
- default

Index

Constructors

Properties

after? id imagePath? random

Methods

getGroup getOptions getRandom initialize instantiate isGlobal uninitialize areOptionsGlobal isGlobal

Constructors

constructor

new default(id?: Milestone): default
Parameters
- Optional id: Milestone
Returns default
Inherited from default.constructor
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:93

Properties

`Optional` after

after?: Milestone[]

`Readonly` id

`Optional` `Readonly` imagePath

imagePath?: string

A replacement image to use. Used in modding.

`Readonly` random

random: RandomInstance | RandomReference = RandomInstance.Seeded

Methods

getGroup

getGroup(): MilestoneModifierGroup
Returns MilestoneModifierGroup
Overrides default.getGroup
- Defined in src/game/game/options/modifiers/milestone/modifiers/Gatherer.ts:38

getOptions

getOptions(): IGameOptionsPartial
Returns IGameOptionsPartial
Overrides default.getOptions
- Defined in src/game/game/options/modifiers/milestone/modifiers/Gatherer.ts:19

`Protected` getRandom

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

initialize

initialize(instance: MilestoneModifierInstance<any>): MilestoneModifierInstance<any>
Parameters
- instance: MilestoneModifierInstance<any>
Returns MilestoneModifierInstance<any>
Inherited from default.initialize
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:103

instantiate

instantiate(id: Milestone, human?: default<number>): undefined | MilestoneModifierInstance<any>
Parameters
- id: Milestone
- Optional human: default<number>
Returns undefined | MilestoneModifierInstance<any>
Inherited from default.instantiate
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:97

isGlobal

isGlobal(): boolean
Whether this milestone modifier is host-exclusive, IE, clients connecting to a server can't select this modifier.

Modifiers with custom options: IGameOptions are always host-exclusive.

Returns boolean
Inherited from default.isGlobal
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:89

uninitialize

uninitialize(instance: MilestoneModifierInstance<any>): any
Parameters
- instance: MilestoneModifierInstance<any>
Returns any
Inherited from default.uninitialize
- Defined in src/game/game/options/modifiers/GameplayModifier.ts:99

`Static` areOptionsGlobal

areOptionsGlobal(gameOptions: IGameOptionsPartial): boolean
Parameters
- gameOptions: IGameOptionsPartial
Returns boolean
Inherited from default.areOptionsGlobal
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:73

`Static` isGlobal

isGlobal(modifier: default): boolean
Parameters
- modifier: default
Returns boolean
Inherited from default.isGlobal
- Defined in src/game/game/options/modifiers/milestone/MilestoneModifier.ts:68

Generated using TypeDoc