Interface ICreatureEvents

Hierarchy

IEntityWithStatsEvents
- ICreatureEvents

Methods

canAttack

canAttack(enemy: default | default<number>): undefined | boolean
Called before a creature attacks

Returns
False if the creature cannot attack, or undefined to use the default logic
Parameters
- enemy: default | default<number>
  
  The enemy (human or creature)
Returns undefined | boolean
- Defined in src/game/game/entity/creature/ICreature.ts:408

`Optional` canDespawn

canDespawn(): undefined | boolean
Called when a creature despawns

Returns
True if the creature can despawn, false if the creature can't despawn, or undefined to use the default logic

Returns undefined | boolean
- Defined in src/game/game/entity/creature/ICreature.ts:436

`Optional` canFaceDirections

canFaceDirections(x: number, y: number): undefined | boolean
Called when a creature tries to face a new direction

Returns
True if the creature can face a new direction, false if the creature can't face a new direction, or undefined to use the default logic
Parameters
- x: number
  
  The x coordinate of the creature's facing direction
- y: number
  
  The y coordinate of the creature's facing direction
Returns undefined | boolean
- Defined in src/game/game/entity/creature/ICreature.ts:424

`Optional` canMove

canMove(tile: default, moveType: MoveType): undefined | boolean
Called when a creature tries to move

Returns
True if the creature can move, false if the creature cannot move, or undefined to use the default logic
Parameters
- tile: default
  
  The tile the creature is trying to move to
- moveType: MoveType
  
  The creatures move type
Returns undefined | boolean
- Defined in src/game/game/entity/creature/ICreature.ts:416

`Optional` canPerformSpecialAbilities

canPerformSpecialAbilities(): undefined | boolean
Called when a creature may attempt to do a special ability

Returns
True if the creature can attempt to do a special ability, false if the creature can't perform special abilities, or undefined to use the default logic

Returns undefined | boolean
- Defined in src/game/game/entity/creature/ICreature.ts:430

created

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

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

`Optional` damage

damage(damageInfo: IDamageInfo): undefined | number
Called when a creature is damaged

Returns
The amount of damage the creature should take (the creature will take this damage) or undefined to use the default logic
Parameters
- damageInfo: IDamageInfo
  
  The damage info object
Returns undefined | number
- Defined in src/game/game/entity/creature/ICreature.ts:454

`Optional` die

die(): void
Called when a creature dies

Returns void
- Defined in src/game/game/entity/creature/ICreature.ts:447

`Optional` kill

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

postMove

postMove(fromTile: default, toTile: default, flags: MoveFlag): void
Called after moving.
Parameters
- fromTile: default
- toTile: default
- flags: MoveFlag
Returns void
Inherited from IEntityWithStatsEvents.postMove
- Defined in src/game/game/entity/EntityMovable.ts:47

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 IEntityWithStatsEvents.preMove
- Defined in src/game/game/entity/EntityMovable.ts:42

removed

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

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

renamed

renamed(): void
Called when the entity is renamed

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

statBonusChanged

statBonusChanged(stat: IStat, oldValue?: number, info?: IStatChangeInfo<any>): void
Called when a stat changes, for any reason
Parameters
- stat: IStat
  
  An IStat object, the stat that was affected
- Optional oldValue: number
  
  The value that the stat changed from
- Optional info: IStatChangeInfo<any>
  
  An IStatChangeInfo object describing why the change occurred. It will always be passed with a reason
Returns void
Inherited from IEntityWithStatsEvents.statBonusChanged
- Defined in src/game/game/entity/IStats.ts:197

statChanged

statChanged(stat: IStat, oldValue: number, info: IStatChangeInfo<any>): void
Called when a stat changes, for any reason
Parameters
- stat: IStat
  
  An IStat object, the stat that was affected
- oldValue: number
  
  The value that the stat changed from
- info: IStatChangeInfo<any>
  
  An IStatChangeInfo object describing why the change occurred. It will always be passed with a reason
Returns void
Inherited from IEntityWithStatsEvents.statChanged
- Defined in src/game/game/entity/IStats.ts:165

statMaxChanged

statMaxChanged(stat: IStatMax, oldValue?: number, info?: IStatChangeInfo<any>): void
Called when a stat's max value changes, for any reason
Parameters
- stat: IStatMax
  
  An IStat object, the stat that was affected
- Optional oldValue: number
  
  The value that the stat changed from
- Optional info: IStatChangeInfo<any>
  
  An IStatChangeInfo object describing why the change occurred. It will always be passed with a reason
Returns void
Inherited from IEntityWithStatsEvents.statMaxChanged
- Defined in src/game/game/entity/IStats.ts:190

statTimerChanged

statTimerChanged(stat: IStat, oldValue?: number): void
Called when a stat timer changes
Parameters
- stat: IStat
  
  An IStat object, the stat that was affected
- Optional oldValue: number
  
  The value that the stat changed from
Returns void
Inherited from IEntityWithStatsEvents.statTimerChanged
- Defined in src/game/game/entity/IStats.ts:171

statTimerRemoved

statTimerRemoved(stat: IStat): any
Called when a stat timer is removed
Parameters
- stat: IStat
  
  An IStat object, the stat that was affected
Returns any
Inherited from IEntityWithStatsEvents.statTimerRemoved
- Defined in src/game/game/entity/IStats.ts:183

statTimerWillChange

statTimerWillChange(stat: IStat, changeFactory: StatChangeTimerFactory): undefined | false
Called when a stat timer will change

Returns
false to cancel the stat timer change, undefined otherwise.
Parameters
- stat: IStat
  
  An IStat object, the stat that will be affected
- changeFactory: StatChangeTimerFactory
  
  An object for manipulating how the new stat change timer will be set
Returns undefined | false
Inherited from IEntityWithStatsEvents.statTimerWillChange
- Defined in src/game/game/entity/IStats.ts:178

statusChange

statusChange(status: StatusType, level: number, reason: StatusEffectChangeReason): void
Called when this entity gets or loses a status effect
Parameters
- status: StatusType
  
  The type of status effect that was gained or lost
- level: number
  
  Whether the entity now has the status effect
- reason: StatusEffectChangeReason
  
  The reason for the change
Returns void
Inherited from IEntityWithStatsEvents.statusChange
- Defined in src/game/game/entity/EntityWithStats.ts:39

`Optional` tame

tame(owner: default<number>): void
Called when a creature becomes tamed
Parameters
- owner: default<number>
  
  The human which the creature is tamed for
Returns void
- Defined in src/game/game/entity/creature/ICreature.ts:442

Interface ICreatureEvents

Hierarchy

Index

Methods

Methods

canAttack

Returns

Parameters

enemy: default | default<number>

Returns undefined | boolean

Optional canDespawn

Returns

Returns undefined | boolean

Optional canFaceDirections

Returns

Parameters

x: number

y: number

Returns undefined | boolean

Optional canMove

Returns

Parameters

tile: default

moveType: MoveType

Returns undefined | boolean

Optional canPerformSpecialAbilities

Returns

Returns undefined | boolean

created

Returns void

Optional damage

Returns

Parameters

damageInfo: IDamageInfo

Returns undefined | number

Optional die

Returns void

Optional kill

Parameters

attacker: default | default<unknown, number, unknown, unknown>

Returns void

postMove

Parameters

fromTile: default

toTile: default

flags: MoveFlag

Returns void

preMove

Parameters

fromTile: default

toTile: default

isMoving: boolean

Returns undefined | boolean | void

removed

Returns void

renamed

Returns void

statBonusChanged

Parameters

stat: IStat

Optional oldValue: number

Optional info: IStatChangeInfo<any>

Returns void

statChanged

Parameters

stat: IStat

oldValue: number

info: IStatChangeInfo<any>

Returns void

statMaxChanged

Parameters

stat: IStatMax

Optional oldValue: number

Optional info: IStatChangeInfo<any>

Returns void

statTimerChanged

Parameters

stat: IStat

Optional oldValue: number

Returns void

`Optional` canDespawn

`Optional` canFaceDirections

`Optional` canMove

`Optional` canPerformSpecialAbilities

`Optional` damage

`Optional` die

`Optional` kill

`Optional` oldValue: number

`Optional` info: IStatChangeInfo<any>

`Optional` oldValue: number

`Optional` info: IStatChangeInfo<any>

`Optional` oldValue: number

`Optional` tame