Class Game

Hierarchy

Host<IGameEvents>
- Game

Index

Constructors

constructor

Accessors

isChallenge isPaused

Constructors

constructor

new Game(): Game
Returns Game

Inherited from Host.constructor

Properties

absoluteTime

absoluteTime: number

`Readonly` autoSave

autoSave: AutoSave = ...

canvasElement

canvasElement: undefined | HTMLCanvasElement

`Optional` challengeCollection

challengeCollection?: ChallengeModifiersCollection

`Readonly` commandManager

commandManager: default = ...

customMilestoneModifiersAllowed

customMilestoneModifiersAllowed: boolean

difficulty

difficulty: GameMode

`Readonly` event

event: IEventEmitter<Game, IGameEvents> = ...

gameplayModifierData

gameplayModifierData: Record<number, any> = {}

initialThumbnailTimeout

initialThumbnailTimeout: undefined | Timer

`Readonly` interval

interval: 16.6666 = INTERVAL

`Readonly` islands

islands: default = ...

`Readonly` itemStylesheetHandler

itemStylesheetHandler: undefined | default = ...

lastTickTime

lastTickTime: undefined | number

`Readonly` milestoneManager

milestoneManager: MilestoneManager = ...

`Optional` milestonesCollection

milestonesCollection?: GameplayModifiersCollection<default, Milestone, MilestoneModifierInstance<any>, [default<number>?]>

`Readonly` modManager

modManager: default = ...

nextTickTime

nextTickTime: undefined | number

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

saveClear

saveClear: boolean

`Readonly` saveLoad

saveLoad: SaveLoad = ...

`Readonly` saveManager

saveManager: default

`Optional` saveSize

saveSize?: string

saveVersion

saveVersion: String

shouldUpdateTablesAndWeight

shouldUpdateTablesAndWeight: boolean

slot

slot: undefined | number

`Readonly` steamworks

steamworks: default

`Protected` stringTokenizer

stringTokenizer: undefined | default

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 | default

`Readonly` webWorkerManager

webWorkerManager: WebWorkerManager = ...

worldId

worldId: string

Accessors

isChallenge

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

isPaused

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

Methods

createRenderer

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

ensureTurnMode

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

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

fastForwardIsland

fastForwardIsland(island: default, ticks: number, multiplayerLoadingDescription?: MultiplayerLoadingDescription): Promise<void>
Parameters
- island: default
- ticks: number
- Optional multiplayerLoadingDescription: MultiplayerLoadingDescription
Returns Promise<void>
- Defined in src/game/game/Game.ts:1306

gameLogicLoop

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

getGameMode

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

getGameOptions

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

getGameOptionsBeforeModifiers

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

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:927

getMovementProgress

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

getMovementTime

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

getNonPlayerHumans

getNonPlayerHumans(): default<number>[]
Returns default<number>[]
- Defined in src/game/game/Game.ts:265

getPlayingHuman

getPlayingHuman(identifier: string): undefined | default<number>
Parameters
- identifier: string
Returns undefined | default<number>
- Defined in src/game/game/Game.ts:269

getPlayingHumans

getPlayingHumans(includeGhosts?: boolean, includeConnecting?: boolean, includeDedicatedServer?: boolean, includeAbsent?: boolean): default<number>[]
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<number>[]
- Defined in src/game/game/Game.ts:260

getSynchronizeState

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

getTickSpeed

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

getTurnMode

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

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:306

initGl

initGl(forceWebGlVersion?: number): Promise<void>
Initializes WebGl
Parameters
- Optional forceWebGlVersion: number
  
  Set to force a specific webgl version
Returns Promise<void>
- Defined in src/game/game/Game.ts:317

initialize

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

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:767

initializeModifiers

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

initializeRenderer

initializeRenderer(): void
Returns void
- Defined in src/game/game/Game.ts:285

isSimulatedOrRealTimeMode

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

isTurnModeAllowed

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

onPlayingEntityChange

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

passTurn

passTurn(human: default<number>, turnType?: TurnTypeFlag, dueToAction?: boolean): void
Marks that the human had a turn In manual turn mode, it will tick the humans stat timers & the game
Parameters
- human: default<number>
- Optional turnType: TurnTypeFlag
- dueToAction: boolean = false
Returns void
- Defined in src/game/game/Game.ts:862

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:1140

resetWebGL

resetWebGL(): void
Returns void
- Defined in src/game/game/Game.ts:430

resizeRenderer

resizeRenderer(): void
Returns void
- Defined in src/game/game/Game.ts:451

selectBiome

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

setGlContextSize

setGlContextSize(): void
Returns void
- Defined in src/game/game/Game.ts:443

setPaused

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

setTickSpeed

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

setTurnMode

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

setupGl

setupGl(restoring: boolean): Promise<void>
Compiles webgl programs / shaders and creates renderers
Parameters
- restoring: boolean
Returns Promise<void>
- Defined in src/game/game/Game.ts:395

stopGameLogicLoop

stopGameLogicLoop(): void
Stops the game logic loop timer

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

synchronizeState

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

testFastForwardSpeed

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

tick

tick(ticks?: number, playingHumans?: default<number>[], tickFlag?: TickFlag, dueToAction?: boolean): void
Collection of things to perform on each tick
Parameters
- ticks: number = 1
- playingHumans: default<number>[] = ...
- tickFlag: TickFlag = TickFlag.All
- dueToAction: boolean = false
Returns void
- Defined in src/game/game/Game.ts:1031

tickAsync

tickAsync(island: default, ticks: number, playingHumans?: default<number>[], tickFlag?: TickFlag, onProgress: ((progess: number) => Promise<void>), dueToAction?: boolean): Promise<void>
Collection of things to perform on each tick
Parameters
- island: default
- ticks: number
- playingHumans: default<number>[] = ...
- tickFlag: TickFlag = TickFlag.All
- onProgress: ((progess: number) => Promise<void>)
  - - (progess: number): Promise<void>
    - Parameters
      
      progess: number
      
      Returns Promise<void>
- dueToAction: boolean = false
Returns Promise<void>
- Defined in src/game/game/Game.ts:1066

tickRealtime

tickRealtime(): void
Returns void
- Defined in src/game/game/Game.ts:886

toString

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

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:642

uninitialize

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

unlockAllMilestones

unlockAllMilestones(): void
Returns void
- Defined in src/game/game/Game.ts:1364

updateGameOptions

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

updateOption

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

updateOptionInternal

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

updateTablesAndWeight

updateTablesAndWeight(): void
Returns void
- Defined in src/game/game/Game.ts:914

Class Game

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Game

Properties

absoluteTime

Readonly autoSave

canvasElement

Optional challengeCollection

Readonly commandManager

customMilestoneModifiersAllowed

difficulty

Readonly event

gameplayModifierData

initialThumbnailTimeout

Readonly interval

Readonly islands

Readonly itemStylesheetHandler

lastTickTime

Readonly milestoneManager

Optional milestonesCollection

Readonly modManager

nextTickTime

originalPlayOptions

paused

Readonly playerManager

playing

previousSaveVersion

Readonly references

replay

saveClear

Readonly saveLoad

Readonly saveManager

Optional saveSize

saveVersion

shouldUpdateTablesAndWeight

slot

Readonly steamworks

Protected stringTokenizer

tickSpeed

tileDecorations

time

turnMode

Readonly uninit

upgrades

version

visible

webGlContext

Readonly webWorkerManager

worldId

Accessors

isChallenge

Returns boolean

isPaused

Returns boolean

Methods

createRenderer

Parameters

origin: IRendererOrigin

Returns void

ensureTurnMode

Returns void

fastForwardIsland

Parameters

island: default

ticks: number

Optional multiplayerLoadingDescription: MultiplayerLoadingDescription

Returns Promise<void>

gameLogicLoop

Returns void

getGameMode

Returns GameMode

getGameOptions

Returns IGameOptions

`Readonly` autoSave

`Optional` challengeCollection

`Readonly` commandManager

`Readonly` event

`Readonly` interval

`Readonly` islands

`Readonly` itemStylesheetHandler

`Readonly` milestoneManager

`Optional` milestonesCollection

`Readonly` modManager

`Readonly` playerManager

`Readonly` references

`Readonly` saveLoad

`Readonly` saveManager

`Optional` saveSize

`Readonly` steamworks

`Protected` stringTokenizer

`Readonly` uninit

`Readonly` webWorkerManager

`Optional` multiplayerLoadingDescription: MultiplayerLoadingDescription

`Optional` includeGhosts: boolean

`Optional` includeConnecting: boolean

`Optional` includeDedicatedServer: boolean

`Optional` includeAbsent: boolean

`Optional` forceWebGlVersion: number

`Optional` options: IGameOptions

`Optional` milestoneModifiers: Set<Milestone>