Interface IIslandEvents

Hierarchy

IIslandEvents

Index

Methods

activated calculateAttackOutcome createWorld deactivated delete getDefense getFastForwardAmount loadedReferences portsChanged postGenerateWorld? preLoadWorld preLoadWorldDifferences? rename terrainChange tickEnd tickStart tileUpdate unloaded

Methods

activated

activated(): void
Called when the island is activated This means a player loaded onto the island

Returns void
- Defined in src/game/game/island/IIsland.ts:82

calculateAttackOutcome

calculateAttackOutcome(damageOutcome: IDamageOutcome, input: IDamageOutcomeInput, attackValue: number, defenseValue: number): undefined | IDamageOutcome
Parameters
- damageOutcome: IDamageOutcome
- input: IDamageOutcomeInput
- attackValue: number
- defenseValue: number
Returns undefined | IDamageOutcome
- Defined in src/game/game/island/IIsland.ts:159

createWorld

createWorld(world: default): any
Called when the world is created
Parameters
- world: default
  
  World object
Returns any
- Defined in src/game/game/island/IIsland.ts:125

deactivated

deactivated(): void
CValled when the island is deactivated This means there are no longer players on the island

Returns void
- Defined in src/game/game/island/IIsland.ts:88

delete

delete(): void
Called when the island is deleted

Returns void
- Defined in src/game/game/island/IIsland.ts:98

getDefense

getDefense(defense: undefined | Defense, target: default | default<number> | CreatureType, damageType?: DamageType): undefined | Defense
Parameters
- defense: undefined | Defense
- target: default | default<number> | CreatureType
- Optional damageType: DamageType
Returns undefined | Defense
- Defined in src/game/game/island/IIsland.ts:157

getFastForwardAmount

getFastForwardAmount(fastForwardAmount: number, travelTime: number): undefined | number
Called when determining how many ticks to process when fast forwarding an island during traveling
Parameters
- fastForwardAmount: number
  
  Fast forward amount
- travelTime: number
  
  Travel time
Returns undefined | number
- Defined in src/game/game/island/IIsland.ts:166

loadedReferences

loadedReferences(): void
Called when item references are loaded

Returns void
- Defined in src/game/game/island/IIsland.ts:118

portsChanged

portsChanged(addedPort?: default, removedPort?: default): any
Emitted when island ports have changed
Parameters
- Optional addedPort: default
- Optional removedPort: default
Returns any
- Defined in src/game/game/island/IIsland.ts:155

`Optional` postGenerateWorld

postGenerateWorld(generateNewWorld: boolean): void
Called after the world is generating
Parameters
- generateNewWorld: boolean
  
  True if a new world is being generated
Returns void
- Defined in src/game/game/island/IIsland.ts:138

preLoadWorld

preLoadWorld(world: default): any
Called when right before the world is loaded
Parameters
- world: default
  
  World object
Returns any
- Defined in src/game/game/island/IIsland.ts:132

`Optional` preLoadWorldDifferences

preLoadWorldDifferences(generateNewWorld: boolean): void
Called before loading world differences Loading differences involving setting up corpses, creatures, doodads, and related things onto the world
Parameters
- generateNewWorld: boolean
  
  True if a new world is being generated
Returns void
- Defined in src/game/game/island/IIsland.ts:145

rename

rename(human: default<number>, newName?: string, oldName?: string): any
Emitted when an island is renamed
Parameters
- human: default<number>
- Optional newName: string
- Optional oldName: string
Returns any
- Defined in src/game/game/island/IIsland.ts:150

terrainChange

terrainChange(tile: default, oldType: TerrainType): any
Called when a tile type changes.
Parameters
- tile: default
- oldType: TerrainType
Returns any
- Defined in src/game/game/island/IIsland.ts:113

tickEnd

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

tickStart

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

tileUpdate

tileUpdate(tile: default, tileUpdateType: TileUpdateType): void
Called when a tile is updated (tile type changed, doodad created on it, etc)
Parameters
- tile: default
  
  The tile that was updated
- tileUpdateType: TileUpdateType
  
  The tile update type
Returns void
- Defined in src/game/game/island/IIsland.ts:108

unloaded

unloaded(): void
Called when the island is unloaded

Returns void
- Defined in src/game/game/island/IIsland.ts:93

Generated using TypeDoc