Interface IIslandEvents

Hierarchy

IIslandEvents

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

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

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

damage

damage(target: default | default<unknown, number, NPC | Player>, damageInfo: IDamageInfo, attackOutcome: number): false | void
Called when damaging an entity

Returns
false to cancel default damage
Parameters
- target: default | default<unknown, number, NPC | Player>
- damageInfo: IDamageInfo
- attackOutcome: number
Returns false | void
- Defined in src/game/game/island/IIsland.ts:169

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

delete

delete(): void
Called when the island is deleted

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

fastForwardEnd

fastForwardEnd(): any
Returns any
- Defined in src/game/game/island/IIsland.ts:157

fastForwardStart

fastForwardStart(): any
Returns any
- Defined in src/game/game/island/IIsland.ts:156

getDefense

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

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

loadedReferences

loadedReferences(): void
Called when item references are loaded

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

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

`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:127

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

`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:134

randomEvents

randomEvents(tile: default, human: default<unknown, number, NPC | Player>): undefined | boolean | void
Emitted when random events are attempting to run on a tile.

Returns
false to cancel default events
Parameters
- tile: default
- human: default<unknown, number, NPC | Player>
Returns undefined | boolean | void
- Defined in src/game/game/island/IIsland.ts:163

rename

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

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

tickEnd

tickEnd(options: IIslandTickOptions): any
Parameters
- options: IIslandTickOptions
Returns any
- Defined in src/game/game/island/IIsland.ts:90

tickStart

tickStart(options: IIslandTickOptions): any
Parameters
- options: IIslandTickOptions
Returns any
- Defined in src/game/game/island/IIsland.ts:89

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

unloaded

unloaded(): void
Called when the island is unloaded

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

Generated using TypeDoc