Interface IGameEvents

Hierarchy

IGameEvents

Methods

exploreAsGhost

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

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

getBiomeType

getBiomeType(positon: IVector2, biomeType: BiomeTypes): undefined | BiomeTypes
Called when selecting the biome type for and island
Parameters
- positon: IVector2
  
  Island position
- biomeType: BiomeTypes
  
  Biome type
Returns undefined | BiomeTypes
- Defined in src/game/game/IGame.ts:87

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

glInitialized

glInitialized(): any
Returns any
- Defined in src/game/game/IGame.ts:119

glLostContext

glLostContext(): any
Returns any
- Defined in src/game/game/IGame.ts:117

glSetup

glSetup(restored: boolean): any
Parameters
- restored: boolean
Returns any
- Defined in src/game/game/IGame.ts:118

loadStep

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

pause

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

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

playingEntityChange

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

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

`Optional` postFieldOfView

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

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

postSaveGame

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

preSaveGame

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

rendererCreated

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

reset

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

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

resume

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

setTurnMode

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

stopPlay

stopPlay(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:68

stoppingPlay

stoppingPlay(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:62

tickEnd

tickEnd(tickFlag: TickFlag, ticks: number, dueToAction: boolean): any
Parameters
- tickFlag: TickFlag
- ticks: number
- dueToAction: boolean
Returns any
- Defined in src/game/game/IGame.ts:101

tickStart

tickStart(tickFlag: TickFlag, ticks: number, dueToAction: boolean): any
Parameters
- tickFlag: TickFlag
- ticks: number
- dueToAction: boolean
Returns any
- Defined in src/game/game/IGame.ts:100

Generated using TypeDoc