Class Game

Hierarchy

Host<IGameEvents>
- Game

Index

Constructors

constructor

Accessors

actionExecutor isChallenge isPaused isSimulatedOrRealTimeMode

Constructors

constructor

new Game(): Game
Returns Game

Inherited from EventEmitter.Host<IGameEvents>.constructor

Properties

absoluteTime

absoluteTime: number

`Readonly` autoSave

autoSave: AutoSave = ...

`Optional` challengeCollection

challengeCollection?: ChallengeModifiersCollection

`Readonly` commandManager

commandManager: default = ...

customMilestoneModifiersAllowed

customMilestoneModifiersAllowed: boolean

difficulty

difficulty: GameMode

`Readonly` event

event: IEventEmitter<Game, IGameEvents>

gameplayModifierData

gameplayModifierData: SaferNumberIndexedObject<any> = {}

history

history: default[] = []

initialThumbnailTimeout

initialThumbnailTimeout: undefined | number

`Readonly` interval

interval: 16.6666 = INTERVAL

`Readonly` islands

islands: default = ...

`Readonly` languageManager

languageManager: default = ...

`Optional` lastSaveBuildTime

lastSaveBuildTime?: number

`Optional` lastSaveVersion

lastSaveVersion?: String

`Readonly` milestoneManager

milestoneManager: MilestoneManager = ...

`Optional` milestonesCollection

milestonesCollection?: GameplayModifiersCollection<default, Milestone, MilestoneModifierInstance<any>, [default<unknown, number, NPC | Player>?]>

`Readonly` modManager

modManager: default = ...

originalPlayOptions

originalPlayOptions: Partial<IPlayOptions>

paused

paused: Set<PauseSource>

`Readonly` playerManager

playerManager: default = ...

playing

playing: boolean

previousSaveVersion

previousSaveVersion: IVersionInfo

`Readonly` references

references: default = ...

replay

replay: undefined | default

resetting

resetting: undefined | Promise<void>

saveClear

saveClear: boolean

`Readonly` saveLoad

saveLoad: SaveLoad = ...

`Readonly` saveManager

saveManager: default

`Optional` saveSize

saveSize?: string

saveVersion

saveVersion: String

slot

slot: undefined | number

`Readonly` steamworks

steamworks: default

`Protected` stringTokenizer

stringTokenizer: undefined | default

`Readonly` tickHelper

tickHelper: TickHelper = ...

Helps instruct when to increment the time in simulated and real-time mode

tickSpeed

tickSpeed: number

tileDecorations

tileDecorations: Uint16Array

time

time: default

turnMode

turnMode: TurnMode

`Readonly` uninit

uninit: Uninit = ...

upgrades

upgrades: string[] = []

version

version: String = gameVersion

The version the save was originally created on

visible

visible: boolean = true

webGlContext

webGlContext: undefined | WebGlContext

`Readonly` webWorkerManager

webWorkerManager: WebWorkerManager = ...

worldId

worldId: string

Accessors

actionExecutor

get actionExecutor(): typeof default
Returns typeof default
- Defined in src/game/game/Game.ts:162

isChallenge

get isChallenge(): boolean
Returns boolean
- Defined in src/game/game/Game.ts:111

isPaused

get isPaused(): boolean
Returns boolean
- Defined in src/game/game/Game.ts:273

isSimulatedOrRealTimeMode

get isSimulatedOrRealTimeMode(): boolean
Returns boolean
- Defined in src/game/game/Game.ts:684

Methods

addHistory

addHistory(executor: default<unknown, number, EntityReferenceTypes, unknown>, context: default): void
Parameters
- executor: default<unknown, number, EntityReferenceTypes, unknown>
- context: default
Returns void
- Defined in src/game/game/Game.ts:1338

createRenderer

createRenderer(origin: IRendererOrigin): Promise<void>
Creates the renderer. Should only be called once when starting / loading a save
Parameters
- origin: IRendererOrigin
Returns Promise<void>
- Defined in src/game/game/Game.ts:1023

ensureTurnMode

ensureTurnMode(): void
Changes the turn mode if it's not correct

Returns void
- Defined in src/game/game/Game.ts:717

gameLogicLoop

gameLogicLoop(): void
Returns void
- Defined in src/game/game/Game.ts:574

getGameMode

getGameMode(): GameMode
Returns GameMode
- Defined in src/game/game/Game.ts:776

getGameOptions

getGameOptions(): IGameOptions
Returns IGameOptions
- Defined in src/game/game/Game.ts:784

getGameOptionsBeforeModifiers

getGameOptionsBeforeModifiers(): IGameOptions
Returns IGameOptions
- Defined in src/game/game/Game.ts:780

getGreatestWeaknesses

getGreatestWeaknesses(defense: Defense, damageTypes: DamageType, damage: number): DamageType[]
Gets the largest damage type weaknesses of a human or creature based on a type and damage value

Returns
returns DamageType array or undefined if there are no weaknesses
Parameters
- defense: Defense
  
  Defense of the human or creature
- damageTypes: DamageType
  
  Measures the weaknesses compared to damage types passed
- damage: number
  
  The damage value given to the human or creature
Returns DamageType[]
- Defined in src/game/game/Game.ts:919

getMovementProgress

getMovementProgress(timeStamp: number, movementTime: undefined | IMovementTime): number
Parameters
- timeStamp: number
- movementTime: undefined | IMovementTime
Returns number
- Defined in src/game/game/Game.ts:856

getMovementTime

getMovementTime(delay: number, timestamp?: number): IMovementTime
Parameters
- delay: number
- timestamp: number = ...
Returns IMovementTime
- Defined in src/game/game/Game.ts:849

getNonPlayerHumans

getNonPlayerHumans(): default<unknown, number, NPC | Player>[]
Returns default<unknown, number, NPC | Player>[]
- Defined in src/game/game/Game.ts:296

getPlayingHuman

getPlayingHuman(identifier: string): undefined | default<unknown, number, NPC | Player>
Parameters
- identifier: string
Returns undefined | default<unknown, number, NPC | Player>
- Defined in src/game/game/Game.ts:300

getPlayingHumans

getPlayingHumans(includeGhosts?: boolean, includeConnecting?: boolean, includeDedicatedServer?: boolean, includeAbsent?: boolean): default<unknown, number, NPC | Player>[]
Get humans in the game; ie, players, NPCs, and other non-player humans. Parameters include additional players that may not be relevant, such as ghosts, connecting players, absent players, the dedicated server fake player. Only want players?

See
PlayerManager.getAll

Returns
Array of Human objects
Parameters
- Optional includeGhosts: boolean
  
  True to include players that are ghosts
- Optional includeConnecting: boolean
  
  True to include players that are connecting
- Optional includeDedicatedServer: boolean
  
  True to include the dedicated server fake player
- Optional includeAbsent: boolean
  
  True to include the absent players
Returns default<unknown, number, NPC | Player>[]
- Defined in src/game/game/Game.ts:291

getSynchronizeState

getSynchronizeState(identifier: string): ISynchronizeState
Parameters
- identifier: string
Returns ISynchronizeState
- Defined in src/game/game/Game.ts:864

getTickSpeed

getTickSpeed(): number
Returns number
- Defined in src/game/game/Game.ts:745

getTurnMode

getTurnMode(): TurnMode
Returns TurnMode
- Defined in src/game/game/Game.ts:688

globalSlotReady

globalSlotReady(): void
It's important that this is lowest, so that it happens after modManager's globalSlotReady event

Returns void
- Defined in src/game/game/Game.ts:319

initialize

initialize(): Promise<void>
Returns Promise<void>
- Defined in src/game/game/Game.ts:206

initializeGameOptions

initializeGameOptions(seed: string | number, mode?: GameMode, options?: IGameOptions, milestoneModifiers?: Set<Milestone>): void
Parameters
- seed: string | number
- mode: GameMode = GameMode.Hardcore
- Optional options: IGameOptions
- Optional milestoneModifiers: Set<Milestone>
Returns void
- Defined in src/game/game/Game.ts:816

initializeModifiers

initializeModifiers(): void
Returns void
- Defined in src/game/game/Game.ts:827

initializeRenderer

initializeRenderer(options?: {
clearSpritePackCache?: boolean;
}): Promise<void>
Parameters
- Optional options: {
  clearSpritePackCache?: boolean;
  }
  - Optional clearSpritePackCache?: boolean
Returns Promise<void>
- Defined in src/game/game/Game.ts:326

isTurnModeAllowed

isTurnModeAllowed(turnMode: TurnMode): boolean
Parameters
- turnMode: TurnMode
Returns boolean
- Defined in src/game/game/Game.ts:728

loseWebGlContext

loseWebGlContext(): void
Returns void
- Defined in src/game/game/Game.ts:457

onPlayingEntityChange

onPlayingEntityChange(_manager: any, entity: default<unknown, number, EntityReferenceTypes, unknown>): void
Parameters
- _manager: any
- entity: default<unknown, number, EntityReferenceTypes, unknown>
Returns void
- Defined in src/game/game/Game.ts:561

postSerializeObject

postSerializeObject(serializer: ISerializer): void
Parameters
- serializer: ISerializer
Returns void
- Defined in src/game/game/Game.ts:1371

postSerializeProperty

postSerializeProperty(serializer: ISerializer, key: string): void
Parameters
- serializer: ISerializer
- key: string
Returns void
- Defined in src/game/game/Game.ts:1379

preSerializeObject

preSerializeObject(serializer: ISerializer): void
Serialization tracking
Parameters
- serializer: ISerializer
Returns void
- Defined in src/game/game/Game.ts:1367

preSerializeProperty

preSerializeProperty(serializer: ISerializer, key: string): void
Parameters
- serializer: ISerializer
- key: string
Returns void
- Defined in src/game/game/Game.ts:1375

reset

reset(saveType?: false | SaveType, shouldDisconnect?: boolean, hasDisconnected?: boolean): Promise<void>
Resets the game state. This should be called when returning to the main menu from a game and/or right before starting/joining a game. This method should be able to be called multiple times in a row and nothing unexpected should occur.
Parameters
- saveType: false | SaveType = SaveType.BackToMainMenu
  
  Saves the game with the specified save type. Set to false to not save. Defaults to BackToMainMenu.
- shouldDisconnect: boolean = true
  
  Marks if the game should disconnect from multiplayer. Defaults to true.
- hasDisconnected: boolean = false
  
  Marks if the game just disconnected from multiplayer. Defaults to false.
Returns Promise<void>
- Defined in src/game/game/Game.ts:1069

selectBiome

selectBiome(position: undefined | IVector2, random: Random<IRandomGenerator<any>>): BiomeTypes
Parameters
- position: undefined | IVector2
- random: Random<IRandomGenerator<any>>
Returns BiomeTypes
- Defined in src/game/game/Game.ts:762

setPaused

setPaused(pause: boolean, source: PauseSource): void
Parameters
- pause: boolean
- source: PauseSource
Returns void
- Defined in src/game/game/Game.ts:515

setTickSpeed

setTickSpeed(tickSpeed: number): void
Parameters
- tickSpeed: number
Returns void
- Defined in src/game/game/Game.ts:749

setTurnMode

setTurnMode(turnMode: TurnMode): void
Parameters
- turnMode: TurnMode
Returns void
- Defined in src/game/game/Game.ts:693

stopGameLogicLoop

stopGameLogicLoop(): void
Stops the game logic loop timer

Returns void
- Defined in src/game/game/Game.ts:668

synchronizeState

synchronizeState(synchronizeState: ISynchronizeState): void
Parameters
- synchronizeState: ISynchronizeState
Returns void
- Defined in src/game/game/Game.ts:899

testFastForwardSpeed

testFastForwardSpeed(ticks?: number, biomeType?: BiomeType): Promise<void>
Parameters
- ticks: number = 5001
- biomeType: BiomeType = BiomeType.Coastal
Returns Promise<void>
- Defined in src/game/game/Game.ts:1250

tickTime

tickTime(isIslandTimeAdjustment: boolean): void
Called when an Island is ticking. Always tick time immediately in manual mode. Schedules a time tick in simulated mode.
Parameters
- isIslandTimeAdjustment: boolean
  
  True if it's due to island fast forwarding
Returns void
- Defined in src/game/game/Game.ts:1318

toString

toString(): string
Returns string
- Defined in src/game/game/Game.ts:268

triggerGameLogicLoop

triggerGameLogicLoop(): void
Triggers a game logic loop to run in the next javascript event loop

Returns void
- Defined in src/game/game/Game.ts:678

uncacheGameOptions

uncacheGameOptions(): void
Returns void
- Defined in src/game/game/Game.ts:802

uninitialize

uninitialize(): Promise<void>
Returns Promise<void>
- Defined in src/game/game/Game.ts:248

updateGameOptions

updateGameOptions(gameOptions: IGameOptions): void
Parameters
- gameOptions: IGameOptions
Returns void
- Defined in src/game/game/Game.ts:806

updateOption

updateOption(human: undefined | default<unknown, number, NPC | Player>, id: keyof IOptions, value: number | boolean): void
Parameters
- human: undefined | default<unknown, number, NPC | Player>
- id: keyof IOptions
- value: number | boolean
Returns void
- Defined in src/game/game/Game.ts:950

updateOptionInternal

updateOptionInternal(id: keyof IOptions, value: number | boolean, human?: default<unknown, number, NPC | Player>): void
Do not call this directly. Use updateOption instead
Parameters
- id: keyof IOptions
- value: number | boolean
- Optional human: default<unknown, number, NPC | Player>
Returns void
- Defined in src/game/game/Game.ts:976

updateRendererSizes

updateRendererSizes(): void
Returns void
- Defined in src/game/game/Game.ts:471

updateRendererViewportSize

updateRendererViewportSize(): void
Returns void
- Defined in src/game/game/Game.ts:507

Class Game

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Game

Properties

absoluteTime

Readonly autoSave

Optional challengeCollection

Readonly commandManager

customMilestoneModifiersAllowed

difficulty

Readonly event

gameplayModifierData

history

initialThumbnailTimeout

Readonly interval

Readonly islands

Readonly languageManager

Optional lastSaveBuildTime

Optional lastSaveVersion

Readonly milestoneManager

Optional milestonesCollection

Readonly modManager

originalPlayOptions

paused

Readonly playerManager

playing

previousSaveVersion

Readonly references

replay

resetting

saveClear

Readonly saveLoad

Readonly saveManager

Optional saveSize

saveVersion

slot

Readonly steamworks

Protected stringTokenizer

Readonly tickHelper

tickSpeed

tileDecorations

time

turnMode

Readonly uninit

upgrades

version

visible

webGlContext

Readonly webWorkerManager

worldId

Accessors

actionExecutor

Returns typeof default

isChallenge

Returns boolean

isPaused

Returns boolean

isSimulatedOrRealTimeMode

Returns boolean

Methods

addHistory

Parameters

executor: default<unknown, number, EntityReferenceTypes, unknown>

context: default

Returns void

createRenderer

Parameters

origin: IRendererOrigin

Returns Promise<void>

ensureTurnMode

Returns void

gameLogicLoop

Returns void

`Readonly` autoSave

`Optional` challengeCollection

`Readonly` commandManager

`Readonly` event

`Readonly` interval

`Readonly` islands

`Readonly` languageManager

`Optional` lastSaveBuildTime

`Optional` lastSaveVersion

`Readonly` milestoneManager

`Optional` milestonesCollection

`Readonly` modManager

`Readonly` playerManager

`Readonly` references

`Readonly` saveLoad

`Readonly` saveManager

`Optional` saveSize

`Readonly` steamworks

`Protected` stringTokenizer

`Readonly` tickHelper

`Readonly` uninit

`Readonly` webWorkerManager

`Optional` includeGhosts: boolean

`Optional` includeConnecting: boolean

`Optional` includeDedicatedServer: boolean

`Optional` includeAbsent: boolean

`Optional` options: IGameOptions

`Optional` milestoneModifiers: Set<Milestone>

`Optional` options: {
clearSpritePackCache?: boolean;
}

`Optional` clearSpritePackCache?: boolean