Interface IGameEvents

Hierarchy

IGameEvents

Methods

addHistoricalAction

addHistoricalAction(executor: default<unknown, number, EntityReferenceTypes, unknown>, context: default): any
Parameters
- executor: default<unknown, number, EntityReferenceTypes, unknown>
- context: default
Returns any
- Defined in src/game/game/IGame.ts:150

exploreAsGhost

exploreAsGhost(): any
Called when the local player clicks "explore world as ghost"

Returns any
- Defined in src/game/game/IGame.ts:61

getBiomeType

getBiomeType(positon: undefined | IVector2, biomeType: BiomeTypes): undefined | BiomeTypes
Called when selecting the biome type for and island
Parameters
- positon: undefined | IVector2
  
  Island position, or undefined if this is not related to island initialisation
- biomeType: BiomeTypes
  
  Biome type
Returns undefined | BiomeTypes
- Defined in src/game/game/IGame.ts:104

getBiomeTypeChances

getBiomeTypeChances(): undefined | [number, BiomeTypes][]
Called when getting the biome type distribution for random biome selection

Returns undefined | [number, BiomeTypes][]
- Defined in src/game/game/IGame.ts:97

getGameOptions

getGameOptions(gameOptions: IGameOptions): IGameOptions
Called when game options are first processed, after modifiers are applied.

You can use this combined with game.uncacheGameOptions() to dynamically modify game options.
Parameters
- gameOptions: IGameOptions
Returns IGameOptions
- Defined in src/game/game/IGame.ts:45

initializeGameplayModifiers

initializeGameplayModifiers(): any
Returns any
- Defined in src/game/game/IGame.ts:66

loadStep

loadStep(): any
Returns any
- Defined in src/game/game/IGame.ts:87

pause

pause(): any
Returns any
- Defined in src/game/game/IGame.ts:110

play

play(isLoadingSave: boolean, playedCount: number): any
Called when the game is starting
Parameters
- isLoadingSave: boolean
  
  True if a save game was loaded
- playedCount: number
  
  The number of times the player has played the game (globally, not per slot)
Returns any
- Defined in src/game/game/IGame.ts:56

playingEntityChange

playingEntityChange(): any
Called when the playing entity count changes

Returns any
- Defined in src/game/game/IGame.ts:120

`Optional` postFieldOfView

postFieldOfView(): void
Called after the field of view has initialized

Returns void
- Defined in src/game/game/IGame.ts:148

postSaveGame

postSaveGame(saveType: SaveType): any
Parameters
- saveType: SaveType
Returns any
- Defined in src/game/game/IGame.ts:64

preSaveGame

preSaveGame(saveType: SaveType): any
Parameters
- saveType: SaveType
Returns any
- Defined in src/game/game/IGame.ts:63

rendererCreated

rendererCreated(renderer: Renderer): any
Called when the game creates the primary renderer
Parameters
- renderer: Renderer
Returns any
- Defined in src/game/game/IGame.ts:139

rendererReady

rendererReady(): any
Called when the renderer is configured during game startup

Returns any
- Defined in src/game/game/IGame.ts:134

reset

reset(): any
Called when all game state was reset

Returns any
- Defined in src/game/game/IGame.ts:92

resume

resume(): any
Returns any
- Defined in src/game/game/IGame.ts:111

setTurnMode

setTurnMode(turnMode: TurnMode): any
Called when the turn mode is set
Parameters
- turnMode: TurnMode
Returns any
- Defined in src/game/game/IGame.ts:125

stoppedPlay

stoppedPlay(state: PlayerState): any
Called when the game has stopped being played
Parameters
- state: PlayerState
  
  The state of the player (why the game ended)
Returns any
- Defined in src/game/game/IGame.ts:85

stoppingPlayPostSave

stoppingPlayPostSave(state: PlayerState): any
Called when the game is stopping being played, and it has saved
Parameters
- state: PlayerState
  
  The state of the player (why the game is ending)
Returns any
- Defined in src/game/game/IGame.ts:79

stoppingPlayPreSave

stoppingPlayPreSave(state: PlayerState): any
Called when the game is stopping being played
Parameters
- state: PlayerState
  
  The state of the player (why the game is ending)
Returns any
- Defined in src/game/game/IGame.ts:73

uninit

uninit(): any
Called as the game is closing

Returns any
- Defined in src/game/game/IGame.ts:155

uninitializeGameplayModifiers

uninitializeGameplayModifiers(): any
Returns any
- Defined in src/game/game/IGame.ts:67

Generated using TypeDoc