Interface IPlayerEvents

Called when something is built on a tile

Called before an npc attacks

Returns

False if the npc cannot attack, or undefined to use the default logic

Called when the walkTo of the player is about to change.

Returns

False to prevent the walk change or undefined to use the default logic

Called before consuming an item

Returns

True if the human can consume the item (default logic isn't called, should use your own code for consumption), false if the human cannot consume the item, or undefined to use the default logic

Called when a human tries to interact with an NPC

Returns

True if the human can interact, false if the human cannot interact, or undefined to use the default logic

Called when movement is attempted on the server

Returns

False to prevent movement or undefined to use the default logic

Called when the human changes their layer (z position)

Called when the entity is created in the game Also called for players that "rejoin" the game

Called when the human is damaged

Returns

The amount of damage the player should take (the player will take this damage)

Used for deregistering events

Called when the human equips an item to a slot

Called when the human fails to equip an item to a slot

Called in Drop.canUse()

Returns

an Item[] if filtering, undefined to allow all of these items to be dropped

Luck is a multiplier applied to some chance calculations. 1 is default, 0.5 would mean chances are halved, 2 would mean chances are doubled, etc.

Called when getting the player's maximum health

Called when getting the player's maximum weight

Called when getting the players movement intent

Returns

The movement intent of the player or undefined to use the default logic

Called when we get the skill gain multiplier

Returns

The multiplier for skill gain as a number or undefined to use the default logic

Called when calculating the movement penalty of a tile.

Called when getting the players weight or stamina movement penalty

Returns

The weight/stamina movement penalty for the player or undefined to use the default logic

Called when getting the players weight status

Returns

The weight status of the player or undefined to use the default logic

Called when an item is added to the player's inventory

Called when an item is removed from the players inventory

Called when an item is moved from one container to another, while still in the players inventory.

Called when checking if a human is swimming

Returns

True if the human should be swimming, false if they should not be swimming, or undefined to use the default logic

Called when an entity is killed by another entity.

Called when the human is loaded onto an island

Called when the player completes a movement

Called when the human is moving to another island

Called when no input is received

Called when a book is opened by a player

Called when an doodad is picked up

Called after moving.

Called before moving. Can be called twice for humans

Called when the human is moving to another island

Called when input is being processed on the server

Returns

False to prevent input processing or undefined to use the default logic

Called when the entity is removed from the game

Called when the entity is renamed

Used for registering events This may be called more than once on the same player

Called when the player stops resting

Called when the player starts resting

Called when the human will be killed. If any handlers return false to stop the human from dying, no further handlers will be called.

Returns

false to stop the human from dying

Called to check whether the human should be rendered. If any handlers return false, then the human will not be rendered.

Returns

false to stop the human from being rendered

Returns

True if the skill check should pass, false if it shouldn't, undefined if it should be random

Called when the human is spawned. (At the end of Player.setup / NPC.spawn)

Called when a stat changes, for any reason

Called when a stat changes, for any reason

Called when a stat's max value changes, for any reason

Called when a stat timer changes

Called when a stat timer is removed

Called when a stat timer will change

Returns

false to cancel the stat timer change, undefined otherwise.

Called when this entity gets or loses a status effect

Called when the player tick ends

Called when the player tick starts

Called when a turn is ending

Called when a turn is starting

Called when the human unequips an item from a slot

Called when the human fails to unequip an item from a slot

Called when the human faces a different direction

Called when the players weight is being updated

Returns

A number to set the player weight to or undefined to use the default logic

Called when the walk path of the player changes.