Player Events

PLAYER JOIN

Event called when a player joins the server.

example:
  type: player_join
  actions:
    default:
    - 'message: &eWelcome %player% to the server.'

This event has no variables, but you can still use ConditionalEvents variables or PlaceholderAPI variables.

This event can't be cancelled with cancel_event action.

PLAYER LEAVE

Event called when a player leaves the server.

example:
  type: player_leave
  actions:
    default:
    - 'to_all: message: &e%player% left the server.'

This event has no variables, but you can still use ConditionalEvents variables or PlaceholderAPI variables.

This event can't be cancelled with cancel_event action.

PLAYER PRE JOIN

Event called when a player tries to join the server.

Variables:

  • %name% (Name of the player trying to join the server)

  • %ip% (IP of the player)

  • %uuid% (UUID of the player)

This is not a player event, which means you can't use player variables or player actions. Don't be confused, it is called a "player pre join", but it is a special event which doesn't contain player data.

This event can't be cancelled with cancel_event action. If you want to block the player from joining, use the prevent_join action instead.

PLAYER RESPAWN

Event called when a player respawns.

This event has no variables, but you can still use ConditionalEvents variables or PlaceholderAPI variables.

This event can't be cancelled with cancel_event action.

PLAYER DEATH

Event called when a player dies.

Variables:

This event can't be cancelled with cancel_event action.

PLAYER COMMAND

Event called when a player executes a command.

Variables:

  • %command% (The full command the player used)

  • %main_command% (The main command without arguments)

  • %arg_X% (The argument in the X position of the command. If the command is /announce hello world the %arg_1% variable would be "hello" and the %arg_2% would be "world")

  • %args_length% (The amount of arguments of the command)

  • %args_substring_<arg1>-<arg2>% (This variable will create a text using a first argument and a last argument. For example, if the command is /announce I am currently doing a Youtube livestreaming, you could use the %args_substring_1-6% variable to take arg1, arg2,...,arg6 and get the text that the player is announcing. If you don't care about the arguments length, instead of 6 use a large number like 100)

PLAYER CHAT

Event called when a player writes something in chat.

Variables:

  • %message% (The chat message)

PLAYER LEVELUP

Event called when a player changes its level.

Variables:

  • %old_level% (The previous level of the player)

  • %new_level% (The new level of the player)

This event can't be cancelled with cancel_event action.

PLAYER WORLD CHANGE

Event called when a player is moving to another world.

Variables:

  • %world_from% (The previous world)

  • %world_to% (The world where the player is moving to)

  • %online_players_from% (Amount of online players in the previous world)

  • %online_players_to% (Amount of online players in the world where the player is moving to)

This event can't be cancelled with cancel_event action.

PLAYER ATTACK

Event called when a player damages an entity.

Variables:

  • %damage% (Damage made by the player)

  • %original_damage% (Original damage made by the player)

  • %attack_type% (Type of the damage. For projectiles it could be: ARROW, TRIDENT, SNOWBALL. If the damage is not made by a projectile, it will result in PLAYER)

  • ConditionalEvents item variables (for item in hand)

  • ConditionalEvents victim variables

On this event you can use target player variables and to_target actions.

PLAYER KILL

Event called when a player kills an entity.

Variables:

  • ConditionalEvents item variables (for item in hand)

  • ConditionalEvents victim variables

This event can't be cancelled with cancel_event action.

On this event you can use target player variables and to_target actions.

PLAYER DAMAGE

Event called when a player is taking damage.

Variables:

PLAYER ARMOR

Event called when a player equips or unequips armor.

Variables:

  • %armor_type% (Type of the armor. Could be: HELMET, CHESTPLATE, LEGGINGS or BOOTS)

  • %equip_type% (Could be: EQUIP or UNEQUIP)

  • ConditionalEvents item variables

If you are using EssentialsX: EssentialsX changes the way interactions behave in player armor, so if you want to use the player_armor event, set allow-direct-hat: false on EssentialsX config.

PLAYER TELEPORT

Event called when a player teleports somehow.

Variables:

  • %cause% (Cause of the event. Why is the player teleporting. All causes here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/player/PlayerTeleportEvent.TeleportCause.html)

  • %from_x% (Coordinate X of the previous location)

  • %from_y% (Coordinate Y of the previous location)

  • %from_z% (Coordinate Z of the previous location)

  • %from_world% (World of the previous location)

  • %from_yaw% (Yaw of the previous location)

  • %from_pitch% (Pitch of the previous location)

  • %to_x% (Coordinate Z of the new location)

  • %to_y% (Coordinate Y of the new location)

  • %to_x% (Coordinate X of the new location)

  • %to_world% (World of the new location)

  • %to_yaw% (Yaw of the new location)

  • %to_pitch% (Pitch of the new location)

PLAYER BED ENTER

Event called when a player enters a bed.

Variables:

Only works on 1.13+!

PLAYER OFFHAND

Event called when players interact with their offhand.

  • Swap items between main hand and offhand using the hotkey.

  • Use the inventory to move items to the offhand.

  • Use the inventory to recover items from the offhand.

Variables:

  • %movement_type% (Could be: SWAP, PLACE, RECOVER, NOTHING)

  • ConditionalEvents item variables (for the item the player is trying to put in the offhand)

  • ConditionalEvents item variables (for the item the player is trying to recover from the offhand: %offhand:<variable>%)

PLAYER FISH

Event called when a player is fishing.

Variables:

On this event you can use target player variables and to_target actions (Only if %state% is CAUGHT_ENTITY and %caught_type% is a Living Entity)

PLAYER OPEN INVENTORY

Event called when a player opens an inventory.

Variables:

PLAYER CLOSE INVENTORY

Event called when a players closes an inventory.

Variables:

This event can't be cancelled with cancel_event action.

PLAYER CLICK INVENTORY

Event called when a player clicks on an inventory.

Variables:

PLAYER STATISTIC

Event called when a player statistic is incremented, like certain blocks breaked, jumps, items pickup...

Variables:

PLAYER SNEAK

Event called when a player toggles their sneaking state.

Variables:

  • %is_sneaking% (Whether the player is sneaking or not. Will return "true" or "false")

This event can't be cancelled with cancel_event action.

PLAYER RUN

Event called when a player toggles their running state (starts or stops running).

Variables:

  • %is_running% (Whether the player is running or not. Will return "true" or "false")

This event can't be cancelled with cancel_event action.

PLAYER REGAIN HEALTH

Event called when a player regains/regenerates health.

Variables:

PLAYER CHANGE FOOD

Event called when the food level of a player changes.

Variables:

  • %old_food_level% (The previous food level of the player)

  • %new_food_level% (The new food level of the player)

Only works on 1.16+!

PLAYER TAB COMPLETE

Event called when a player is writing a command and about to display possible arguments. Mainly used with the tab_complete action.

Variables:

  • %main_command% (The command involved in this event)

  • %args_length% (The current argument position of the command the player is trying to autocomplete)

  • %arg_X% ( The argument in the X position of the command. If the command is /help worlds plots the %arg_1% variable would be "worlds" and the %arg_2% would be "plots")

This event will be detected ONLY if the command is already registered as a command, either by another plugin, or by ConditionalEvents. Remember that you can register commands on the register_commands option in the config.

Only works on 1.9+!

PreviousEvent TypesNextBlock Events

Last updated

Was this helpful?