Note:
You can specify the event priority after each event syntax using the following syntax [with priority (lowest|low|normal|high|highest|monitor)] e.g. on spawn with priority lowest.
Note that not all of the events support event priority feature and they will throw an error.
| Patterns: | |
| Since: | 1.3.4 |
An event that occurs at a given minecraft time in every world or only in specific worlds.
Examples:
at 18:00
at 7am in "world"
at 7am in "world"
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper |
Called when an anvil is damaged/broken from being used to repair/rename items.
Note: this does not include anvil damage from falling.
Note: this does not include anvil damage from falling.
Examples:
on anvil damage:
cancel the event
cancel the event
| Patterns: |
|
| Since: | 2.7 |
Called when an item is put in a slot for repair by an anvil. Please note that this event is called multiple times in a single item slot move.
Examples:
on anvil prepare:
event-item is set # result item
chance of 5%:
set repair cost to repair cost * 50%
send "You're LUCKY! You got 50% discount." to player
event-item is set # result item
chance of 5%:
set repair cost to repair cost * 50%
send "You're LUCKY! You got 50% discount." to player
| Patterns: |
|
| Since: | 2.2-dev21 |
Called when area effect cloud applies its potion effect. This happens every 5 ticks by default.
Examples:
on area cloud effect:
| Patterns: |
|
| Since: | 2.5.1 |
Called when a player swings their arm.
Examples:
on arm swing:
send "You swung your arm!"
send "You swung your arm!"
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | Paper |
Called when armor pieces of a player are changed.
Examples:
on armor change:
send "You equipped %event-item%!"
send "You equipped %event-item%!"
| Patterns: |
|
| Since: | 1.0 |
Called when a player starts sleeping.
Examples:
on bed enter:
| Patterns: |
|
| Since: | 1.0 |
Called when a player leaves a bed.
Examples:
on player leaving a bed:
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Spigot 1.19.4+ |
Called when a bell resonates, highlighting nearby raiders.
Examples:
on bell resonate:
send "<red>Raiders are nearby!" to all players in radius 32 around event-block
send "<red>Raiders are nearby!" to all players in radius 32 around event-block
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Spigot 1.19.4+ or Paper 1.16.5+ (no event-direction) |
Called when a bell is rung.
Examples:
on bell ring:
send "<gold>Ding-dong!<reset>" to all players in radius 10 of event-block
send "<gold>Ding-dong!<reset>" to all players in radius 10 of event-block
| Patterns: |
|
| Since: | 1.0 |
Called when a player starts to break a block. You can usually just use the leftclick event for this.
Examples:
on block damaging:
if block is log:
send "You can't break the holy log!"
if block is log:
send "You can't break the holy log!"
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | Minecraft 1.13 or newer |
Called when a player fertilizes blocks.
Examples:
on block fertilize:
send "Fertilized %size of fertilized blocks% blocks got fertilized."
send "Fertilized %size of fertilized blocks% blocks got fertilized."
| Patterns: |
|
| Since: | 2.2-Fixes-V10 |
Called when a crop grows. Alternative to new form of generic grow event.
Examples:
on crop growth:
| Patterns: |
|
| Since: | 2.2-dev31 |
Called when a player edits a book.
Examples:
on book edit:
| Patterns: |
|
| Since: | 2.2-dev31 |
Called when a player signs a book.
Examples:
on book sign:
| Patterns: |
|
| Since: | 1.0 (break), unknown (mine), 2.6 (BlockData support) |
Called when a block is broken by a player. If you use 'on mine', only events where the broken block dropped something will call the trigger.
Examples:
on mine:
on break of stone:
on mine of any ore:
on break of chest[facing=north]:
on break of potatoes[age=7]:
on break of stone:
on mine of any ore:
on break of chest[facing=north]:
on break of potatoes[age=7]:
| Patterns: |
|
| Since: | 1.0 |
Called when a player empties a bucket. You can also use the place event with a check for water or lava.
Examples:
on bucket empty:
| Patterns: |
|
| Since: | 1.0 |
Called when a player fills a bucket.
Examples:
on player filling a bucket:
| Patterns: |
|
| Since: | 1.0, 2.6 (BlockData support) |
Called when a block is destroyed by fire.
Examples:
on burn:
on burn of wood, fences, or chests:
on burn of oak_log[axis=y]:
on burn of wood, fences, or chests:
on burn of oak_log[axis=y]:
| Patterns: |
|
| Since: | 1.0 (basic), 2.0 ([un]cancellable) |
Called when a player rightclicks on a block while holding a block or a placeable item. You can either cancel the event to prevent the block from being built, or uncancel it to allow it.
Please note that the data value of the block to be placed is not available in this event, only its ID.
Please note that the data value of the block to be placed is not available in this event, only its ID.
Examples:
on block can build check:
cancel event
cancel event
| Patterns: |
|
| Since: | 1.4.1 |
Called whenever a player chats.
Use chat format to change message format.
Use chat recipients to edit chat recipients.
Use chat format to change message format.
Use chat recipients to edit chat recipients.
Examples:
on chat:
if player has permission "owner":
set chat format to "<red>[player]<light gray>: <light red>[message]"
else if player has permission "admin":
set chat format to "<light red>[player]<light gray>: <orange>[message]"
else: #default message format
set chat format to "<orange>[player]<light gray>: <white>[message]"
if player has permission "owner":
set chat format to "<red>[player]<light gray>: <light red>[message]"
else if player has permission "admin":
set chat format to "<light red>[player]<light gray>: <orange>[message]"
else: #default message format
set chat format to "<orange>[player]<light gray>: <white>[message]"
| Patterns: |
|
| Since: | 1.0 |
Called after a new chunk was generated.
Examples:
on chunk generate:
| Patterns: |
|
| Since: | 1.0 |
Called when a chunk loads. The chunk might or might not contain mobs when it's loaded.
Examples:
on chunk load:
| Patterns: |
|
| Since: | 1.0 |
Called when a chunk is unloaded due to not being near any player.
Examples:
on chunk unload:
| Patterns: |
|
| Since: | 1.0 |
Called when a user clicks on a block, an entity or air with or without an item in their hand.
Please note that rightclick events with an empty hand while not looking at a block are not sent to the server, so there's no way to detect them.
Also note that a leftclick on an entity is an attack and thus not covered by the 'click' event, but the 'damage' event.
Please note that rightclick events with an empty hand while not looking at a block are not sent to the server, so there's no way to detect them.
Also note that a leftclick on an entity is an attack and thus not covered by the 'click' event, but the 'damage' event.
Examples:
on click:
on rightclick holding a fishing rod:
on leftclick on a stone or obsidian:
on rightclick on a creeper:
on click with a sword:
on rightclick holding a fishing rod:
on leftclick on a stone or obsidian:
on rightclick on a creeper:
on click with a sword:
| Patterns: |
|
| Since: | 1.0 |
Called when an entity is set on fire, e.g. by fire or lava, a fireball, or by standing in direct sunlight (zombies, skeletons).
Examples:
on combust:
| Patterns: |
|
| Since: | 2.0 |
Called when a player enters a command (not necessarily a Skript command) but you can check if command is a skript command, see Is a Skript command condition.
Examples:
on command:
on command "/stop":
on command "pm Njol ":
on command "/stop":
on command "pm Njol ":
| Patterns: |
|
| Since: | 2.0 |
Called when the player connects to the server. This event is called before the player actually joins the server, so if you want to prevent players from joining you should prefer this event over on join.
Examples:
on connect:
player doesn't have permission "VIP"
number of players is greater than 15
kick the player due to "The last 5 slots are reserved for VIP players."
player doesn't have permission "VIP"
number of players is greater than 15
kick the player due to "The last 5 slots are reserved for VIP players."
| Patterns: |
|
| Since: | 2.0 |
Called when a player is done eating/drinking something, e.g. an apple, bread, meat, milk or a potion.
Examples:
on consume:
| Patterns: |
|
| Since: | unknown (before 2.1) |
Called when a player crafts an item.
Examples:
on craft:
| Patterns: |
|
| Since: | 1.0 |
Called when a creeper is struck by lighting and gets powered. Cancel the event to prevent the creeper from being powered.
Examples:
on creeper power:
| Patterns: |
|
| Since: | 1.0, 2.7 (by entity) |
Called when an entity receives damage, e.g. by an attack from another entity, lava, fire, drowning, fall, suffocation, etc.
Examples:
on damage:
on damage of a player:
on damage of player by zombie:
on damage of a player:
on damage of player by zombie:
| Patterns: |
|
| Since: | 1.0 |
Called when a living entity (including players) dies.
Examples:
on death:
on death of player:
on death of a wither or ender dragon:
broadcast "A %entity% has been slain in %world%!"
on death of player:
on death of a wither or ender dragon:
broadcast "A %entity% has been slain in %world%!"
| Patterns: |
|
| Since: | unknown (before 2.1) |
Called when a dispenser dispenses an item.
Examples:
on dispense of iron block:
send "that'd be 19.99 please!"
send "that'd be 19.99 please!"
| Patterns: |
|
| Since: | unknown (before 2.1), 2.7 (entity) |
Called when a player drops an item from their inventory, or an entity drops an item, such as a chicken laying an egg.
Examples:
on drop:
if event-item is compass:
cancel event
on entity drop of an egg:
if event-entity is a chicken:
set item of event-dropped item to a diamond
if event-item is compass:
cancel event
on entity drop of an egg:
if event-entity is a chicken:
set item of event-dropped item to a diamond
| Patterns: |
|
| Since: | 1.0 |
Called when a player throws an egg and it lands. You can just use the shoot event in most cases. However, this event allows modification of properties like the hatched entity type and the number of entities to hatch.
Examples:
on throw of an egg:
| Patterns: |
|
| Since: | 2.5 |
Called when a player successfully enchants an item.
To get the enchanted item, see the enchant item expression
To get the enchanted item, see the enchant item expression
Examples:
on enchant:
if the clicked button is 1: # offer 1
set the applied enchantments to sharpness 10 and unbreaking 10
if the clicked button is 1: # offer 1
set the applied enchantments to sharpness 10 and unbreaking 10
| Patterns: |
|
| Since: | 2.5 |
Called when a player puts an item into enchantment table. This event may be called multiple times.
To get the enchant item, see the enchant item expression
To get the enchant item, see the enchant item expression
Examples:
on enchant prepare:
set enchant offer 1 to sharpness 1
set the cost of enchant offer 1 to 10 levels
set enchant offer 1 to sharpness 1
set the cost of enchant offer 1 to 10 levels
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Paper |
Called when an enderman gets mad because a player looked at them.
Note: This does not stop enderman from targeting the player as a result of getting damaged.
Note: This does not stop enderman from targeting the player as a result of getting damaged.
Examples:
# Stops endermen from getting angry players with the permission "safeFrom.enderman"
on enderman enrage:
if player has permission "safeFrom.enderman":
cancel event
on enderman enrage:
if player has permission "safeFrom.enderman":
cancel event
| Patterns: |
|
| Since: | unknown, 2.5.2 (falling block), 2.8.0 (any entity support) |
Called when an enderman places or picks up a block, a sheep eats grass, a silverfish boops into/out of a block or a falling block lands and turns into a block respectively.
event-block represents the old block and event-blockdata represents the new replacement that'll be applied to the block.
event-block represents the old block and event-blockdata represents the new replacement that'll be applied to the block.
Examples:
on sheep eat:
kill event-entity
broadcast "A sheep stole some grass!"
on falling block land:
event-entity is a falling dirt
cancel event
kill event-entity
broadcast "A sheep stole some grass!"
on falling block land:
event-entity is a falling dirt
cancel event
| Patterns: |
|
| Since: | 2.2-dev13b |
Called when an entity dismounts.
Examples:
on dismount:
kill event-entity
kill event-entity
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper 1.15.2+ |
Called when an entity jumps.
Examples:
on entity jump:
if entity is a wither skeleton:
cancel event
if entity is a wither skeleton:
cancel event
| Patterns: |
|
| Since: | 2.2-dev13b |
Called when entity starts riding another.
Examples:
on mount:
cancel event
cancel event
| Patterns: |
|
| Since: | 2.5.3 |
Called when an entity uses a nether or end portal. Cancel the event to prevent the entity from teleporting.
Examples:
on entity portal:
broadcast "A %type of event-entity% has entered a portal!
broadcast "A %type of event-entity% has entered a portal!
| Patterns: |
|
| Since: | 2.8.0 |
Called when an entity is about to be replaced by another entity.
Examples when it's called include; when a zombie gets cured and a villager spawns, an entity drowns in water like a zombie that turns to a drown, an entity that gets frozen in powder snow, a mooshroom that when sheared, spawns a new cow.
Examples when it's called include; when a zombie gets cured and a villager spawns, an entity drowns in water like a zombie that turns to a drown, an entity that gets frozen in powder snow, a mooshroom that when sheared, spawns a new cow.
Examples:
on a zombie transforming due to curing:
on mooshroom transforming:
on zombie, skeleton or slime transform:
on mooshroom transforming:
on zombie, skeleton or slime transform:
| Patterns: |
|
| Since: | 2.7 |
Called when a player's experience changes.
Examples:
on level progress change:
set {_xp} to event-experience
broadcast "%{_xp}%"
set {_xp} to event-experience
broadcast "%{_xp}%"
| Patterns: |
|
| Since: | 2.0 |
Called whenever experience is about to spawn.
Please note that this event will not fire for xp orbs spawned by plugins (including Skript) with Bukkit.
Please note that this event will not fire for xp orbs spawned by plugins (including Skript) with Bukkit.
Examples:
on xp spawn:
world is "minigame_world"
cancel event
world is "minigame_world"
cancel event
| Patterns: |
|
| Since: | 1.0 |
Called when an entity (a primed TNT or a creeper) explodes.
Examples:
on explosion:
| Patterns: |
|
| Since: | 1.0 |
Called when an explosive is primed, i.e. an entity will explode shortly. Creepers can abort the explosion if the player gets too far away, while TNT will explode for sure after a short time.
Examples:
on explosion prime:
| Patterns: |
|
| Since: | 1.0, 2.6 (BlockData support) |
Called when a block 'fades away', e.g. ice or snow melts.
Examples:
on fade of snow or ice:
on fade of snow[layers=2]
on fade of snow[layers=2]
| Patterns: |
|
| Since: | 2.4 |
Called when a firework explodes.
Examples:
on firework explode
on firework exploding colored red, light green and black
on firework explosion colored light green:
broadcast "A firework colored %colors% was exploded at %location%!"
on firework exploding colored red, light green and black
on firework explosion colored light green:
broadcast "A firework colored %colors% was exploded at %location%!"
| Patterns: |
|
| Since: | 1.3.7 |
Called when a player joins the server for the first time.
Examples:
on first join:
broadcast "Welcome %player% to the server!"
broadcast "Welcome %player% to the server!"
| Patterns: |
|
| Since: | 1.0 |
Called when a player fishes something. This is not of much use yet.
Examples:
on fish:
| Patterns: |
|
| Since: | 2.2-dev36 |
Called when a players stops/starts flying.
Examples:
on flight toggle:
if {game::%player%::playing} exists:
cancel event
if {game::%player%::playing} exists:
cancel event
| Patterns: |
|
| Since: | 1.0 |
Called when a blocks flows or teleports to another block. This not only applies to water and lava, but teleporting dragon eggs as well.
Examples:
on block flow:
if event-block is water:
broadcast "Build more dams! It's starting to get wet in here"
if event-block is water:
broadcast "Build more dams! It's starting to get wet in here"
| Patterns: |
|
| Since: | 1.0, 2.6 (BlockData support) |
Called when a block is created, but not by a player, e.g. snow forms due to snowfall, water freezes in cold biomes. This isn't called when block spreads (mushroom growth, water physics etc.), as it has its own event (see spread event).
Examples:
on form of snow:
on form of a mushroom:
on form of a mushroom:
| Patterns: |
|
| Since: | 1.0 |
Called when a furnace burns an item from its fuel slot.
Examples:
on fuel burning:
| Patterns: |
|
| Since: | 2.2-dev21 |
Called when an entity toggles glider on or off, or when server toggles gliding state of an entity forcibly.
Examples:
on toggling gliding:
cancel the event # bad idea, but you CAN do it!
cancel the event # bad idea, but you CAN do it!
| Patterns: |
|
| Since: | 1.0, 2.2-dev20 (plants), 2.8.0 (from, into, blockdata) |
Called when a tree, giant mushroom or plant grows to next stage.
"of" matches any grow event, "from" matches only the old state, "into" matches only the new state,and "from into" requires matching both the old and new states.
Using "and" lists in this event is equivalent to using "or" lists. The event will trigger if any one of the elements is what grew.
"of" matches any grow event, "from" matches only the old state, "into" matches only the new state,and "from into" requires matching both the old and new states.
Using "and" lists in this event is equivalent to using "or" lists. The event will trigger if any one of the elements is what grew.
Examples:
on grow:
on grow of tree:
on grow of wheat[age=7]:
on grow from a sapling:
on grow into tree:
on grow from a sapling into tree:
on grow of wheat, carrots, or potatoes:
on grow into tree, giant mushroom, cactus:
on grow from wheat[age=0] to wheat[age=1] or wheat[age=2]:
on grow of tree:
on grow of wheat[age=7]:
on grow from a sapling:
on grow into tree:
on grow from a sapling into tree:
on grow of wheat, carrots, or potatoes:
on grow into tree, giant mushroom, cactus:
on grow from wheat[age=0] to wheat[age=1] or wheat[age=2]:
| Patterns: |
|
| Since: | 2.3 |
Called whenever a player swaps the items in their main- and offhand slots.
Works also when one or both of the slots are empty.
The event is called before the items are actually swapped,
so when you use the player's tool or player's offtool expressions,
they will return the values before the swap -
this enables you to cancel the event before anything happens.
Works also when one or both of the slots are empty.
The event is called before the items are actually swapped,
so when you use the player's tool or player's offtool expressions,
they will return the values before the swap -
this enables you to cancel the event before anything happens.
Examples:
on swap hand items:
event-player's tool is a diamond sword
cancel event
event-player's tool is a diamond sword
cancel event
| Patterns: |
|
| Since: | 1.0, 2.9.0 (by reason) |
Called when an entity is healed, e.g. by eating (players), being fed (pets), or by the effect of a potion of healing (overworld mobs) or harm (nether mobs).
Examples:
on heal:
on player healing from a regeneration potion:
on healing of a zombie, cow or a wither:
heal reason is healing potion
cancel event
on player healing from a regeneration potion:
on healing of a zombie, cow or a wither:
heal reason is healing potion
cancel event
| Patterns: |
|
| Since: | 2.5.1 |
Called when a horse jumps.
Examples:
on horse jump:
push event-entity upwards at speed 2
push event-entity upwards at speed 2
| Patterns: |
|
| Since: | 1.4.4 |
Called when the hunger bar of a player changes, i.e. either increases by eating or decreases over time.
Examples:
on food bar change:
| Patterns: |
|
| Since: | 1.0 |
Called when a block starts burning, i.e. a fire block is placed next to it and this block is flammable.
The burn event will be called when the block is about do be destroyed by the fire.
The burn event will be called when the block is about do be destroyed by the fire.
Examples:
on block ignite:
if event-block is a ladder:
cancel event
if event-block is a ladder:
cancel event
| Patterns: |
|
| Since: | 2.2-Fixes-V10 |
Called when clicking on inventory slot.
Examples:
on inventory click:
if event-item is stone:
give player 1 stone
remove 20$ from player's balance
if event-item is stone:
give player 1 stone
remove 20$ from player's balance
| Patterns: |
|
| Since: | 2.2-dev21 |
Called when player's currently viewed inventory is closed.
Examples:
on inventory close:
if player's location is {location}:
send "You exited the shop!"
if player's location is {location}:
send "You exited the shop!"
| Patterns: |
|
| Since: | 2.7 |
Called when a player drags an item in their cursor across the inventory.
Examples:
on inventory drag:
if player's current inventory is {_gui}:
send "You can't drag your items here!" to player
cancel event
if player's current inventory is {_gui}:
send "You can't drag your items here!" to player
cancel event
| Patterns: |
|
| Since: | 2.8.0 |
Called when an entity or block (e.g. hopper) tries to move items directly from one inventory to another.
When this event is called, the initiator may have already removed the item from the source inventory and is ready to move it into the destination inventory.
If this event is cancelled, the items will be returned to the source inventory.
When this event is called, the initiator may have already removed the item from the source inventory and is ready to move it into the destination inventory.
If this event is cancelled, the items will be returned to the source inventory.
Examples:
on inventory item move:
broadcast "%holder of past event-inventory% is transporting %event-item% to %holder of event-inventory%!"
broadcast "%holder of past event-inventory% is transporting %event-item% to %holder of event-inventory%!"
| Patterns: |
|
| Since: | 2.2-dev21 |
Called when an inventory is opened for player.
Examples:
on inventory open:
close player's inventory
close player's inventory
| Patterns: |
|
| Since: | 2.5.1 |
Called when an inventory (a hopper, a hopper minecart, etc.) picks up an item
Examples:
on inventory pickup:
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper 1.19.2+ |
Called when a slot in a player's inventory is changed.
Warning: setting the event-slot to a new item can result in an infinite loop.
Warning: setting the event-slot to a new item can result in an infinite loop.
Examples:
on inventory slot change:
if event-item is a diamond:
send "You obtained a diamond!" to player
if event-item is a diamond:
send "You obtained a diamond!" to player
| Patterns: |
|
| Since: | 2.1.1 |
Called when a player breaks their tool because its damage reached the maximum value.
This event cannot be cancelled.
This event cannot be cancelled.
Examples:
on tool break:
| Patterns: |
|
| Since: | 2.5 |
Called when an item is damaged. Most tools are damaged by using them; armor is damaged when the wearer takes damage.
Examples:
on item damage:
cancel event
cancel event
| Patterns: | |
| Since: | 2.2-dev35 |
Called when an item is about to be despawned from the world, usually 5 minutes after it was dropped.
Examples:
on item despawn of diamond:
send "Not my precious!"
cancel event
send "Not my precious!"
cancel event
| Patterns: |
|
| Since: | 2.5.1 |
| Requirements: | Minecraft 1.13 or newer |
Called when a player has an item repaired via the Mending enchantment.
Examples:
on item mend:
chance of 50%:
cancel the event
send "Oops! Mending failed!" to player
chance of 50%:
cancel the event
send "Oops! Mending failed!" to player
| Patterns: | |
| Since: | 2.2-dev35 |
Called when dropped items merge into a single stack. event-entity will be the entity which is trying to merge, and future event-entity will be the entity which is being merged into.
Examples:
on item merge of gold blocks:
cancel event
cancel event
| Patterns: |
|
| Since: | unknown (before 2.1) |
Called whenever an item stack is spawned in a world, e.g. as drop of a block or mob, a player throwing items out of their inventory, or a dispenser dispensing an item (not shooting it).
Examples:
on item spawn of iron sword:
broadcast "Someone dropped an iron sword!"
broadcast "Someone dropped an iron sword!"
| Patterns: |
|
| Since: | 1.0 |
Called when the player joins the server. The player is already in a world when this event is called, so if you want to prevent players from joining you should prefer on connect over this event.
Examples:
on join:
message "Welcome on our awesome server!"
broadcast "%player% just joined the server!"
message "Welcome on our awesome server!"
broadcast "%player% just joined the server!"
| Patterns: |
|
| Since: | 2.3 |
Called whenever a player jumps.
This event requires PaperSpigot.
This event requires PaperSpigot.
Examples:
on jump:
event-player does not have permission "jump"
cancel event
event-player does not have permission "jump"
cancel event
| Patterns: |
|
| Since: | 1.0 |
Called when a player is kicked from the server. You can change the kick message or cancel the event entirely.
Examples:
on kick:
| Patterns: |
|
| Since: | 2.3 |
Called after a player changed their language in the game settings. You can use the language expression to get the current language of the player.
This event requires Minecraft 1.12+.
This event requires Minecraft 1.12+.
Examples:
on language change:
if player's language starts with "en":
send "Hello!"
if player's language starts with "en":
send "Hello!"
| Patterns: |
|
| Since: | 1.0 |
Called when a leaf block decays due to not being connected to a tree.
Examples:
on leaves decay:
| Patterns: |
|
| Since: | 1.0, 2.4 (level up/down) |
Called when a player's level changes, e.g. by gathering experience or by enchanting something.
Examples:
on level change:
| Patterns: |
|
| Since: | 1.0 |
Called when lightning strikes.
Examples:
on lightning:
spawn a zombie at location of event-entity
spawn a zombie at location of event-entity
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | MC 1.16+ |
Called when a loot table of an inventory is generated in the world.
For example, when opening a shipwreck chest.
For example, when opening a shipwreck chest.
Examples:
on loot generate:
chance of 10%
add 64 diamonds to the loot
send "You hit the jackpot at %event-location%!"
chance of 10%
add 64 diamonds to the loot
send "You hit the jackpot at %event-location%!"
| Patterns: |
|
| Since: | 2.6, 2.8.0 (turn around) |
| Requirements: | Paper 1.16.5+ (entity move) |
Called when a player or entity moves or rotates their head.
NOTE: Move event will only be called when the entity/player moves position, keyword 'turn around' is for orientation (ie: looking around), and the combined syntax listens for both.
NOTE: These events can be performance heavy as they are called quite often.
NOTE: Move event will only be called when the entity/player moves position, keyword 'turn around' is for orientation (ie: looking around), and the combined syntax listens for both.
NOTE: These events can be performance heavy as they are called quite often.
Examples:
on player move:
if player does not have permission "player.can.move":
cancel event
on skeleton move:
if event-entity is not in world "world":
kill event-entity
on player turning around:
send action bar "You are currently turning your head around!" to player
if player does not have permission "player.can.move":
cancel event
on skeleton move:
if event-entity is not in world "world":
kill event-entity
on player turning around:
send action bar "You are currently turning your head around!" to player
| Patterns: |
|
| Since: | 2.0 |
Called when a player moves onto a certain type of block.
Please note that using this event can cause lag if there are many players online.
Please note that using this event can cause lag if there are many players online.
Examples:
on walking on dirt or grass:
on stepping on stone:
on stepping on stone:
| Patterns: |
|
| Since: | 1.4.6 |
Called when a physics check is done on a block. By cancelling this event you can prevent some things from happening, e.g. sand falling, dirt turning into grass, torches dropping if their supporting block is destroyed, etc.Please note that using this event might cause quite some lag since it gets called extremely often.
Examples:
# prevents sand from falling
on block physics:
block is sand
cancel event
on block physics:
block is sand
cancel event
| Patterns: |
|
| Since: | unknown (before 2.1), 2.5 (entity) |
Called when a player/entity picks up an item. Please note that the item is still on the ground when this event is called.
Examples:
on pick up:
on entity pickup of wheat:
on entity pickup of wheat:
| Patterns: |
|
| Since: | 1.0 |
Called when a pig is stroke by lightning and transformed into a zombie pigman. Cancel the event to prevent the transformation.
Examples:
on pig zap:
| Patterns: |
|
| Since: | 1.0 |
Called when a piston is about to extend.
Examples:
on piston extend:
broadcast "A piston is extending!"
broadcast "A piston is extending!"
| Patterns: |
|
| Since: | 1.0 |
Called when a piston is about to retract.
Examples:
on piston retract:
broadcast "A piston is retracting!"
broadcast "A piston is retracting!"
| Patterns: |
|
| Since: | 1.0, 2.6 (BlockData support) |
Called when a player places a block.
Examples:
on place:
on place of a furnace, workbench or chest:
on break of chest[type=right] or chest[type=left]
on place of a furnace, workbench or chest:
on break of chest[type=right] or chest[type=left]
| Patterns: |
|
| Since: | 2.7 |
Called when a player enters a chunk. Note that this event is based on 'player move' event, and may be called frequent internally.
Examples:
on player enters a chunk:
send "You entered a chunk: %past event-chunk% -> %event-chunk%!" to player
send "You entered a chunk: %past event-chunk% -> %event-chunk%!" to player
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper 1.16+ |
Called when a player has slept long enough to count as passing the night/storm.
Cancelling this event will prevent the player from being counted as deeply sleeping unless they exit and re-enter the bed.
Cancelling this event will prevent the player from being counted as deeply sleeping unless they exit and re-enter the bed.
Examples:
on player deep sleeping:
send "Zzzz.." to player
send "Zzzz.." to player
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Minecraft 1.14+ (event-projectile) |
Called when a player picks up an arrow from the ground.
Examples:
on arrow pickup:
cancel the event
teleport event-projectile to block 5 above event-projectile
cancel the event
teleport event-projectile to block 5 above event-projectile
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper 1.16.5+ |
Called when a player has traded with a villager.
Examples:
on player trade:
chance of 50%:
cancel event
send "The trade was somehow denied!" to player
chance of 50%:
cancel event
send "The trade was somehow denied!" to player
| Patterns: |
|
| Since: | 2.2-dev28 |
Called when a player enters a world. Does not work with other entities!
Examples:
on player world change:
world is "city"
send "Welcome to the City!"
world is "city"
send "Welcome to the City!"
| Patterns: |
|
| Since: | 1.0 |
Called when a player uses a nether or end portal. Cancel the event to prevent the player from teleporting.
Examples:
on player portal:
| Patterns: |
|
| Since: | 1.0, 2.5.3 (event-entity support) |
| Requirements: | Minecraft 1.14+ (event-entity support) |
Called when a portal is created, either by a player or mob lighting an obsidian frame on fire, or by a nether portal creating its teleportation target in the nether/overworld.
In Minecraft 1.14+, you can use the player in this event.
Please note that there may not always be a player (or other entity) in this event.
In Minecraft 1.14+, you can use the player in this event.
Please note that there may not always be a player (or other entity) in this event.
Examples:
on portal create:
| Patterns: |
|
| Since: | 1.0 |
Called when an entity enters a nether portal or an end portal. Please note that this event will be fired many times for a nether portal.
Examples:
on portal enter:
| Patterns: |
|
| Since: | 2.2-Fixes-V10 |
Called just before displaying crafting result to player. Note that setting the result item might or might not work due to Bukkit bugs.
Examples:
on preparing craft of torch:
| Patterns: |
|
| Since: | 1.0 (pressure plate), 1.4.4 (tripwire) |
Called when a player steps on a pressure plate or tripwire respectively.
Examples:
on step on pressure plate:
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | Paper |
Called when a projectile collides with an entity.
Examples:
on projectile collide:
teleport shooter of event-projectile to event-entity
teleport shooter of event-projectile to event-entity
| Patterns: |
|
| Since: | 1.0 |
Called when a projectile hits an entity or a block.
Use the damage event with a check for a projectile to be able to use the entity that got hit in the case when the projectile hit a living entity.
A damage event will even be fired if the damage is 0, e.g. when throwing snowballs at non-nether mobs.
Use the damage event with a check for a projectile to be able to use the entity that got hit in the case when the projectile hit a living entity.
A damage event will even be fired if the damage is 0, e.g. when throwing snowballs at non-nether mobs.
Examples:
on projectile hit:
event-projectile is arrow
delete event-projectile
event-projectile is arrow
delete event-projectile
| Patterns: |
|
| Since: | 1.0 (simple disconnection) |
Called when a player leaves the server.
Examples:
on quit:
on disconnect:
on disconnect:
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper |
Called when a player is firing a bow and the server is choosing an arrow to use.
Cancelling this event will skip the current arrow item and fire a new event for the next arrow item.
The arrow and bow in the event can be accessed with the Readied Arrow/Bow expression.
Cancelling this event will skip the current arrow item and fire a new event for the next arrow item.
The arrow and bow in the event can be accessed with the Readied Arrow/Bow expression.
Examples:
on player ready arrow:
selected bow's name is "Spectral Bow"
if selected arrow is not a spectral arrow:
cancel event
selected bow's name is "Spectral Bow"
if selected arrow is not a spectral arrow:
cancel event
| Patterns: |
|
| Since: | 1.0 |
Called when the redstone current of a block changes. This event is of not much use yet.
Examples:
on redstone change:
send "someone is using redstone" to console
send "someone is using redstone" to console
| Patterns: |
|
| Since: | 2.1 |
| Requirements: | Supported regions plugin |
Called when a player enters or leaves a region.
This event requires a supported regions plugin to be installed.
This event requires a supported regions plugin to be installed.
Examples:
on region exit:
message "Leaving %region%."
message "Leaving %region%."
| Patterns: |
|
| Since: | 2.4 |
Called when a player takes action on a resource pack request sent via the
send resource pack effect.
The resource pack condition can be used
to check the resource pack state.
This event will be triggered once when the player accepts or declines the resource pack request,
and once when the resource pack is successfully installed or failed to download.
send resource pack effect.
The resource pack condition can be used
to check the resource pack state.
This event will be triggered once when the player accepts or declines the resource pack request,
and once when the resource pack is successfully installed or failed to download.
Examples:
on resource pack request response:
if the resource pack was declined or failed to download:
on resource pack deny:
kick the player due to "You have to install the resource pack to play in this server!"
if the resource pack was declined or failed to download:
on resource pack deny:
kick the player due to "You have to install the resource pack to play in this server!"
| Patterns: |
|
| Since: | 1.0 |
Called when a player respawns. You should prefer this event over the death event as the player is technically alive when this event is called.
Examples:
on respawn:
| Patterns: |
|
| Since: | 2.2-dev28 |
Called when an entity dies, always. If they are not holding a totem, this is cancelled - you can, however, uncancel it.
Examples:
on resurrect attempt:
entity is player
entity has permission "admin.undying"
uncancel the event
entity is player
entity has permission "admin.undying"
uncancel the event
| Patterns: |
|
| Since: | 2.5 |
Called when the player activates the riptide enchantment, using their trident to propel them through the air.
Note: the riptide action is performed client side, so manipulating the player in this event may have undesired effects.
Note: the riptide action is performed client side, so manipulating the player in this event may have undesired effects.
Examples:
on riptide:
send "You are riptiding!"
send "You are riptiding!"
| Patterns: |
|
| Since: | 2.0 |
Called directly after the trigger is loaded, or directly before the whole script is unloaded.
The keyword 'async' indicates the trigger can be ran asynchronously,
The keyword 'async' indicates the trigger can be ran asynchronously,
Examples:
on load:
set {running::%script%} to true
on unload:
set {running::%script%} to false
set {running::%script%} to true
on unload:
set {running::%script%} to false
| Patterns: |
|
| Since: | 2.8.0 |
Called when the server sends a list of commands to the player. This usually happens on join. The sent commands can be modified via the sent commands expression.
Modifications will affect what commands show up for the player to tab complete. They will not affect what commands the player can actually run.
Adding new commands to the list is illegal behavior and will be ignored.
Modifications will affect what commands show up for the player to tab complete. They will not affect what commands the player can actually run.
Adding new commands to the list is illegal behavior and will be ignored.
Examples:
on send command list:
set command list to command list where [input does not contain ":"]
remove "help" from command list
set command list to command list where [input does not contain ":"]
remove "help" from command list
| Patterns: |
|
| Since: | 2.3 |
Called when a server list ping is coming in, generally when a Minecraft client pings the server to show its information in the server list.
The IP expression can be used to get the IP adress of the pinger.
This event can be cancelled on PaperSpigot 1.12.2+ only and this means the player will see the server as offline (but still can join).
Also you can use MOTD, Max Players, Online Players Count, Protocol Version, Version String, Hover List and Server Icon expressions, and Player Info Visibility and Hide Player from Server List effects to modify the server list.
The IP expression can be used to get the IP adress of the pinger.
This event can be cancelled on PaperSpigot 1.12.2+ only and this means the player will see the server as offline (but still can join).
Also you can use MOTD, Max Players, Online Players Count, Protocol Version, Version String, Hover List and Server Icon expressions, and Player Info Visibility and Hide Player from Server List effects to modify the server list.
Examples:
on server list ping:
set the motd to "Welcome %{player-by-IP::%ip%}%! Join now!" if {player-by-IP::%ip%} is set, else "Join now!"
set the fake max players count to (online players count + 1)
set the shown icon to a random server icon out of {server-icons::*}
set the motd to "Welcome %{player-by-IP::%ip%}%! Join now!" if {player-by-IP::%ip%} is set, else "Join now!"
set the fake max players count to (online players count + 1)
set the shown icon to a random server icon out of {server-icons::*}
| Patterns: |
|
| Since: | 2.0 |
Called when the server starts or stops (actually, when Skript starts or stops, so a /reload will trigger these events as well).
Examples:
on skript start:
on server stop:
on server stop:
| Patterns: |
|
| Since: | 2.2-dev21 |
Called when sheep regrows its sheared wool back.
Examples:
on sheep grow wool:
cancel event
cancel event
| Patterns: |
|
| Since: | 1.0 |
Called whenever a projectile is shot. Use the shooter expression to get who shot the projectile.
Examples:
on shoot:
if projectile is an arrow:
send "you shot an arrow!" to shooter
if projectile is an arrow:
send "you shot an arrow!" to shooter
| Patterns: |
|
| Since: | 1.0 |
As signs are placed empty, this event is called when a player is done editing a sign.
Examples:
on sign change:
line 2 is empty
set line 1 to "<red>%line 1%"
line 2 is empty
set line 1 to "<red>%line 1%"
| Patterns: |
|
| Since: | 2.2-dev26 |
Called when a slime splits. Usually this happens when a big slime dies.
Examples:
on slime split:
| Patterns: |
|
| Since: | 1.0 |
Called when a furnace smelts an item in its ore slot.
Examples:
on smelt:
| Patterns: |
|
| Since: | 1.0 |
Called when a player starts or stops sneaking. Use is sneaking to get whether the player was sneaking before the event was called.
Examples:
# make players that stop sneaking jump
on sneak toggle:
player is sneaking
push the player upwards at speed 0.5
on sneak toggle:
player is sneaking
push the player upwards at speed 0.5
| Patterns: |
|
| Since: | 1.0, 2.5.1 (non-living entities) |
Called when an entity spawns (excluding players).
Examples:
on spawn of a zombie:
on spawn of an ender dragon:
broadcast "A dragon has been sighted in %world%!"
on spawn of an ender dragon:
broadcast "A dragon has been sighted in %world%!"
| Patterns: |
|
| Since: | 1.0 |
Called when the spawn point of a world changes.
Examples:
on spawn change:
broadcast "someone changed the spawn!"
broadcast "someone changed the spawn!"
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper |
Called with a player starts, stops or swaps spectating an entity.
Examples:
on player start spectating of a zombie:
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | Minecraft 1.13 or newer |
Called when a sponge absorbs blocks.
Examples:
on sponge absorb:
loop absorbed blocks:
broadcast "%loop-block% was absorbed by a sponge"!
loop absorbed blocks:
broadcast "%loop-block% was absorbed by a sponge"!
| Patterns: |
|
| Since: | 1.0 |
Called when a new block forms as a result of a block that can spread, e.g. water or mushrooms.
Examples:
on spread:
| Patterns: |
|
| Since: | 1.0 |
Called when a player starts or stops sprinting. Use is sprinting to get whether the player was sprinting before the event was called.
Examples:
on sprint toggle:
player is not sprinting
send "Run!"
player is not sprinting
send "Run!"
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper 1.16+ |
Called when a player selects a recipe in a stonecutter.
Examples:
on stonecutting stone slabs
cancel the event
on stonecutting:
broadcast "%player% is using stonecutter to craft %event-item%!"
cancel the event
on stonecutting:
broadcast "%player% is using stonecutter to craft %event-item%!"
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper 1.18.2+ |
Called when a player stops using an item. For example, when the player releases the interact button when holding a bow, an edible item, or a spyglass.
Note that event-timespan will return the time the item was used for.
Note that event-timespan will return the time the item was used for.
Examples:
on player stop using item:
broadcast "%player% used %event-item% for %event-timespan%."
broadcast "%player% used %event-item% for %event-timespan%."
| Patterns: |
|
| Since: | 2.3 |
| Requirements: | 1.13 or newer |
Called when an entity swims or stops swimming.
Examples:
on swim toggle:
event-entity does not have permission "swim"
cancel event
event-entity does not have permission "swim"
cancel event
| Patterns: |
|
| Since: | 1.0 |
Called when a player tames a wolf or ocelot. Can be cancelled to prevent the entity from being tamed.
Examples:
on tame:
| Patterns: |
|
| Since: | 1.0 |
Called when a mob starts/stops following/attacking another entity, usually a player.
Examples:
on entity target:
target is a player
target is a player
| Patterns: |
|
| Since: | 1.0, 2.9.0 (entity teleport) |
This event can be used to listen to teleports from non-players or player entities respectively.
When teleporting entities, the event may also be called due to a result of natural causes, such as an enderman or shulker teleporting, or wolves teleporting to players.
When teleporting players, the event can be called by teleporting through a nether/end portal, or by other means (e.g. plugins).
When teleporting entities, the event may also be called due to a result of natural causes, such as an enderman or shulker teleporting, or wolves teleporting to players.
When teleporting players, the event can be called by teleporting through a nether/end portal, or by other means (e.g. plugins).
Examples:
on teleport:
on player teleport:
on creeper teleport:
on player teleport:
on creeper teleport:
| Patterns: |
|
| Since: | 1.0 |
Called whenever a player changes their held item by selecting a different slot (e.g. the keys 1-9 or the mouse wheel), not by dropping or replacing the item in the current slot.
Examples:
on player's held item change:
| Patterns: |
|
| Since: | 1.0 |
Called when a new vehicle is created, e.g. when a player places a boat or minecart.
Examples:
on vehicle create:
| Patterns: |
|
| Since: | 1.0 |
Called when a vehicle gets damage. Too much damage will destroy the vehicle.
Examples:
on vehicle damage:
| Patterns: |
|
| Since: | 1.0 |
Called when a vehicle is destroyed. Any passenger will be ejected and the vehicle might drop some item(s).
Examples:
on vehicle destroy:
cancel event
cancel event
| Patterns: |
|
| Since: | 1.0 |
Called when an entity enters a vehicle, either deliberately (players) or by falling into them (mobs).
Examples:
on vehicle enter:
entity is a player
cancel event
entity is a player
cancel event
| Patterns: |
|
| Since: | 1.0 |
Called when an entity exits a vehicle.
Examples:
on vehicle exit:
if event-entity is a spider:
kill event-entity
if event-entity is a spider:
kill event-entity
| Patterns: |
|
| Since: | 1.0 |
Called when a world's weather changes.
Examples:
on weather change:
on weather change to sunny:
on weather change to sunny:
| Patterns: |
|
| Since: | 1.0, 2.8.0 (defining worlds) |
Called when a world is initialized. As all default worlds are initialized before
any scripts are loaded, this event is only called for newly created worlds.
World management plugins might change the behaviour of this event though.
any scripts are loaded, this event is only called for newly created worlds.
World management plugins might change the behaviour of this event though.
Examples:
on world init of "world_the_end":
| Patterns: |
|
| Since: | 1.0, 2.8.0 (defining worlds) |
Called when a world is loaded. As with the world init event, this event will not be called for the server's default world(s).
Examples:
on world load of "world_nether":
broadcast "The world %event-world% has been loaded!"
broadcast "The world %event-world% has been loaded!"
| Patterns: |
|
| Since: | 1.0, 2.8.0 (defining worlds) |
Called when a world is saved to disk. Usually all worlds are saved simultaneously, but world management plugins could change this.
Examples:
on world save of "world":
broadcast "The world %event-world% has been saved"
broadcast "The world %event-world% has been saved"
| Patterns: |
|
| Since: | 1.0, 2.8.0 (defining worlds) |
Called when a world is unloaded. This event will never be called if you don't have a world management plugin.
Examples:
on world unload:
broadcast "the %event-world% has been unloaded!"
broadcast "the %event-world% has been unloaded!"
| Patterns: |
|
| Since: | 1.0 |
Called when a zombie is done breaking a wooden door. Can be cancelled to prevent the zombie from breaking the door.
Examples:
on zombie breaking a wood door:
| Patterns: |
|
| Since: | 1.0 |
An event that is called periodically.
Examples:
every 2 seconds:
every minecraft hour:
every tick: # can cause lag depending on the code inside the event
every minecraft days:
every minecraft hour:
every tick: # can cause lag depending on the code inside the event
every minecraft days: