Interface ITileEventEvents

Hierarchy

IEntityMovableEvents
- ITileEventEvents

Index

Methods

created fireUpdate kill? postMove preMove removed renamed updateHistoricalActionCount

Methods

created

created(): void
Called when the entity is created in the game Also called for players that "rejoin" the game

Returns void
Inherited from IEntityMovableEvents.created
- Defined in src/game/game/entity/IEntity.ts:49

fireUpdate

fireUpdate(tile: default, stage: undefined | FireStage): any
Emitted when the fire stage of this tile event changes.
Note: The fire stage of tile event is not saved, so when the tile event's fire stage is first checked on load, this event will be emitted.
Parameters
- tile: default
- stage: undefined | FireStage
Returns any
- Defined in src/game/game/tile/TileEvent.ts:50

`Optional` kill

kill(attacker: default | default<unknown, number, EntityReferenceTypes, unknown>): void
Called when an entity is killed by another entity.
Parameters
- attacker: default | default<unknown, number, EntityReferenceTypes, unknown>
Returns void
Inherited from IEntityMovableEvents.kill
- Defined in src/game/game/entity/IEntity.ts:39

postMove

postMove(fromTile: default, toTile: default, flags: MoveFlag, skipExtinguishTorches?: boolean): void
Called after moving.
Parameters
- fromTile: default
- toTile: default
- flags: MoveFlag
- Optional skipExtinguishTorches: boolean
Returns void
Inherited from IEntityMovableEvents.postMove
- Defined in src/game/game/entity/EntityMovable.ts:52

preMove

preMove(fromTile: default, toTile: default, isMoving: boolean): undefined | boolean | void
Called before moving. Can be called twice for humans
Parameters
- fromTile: default
- toTile: default
- isMoving: boolean
  
  True the second time it's called, right as the entity is about to actually move
Returns undefined | boolean | void
Inherited from IEntityMovableEvents.preMove
- Defined in src/game/game/entity/EntityMovable.ts:47

removed

removed(): void
Called when the entity is removed from the game

Returns void
Inherited from IEntityMovableEvents.removed
- Defined in src/game/game/entity/IEntity.ts:59

renamed

renamed(): void
Called when the entity is renamed

Returns void
Inherited from IEntityMovableEvents.renamed
- Defined in src/game/game/entity/IEntity.ts:54

updateHistoricalActionCount

updateHistoricalActionCount(action: ActionType, count: number, oldCount: number): any
Parameters
- action: ActionType
- count: number
- oldCount: number
Returns any
Inherited from IEntityMovableEvents.updateHistoricalActionCount
- Defined in src/game/game/entity/IEntity.ts:61

Generated using TypeDoc