| Patterns: |
|
| Since: | 1.0 |
Used for registering custom aliases for a script.
Examples:
aliases:
blacklisted items = TNT, bedrock, obsidian, mob spawner, lava, lava bucket
shiny swords = golden sword, iron sword, diamond sword
blacklisted items = TNT, bedrock, obsidian, mob spawner, lava, lava bucket
shiny swords = golden sword, iron sword, diamond sword
| Patterns: |
|
| Required Entries: | trigger |
| Optional Entries: | usage, description, prefix, permission, permission message, aliases, executable by, cooldown, cooldown message, cooldown bypass, cooldown storage |
| Since: | 1.0 |
Used for registering custom commands.
Examples:
command /broadcast <string>:
usage: A command for broadcasting a message to all players.
permission: skript.command.broadcast
permission message: You don't have permission to broadcast messages
aliases: /bc
executable by: players and console
cooldown: 15 seconds
cooldown message: You last broadcast a message %elapsed time% ago. You can broadcast another message in %remaining time%.
cooldown bypass: skript.command.broadcast.admin
cooldown storage: {cooldown::%player%}
trigger:
broadcast the argument
usage: A command for broadcasting a message to all players.
permission: skript.command.broadcast
permission message: You don't have permission to broadcast messages
aliases: /bc
executable by: players and console
cooldown: 15 seconds
cooldown message: You last broadcast a message %elapsed time% ago. You can broadcast another message in %remaining time%.
cooldown bypass: skript.command.broadcast.admin
cooldown storage: {cooldown::%player%}
trigger:
broadcast the argument
| Patterns: |
|
| Since: | 2.2, 2.7 (local functions) |
Functions are structures that can be executed with arguments/parameters to run code.
They can also return a value to the trigger that is executing the function.
Note that local functions come before global functions execution
They can also return a value to the trigger that is executing the function.
Note that local functions come before global functions execution
Examples:
function sayMessage(message: text):
broadcast {_message} # our message argument is available in '{_message}'
local function giveApple(amount: number) :: item:
return {_amount} of apple
function getPoints(p: player) returns number:
return {points::%{_p}%}
broadcast {_message} # our message argument is available in '{_message}'
local function giveApple(amount: number) :: item:
return {_amount} of apple
function getPoints(p: player) returns number:
return {points::%{_p}%}
| Patterns: |
|
| Since: | 1.0 |
Options are used for replacing parts of a script with something else.
For example, an option may represent a message that appears in multiple locations.
Take a look at the example below that showcases this.
For example, an option may represent a message that appears in multiple locations.
Take a look at the example below that showcases this.
Examples:
options:
no_permission: You're missing the required permission to execute this command!
command /ping:
permission: command.ping
permission message: {@no_permission}
trigger:
message "Pong!"
command /pong:
permission: command.pong
permission message: {@no_permission}
trigger:
message "Ping!"
no_permission: You're missing the required permission to execute this command!
command /ping:
permission: command.ping
permission message: {@no_permission}
trigger:
message "Pong!"
command /pong:
permission: command.pong
permission message: {@no_permission}
trigger:
message "Ping!"
| Patterns: |
|
| Since: | 2.9.0 |
Place at the top of a script file to enable an optional experimental feature.
For example, this might include
For example, this might include
Examples:
using 1.21
using my-cool-addon-feature
using my-cool-addon-feature
| Patterns: |
|
| Since: | 1.0 |
Used for defining variables present within a script.
This section is not required, but it ensures that a variable has a value if it doesn't exist when the script is loaded.
This section is not required, but it ensures that a variable has a value if it doesn't exist when the script is loaded.
Examples:
variables:
{joins} = 0
{balance::%player%} = 0
on join:
add 1 to {joins}
message "Your balance is %{balance::%player%}%"
{joins} = 0
{balance::%player%} = 0
on join:
add 1 to {joins}
message "Your balance is %{balance::%player%}%"
| Patterns: |
|
| Since: | 2.5 |
| Usable in events: | sponge absorb |
| Return Type: | Block |
The blocks absorbed by a sponge block.
Examples:
the absorbed blocks
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper |
| Return Type: | Item |
Returns the item the entities are currently using (ie: the food they're eating, the bow they're drawing back, etc.). This cannot be changed. If an entity is not using any item, this will return null.
Examples:
on damage of player:
if victim's active tool is a bow:
interrupt player's active item use
if victim's active tool is a bow:
interrupt player's active item use
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper |
| Return Type: | Timespan |
Returns the time that the entities have either spent using an item, or the time left for them to finish using an item.
If an entity is not using any item, this will return 0 seconds.
If an entity is not using any item, this will return 0 seconds.
Examples:
on right click:
broadcast player's remaining item use time
wait 1 second
broadcast player's item use time
broadcast player's remaining item use time
wait 1 second
broadcast player's item use time
| Patterns: |
|
| Since: | 2.4 |
| Return Type: | Living Entity |
The affected entities in the area cloud effect event.
Examples:
on area cloud effect:
loop affected entities:
if loop-value is a player:
send "WARNING: you've step on an area effect cloud!" to loop-value
loop affected entities:
if loop-value is a player:
send "WARNING: you've step on an area effect cloud!" to loop-value
| Patterns: | |
| Since: | 2.7 |
| Return Type: |
Returns the age or maximum age of blocks and age for entities (there in no maximum age for entities).
For blocks, 'Age' represents the different growth stages that a crop-like block can go through. A value of 0 indicates that the crop was freshly planted, whilst a value equal to 'maximum age' indicates that the crop is ripe and ready to be harvested.
For entities, 'Age' represents the time left for them to become adults and it's in minus increasing to be 0 which means they're adults, e.g. A baby cow needs 20 minutes to become an adult which equals to 24,000 ticks so their age will be -24000 once spawned.
For blocks, 'Age' represents the different growth stages that a crop-like block can go through. A value of 0 indicates that the crop was freshly planted, whilst a value equal to 'maximum age' indicates that the crop is ripe and ready to be harvested.
For entities, 'Age' represents the time left for them to become adults and it's in minus increasing to be 0 which means they're adults, e.g. A baby cow needs 20 minutes to become an adult which equals to 24,000 ticks so their age will be -24000 once spawned.
Examples:
# Set targeted crop to fully grown crop
set age of targeted block to maximum age of targeted block
# Spawn a baby cow that will only need 1 minute to become an adult
spawn a baby cow at player
set age of last spawned entity to -1200 # in ticks = 60 seconds
set age of targeted block to maximum age of targeted block
# Spawn a baby cow that will only need 1 minute to become an adult
spawn a baby cow at player
set age of last spawned entity to -1200 # in ticks = 60 seconds
| Patterns: |
|
| Since: | 2.7 |
| Return Type: | Object |
Obtains the list of all banned players or IP addresses.
Examples:
command /banlist:
trigger:
send all the banned players
trigger:
send all the banned players
| Patterns: |
|
| Since: | 2.2-dev35 |
| Requirements: | Vault, a permission plugin that supports Vault |
| Return Type: | Text |
All the groups a player can have. This expression requires Vault and a compatible permissions plugin to be installed.
Examples:
command /group <text>:
trigger:
if argument is "list":
send "%all groups%"
trigger:
if argument is "list":
send "%all groups%"
| Patterns: |
|
| Since: | 2.7 |
| Return Type: | Offline Player |
The list of operators on the server.
Examples:
set {_ops::*} to all operators
| Patterns: | |
| Since: | 2.2-dev33 |
| Return Type: | Text |
Returns all permissions of the defined player(s). Note that the modifications to resulting list do not actually change permissions.
Examples:
set {_permissions::*} to all permissions of the player
| Patterns: |
|
| Since: | 2.5 |
| Return Type: | Text |
Returns all of the scripts, or just the enabled or disabled ones.
Examples:
command /scripts:
trigger:
send "All Scripts: %scripts%" to player
send "Loaded Scripts: %enabled scripts%" to player
send "Unloaded Scripts: %disabled scripts%" to player
trigger:
send "All Scripts: %scripts%" to player
send "Loaded Scripts: %enabled scripts%" to player
send "Unloaded Scripts: %disabled scripts%" to player
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Script |
Returns all of the scripts, or just the enabled or disabled ones.
Examples:
command /scripts:
trigger:
send "All Scripts: %scripts%" to player
send "Loaded Scripts: %enabled scripts%" to player
send "Unloaded Scripts: %disabled scripts%" to player
trigger:
send "All Scripts: %scripts%" to player
send "Loaded Scripts: %enabled scripts%" to player
send "Unloaded Scripts: %disabled scripts%" to player
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Paper (paper tags) |
| Return Type: | Minecraft Tag |
Returns all the tags.
`minecraft tag` will return only the vanilla tags, `datapack tag` will return only datapack-provided tags, `paper tag` will return only Paper's custom tags (if you are running Paper), and `custom tag` will look in the "skript" namespace for custom tags you've registered.
You can also filter by tag types using "item", "block", or "entity".
`minecraft tag` will return only the vanilla tags, `datapack tag` will return only datapack-provided tags, `paper tag` will return only Paper's custom tags (if you are running Paper), and `custom tag` will look in the "skript" namespace for custom tags you've registered.
You can also filter by tag types using "item", "block", or "entity".
Examples:
broadcast minecraft tags
send paper entity tags
broadcast all block tags
send paper entity tags
broadcast all block tags
| Patterns: |
|
| Since: | 2.6 |
| Return Type: | Text |
Returns all registered commands or all script commands.
Examples:
send "Number of all commands: %size of all commands%"
send "Number of all script commands: %size of all script commands%"
send "Number of all script commands: %size of all script commands%"
| Patterns: | |
| Since: | 2.10 |
| Return Type: |
The alpha, red, green, or blue value of colors. Ranges from 0 to 255.
Alpha represents opacity.
Alpha represents opacity.
Examples:
broadcast red value of rgb(100, 0, 50) # sends '100'
set {_red} to red's red value + 10
set {_red} to red's red value + 10
| Patterns: | |
| Since: | 1.4.3 |
| Return Type: | Number |
Effectively an alias of 'y-coordinate of …', it represents the height of some object above bedrock.
Examples:
on damage:
altitude of the attacker is higher than the altitude of the victim
set damage to damage * 1.2
altitude of the attacker is higher than the altitude of the victim
set damage to damage * 1.2
| Patterns: |
|
| Since: | 1.0 |
| Return Type: | Number |
The amount or size of something.
Please note that
Also, you can get the recursive size of a list, which will return the recursive size of the list with sublists included, e.g.
Where using %size of {list::*}% will only return 3 (the first layer of indices only), while %recursive size of {list::*}% will return 6 (the entire list)
Please note that getting a list's recursive size can cause lag if the list is large, so only use this expression if you need to!
Please note that
amount of %items% will not return the number of items, but the number of stacks, e.g. 1 for a stack of 64 torches. To get the amount of items in a stack, see the item amount expression.Also, you can get the recursive size of a list, which will return the recursive size of the list with sublists included, e.g.
{list::*} Structure
├──── {list::1}: 1
├──── {list::2}: 2
│ ├──── {list::2::1}: 3
│ │ └──── {list::2::1::1}: 4
│ └──── {list::2::2}: 5
└──── {list::3}: 6
Where using %size of {list::*}% will only return 3 (the first layer of indices only), while %recursive size of {list::*}% will return 6 (the entire list)
Please note that getting a list's recursive size can cause lag if the list is large, so only use this expression if you need to!
Examples:
message "There are %number of all players% players online!"
| Patterns: |
|
| Since: | 2.0 |
| Return Type: |
Counts how many of a particular item type are in a given inventory.
Examples:
message "You have %number of ores in the player's inventory% ores in your inventory."
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Number |
Represents the passed number value in degrees.
If radians is specified, converts the passed value to degrees. This conversion may not be entirely accurate, due to floating point precision.
If radians is specified, converts the passed value to degrees. This conversion may not be entirely accurate, due to floating point precision.
Examples:
set {_angle} to 90 degrees
{_angle} is 90 # true
180 degrees is pi # true
pi radians is 180 degrees # true
{_angle} is 90 # true
180 degrees is pi # true
pi radians is 180 degrees # true
| Patterns: |
|
| Since: | 2.8.0 |
| Return Type: |
Returns the experience cost (in levels) to complete the current repair or the maximum experience cost (in levels) to be allowed by the current repair.
The default value of max cost set by vanilla Minecraft is 40.
The default value of max cost set by vanilla Minecraft is 40.
Examples:
on inventory click:
if {AnvilRepairSaleActive} = true:
wait a tick # recommended, to avoid client bugs
set anvil repair cost to anvil repair cost * 50%
send "Anvil repair sale is ON!" to player
on inventory click:
player have permission "anvil.repair.max.bypass"
set max repair cost of event-inventory to 99999
if {AnvilRepairSaleActive} = true:
wait a tick # recommended, to avoid client bugs
set anvil repair cost to anvil repair cost * 50%
send "Anvil repair sale is ON!" to player
on inventory click:
player have permission "anvil.repair.max.bypass"
set max repair cost of event-inventory to 99999
| Patterns: |
|
| Since: | 2.7 |
| Return Type: | Text |
An expression to get the name to be applied to an item in an anvil inventory.
Examples:
on inventory click:
type of event-inventory is anvil inventory
if the anvil text input of the event-inventory is "FREE OP":
ban player
type of event-inventory is anvil inventory
if the anvil text input of the event-inventory is "FREE OP":
ban player
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Beacon Effect |
| Requirements: | Paper |
| Return Type: | Potion Effect Type |
The type of effect applied by a beacon.
Examples:
on beacon effect:
if the applied effect is primary beacon effect:
broadcast "Is Primary"
else if applied effect = secondary effect:
broadcast "Is Secondary"
if the applied effect is primary beacon effect:
broadcast "Is Primary"
else if applied effect = secondary effect:
broadcast "Is Secondary"
| Patterns: |
|
| Since: | 2.5 |
| Usable in events: | enchant |
| Return Type: | Enchantment Type |
The applied enchantments in an enchant event.
Deleting or removing the applied enchantments will prevent the item's enchantment.
Deleting or removing the applied enchantments will prevent the item's enchantment.
Examples:
on enchant:
set the applied enchantments to sharpness 10 and fire aspect 5
set the applied enchantments to sharpness 10 and fire aspect 5
| Patterns: | |
| Since: | 1.0, 2.7 (support for command events) |
| Return Type: | Object |
Usable in script commands and command events. Holds the value of an argument given to the command, e.g. if the command "/tell <player> <text>" is used like "/tell Njol Hello Njol!" argument 1 is the player named "Njol" and argument 2 is "Hello Njol!".
One can also use the type of the argument instead of its index to address the argument, e.g. in the above example 'player-argument' is the same as 'argument 1'.
Please note that specifying the argument type is only supported in script commands.
One can also use the type of the argument instead of its index to address the argument, e.g. in the above example 'player-argument' is the same as 'argument 1'.
Please note that specifying the argument type is only supported in script commands.
Examples:
give the item-argument to the player-argument
damage the player-argument by the number-argument
give a diamond pickaxe to the argument
add argument 1 to argument 2
heal the last argument
damage the player-argument by the number-argument
give a diamond pickaxe to the argument
add argument 1 to argument 2
heal the last argument
| Patterns: |
|
| Since: | 1.4.2 |
| Return Type: | Object |
Arithmetic expressions, e.g. 1 + 2, (health of player - 2) / 3, etc.
Examples:
set the player's health to 10 - the player's health
loop (argument + 2) / 5 times:
message "Two useless numbers: %loop-num * 2 - 5%, %2^loop-num - 1%"
message "You have %health of player * 2% half hearts of HP!"
loop (argument + 2) / 5 times:
message "Two useless numbers: %loop-num * 2 - 5%, %2^loop-num - 1%"
message "You have %health of player * 2% half hearts of HP!"
| Patterns: |
|
| Since: | 1.0, 2.8.0 (armor), 2.10 (body armor) |
| Return Type: | Slot |
Equipment of living entities, i.e. the boots, leggings, chestplate or helmet.
Body armor is a special slot that can only be used for:
Body armor is a special slot that can only be used for:
- Horses: Horse armour (doesn't work on zombie or skeleton horses)
- Wolves: Wolf Armor
- Llamas (regular or trader): Carpet
Examples:
set chestplate of the player to a diamond chestplate
helmet of player is neither a helmet nor air # player is wearing a block, e.g. from another plugin
helmet of player is neither a helmet nor air # player is wearing a block, e.g. from another plugin
| Patterns: |
|
| Since: | 2.8.0 |
| Return Type: | Block |
Returns the attached block of an arrow.
Examples:
set hit block of last shot arrow to diamond block
| Patterns: |
|
| Since: | 2.5.1 |
| Return Type: |
An arrow's knockback strength.
Examples:
on shoot:
event-projectile is an arrow
set arrow knockback strength of event-projectile to 10
event-projectile is an arrow
set arrow knockback strength of event-projectile to 10
| Patterns: |
|
| Since: | 2.5 |
| Return Type: |
The number of arrows stuck in a living entity.
Examples:
set arrows stuck in player to 5
| Patterns: | |
| Since: | 2.6.1 |
| Requirements: | Minecraft 1.15+ |
| Return Type: |
Returns the current cooldown for a player's attack. This is used to calculate damage, with 1.0 representing a fully charged attack and 0.0 representing a non-charged attack.
NOTE: Currently this can not be set to anything.
NOTE: Currently this can not be set to anything.
Examples:
on damage:
if attack cooldown of attacker < 1:
set damage to 0
send "Your hit was too weak! wait until your weapon is fully charged next time." to attacker
if attack cooldown of attacker < 1:
set damage to 0
send "Your hit was too weak! wait until your weapon is fully charged next time." to attacker
| Patterns: |
|
| Since: | 1.3, 2.6.1 (projectile hit event) |
| Usable in events: | damage, death, projectile hit |
| Return Type: | Entity |
The victim of a damage event, e.g. when a player attacks a zombie this expression represents the zombie. When using Minecraft 1.11+, this also covers the hit entity in a projectile hit event.
Examples:
on damage:
victim is a creeper
damage the attacked by 1 heart
victim is a creeper
damage the attacked by 1 heart
| Patterns: |
|
| Since: | 1.3 |
| Usable in events: | damage, death, destroy |
| Return Type: | Entity |
The attacker of a damage event, e.g. when a player attacks a zombie this expression represents the player.
Please note that the attacker can also be a block, e.g. a cactus or lava, but this expression will not be set in these cases.
Please note that the attacker can also be a block, e.g. a cactus or lava, but this expression will not be set in these cases.
Examples:
on damage:
attacker is a player
health of attacker is less than or equal to 2
damage victim by 1 heart
attacker is a player
health of attacker is less than or equal to 2
damage victim by 1 heart
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Banner Pattern |
Creates a new banner pattern.
Examples:
set {_pattern} to a creeper banner pattern colored red
add {_pattern} to banner patterns of {_banneritem}
remove {_pattern} from banner patterns of {_banneritem}
set the 1st banner pattern of block at location(0,0,0) to {_pattern}
clear the 1st banner pattern of block at location(0,0,0)
set {_pattern} to a red mojang banner pattern
add {_pattern} to banner patterns of {_banneritem}
remove {_pattern} from banner patterns of {_banneritem}
set the 1st banner pattern of block at location(0,0,0) to {_pattern}
clear the 1st banner pattern of block at location(0,0,0)
set {_pattern} to a red mojang banner pattern
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Item Type |
Gets the item from a banner pattern type.
Note that not all banner pattern types have an item.
Note that not all banner pattern types have an item.
Examples:
set {_item} to creeper charged banner pattern item
set {_item} to snout banner pattern item
set {_item} to thing banner pattern item
set {_item} to snout banner pattern item
set {_item} to thing banner pattern item
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Banner Pattern |
Gets or sets the banner patterns of a banner.
In order to set a specific position of a banner, there needs to be that many patterns already on the banner.
This expression will add filler patterns to the banner to allow the specified position to be set.
For Example, setting the 3rd banner pattern of a banner that has no patterns on it, will internally add 3 base patterns, allowing the 3rd banner pattern to be set.
In order to set a specific position of a banner, there needs to be that many patterns already on the banner.
This expression will add filler patterns to the banner to allow the specified position to be set.
For Example, setting the 3rd banner pattern of a banner that has no patterns on it, will internally add 3 base patterns, allowing the 3rd banner pattern to be set.
Examples:
broadcast banner patterns of {_banneritem}
broadcast 1st banner pattern of block at location(0,0,0)
clear banner patterns of {_banneritem}
broadcast 1st banner pattern of block at location(0,0,0)
clear banner patterns of {_banneritem}
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Item Type |
The items dropped by the piglin in a piglin bartering event.
Examples:
on piglin barter:
if the bartering drops contain a jack-o-lantern:
remove jack-o-lantern from bartering output
broadcast "it's not halloween yet!"
if the bartering drops contain a jack-o-lantern:
remove jack-o-lantern from bartering output
broadcast "it's not halloween yet!"
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Item Type |
The item picked up by the piglin in a piglin bartering event.
Examples:
on piglin barter:
if the bartering input is a gold ingot:
broadcast "my precious..."
if the bartering input is a gold ingot:
broadcast "my precious..."
| Patterns: | |
| Since: | 2.10 |
| Usable in events: | Beacon Effect, Beacon Toggle, Beacon Change Effect |
| Requirements: | Paper (range) |
| Return Type: | Object |
The active effects of a beacon.
The secondary effect can be set to anything, but the icon in the GUI will not display correctly.
The secondary effect can only be set when the beacon is at max tier.
The primary and secondary effect can not be the same, primary will always retain the potion type and secondary will be cleared.
You can only change the range on Paper.
The secondary effect can be set to anything, but the icon in the GUI will not display correctly.
The secondary effect can only be set when the beacon is at max tier.
The primary and secondary effect can not be the same, primary will always retain the potion type and secondary will be cleared.
You can only change the range on Paper.
Examples:
broadcast tier of {_block}
set primary beacon effect of {_block} to haste
add 1 to range of {_block}
set primary beacon effect of {_block} to haste
add 1 to range of {_block}
| Patterns: |
|
| Since: | 2.0, 2.7 (offlineplayers, safe bed) |
| Return Type: | Location |
Returns the bed location of a player, i.e. the spawn point of a player if they ever slept in a bed and the bed still exists and is unobstructed however, you can set the unsafe bed location of players and they will respawn there even if it has been obstructed or doesn't exist anymore and that's the default behavior of this expression otherwise you will need to be specific i.e.
NOTE: Offline players can not have their bed location changed, only online players.
safe bed location.NOTE: Offline players can not have their bed location changed, only online players.
Examples:
if bed of player exists:
teleport player the the player's bed
else:
teleport the player to the world's spawn point
set the bed location of player to spawn location of world("world") # unsafe/invalid bed location
set the safe bed location of player to spawn location of world("world") # safe/valid bed location
teleport player the the player's bed
else:
teleport the player to the world's spawn point
set the bed location of player to spawn location of world("world") # unsafe/invalid bed location
set the safe bed location of player to spawn location of world("world") # safe/valid bed location
| Patterns: | |
| Since: | 1.4.4, 2.6.1 (3D biomes) |
| Return Type: | Biome |
The biome at a certain location. Please note that biomes are only defined for x/z-columns
(i.e. the altitude (y-coordinate) doesn't matter), up until Minecraft 1.15.x.
As of Minecraft 1.16, biomes are now 3D (per block vs column).
(i.e. the altitude (y-coordinate) doesn't matter), up until Minecraft 1.15.x.
As of Minecraft 1.16, biomes are now 3D (per block vs column).
Examples:
# damage player in deserts constantly
every real minute:
loop all players:
biome at loop-player is desert
damage the loop-player by 1
every real minute:
loop all players:
biome at loop-player is desert
damage the loop-player by 1
| Patterns: |
|
| Since: | 1.0 |
| Return Type: | Block |
The block involved in the event, e.g. the clicked block or the placed block.
Can optionally include a direction as well, e.g. 'block above' or 'block in front of the player'.
Can optionally include a direction as well, e.g. 'block above' or 'block in front of the player'.
Examples:
block is ore
set block below to air
spawn a creeper above the block
loop blocks in radius 4:
loop-block is obsidian
set loop-block to water
block is a chest:
clear the inventory of the block
set block below to air
spawn a creeper above the block
loop blocks in radius 4:
loop-block is obsidian
set loop-block to water
block is a chest:
clear the inventory of the block
| Patterns: | |
| Since: | 1.0 |
| Return Type: | Block |
The block involved in the event, e.g. the clicked block or the placed block.
Can optionally include a direction as well, e.g. 'block above' or 'block in front of the player'.
Can optionally include a direction as well, e.g. 'block above' or 'block in front of the player'.
Examples:
block is ore
set block below to air
spawn a creeper above the block
loop blocks in radius 4:
loop-block is obsidian
set loop-block to water
block is a chest:
clear the inventory of the block
set block below to air
spawn a creeper above the block
loop blocks in radius 4:
loop-block is obsidian
set loop-block to water
block is a chest:
clear the inventory of the block
| Patterns: | |
| Since: | 2.7 |
| Requirements: | 1.17+ |
| Return Type: |
Gets the speed at which the given player would break this block, taking into account tools, potion effects, whether or not the player is in water, enchantments, etc. The returned value is the amount of progress made in breaking the block each tick. When the total breaking progress reaches 1.0, the block is broken. Note that the break speed can change in the course of breaking a block, e.g. if a potion effect is applied or expires, or the player jumps/enters water.
Examples:
on left click using diamond pickaxe:
event-block is set
send "Break Speed: %break speed for player%" to player
event-block is set
send "Break Speed: %break speed for player%" to player
| Patterns: | |
| Since: | 2.5, 2.5.2 (set), 2.10 (block displays) |
| Return Type: | Block Data |
Get the block data associated with a block.
This data can also be used to set blocks.
This data can also be used to set blocks.
Examples:
set {_data} to block data of target block
set block at player to {_data}
set block data of target block to oak_stairs[facing=south;waterlogged=true]
set block at player to {_data}
set block data of target block to oak_stairs[facing=south;waterlogged=true]
| Patterns: |
|
| Since: | 2.6 |
| Requirements: | Minecraft 1.13+ |
| Return Type: | Number |
Obtains the block's hardness level (also known as "strength"). This number is used to calculate the time required to break each block.
Examples:
set {_hard} to block hardness of target block
if block hardness of target block > 5:
if block hardness of target block > 5:
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Text |
Gets the sound that a given block, blockdata, or itemtype will use in a specific scenario.
This will return a string in the form of "SOUND_EXAMPLE", which can be used in the play sound syntax.
Check out this website for a list of sounds in Minecraft, or this one to go to the Sounds wiki page.
This will return a string in the form of "SOUND_EXAMPLE", which can be used in the play sound syntax.
Check out this website for a list of sounds in Minecraft, or this one to go to the Sounds wiki page.
Examples:
play sound (break sound of dirt) at all players
set {_sounds::*} to place sounds of dirt, grass block, blue wool and stone
set {_sounds::*} to place sounds of dirt, grass block, blue wool and stone
| Patterns: | |
| Since: | 1.0 |
| Return Type: | Block |
All blocks in a sphere around a center, mostly useful for looping.
Examples:
loop blocks in radius 5 around the player:
set loop-block to air
set loop-block to air
| Patterns: |
|
| Since: | 1.0, 2.5.1 (within/cuboid/chunk) |
| Return Type: | Block |
Blocks relative to other blocks or between other blocks. Can be used to get blocks relative to other blocks or for looping.
Blocks from/to and between will return a straight line whereas blocks within will return a cuboid.
Blocks from/to and between will return a straight line whereas blocks within will return a cuboid.
Examples:
loop blocks above the player:
loop blocks between the block below the player and the targeted block:
set the blocks below the player, the victim and the targeted block to air
set all blocks within {loc1} and {loc2} to stone
set all blocks within chunk at player to air
loop blocks between the block below the player and the targeted block:
set the blocks below the player, the victim and the targeted block to air
set all blocks within {loc1} and {loc2} to stone
set all blocks within chunk at player to air
| Patterns: |
|
| Since: | 2.1 |
| Requirements: | Supported regions plugin |
| Return Type: | Block |
All blocks in a region.
This expression requires a supported regions plugin to be installed.
This expression requires a supported regions plugin to be installed.
Examples:
loop all blocks in the region {arena.%{faction.%player%}%}:
clear the loop-block
clear the loop-block
| Patterns: |
|
| Since: | 2.2-dev31 |
| Return Type: | Text |
The author of a book.
Examples:
on book sign:
message "Book Title: %author of event-item%"
message "Book Title: %author of event-item%"
| Patterns: |
|
| Since: | 2.2-dev31, 2.7 (changers) |
| Return Type: | Text |
The pages of a book (Supports Skript's chat format)
Note: In order to modify the pages of a new written book, you must have the title and author
of the book set. Skript will do this for you, but if you want your own, please set those values.
Note: In order to modify the pages of a new written book, you must have the title and author
of the book set. Skript will do this for you, but if you want your own, please set those values.
Examples:
on book sign:
message "Book Pages: %pages of event-item%"
message "Book Page 1: %page 1 of event-item%"
set page 1 of player's held item to "Book writing"
message "Book Pages: %pages of event-item%"
message "Book Page 1: %page 1 of event-item%"
set page 1 of player's held item to "Book writing"
| Patterns: |
|
| Since: | 2.2-dev31 |
| Return Type: | Text |
The title of a book.
Examples:
on book sign:
message "Book Title: %title of event-item%"
message "Book Title: %title of event-item%"
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Living Entity |
Represents family members within a breeding event.
Examples:
on breeding:
send "When a %breeding mother% and %breeding father% love each other very much, they make a %bred offspring%" to breeder
send "When a %breeding mother% and %breeding father% love each other very much, they make a %bred offspring%" to breeder
| Patterns: |
|
| Since: | 2.2-dev16 (lowercase and uppercase), 2.5 (advanced cases) |
| Return Type: | Text |
Copy of given text in Lowercase, Uppercase, Proper Case, camelCase, PascalCase, Snake_Case, and Kebab-Case
Examples:
"Oops!" in lowercase # oops!
"oops!" in uppercase # OOPS!
"hellO i'm steve!" in proper case # HellO I'm Steve!
"hellO i'm steve!" in strict proper case # Hello I'm Steve!
"spAwn neW boSs ()" in camel case # spAwnNeWBoSs()
"spAwn neW boSs ()" in strict camel case # spawnNewBoss()
"geneRate ranDom numBer ()" in pascal case # GeneRateRanDomNumBer()
"geneRate ranDom numBer ()" in strict pascal case # GenerateRandomNumber()
"Hello Player!" in snake case # Hello_Player!
"Hello Player!" in lower snake case # hello_player!
"Hello Player!" in upper snake case # HELLO_PLAYER!
"What is your name?" in kebab case # What-is-your-name?
"What is your name?" in lower kebab case # what-is-your-name?
"What is your name?" in upper kebab case # WHAT-IS-YOUR-NAME?
"oops!" in uppercase # OOPS!
"hellO i'm steve!" in proper case # HellO I'm Steve!
"hellO i'm steve!" in strict proper case # Hello I'm Steve!
"spAwn neW boSs ()" in camel case # spAwnNeWBoSs()
"spAwn neW boSs ()" in strict camel case # spawnNewBoss()
"geneRate ranDom numBer ()" in pascal case # GeneRateRanDomNumBer()
"geneRate ranDom numBer ()" in strict pascal case # GenerateRandomNumber()
"Hello Player!" in snake case # Hello_Player!
"Hello Player!" in lower snake case # hello_player!
"Hello Player!" in upper snake case # HELLO_PLAYER!
"What is your name?" in kebab case # What-is-your-name?
"What is your name?" in lower kebab case # what-is-your-name?
"What is your name?" in upper kebab case # WHAT-IS-YOUR-NAME?
| Patterns: | |
| Since: | 2.9.0 |
| Return Type: |
Returns the Unicode codepoint of a character
Examples:
function is_in_order(letters: strings) :: boolean:
loop {_letters::*}:
set {_codepoint} to codepoint of lowercase loop-value
return false if {_codepoint} is not set # 'loop-value is not a single character'
if:
{_previous-codepoint} is set
# if the codepoint of the current character is not
# 1 more than the codepoint of the previous character
# then the letters are not in order
{_codepoint} - {_previous-codepoint} is not 1
then:
return false
set {_previous-codepoint} to {_codepoint}
return true
loop {_letters::*}:
set {_codepoint} to codepoint of lowercase loop-value
return false if {_codepoint} is not set # 'loop-value is not a single character'
if:
{_previous-codepoint} is set
# if the codepoint of the current character is not
# 1 more than the codepoint of the previous character
# then the letters are not in order
{_codepoint} - {_previous-codepoint} is not 1
then:
return false
set {_previous-codepoint} to {_codepoint}
return true
| Patterns: |
|
| Since: | 2.9.0 |
| Return Type: | Text |
Returns the character at the specified codepoint
Examples:
function chars_between(lower: string, upper: string) :: strings:
set {_lower} to codepoint of {_lower}
return {_none} if {_lower} is not set
set {_upper} to codepoint of {_upper}
return {_none} if {_upper} is not set
loop integers between {_lower} and {_upper}:
add character from codepoint loop-value to {_chars::*}
return {_chars::*}
set {_lower} to codepoint of {_lower}
return {_none} if {_lower} is not set
set {_upper} to codepoint of {_upper}
return {_none} if {_upper} is not set
loop integers between {_lower} and {_upper}:
add character from codepoint loop-value to {_chars::*}
return {_chars::*}
| Patterns: | |
| Since: | 2.8.0 |
| Return Type: | Text |
All characters between two given characters, useful for generating random strings. This expression uses the Unicode numerical code of a character to determine which characters are between the two given characters. The ASCII table linked here shows this ordering for the first 256 characters.
If you would like only alphanumeric characters you can use the 'alphanumeric' option in the expression.
If strings of more than one character are given, only the first character of each is used.
If you would like only alphanumeric characters you can use the 'alphanumeric' option in the expression.
If strings of more than one character are given, only the first character of each is used.
Examples:
loop characters from "a" to "f":
broadcast "%loop-value%"
# 0123456789:;<=>?@ABC... ...uvwxyz
send characters between "0" and "z"
# 0123456789ABC... ...uvwxyz
send alphanumeric characters between "0" and "z"
broadcast "%loop-value%"
# 0123456789:;<=>?@ABC... ...uvwxyz
send characters between "0" and "z"
# 0123456789ABC... ...uvwxyz
send alphanumeric characters between "0" and "z"
| Patterns: |
|
| Since: | 2.2-dev31 |
| Return Type: | Text |
Can be used to get/retrieve the chat format. The sender of a message is represented by [player] or [sender], and the message by [message] or [msg].
Examples:
set the chat format to "<yellow>[player]<light gray>: <green>[message]"
| Patterns: |
|
| Since: | 2.2-Fixes-v7, 2.2-dev35 (clearing recipients) |
| Return Type: | Player |
Recipients of chat events where this is called.
Examples:
chat recipients
| Patterns: |
|
| Since: | 2.0, 2.8.0 (loaded chunks) |
| Return Type: | Chunk |
Returns the chunk of a block, location or entity is in, or a list of the loaded chunks of a world.
Examples:
add the chunk at the player to {protected chunks::*}
set {_chunks::*} to the loaded chunks of the player's world
set {_chunks::*} to the loaded chunks of the player's world
| Patterns: |
|
| Since: | 1.0, 2.2-dev35 (more clickable things) |
| Usable in events: | click, inventory click |
| Return Type: | Object |
The clicked block, entity, inventory, inventory slot, inventory click type or inventory action.
Examples:
message "You clicked on a %type of clicked entity%!"
if the clicked block is a chest:
show the inventory of the clicked block to the player
if the clicked block is a chest:
show the inventory of the clicked block to the player
| Patterns: |
|
| Since: | 1.2, 2.10 (displays) |
| Return Type: | Color |
The color of an item, entity, block, firework effect, or text display.
This can also be used to color chat messages with "<%color of ...%>this text is colored!".
Do note that firework effects support setting, adding, removing, resetting, and deleting; text displays support setting and resetting; and items, entities, and blocks only support setting, and only for very few items/blocks.
This can also be used to color chat messages with "<%color of ...%>this text is colored!".
Do note that firework effects support setting, adding, removing, resetting, and deleting; text displays support setting and resetting; and items, entities, and blocks only support setting, and only for very few items/blocks.
Examples:
on click on wool:
message "This wool block is <%color of block%>%color of block%<reset>!"
set the color of the block to black
message "This wool block is <%color of block%>%color of block%<reset>!"
set the color of the block to black
| Patterns: | |
| Since: | 2.0 |
| Return Type: | Text |
Parses <color>s and, optionally, chat styles in a message or removes
any colors and chat styles from the message. Parsing all
chat styles requires this expression to be used in same line with
the send effect.
any colors and chat styles from the message. Parsing all
chat styles requires this expression to be used in same line with
the send effect.
Examples:
on chat:
set message to colored message # Safe; only colors get parsed
command /fade <player>:
trigger:
set display name of the player-argument to uncolored display name of the player-argument
command /format <text>:
trigger:
message formatted text-argument # Safe, because we're sending to whoever used this command
set message to colored message # Safe; only colors get parsed
command /fade <player>:
trigger:
set display name of the player-argument to uncolored display name of the player-argument
command /format <text>:
trigger:
message formatted text-argument # Safe, because we're sending to whoever used this command
| Patterns: |
|
| Since: | 2.0, 2.7 (support for script commands) |
| Usable in events: | command |
| Return Type: | Text |
The command that caused an 'on command' event (excluding the leading slash and all arguments)
Examples:
# prevent any commands except for the /exit command during some game
on command:
if {game::%player%::playing} is true:
if the command is not "exit":
message "You're not allowed to use commands during the game"
cancel the event
on command:
if {game::%player%::playing} is true:
if the command is not "exit":
message "You're not allowed to use commands during the game"
cancel the event
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Text |
Gets or sets the command associated with a command block or minecart with command block.
Examples:
send command of {_block}
set command of {_cmdMinecart} to "say asdf"
set command of {_cmdMinecart} to "say asdf"
| Patterns: |
|
| Since: | 2.6 |
| Return Type: | Text |
Get information about a command.
Examples:
main command label of command "skript"
description of command "help"
label of command "pl"
usage of command "help"
aliases of command "bukkit:help"
permission of command "/op"
command "op"'s permission message
command "sk"'s plugin owner
command /greet <player>:
usage: /greet <target>
trigger:
if arg-1 is sender:
send "&cYou can't greet yourself! Usage: %the usage%"
stop
send "%sender% greets you!" to arg-1
send "You greeted %arg-1%!"
description of command "help"
label of command "pl"
usage of command "help"
aliases of command "bukkit:help"
permission of command "/op"
command "op"'s permission message
command "sk"'s plugin owner
command /greet <player>:
usage: /greet <target>
trigger:
if arg-1 is sender:
send "&cYou can't greet yourself! Usage: %the usage%"
stop
send "%sender% greets you!" to arg-1
send "You greeted %arg-1%!"
| Patterns: |
|
| Since: | 2.0 |
| Usable in events: | command |
| Return Type: | Command Sender |
The player or the console who sent a command. Mostly useful in commands and command events.
If the command sender is a command block, its location can be retrieved by using %block's location%
If the command sender is a command block, its location can be retrieved by using %block's location%
Examples:
make the command sender execute "/say hi!"
on command:
log "%executor% used command /%command% %arguments%" to "commands.log"
on command:
log "%executor% used command /%command% %arguments%" to "commands.log"
| Patterns: | |
| Since: | 2.0 |
| Return Type: | Location |
The location a player's compass is pointing at.
Examples:
# make all player's compasses target a player stored in {compass::target::%player%}
every 5 seconds:
loop all players:
set the loop-player's compass target to location of {compass::target::%%loop-player%}
every 5 seconds:
loop all players:
set the loop-player's compass target to location of {compass::target::%%loop-player%}
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Config |
The Skript config.
This can be reloaded, or navigated to retrieve options.
This can be reloaded, or navigated to retrieve options.
Examples:
set {_node} to node "language" in the skript config if text value of {_node} is "french": broadcast "Bonjour!"
| Patterns: |
|
| Since: | 1.3.1 |
| Return Type: | Command Sender |
Represents the server's console which can receive messages and execute commands
Examples:
execute console command "/stop"
send "message to console" to the console
send "message to console" to the console
| Patterns: |
|
| Since: | 2.2-dev33 |
| Return Type: | Object |
Only usable in command events. Represents the cooldown time, the remaining time, the elapsed time,
the last usage date, or the cooldown bypass permission.
the last usage date, or the cooldown bypass permission.
Examples:
command /home:
cooldown: 10 seconds
cooldown message: You last teleported home %elapsed time% ago, you may teleport home again in %remaining time%.
trigger:
teleport player to {home::%player%}
cooldown: 10 seconds
cooldown message: You last teleported home %elapsed time% ago, you may teleport home again in %remaining time%.
trigger:
teleport player to {home::%player%}
| Patterns: | |
| Since: | 1.4.3 |
| Return Type: | Number |
Represents a given coordinate of a location.
Examples:
player's y-coordinate is smaller than 40:
message "Watch out for lava!"
message "Watch out for lava!"
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Loot Context |
Create a loot context.
Examples:
set {_player} to player
set {_context} to a loot context at player:
set loot luck value to 10
set looter to {_player}
set looted entity to last spawned pig
give player loot items of loot table "minecraft:entities/iron_golem" with loot context {_context}
set {_context} to a loot context at player:
set loot luck value to 10
set looter to {_player}
set looted entity to last spawned pig
give player loot items of loot table "minecraft:entities/iron_golem" with loot context {_context}
| Patterns: |
|
| Since: | 1.0 |
| Return Type: | Entity |
The entity involved in an event (an entity is a player, a creature or an inanimate object like ignited TNT, a dropped item or an arrow).
You can use the specific type of the entity that's involved in the event, e.g. in a 'death of a creeper' event you can use 'the creeper' instead of 'the entity'.
You can use the specific type of the entity that's involved in the event, e.g. in a 'death of a creeper' event you can use 'the creeper' instead of 'the entity'.
Examples:
give a diamond sword of sharpness 3 to the player
kill the creeper
kill all powered creepers in the wolf's world
projectile is an arrow
kill the creeper
kill all powered creepers in the wolf's world
projectile is an arrow
| Patterns: | |
| Since: | 2.2-dev34, 2.8.0 (chat format) |
| Requirements: | Paper 1.16+ (chat format) |
| Return Type: | Inventory |
Returns a chest inventory with the given amount of rows and the name. Use the open inventory effect to open it.
Examples:
open chest inventory with 1 row named "test" to player
set {_inventory} to a chest inventory with 1 row
set slot 4 of {_inventory} to a diamond named "example"
open {_inventory} to player
open chest inventory named "<#00ff00>hex coloured title!" with 6 rows to player
set {_inventory} to a chest inventory with 1 row
set slot 4 of {_inventory} to a diamond named "example"
open {_inventory} to player
open chest inventory named "<#00ff00>hex coloured title!" with 6 rows to player
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | 1.14+ |
| Return Type: |
Get/set the CustomModelData tag for an item. (Value is an integer between 0 and 99999999)
Examples:
set custom model data of player's tool to 3
set {_model} to custom model data of player's tool
set {_model} to custom model data of player's tool
| Patterns: |
|
| Since: | 1.3.5, 2.8.0 (item damage event) |
| Usable in events: | Damage, Vehicle Damage, Item Damage |
| Return Type: | Number |
How much damage is done in a entity/vehicle/item damage events.
For entity damage events, possibly ignoring armour, criticals and/or enchantments (remember that in Skript '1' is one full heart, not half a heart).
For items, it's the amount of durability damage the item will be taking.
For entity damage events, possibly ignoring armour, criticals and/or enchantments (remember that in Skript '1' is one full heart, not half a heart).
For items, it's the amount of durability damage the item will be taking.
Examples:
on item damage:
event-item is any tool
clear damage # unbreakable tools as the damage will be 0
on damage:
increase the damage by 2
event-item is any tool
clear damage # unbreakable tools as the damage will be 0
on damage:
increase the damage by 2
| Patterns: |
|
| Since: | 2.0 |
| Return Type: | Damage Cause |
The damage cause of a damage event. Please click on the link for more information.
Examples:
damage cause is lava, fire or burning
| Patterns: |
|
| Since: | 1.2, 2.7 (durability reversed) |
| Return Type: |
The damage value/durability of an item.
Examples:
set damage value of player's tool to 10
reset the durability of {_item}
set durability of player's held item to 0
reset the durability of {_item}
set durability of player's held item to 0
| Patterns: | |
| Since: | 2.4 |
| Return Type: | Item Type |
Directly damages an item. In MC versions 1.12.2 and lower, this can be used to apply data values to items/blocks
Examples:
give player diamond sword with damage value 100
set player's tool to diamond hoe damaged by 250
give player diamond sword with damage 700 named "BROKEN SWORD"
set {_item} to diamond hoe with damage value 50 named "SAD HOE"
set target block of player to wool with data value 1
set target block of player to potato plant with data value 7
set player's tool to diamond hoe damaged by 250
give player diamond sword with damage 700 named "BROKEN SWORD"
set {_item} to diamond hoe with damage value 50 named "SAD HOE"
set target block of player to wool with data value 1
set target block of player to potato plant with data value 7
| Patterns: | |
| Since: | 2.2-dev33 |
| Return Type: | Date |
A date the specified timespan before/after another date.
Examples:
set {_yesterday} to 1 day ago
set {_hourAfter} to 1 hour after {someOtherDate}
set {_hoursBefore} to 5 hours before {someOtherDate}
set {_hourAfter} to 1 hour after {someOtherDate}
set {_hoursBefore} to 5 hours before {someOtherDate}
| Patterns: | |
| Since: | 2.10 (experimental) |
| Return Type: | Object |
Requires the
using queues experimental feature flag to be enabled.Unrolls a queue into a regular list of values, which can be stored in a list variable. The order of the list will be the same as the order of the elements in the queue. If a list variable is set to this, it will use numerical indices. The original queue will not be changed.
Examples:
set {queue} to a new queue add "hello" and "there" to {queue} set {list::*} to dequeued {queue}
| Patterns: | |
| Since: | 1.4 |
| Return Type: | Object |
Examples:
if difference between {command::%player%::lastuse} and now is smaller than a minute:
message "You have to wait a minute before using this command again!"
message "You have to wait a minute before using this command again!"
| Patterns: | |
| Since: | 2.3 |
| Return Type: | Difficulty |
The difficulty of a world.
Examples:
set the difficulty of "world" to hard
| Patterns: |
|
| Since: | 1.0 (basic), 2.0 (extended) |
| Return Type: | Direction |
A helper expression for the direction type.
Examples:
thrust the player upwards
set the block behind the player to water
loop blocks above the player:
set {_rand} to a random integer between 1 and 10
set the block {_rand} meters south east of the loop-block to stone
block in horizontal facing of the clicked entity from the player is air
spawn a creeper 1.5 meters horizontally behind the player
spawn a TNT 5 meters above and 2 meters horizontally behind the player
thrust the last spawned TNT in the horizontal direction of the player with speed 0.2
push the player upwards and horizontally forward at speed 0.5
push the clicked entity in in the direction of the player at speed -0.5
open the inventory of the block 2 blocks below the player to the player
teleport the clicked entity behind the player
grow a regular tree 2 meters horizontally behind the player
set the block behind the player to water
loop blocks above the player:
set {_rand} to a random integer between 1 and 10
set the block {_rand} meters south east of the loop-block to stone
block in horizontal facing of the clicked entity from the player is air
spawn a creeper 1.5 meters horizontally behind the player
spawn a TNT 5 meters above and 2 meters horizontally behind the player
thrust the last spawned TNT in the horizontal direction of the player with speed 0.2
push the player upwards and horizontally forward at speed 0.5
push the clicked entity in in the direction of the player at speed -0.5
open the inventory of the block 2 blocks below the player to the player
teleport the clicked entity behind the player
grow a regular tree 2 meters horizontally behind the player
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Display Billboard |
Returns or changes the billboard setting of displays.
This describes the axes/points around which the display can pivot.
Displays spawn with the 'fixed' billboard by default. Resetting this expression will also set it to 'fixed'.
This describes the axes/points around which the display can pivot.
Displays spawn with the 'fixed' billboard by default. Resetting this expression will also set it to 'fixed'.
Examples:
set billboard of the last spawned text display to center
| Patterns: | |
| Since: | 2.10 |
| Return Type: |
Returns or changes the brightness override of displays.
Unmodified displays will not have a brightness override value set. Resetting or deleting this value will remove the override.
Use the 'block' or 'sky' options to get/change specific values or get both values as a list by using neither option.
NOTE: setting only one of the sky/block light overrides of a display without an existing override will set both sky and block light to the given value. Make sure to set both block and sky levels to your desired values for the best results. Likewise, you can only clear the brightness override, you cannot clear/reset the sky/block values individually.
Unmodified displays will not have a brightness override value set. Resetting or deleting this value will remove the override.
Use the 'block' or 'sky' options to get/change specific values or get both values as a list by using neither option.
NOTE: setting only one of the sky/block light overrides of a display without an existing override will set both sky and block light to the given value. Make sure to set both block and sky levels to your desired values for the best results. Likewise, you can only clear the brightness override, you cannot clear/reset the sky/block values individually.
Examples:
set sky light override of the last spawned text display to 7
subtract 3 from the block light level override of the last spawned text display
if sky light level override of {_display} is 5:
clear brightness override of {_display}
subtract 3 from the block light level override of the last spawned text display
if sky light level override of {_display} is 5:
clear brightness override of {_display}
| Patterns: | |
| Since: | 2.10 |
| Return Type: |
Returns or changes the height or width of displays.
The rendering culling bounding box spans horizontally width/2 from entity position, which determines the point at which the display will be frustum culled (no longer rendered because the game determines you are no longer able to see it).
If set to 0, no culling will occur on both the vertical and horizontal directions. Default is 0.0.
The rendering culling bounding box spans horizontally width/2 from entity position, which determines the point at which the display will be frustum culled (no longer rendered because the game determines you are no longer able to see it).
If set to 0, no culling will occur on both the vertical and horizontal directions. Default is 0.0.
Examples:
set display height of the last spawned text display to 2.5
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Timespan |
Returns or changes the interpolation delay/duration of displays.
Interpolation duration is the amount of time a display will take to interpolate, or shift, between its current state and a new state.
Interpolation delay is the amount of ticks before client-side interpolation will commence.Setting to 0 seconds will make it immediate.
Resetting either value will return that value to 0.
Interpolation duration is the amount of time a display will take to interpolate, or shift, between its current state and a new state.
Interpolation delay is the amount of ticks before client-side interpolation will commence.Setting to 0 seconds will make it immediate.
Resetting either value will return that value to 0.
Examples:
set interpolation delay of the last spawned text display to 2 ticks
| Patterns: | |
| Since: | 2.10 |
| Requirements: | Spigot 1.20.4+ |
| Return Type: | Timespan |
The teleport duration of displays is the amount of time it takes to get between locations.
0 means that updates are applied immediately.
1 means that the display entity will move from current position to the updated one over one tick.
Higher values spread the movement over multiple ticks. Max of 59 ticks.
0 means that updates are applied immediately.
1 means that the display entity will move from current position to the updated one over one tick.
Higher values spread the movement over multiple ticks. Max of 59 ticks.
Examples:
set teleport delay of the last spawned text display to 2 ticks
teleport last spawned text display to {_location}
wait 2 ticks
message "display entity has arrived at %{_location}%"
teleport last spawned text display to {_location}
wait 2 ticks
message "display entity has arrived at %{_location}%"
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Quaternion |
Returns or changes the transformation rotation of displays.
The left rotation is applied first, with the right rotation then being applied based on the rotated axis.
The left rotation is applied first, with the right rotation then being applied based on the rotated axis.
Examples:
set left transformation rotation of last spawned block display to quaternion(1, 0, 0, 0) # reset block display
| Patterns: | |
| Since: | 2.10 |
| Return Type: |
Returns or changes the view range of displays.
Default value is 1.0. This value is then multiplied by 64 and the player's entity view distance setting to determine the actual range.
For example, a player with 150% entity view distance will see a block display with a view range of 1.2 at 1.2 * 64 * 150% = 115.2 blocks away.
Default value is 1.0. This value is then multiplied by 64 and the player's entity view distance setting to determine the actual range.
For example, a player with 150% entity view distance will see a block display with a view range of 1.2 at 1.2 * 64 * 150% = 115.2 blocks away.
Examples:
set view range of the last spawned text display to 2.9
| Patterns: |
|
| Since: | 1.0 |
| Usable in events: | death |
| Return Type: | Item Type |
Only works in death events. Holds the drops of the dying creature. Drops can be prevented by removing them with "remove ... from drops", e.g. "remove all pickaxes from the drops", or "clear drops" if you don't want any drops at all.
Examples:
clear drops
remove 4 planks from the drops
remove 4 planks from the drops
| Patterns: | |
| Since: | 2.5.1 |
| Requirements: | Minecraft 1.15+ ('as %entity%') |
| Return Type: | Item Type |
A list of the items that will drop when a block is broken.
Examples:
on break of block:
give drops of block using player's tool to player
give drops of block using player's tool to player
| Patterns: |
|
| Since: | 2.0, 2.7 (relative to last element), 2.8.0 (range of elements) |
| Return Type: | Object |
The first, last, range or a random element of a set, e.g. a list variable, or a queue.
Asking for elements from a queue will also remove them from the queue, see the new queue expression for more information.
See also: random expression
Asking for elements from a queue will also remove them from the queue, see the new queue expression for more information.
See also: random expression
Examples:
broadcast the first 3 elements of {top players::*}
set {_last} to last element of {top players::*}
set {_random player} to random element out of all players
send 2nd last element of {top players::*} to player
set {page2::*} to elements from 11 to 20 of {top players::*}
broadcast the 1st element in {queue}
broadcast the first 3 elements in {queue}
set {_last} to last element of {top players::*}
set {_random player} to random element out of all players
send 2nd last element of {top players::*} to player
set {page2::*} to elements from 11 to 20 of {top players::*}
broadcast the 1st element in {queue}
broadcast the first 3 elements in {queue}
| Patterns: |
|
| Since: | 2.5 |
| Usable in events: | enchant prepare, enchant |
| Return Type: | Item Type |
The enchant item in an enchant prepare event or enchant event.
It can be modified, but enchantments will still be applied in the enchant event.
It can be modified, but enchantments will still be applied in the enchant event.
Examples:
on enchant:
set the enchanted item to a diamond chestplate
on enchant prepare:
set the enchant item to a wooden sword
set the enchanted item to a diamond chestplate
on enchant prepare:
set the enchant item to a wooden sword
| Patterns: |
|
| Since: | 2.5 |
| Usable in events: | enchant |
| Return Type: |
The cost of enchanting in an enchant event.
This is number that was displayed in the enchantment table, not the actual number of levels removed.
This is number that was displayed in the enchantment table, not the actual number of levels removed.
Examples:
on enchant:
send "Cost: %the displayed enchanting cost%" to player
send "Cost: %the displayed enchanting cost%" to player
| Patterns: |
|
| Since: | 2.5 |
| Usable in events: | enchant prepare |
| Return Type: |
The enchantment bonus in an enchant prepare event. This represents the number of bookshelves affecting/surrounding the enchantment table.
Examples:
on enchant:
send "There are %enchantment bonus% bookshelves surrounding this enchantment table!" to player
send "There are %enchantment bonus% bookshelves surrounding this enchantment table!" to player
| Patterns: |
|
| Since: | 2.0 |
| Return Type: |
The level of a particular enchantment on an item.
Examples:
player's tool is a sword of sharpness:
message "You have a sword of sharpness %level of sharpness of the player's tool% equipped"
message "You have a sword of sharpness %level of sharpness of the player's tool% equipped"
| Patterns: | |
| Since: | 2.5 |
| Usable in events: | enchant prepare |
| Requirements: | 1.11 or newer |
| Return Type: | Enchantment Offer |
The enchantment offer in enchant prepare events.
Examples:
on enchant prepare:
send "Your enchantment offers are: %the enchantment offers%" to player
send "Your enchantment offers are: %the enchantment offers%" to player
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | 1.11 or newer |
| Return Type: |
The cost of an enchantment offer. This is displayed to the right of an enchantment offer.
If the cost is changed, it will always be at least 1.
This changes how many levels are required to enchant, but does not change the number of levels removed.
To change the number of levels removed, use the enchant event.
If the cost is changed, it will always be at least 1.
This changes how many levels are required to enchant, but does not change the number of levels removed.
To change the number of levels removed, use the enchant event.
Examples:
set cost of enchantment offer 1 to 50
| Patterns: |
|
| Since: | 1.2.1, 2.5 (chunks), 2.10 (within) |
| Return Type: | Entity |
All entities in all worlds, in a specific world, in a chunk, in a radius around a certain location or within two locations. e.g.
all players, all creepers in the player's world, or players in radius 100 of the player. Examples:
kill all creepers in the player's world
send "Psst!" to all players within 100 meters of the player
give a diamond to all ops
heal all tamed wolves in radius 2000 around {town center}
delete all monsters in chunk at player
size of all players within {_corner::1} and {_corner::2}}
send "Psst!" to all players within 100 meters of the player
give a diamond to all ops
heal all tamed wolves in radius 2000 around {town center}
delete all monsters in chunk at player
size of all players within {_corner::1} and {_corner::2}}
| Patterns: |
|
| Since: | 2.5 |
| Return Type: | Boolean |
Returns whether an entity has AI.
Examples:
set artificial intelligence of target entity to false
| Patterns: |
|
| Since: | 2.5, 2.6.1 (final attribute value) |
| Return Type: | Number |
The numerical value of an entity's particular attribute.
Note that the movement speed attribute cannot be reliably used for players. For that purpose, use the speed expression instead.
Resetting an entity's attribute is only available in Minecraft 1.11 and above.
Note that the movement speed attribute cannot be reliably used for players. For that purpose, use the speed expression instead.
Resetting an entity's attribute is only available in Minecraft 1.11 and above.
Examples:
on damage of player:
send "You are wounded!" to victim
set victim's attack speed attribute to 2
send "You are wounded!" to victim
set victim's attack speed attribute to 2
| Patterns: | |
| Since: | 2.7, 2.10 (maximum) |
| Return Type: | Timespan |
How much time an entity will be burning for.
Examples:
send "You will stop burning in %fire time of player%"
send the max burn time of target
send the max burn time of target
| Patterns: |
|
| Since: | 2.5 |
| Return Type: | Offline Player |
The owner of a tameable entity, such as a horse or wolf.
Examples:
set owner of target entity to player
delete owner of target entity
set {_t} to uuid of tamer of target entity
delete owner of target entity
set {_t} to uuid of tamer of target entity
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Minecraft 1.20.2+ |
| Return Type: | Entity Snapshot |
Returns the entity snapshot of a provided entity, which includes all the data associated with it (name, health, attributes, etc.) at the time this expression is used.
Individual attributes of a snapshot cannot be modified or retrieved.
Individual attributes of a snapshot cannot be modified or retrieved.
Examples:
spawn a pig at location(0, 0, 0):
set the max health of entity to 20
set the health of entity to 20
set {_snapshot} to the entity snapshot of entity
clear entity
spawn {_snapshot} at location(0, 0, 0)
set the max health of entity to 20
set the health of entity to 20
set {_snapshot} to the entity snapshot of entity
clear entity
spawn {_snapshot} at location(0, 0, 0)
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Spigot 1.19.2+ |
| Return Type: | Text |
Gets the sound that a given entity will make in a specific scenario.
Examples:
play sound (hurt sound of player) at player
set {_sounds::*} to death sounds of (all mobs in radius 10 of player)
set {_sounds::*} to death sounds of (all mobs in radius 10 of player)
| Patterns: |
|
| Since: | 2.1, 2.5.3 (block break event), 2.7 (experience change event), 2.10 (breeding, fishing) |
| Usable in events: | experience spawn, break / mine, experience change, entity breeding |
| Return Type: | Experience |
How much experience was spawned in an experience spawn or block break event. Can be changed.
Examples:
on experience spawn:
add 5 to the spawned experience
on break of coal ore:
clear dropped experience
on break of diamond ore:
if tool of player = diamond pickaxe:
add 100 to dropped experience
on breed:
breeding father is a cow
set dropped experience to 10
on fish catch:
add 70 to dropped experience
add 5 to the spawned experience
on break of coal ore:
clear dropped experience
on break of diamond ore:
if tool of player = diamond pickaxe:
add 100 to dropped experience
on breed:
breeding father is a cow
set dropped experience to 10
on fish catch:
add 70 to dropped experience
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Experience Cooldown Change Reason |
The experience change reason within an experience cooldown change event.
Examples:
on player experience cooldown change:
if xp cooldown change reason is plugin:
#Changed by a plugin
else if xp cooldown change reason is orb pickup:
#Changed by picking up xp orb
if xp cooldown change reason is plugin:
#Changed by a plugin
else if xp cooldown change reason is orb pickup:
#Changed by picking up xp orb
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Timespan |
The experience cooldown of a player.
Experience cooldown is how long until a player can pick up another orb of experience.
The cooldown of a player must be 0 to pick up another orb of experience.
Experience cooldown is how long until a player can pick up another orb of experience.
The cooldown of a player must be 0 to pick up another orb of experience.
Examples:
send experience cooldown of player
set the xp pickup cooldown of player to 1 hour
if exp collection cooldown of player >= 10 minutes:
clear the experience pickup cooldown of player
set the xp pickup cooldown of player to 1 hour
if exp collection cooldown of player >= 10 minutes:
clear the experience pickup cooldown of player
| Patterns: |
|
| Since: | 2.5, 2.8.6 (modify blocks) |
| Usable in events: | explode |
| Return Type: | Block |
Get all the blocks that were destroyed in an explode event. Supports add/remove/set/clear/delete blocks.
Examples:
on explode:
loop exploded blocks:
add loop-block to {exploded::blocks::*}
on explode:
loop exploded blocks:
if loop-block is grass:
remove loop-block from exploded blocks
on explode:
clear exploded blocks
on explode:
set exploded blocks to blocks in radius 10 around event-entity
on explode:
add blocks above event-entity to exploded blocks
loop exploded blocks:
add loop-block to {exploded::blocks::*}
on explode:
loop exploded blocks:
if loop-block is grass:
remove loop-block from exploded blocks
on explode:
clear exploded blocks
on explode:
set exploded blocks to blocks in radius 10 around event-entity
on explode:
add blocks above event-entity to exploded blocks
| Patterns: |
|
| Since: | 2.5 |
| Usable in events: | explosion |
| Return Type: | Number |
The percentage of exploded blocks dropped in an explosion event.
When changing the yield, a value greater than 1 will function the same as using 1.
Attempting to change the yield to a value less than 0 will have no effect.
When changing the yield, a value greater than 1 will function the same as using 1.
Attempting to change the yield to a value less than 0 will have no effect.
Examples:
on explode:
set the explosion's block yield to 10%
set the explosion's block yield to 10%
| Patterns: |
|
| Since: | 2.5 |
| Usable in events: | explosion prime |
| Return Type: | Number |
The yield of the explosion in an explosion prime event. This is how big the explosion is.
When changing the yield, values less than 0 will be ignored.
Read this wiki page for more information
When changing the yield, values less than 0 will be ignored.
Read this wiki page for more information
Examples:
on explosion prime:
set the yield of the explosion to 10
set the yield of the explosion to 10
| Patterns: | |
| Since: | 2.5 |
| Requirements: | Minecraft 1.12 or newer for creepers |
| Return Type: | Number |
The yield of an explosive (creeper, primed tnt, fireball, etc.). This is how big of an explosion is caused by the entity.
Read this wiki page for more information
Read this wiki page for more information
Examples:
on spawn of a creeper:
set the explosive yield of the event-entity to 10
set the explosive yield of the event-entity to 10
| Patterns: |
|
| Since: | 1.4 |
| Return Type: | Direction |
The facing of an entity or block, i.e. exactly north, south, east, west, up or down (unlike direction which is the exact direction, e.g. '0.5 south and 0.7 east')
Examples:
# makes a bridge
loop blocks from the block below the player in the horizontal facing of the player:
set loop-block to cobblestone
loop blocks from the block below the player in the horizontal facing of the player:
set loop-block to cobblestone
| Patterns: |
|
| Since: | 2.5 |
| Usable in events: | block fertilize |
| Requirements: | Minecraft 1.13 or newer |
| Return Type: | Block |
The blocks fertilized in block fertilize events.
Examples:
the fertilized blocks
| Patterns: | |
| Since: | 2.2-dev36, 2.10 (parenthesis pattern) |
| Return Type: | Object |
Filters a list based on a condition.
For example, if you ran 'broadcast "something" and "something else" where [string input is "something"]',
only "something" would be broadcast as it is the only string that matched the condition.
For example, if you ran 'broadcast "something" and "something else" where [string input is "something"]',
only "something" would be broadcast as it is the only string that matched the condition.
Examples:
send "congrats on being staff!" to all players where [player input has permission "staff"]
loop (all blocks in radius 5 of player) where [block input is not air]:
loop (all blocks in radius 5 of player) where [block input is not air]:
| Patterns: |
|
| Since: | 2.4 |
| Return Type: | Firework Effect |
Represents a 'firework effect' which can be used in the launch firework effect.
Examples:
launch flickering trailing burst firework colored blue and green at player
launch trailing flickering star colored purple, yellow, blue, green and red fading to pink at target entity
launch ball large colored red, purple and white fading to light green and black at player's location with duration 1
launch trailing flickering star colored purple, yellow, blue, green and red fading to pink at target entity
launch ball large colored red, purple and white fading to light green and black at player's location with duration 1
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Fishing |
| Return Type: |
Returns the angle at which the fish will approach the fishing hook, after the wait time.
The angle is in degrees, with 0 being positive Z, 90 being negative X, 180 being negative Z, and 270 being positive X.
By default, returns a value between 0 and 360 degrees.
The angle is in degrees, with 0 being positive Z, 90 being negative X, 180 being negative Z, and 270 being positive X.
By default, returns a value between 0 and 360 degrees.
Examples:
on fish approach:
if fishing approach angle is bigger than 300.5 degrees or fishing approach angle is smaller than 59.5 degrees:
cancel event
if fishing approach angle is bigger than 300.5 degrees or fishing approach angle is smaller than 59.5 degrees:
cancel event
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Fishing |
| Requirements: | Paper 1.20.6 |
| Return Type: | Timespan |
Returns the time it takes a fish to bite the fishing hook, after it started approaching the hook.
May return a timespan of 0 seconds. If modifying the value, it should be at least 1 tick.
May return a timespan of 0 seconds. If modifying the value, it should be at least 1 tick.
Examples:
on fish approach:
set fishing bite time to 5 seconds
set fishing bite time to 5 seconds
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Fishing |
| Return Type: | Entity |
The fishing hook in a fishing event.
Examples:
on fish line cast:
wait a second
teleport player to fishing hook
wait a second
teleport player to fishing hook
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Fishing |
| Return Type: | Timespan |
Returns the minimum and/or maximum waiting time of the fishing hook.
Default minimum value is 5 seconds and maximum is 30 seconds, before lure is applied.
Default minimum value is 5 seconds and maximum is 30 seconds, before lure is applied.
Examples:
on fishing line cast:
set min waiting time to 10 seconds
set max waiting time to 20 seconds
set min waiting time to 10 seconds
set max waiting time to 20 seconds
| Patterns: | |
| Since: | 2.2-dev31, 2.7 (support variables in format) |
| Return Type: | Text |
Converts date to human-readable text format. By default, 'yyyy-MM-dd HH:mm:ss z' (e.g. '2018-03-30 16:03:12 +01') will be used. For reference, see this Wikipedia article.
Examples:
command /date:
trigger:
send "Full date: %now formatted human-readable%" to sender
send "Short date: %now formatted as "yyyy-MM-dd"%" to sender
trigger:
send "Full date: %now formatted human-readable%" to sender
send "Short date: %now formatted as "yyyy-MM-dd"%" to sender
| Patterns: | |
| Since: | 1.1 |
| Return Type: | Object |
Represents the value of an expression before an event happened or the value it will have directly after the event, e.g. the old or new level respectively in a level change event.
Note: The past, future and present states of an expression are sometimes called 'time states' of an expression.
Note 2: If you don't specify whether to use the past or future state of an expression that has different values, its default value will be used which is usually the value after the event.
Note: The past, future and present states of an expression are sometimes called 'time states' of an expression.
Note 2: If you don't specify whether to use the past or future state of an expression that has different values, its default value will be used which is usually the value after the event.
Examples:
on teleport:
former world was "world_nether" # or 'world was'
world will be "world" # or 'world after the event is'
on tool change:
past tool is an axe
the tool after the event will be air
on weather change:
set {weather::%world%::old} to past weather
set {weather::%world%::current} to the new weather
former world was "world_nether" # or 'world was'
world will be "world" # or 'world after the event is'
on tool change:
past tool is an axe
the tool after the event will be air
on weather change:
set {weather::%world%::old} to past weather
set {weather::%world%::current} to the new weather
| Patterns: |
|
| Since: | 2.8.0 |
| Return Type: |
The free, max or total memory of the server in Megabytes.
Examples:
while player is online:
send action bar "Memory left: %free memory%/%max memory%MB" to player
wait 5 ticks
send action bar "Memory left: %free memory%/%max memory%MB" to player
wait 5 ticks
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Function |
Obtain a function by name, which can be executed.
Examples:
set {_function} to the function named "myFunction"
run {_function} with arguments 13 and true
run {_function} with arguments 13 and true
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | smelt, fuel burn, smelting start, furnace extract |
| Return Type: | Item |
Represents the different items in furnace events.
Only 'smelting item' can be changed.
Only 'smelting item' can be changed.
Examples:
on furnace smelt:
broadcast smelted item
# Or 'result'
on furnace extract:
broadcast extracted item
on fuel burn:
broadcast burned fuel
on smelting start:
broadcast smelting item
clear smelting item
broadcast smelted item
# Or 'result'
on furnace extract:
broadcast extracted item
on fuel burn:
broadcast burned fuel
on smelting start:
broadcast smelting item
clear smelting item
| Patterns: | |
| Since: | 1.0, 2.8.0 (syntax rework) |
| Usable in events: | smelt, fuel burn |
| Return Type: | Slot |
A slot of a furnace, i.e. either the ore, fuel or result slot.
Examples:
set the fuel slot of the clicked block to a lava bucket
set the block's ore slot to 64 iron ore
clear the result slot of the block
on smelt:
if the fuel slot is charcoal:
add 5 seconds to the burn time
set the block's ore slot to 64 iron ore
clear the result slot of the block
on smelt:
if the fuel slot is charcoal:
add 5 seconds to the burn time
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Timespan |
The cook time, total cook time, and burn time of a furnace. Can be changed.
- cook time: The amount of time an item has been smelting for.
- total cook time: The amount of time required to finish smelting an item.
- burn time: The amount of time left for the current fuel until consumption of another fuel item.
Examples:
set the cooking time of {_block} to 10
set the total cooking time of {_block} to 50
set the fuel burning time of {_block} to 100
on smelt:
if the fuel slot is charcoal:
add 5 seconds to the fuel burn time
set the total cooking time of {_block} to 50
set the fuel burning time of {_block} to 100
on smelt:
if the fuel slot is charcoal:
add 5 seconds to the fuel burn time
| Patterns: | |
| Since: | 2.5 |
| Requirements: | Minecraft 1.13+ |
| Return Type: | Gamerule Value |
The gamerule value of a world.
Examples:
set the gamerule commandBlockOutput of world "world" to false
| Patterns: |
|
| Since: | 2.2-dev21 |
| Return Type: | Boolean |
Sets of gets gliding state of player. It allows you to set gliding state of entity even if they do not have an Elytra equipped.
Examples:
set gliding of player to off
| Patterns: |
|
| Since: | 2.2-dev35 |
| Requirements: | Vault, a permission plugin that supports Vault |
| Return Type: | Text |
The primary group or all groups of a player. This expression requires Vault and a compatible permissions plugin to be installed.
If you have LuckPerms, ensure you have vault integration enabled in the luck perms configurations.
If you have LuckPerms, ensure you have vault integration enabled in the luck perms configurations.
Examples:
on join:
broadcast "%group of player%" # this is the player's primary group
broadcast "%groups of player%" # this is all of the player's groups
broadcast "%group of player%" # this is the player's primary group
broadcast "%groups of player%" # this is all of the player's groups
| Patterns: |
|
| Since: | 2.6.2 |
| Return Type: | Entity |
Examples:
on break of item frame:
if item of hanging entity is diamond pickaxe:
cancel event
if hanging remover is a player:
send "You can't break that item frame!" to hanging remover
if item of hanging entity is diamond pickaxe:
cancel event
if hanging remover is a player:
send "You can't break that item frame!" to hanging remover
| Patterns: |
|
| Since: | 2.0, 2.2-dev32 (SHA-256 algorithm) |
| Return Type: | Text |
Hashes the given text using the MD5 or SHA-256 algorithms. Each algorithm is suitable for different use cases.
MD5 is provided mostly for backwards compatibility, as it is outdated and not secure.
SHA-256 is more secure, and can used to hash somewhat confidental data like IP addresses and even passwords.
It is not that secure out of the box, so please consider using salt when dealing with passwords!
When hashing data, you must specify algorithms that will be used for security reasons!
Please note that a hash cannot be reversed under normal circumstanses. You will not be able to get original value from a hash with Skript.
Examples:
command /setpass <text>:
trigger:
set {password::%uuid of player%} to text-argument hashed with SHA-256
command /login <text>:
trigger:
if text-argument hashed with SHA-256 is {password::%uuid of player%}:
message "Login successful."
else:
message "Wrong password!"
trigger:
set {password::%uuid of player%} to text-argument hashed with SHA-256
command /login <text>:
trigger:
if text-argument hashed with SHA-256 is {password::%uuid of player%}:
message "Login successful."
else:
message "Wrong password!"
| Patterns: |
|
| Since: | 2.7 |
| Usable in events: | Egg Throw |
| Return Type: | Entity Type |
The type of the entity that will be hatched in a Player Egg Throw event.
Examples:
on player egg throw:
set the hatching entity type to a primed tnt
set the hatching entity type to a primed tnt
| Patterns: |
|
| Since: | 2.7 |
| Usable in events: | Egg Throw |
| Return Type: |
The number of entities that will be hatched in a Player Egg Throw event.
Please note that no more than 127 entities can be hatched at once.
Please note that no more than 127 entities can be hatched at once.
Examples:
on player egg throw:
set the hatching number to 10
set the hatching number to 10
| Patterns: |
|
| Since: | 2.0 |
| Return Type: | Location |
The location of an entity's head, mostly useful for players and e.g. looping blocks in the player's line of sight.
Please note that this location is only accurate for entities whose head is exactly above their center, i.e. players, endermen, zombies, skeletons, etc., but not sheep, pigs or cows.
Please note that this location is only accurate for entities whose head is exactly above their center, i.e. players, endermen, zombies, skeletons, etc., but not sheep, pigs or cows.
Examples:
set the block at the player's head to air
set the block in front of the player's eyes to glass
loop blocks in front of the player's head:
set the block in front of the player's eyes to glass
loop blocks in front of the player's head:
| Patterns: |
|
| Since: | 2.5.1 |
| Usable in events: | heal |
| Return Type: |
The amount of health healed in a heal event.
Examples:
on player healing:
increase the heal amount by 2
remove 0.5 from the healing amount
increase the heal amount by 2
remove 0.5 from the healing amount
| Patterns: |
|
| Since: | 2.5 |
| Usable in events: | heal |
| Return Type: | Heal Reason |
The heal reason of a heal event.
Examples:
on heal:
heal reason is satiated
send "You ate enough food and gained full health back!"
heal reason is satiated
send "You ate enough food and gained full health back!"
| Patterns: |
|
| Since: | 1.0 |
| Usable in events: | damage |
| Return Type: | Number |
The health of a creature, e.g. a player, mob, villager, etc. The minimum value is 0, and the maximum is the creature's max health (e.g. 10 for players).
Examples:
message "You have %health% HP left."
| Patterns: | |
| Since: | 2.3 |
| Return Type: | Player |
The players hidden from a player that were hidden using the entity visibility effect.
Examples:
message "<light red>You are currently hiding: <light gray>%hidden players of the player%"
| Patterns: |
|
| Since: | 2.10 |
| Return Type: |
Gets and/or sets the (max) domestication of a horse.
The domestication of a horse is how close a horse is to becoming tame - the higher the domestication, the closer they are to becoming tame (must be between 1 and the max domestication level of the horse).
The max domestication of a horse is how long it will take for a horse to become tame (must be greater than 0).
The domestication of a horse is how close a horse is to becoming tame - the higher the domestication, the closer they are to becoming tame (must be between 1 and the max domestication level of the horse).
The max domestication of a horse is how long it will take for a horse to become tame (must be greater than 0).
Examples:
function domesticateAndTame(horse: entity, p: offline player, i: int = 10):
add {_i} to domestication level of {_horse}
if domestication level of {_horse} >= max domestication level of {_horse}:
tame {_horse}
set tamer of {_horse} to {_p}
add {_i} to domestication level of {_horse}
if domestication level of {_horse} >= max domestication level of {_horse}:
tame {_horse}
set tamer of {_horse} to {_p}
| Patterns: |
|
| Since: | 2.5 |
| Return Type: |
The hotbar button clicked in an inventory click event.
Examples:
on inventory click:
send "You clicked the hotbar button %hotbar button%!"
send "You clicked the hotbar button %hotbar button%!"
| Patterns: | |
| Since: | 2.2-dev36 |
| Return Type: | Slot |
The currently selected hotbar slot.
To retrieve its number use Slot Index expression.
Use future and past tense to grab the previous slot in an item change event, see example.
To retrieve its number use Slot Index expression.
Use future and past tense to grab the previous slot in an item change event, see example.
Examples:
message "%player's current hotbar slot%"
set player's selected hotbar slot to slot 4 of player
send "index of player's current hotbar slot = 1" # second slot from the left
on item held change:
if the selected hotbar slot was a diamond:
set the currently selected hotbar slot to slot 5 of player
set player's selected hotbar slot to slot 4 of player
send "index of player's current hotbar slot = 1" # second slot from the left
on item held change:
if the selected hotbar slot was a diamond:
set the currently selected hotbar slot to slot 5 of player
| Patterns: |
|
| Since: | 2.3 |
| Usable in events: | server list ping |
| Requirements: | Paper 1.12.2 or newer |
| Return Type: | Text |
The list when you hover on the player counts of the server in the server list.
This can be changed using texts or players in a server list ping event only. Adding players to the list means adding the name of the players.
And note that, for example if there are 5 online players (includes fake online count) in the server and the hover list is set to 3 values, Minecraft will show "... and 2 more ..." at end of the list.
This can be changed using texts or players in a server list ping event only. Adding players to the list means adding the name of the players.
And note that, for example if there are 5 online players (includes fake online count) in the server and the hover list is set to 3 values, Minecraft will show "... and 2 more ..." at end of the list.
Examples:
on server list ping:
clear the hover list
add "&aWelcome to the &6Minecraft &aserver!" to the hover list
add "" to the hover list # A blank line
add "&cThere are &6%online players count% &conline players!" to the hover list
clear the hover list
add "&aWelcome to the &6Minecraft &aserver!" to the hover list
add "" to the hover list # A blank line
add "&cThere are &6%online players count% &conline players!" to the hover list
| Patterns: | |
| Since: | 1.4, 2.2-dev26 (when used in connect event), 2.3 (when used in server list ping event) |
| Return Type: | Text |
The IP address of a player, or the connected player in a connect event, or the pinger in a server list ping event.
Examples:
ban the IP address of the player
broadcast "Banned the IP %IP of player%"
on connect:
log "[%now%] %player% (%ip%) is connected to the server."
on server list ping:
send "%IP-address%" to the console
broadcast "Banned the IP %IP of player%"
on connect:
log "[%now%] %player% (%ip%) is connected to the server."
on server list ping:
send "%IP-address%" to the console
| Patterns: | |
| Since: | 2.1 |
| Return Type: |
The first or last index of a character (or text) in a text, or -1 if it doesn't occur in the text. Indices range from 1 to the length of the text.
Examples:
set {_first} to the first index of "@" in the text argument
if {_s} contains "abc":
set {_s} to the first (index of "abc" in {_s} + 3) characters of {_s} # removes everything after the first "abc" from {_s}
if {_s} contains "abc":
set {_s} to the first (index of "abc" in {_s} + 3) characters of {_s} # removes everything after the first "abc" from {_s}
| Patterns: | |
| Since: | 2.4 (indices), 2.6.1 (sorting) |
| Return Type: | Text |
Returns all the indices of a list variable, optionally sorted by their values.
To sort the indices, all objects in the list must be comparable;
Otherwise, this expression will just return the unsorted indices.
To sort the indices, all objects in the list must be comparable;
Otherwise, this expression will just return the unsorted indices.
Examples:
set {l::*} to "some", "cool" and "values"
broadcast "%indices of {l::*}%" # result is 1, 2 and 3
set {_leader-board::first} to 17
set {_leader-board::third} to 30
set {_leader-board::second} to 25
set {_leader-board::fourth} to 42
set {_ascending-indices::*} to sorted indices of {_leader-board::*} in ascending order
broadcast "%{_ascending-indices::*}%" #result is first, second, third, fourth
set {_descending-indices::*} to sorted indices of {_leader-board::*} in descending order
broadcast "%{_descending-indices::*}%" #result is fourth, third, second, first
broadcast "%indices of {l::*}%" # result is 1, 2 and 3
set {_leader-board::first} to 17
set {_leader-board::third} to 30
set {_leader-board::second} to 25
set {_leader-board::fourth} to 42
set {_ascending-indices::*} to sorted indices of {_leader-board::*} in ascending order
broadcast "%{_ascending-indices::*}%" #result is first, second, third, fourth
set {_descending-indices::*} to sorted indices of {_leader-board::*} in descending order
broadcast "%{_descending-indices::*}%" #result is fourth, third, second, first
| Patterns: |
|
| Since: | 2.8.0 |
| Usable in events: | Inventory Item Move |
| Return Type: | Inventory |
Returns the initiator inventory in an on inventory item move event.
Examples:
on inventory item move:
holder of event-initiator-inventory is a chest
broadcast "Item transport happening at %location at holder of event-initiator-inventory%!"
holder of event-initiator-inventory is a chest
broadcast "Item transport happening at %location at holder of event-initiator-inventory%!"
| Patterns: |
|
| Since: | 2.2-dev36, 2.9.0 (input index) |
| Return Type: | Object |
Represents the input in a filter expression or sort effect.
For example, if you ran 'broadcast "something" and "something else" where [input is "something"]
the condition would be checked twice, using "something" and "something else" as the inputs.
The 'input index' pattern can be used when acting on a variable to access the index of the input.
For example, if you ran 'broadcast "something" and "something else" where [input is "something"]
the condition would be checked twice, using "something" and "something else" as the inputs.
The 'input index' pattern can be used when acting on a variable to access the index of the input.
Examples:
send "congrats on being staff!" to all players where [input has permission "staff"]
sort {_list::*} based on length of input index
sort {_list::*} based on length of input index
| Patterns: |
|
| Since: | 1.0 |
| Return Type: | Object |
The inventory of a block or player. You can usually omit this expression and can directly add or remove items to/from blocks or players.
Examples:
add a plank to the player's inventory
clear the player's inventory
remove 5 wool from the inventory of the clicked block
clear the player's inventory
remove 5 wool from the inventory of the clicked block
| Patterns: |
|
| Since: | 2.2-dev16 |
| Return Type: | Inventory Action |
The inventory action of an inventory event. Please click on the link for more information.
Examples:
inventory action is pickup all
| Patterns: |
|
| Since: | 2.8.0 |
| Usable in events: | Inventory Close |
| Requirements: | Paper |
| Return Type: | Inventory Close Reasons |
The inventory close reason of an inventory close event.
Examples:
on inventory close:
inventory close reason is teleport
send "Your inventory closed due to teleporting!" to player
inventory close reason is teleport
send "Your inventory closed due to teleporting!" to player
| Patterns: |
|
| Since: | 2.2-dev34, 2.5 (slots) |
| Return Type: | Object |
Gets the amount of rows/slots, viewers and holder of an inventory.
NOTE: 'Viewers' expression returns a list of players viewing the inventory. Note that a player is considered to be viewing their own inventory and internal crafting screen even when said inventory is not open.
NOTE: 'Viewers' expression returns a list of players viewing the inventory. Note that a player is considered to be viewing their own inventory and internal crafting screen even when said inventory is not open.
Examples:
event-inventory's amount of rows
holder of player's top inventory
{_inventory}'s viewers
holder of player's top inventory
{_inventory}'s viewers
| Patterns: | |
| Since: | 2.2-dev24 |
| Return Type: | Slot |
Represents a slot in an inventory. It can be used to change the item in an inventory too.
Examples:
if slot 0 of player is air:
set slot 0 of player to 2 stones
remove 1 stone from slot 0 of player
add 2 stones to slot 0 of player
clear slot 1 of player
set slot 0 of player to 2 stones
remove 1 stone from slot 0 of player
add 2 stones to slot 0 of player
clear slot 1 of player
| Patterns: |
|
| Since: | unknown (before 2.1) |
| Return Type: | Item |
The item involved in an event, e.g. in a drop, dispense, pickup or craft event.
Examples:
on dispense:
item is a clock
set the time to 6:00
item is a clock
set the time to 6:00
| Patterns: |
|
| Since: | 2.2-dev24 |
| Return Type: |
The amount of an item stack.
Examples:
send "You have got %item amount of player's tool% %player's tool% in your hand!" to player
| Patterns: |
|
| Since: | 2.8.0 |
| Return Type: | Timespan |
Change the cooldown of a specific material to a certain amount of Timespan.
Examples:
on right click using stick:
set item cooldown of player's tool for player to 1 minute
set item cooldown of stone and grass for all players to 20 seconds
reset item cooldown of cobblestone and dirt for all players
set item cooldown of player's tool for player to 1 minute
set item cooldown of stone and grass for all players to 20 seconds
reset item cooldown of cobblestone and dirt for all players
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Item Display Transforms |
Returns or changes the item display transform of item displays.
Examples:
set the item transform of the last spawned item display to first person left handed
set the item transform of the last spawned item display to no transform # Reset to default
set the item transform of the last spawned item display to no transform # Reset to default
| Patterns: |
|
| Since: | 2.2-dev36 |
| Return Type: | Enchantment Type |
All the enchantments an item type has.
Examples:
clear enchantments of event-item
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Item Flag |
The item flags of an item. Can be modified.
Examples:
set item flags of player's tool to hide enchants and hide attributes
add hide potion effects to item flags of player's held item
remove hide enchants from item flags of {legendary sword}
add hide potion effects to item flags of player's held item
remove hide enchants from item flags of {legendary sword}
| Patterns: | |
| Since: | 2.2-dev35, 2.2-dev36 (improved), 2.5.2 (throwable projectiles), 2.10 (item displays) |
| Return Type: | Slot |
An item associated with an entity. For dropped item entities, it gets the item that was dropped.
For item frames, the item inside the frame is returned.
For throwable projectiles (snowballs, enderpearls etc.) or item displays, it gets the displayed item.
Other entities do not have items associated with them.
For item frames, the item inside the frame is returned.
For throwable projectiles (snowballs, enderpearls etc.) or item displays, it gets the displayed item.
Other entities do not have items associated with them.
Examples:
item of event-entity
set the item inside of event-entity to a diamond sword named "Example"
set the item inside of event-entity to a diamond sword named "Example"
| Patterns: | |
| Since: | 2.5 |
| Requirements: | 1.14+ |
| Return Type: | Item Type |
Get an item with a CustomModelData tag. (Value is an integer between 0 and 99999999)
Examples:
give player a diamond sword with custom model data 2
set slot 1 of inventory of player to wooden hoe with custom model data 357
set slot 1 of inventory of player to wooden hoe with custom model data 357
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Spigot 1.20.5+ |
| Return Type: | Item Type |
Get an item with or without enchantment glint.
Examples:
set {_item with glint} to diamond with enchantment glint
set {_item without glint} to diamond without enchantment glint
set {_item without glint} to diamond without enchantment glint
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Item Type |
Creates a new item with the specified item flags.
Examples:
give player diamond sword with item flags hide enchants and hide attributes
set {_item} to player's tool with item flag hide additional tooltip
give player torch with hide placed on item flag
set {_item} to diamond sword with all item flags
set {_item} to player's tool with item flag hide additional tooltip
give player torch with hide placed on item flag
set {_item} to diamond sword with all item flags
| Patterns: | |
| Since: | 2.3 |
| Return Type: | Item Type |
Returns the given item type with the specified lore added to it.
If multiple strings are passed, each of them will be a separate line in the lore.
If multiple strings are passed, each of them will be a separate line in the lore.
Examples:
set {_test} to stone with lore "line 1" and "line 2"
give {_test} to player
give {_test} to player
| Patterns: |
|
| Since: | 1.0 pre-5 |
| Return Type: | Item Type |
Items or blocks of a specific type, useful for looping.
Examples:
loop items of type ore and log:
block contains loop-item
message "Theres at least one %loop-item% in this block"
drop all blocks at the player # drops one of every block at the player
block contains loop-item
message "Theres at least one %loop-item% in this block"
drop all blocks at the player # drops one of every block at the player
| Patterns: |
|
| Since: | 2.0, 2.8.0 (specific types of items) |
| Return Type: | Slot |
All items or specific type(s) of items in an inventory. Useful for looping or storing in a list variable.
Please note that the positions of the items in the inventory are not saved, only their order is preserved.
Please note that the positions of the items in the inventory are not saved, only their order is preserved.
Examples:
loop all items in the player's inventory:
loop-item is enchanted
remove loop-item from the player
set {inventory::%uuid of player%::*} to items in the player's inventory
loop-item is enchanted
remove loop-item from the player
set {inventory::%uuid of player%::*} to items in the player's inventory
| Patterns: |
|
| Since: | 2.1, 2.5.2 (regex support), 2.7 (case sensitivity), 2.10 (without trailing string) |
| Return Type: | Text |
Joins several texts with a common delimiter (e.g. ", "), or splits a text into multiple texts at a given delimiter.
Examples:
message "Online players: %join all players' names with "" | ""%" # %all players% would use the default "x, y, and z"
set {_s::*} to the string argument split at ","
set {_s::*} to the string argument split at ","
| Patterns: | |
| Since: | 2.3 |
| Return Type: | Text |
Currently selected game language of a player. The value of the language is not defined properly.
The vanilla Minecraft client will use lowercase language / country pairs separated by an underscore, but custom resource packs may use any format they wish.
The vanilla Minecraft client will use lowercase language / country pairs separated by an underscore, but custom resource packs may use any format they wish.
Examples:
message player's current language
| Patterns: |
|
| Since: | 2.5.1 |
| Return Type: | Number |
The last damage that was done to an entity. Note that changing it doesn't deal more/less damage.
Examples:
set last damage of event-entity to 2
| Patterns: |
|
| Since: | 2.2-Fixes-V10 |
| Return Type: | Damage Cause |
Cause of last damage done to an entity
Examples:
set last damage cause of event-entity to fire tick
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Location |
Gets the last death location of a player, or offline player, if available.
Can also be set, reset, and deleted if the player is online.
Can also be set, reset, and deleted if the player is online.
Examples:
set {_loc} to the last death location of player
teleport player to last death location of (random element out of all players)
teleport player to last death location of (random element out of all players)
| Patterns: |
|
| Since: | 2.3 |
| Requirements: | Paper 1.12.2 or newer |
| Return Type: | Server Icon |
Returns the last loaded server icon with the load server icon effect.
Examples:
set {server-icon} to the last loaded server icon
| Patterns: | |
| Since: | 2.4 |
| Requirements: | Paper 1.9 or newer |
| Return Type: | Resource Pack State |
Returns the last resource pack response received from a player.
Examples:
if player's last resource pack response is deny or download fail:
| Patterns: |
|
| Since: | 1.3 (spawned entity), 2.0 (shot entity), 2.2-dev26 (dropped item), 2.7 (struck lightning, firework) |
| Return Type: | Entity |
Holds the entity that was spawned most recently with the spawn effect (section), dropped with the drop effect, shot with the shoot effect or created with the lightning effect. Please note that even though you can spawn multiple mobs simultaneously (e.g. with 'spawn 5 creepers'), only the last spawned mob is saved and can be used. If you spawn an entity, shoot a projectile and drop an item you can however access all them together.
Examples:
spawn a priest
set {healer::%spawned priest%} to true
shoot an arrow from the last spawned entity
ignite the shot projectile
drop a diamond sword
push last dropped item upwards
teleport player to last struck lightning
delete last launched firework
set {healer::%spawned priest%} to true
shoot an arrow from the last spawned entity
ignite the shot projectile
drop a diamond sword
push last dropped item upwards
teleport player to last struck lightning
delete last launched firework
| Patterns: |
|
| Since: | 2.5 |
| Return Type: | Date |
When a player last/first logged in the server. 'last login' requires paper to get the last login, otherwise it will get the last time they were seen on the server.
Examples:
command /onlinefor:
trigger:
send "You have been online for %difference between player's last login and now%."
send "You first joined the server %difference between player's first login and now% ago."
trigger:
send "You have been online for %difference between player's last login and now%."
send "You first joined the server %difference between player's first login and now% ago."
| Patterns: |
|
| Since: | 2.3 |
| Return Type: | Entity |
The leash holder of a living entity.
Examples:
set {_example} to the leash holder of the target mob
| Patterns: | |
| Since: | unknown (before 2.1) |
| Usable in events: | level change |
| Return Type: |
The level of a player.
Examples:
reduce the victim's level by 1
set the player's level to 0
set the player's level to 0
| Patterns: | |
| Since: | 2.0 |
| Usable in events: | level change |
| Return Type: | Number |
The player's progress in reaching the next level, this represents the experience bar in the game. Please note that this value is between 0 and 1 (e.g. 0.5 = half experience bar).
Changing this value can cause the player's level to change if the resulting level progess is negative or larger than 1, e.g.
Changing this value can cause the player's level to change if the resulting level progess is negative or larger than 1, e.g.
increase the player's level progress by 0.5 will make the player gain a level if their progress was more than 50%. Examples:
# use the exp bar as mana
on rightclick with a blaze rod:
player's level progress is larger than 0.2
shoot a fireball from the player
reduce the player's level progress by 0.2
every 2 seconds:
loop all players:
level progress of loop-player is smaller than 0.9:
increase level progress of the loop-player by 0.1
else:
set level progress of the loop-player to 0.99
on xp spawn:
cancel event
on rightclick with a blaze rod:
player's level progress is larger than 0.2
shoot a fireball from the player
reduce the player's level progress by 0.2
every 2 seconds:
loop all players:
level progress of loop-player is smaller than 0.9:
increase level progress of the loop-player by 0.1
else:
set level progress of the loop-player to 0.99
on xp spawn:
cancel event
| Patterns: | |
| Since: | 1.3.4 |
| Return Type: |
Gets the light level at a certain location which ranges from 0 to 15.
It can be separated into sunlight (15 = direct sunlight, 1-14 = indirect) and block light (torches, glowstone, etc.). The total light level of a block is the maximum of the two different light types.
It can be separated into sunlight (15 = direct sunlight, 1-14 = indirect) and block light (torches, glowstone, etc.). The total light level of a block is the maximum of the two different light types.
Examples:
# set vampire players standing in bright sunlight on fire
every 5 seconds:
loop all players:
{vampire::%uuid of loop-player%} is true
sunlight level at the loop-player is greater than 10
ignite the loop-player for 5 seconds
every 5 seconds:
loop all players:
{vampire::%uuid of loop-player%} is true
sunlight level at the loop-player is greater than 10
ignite the loop-player for 5 seconds
| Patterns: |
|
| Since: | 2.7 |
| Return Type: | Text |
An expression to obtain a list of the names of the server's loaded plugins.
Examples:
if the loaded plugins contains "Vault":
broadcast "This server uses Vault plugin!"
send "Plugins (%size of loaded plugins%): %plugins%" to player
broadcast "This server uses Vault plugin!"
send "Plugins (%size of loaded plugins%): %plugins%" to player
| Patterns: |
|
| Since: | 2.0 |
| Return Type: | Location |
The location where an event happened (e.g. at an entity or block), or a location relative to another (e.g. 1 meter above another location).
Examples:
drop 5 apples at the event-location # exactly the same as writing 'drop 5 apples'
set {_loc} to the location 1 meter above the player
set {_loc} to the location 1 meter above the player
| Patterns: |
|
| Since: | 2.0 |
| Return Type: | Location |
The location where an event happened (e.g. at an entity or block), or a location relative to another (e.g. 1 meter above another location).
Examples:
drop 5 apples at the event-location # exactly the same as writing 'drop 5 apples'
set {_loc} to the location 1 meter above the player
set {_loc} to the location 1 meter above the player
| Patterns: | |
| Since: | Unknown |
| Return Type: | Location |
The location of a block or entity. This not only represents the x, y and z coordinates of the location but also includes the world and the direction an entity is looking (e.g. teleporting to a saved location will make the teleported entity face the same saved direction every time).
Please note that the location of an entity is at it's feet, use head location to get the location of the head.
Please note that the location of an entity is at it's feet, use head location to get the location of the head.
Examples:
set {home::%uuid of player%} to the location of the player
message "You home was set to %player's location% in %player's world%."
message "You home was set to %player's location% in %player's world%."
| Patterns: |
|
| Since: | 2.8.0 |
| Return Type: |
Returns the loop's current iteration count (for both normal and while loops).
Examples:
while player is online:
give player 1 stone
wait 5 ticks
if loop-counter > 30:
stop loop
loop {top-balances::*}:
if loop-iteration <= 10:
broadcast "#%loop-iteration% %loop-index% has $%loop-value%"
give player 1 stone
wait 5 ticks
if loop-counter > 30:
stop loop
loop {top-balances::*}:
if loop-iteration <= 10:
broadcast "#%loop-iteration% %loop-index% has $%loop-value%"
| Patterns: |
|
| Since: | 1.0, 2.8.0 (loop-counter), 2.10 (previous, next) |
| Return Type: | Object |
Returns the previous, current, or next looped value.
Examples:
# Countdown
loop 10 times:
message "%11 - loop-number%"
wait a second
# Generate a 10x10 floor made of randomly colored wool below the player
loop blocks from the block below the player to the block 10 east of the block below the player:
loop blocks from the loop-block to the block 10 north of the loop-block:
set loop-block-2 to any wool
loop {top-balances::*}:
loop-iteration <= 10
send "#%loop-iteration% %loop-index% has $%loop-value%"
loop shuffled (integers between 0 and 8):
if all:
previous loop-value = 1
loop-value = 4
next loop-value = 8
then:
kill all players
loop 10 times:
message "%11 - loop-number%"
wait a second
# Generate a 10x10 floor made of randomly colored wool below the player
loop blocks from the block below the player to the block 10 east of the block below the player:
loop blocks from the loop-block to the block 10 north of the loop-block:
set loop-block-2 to any wool
loop {top-balances::*}:
loop-iteration <= 10
send "#%loop-iteration% %loop-index% has $%loop-value%"
loop shuffled (integers between 0 and 8):
if all:
previous loop-value = 1
loop-value = 4
next loop-value = 8
then:
kill all players
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | MC 1.16+ |
| Return Type: | Item |
The loot that will be generated in a 'loot generate' event.
Examples:
on loot generate:
chance of %10
add 64 diamonds to loot
send "You hit the jackpot!!"
chance of %10
add 64 diamonds to loot
send "You hit the jackpot!!"
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Loot Context |
The loot context involved in the context create section.
Examples:
set {_context} to a new loot context at {_location}:
broadcast loot context
broadcast loot context
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Location |
Returns the loot location of a loot context.
Examples:
set {_player} to player
set {_context} to a loot context at player:
if {_player} is in "world_nether":
set loot location to location of last spawned pig
send loot location of {_context} to player
set {_context} to a loot context at player:
if {_player} is in "world_nether":
set loot location to location of last spawned pig
send loot location of {_context} to player
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Loot Table |
Returns the loot table of an entity or block.
Setting the loot table of a block will update the block state, and once opened will generate loot of the specified loot table. Please note that doing so may cause warnings in the console due to over-filling the chest.
Please note that resetting/deleting the loot table of an ENTITY will reset the entity's loot table to its default.
Setting the loot table of a block will update the block state, and once opened will generate loot of the specified loot table. Please note that doing so may cause warnings in the console due to over-filling the chest.
Please note that resetting/deleting the loot table of an ENTITY will reset the entity's loot table to its default.
Examples:
set loot table of event-entity to "minecraft:entities/ghast"
# this will set the loot table of the entity to a ghast's loot table, thus dropping ghast tears and gunpowder
set loot table of event-block to "minecraft:chests/simple_dungeon"
# this will set the loot table of the entity to a ghast's loot table, thus dropping ghast tears and gunpowder
set loot table of event-block to "minecraft:chests/simple_dungeon"
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Loot Table |
Returns the loot table from a namespaced key.
Examples:
set {_table} to loot table "minecraft:chests/simple_dungeon"
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Item |
Returns the items of a loot table using a loot context. Not specifying a loot context will use a loot context with a location at the world's origin.
Examples:
set {_items::*} to loot items of the loot table "minecraft:chests/simple_dungeon" with loot context {_context}
# this will set {_items::*} to the items that would be dropped from the simple dungeon loot table with the given loot context
give player loot items of entity's loot table with loot context {_context}
# this will give the player the items that the entity would drop with the given loot context
# this will set {_items::*} to the items that would be dropped from the simple dungeon loot table with the given loot context
give player loot items of entity's loot table with loot context {_context}
# this will give the player the items that the entity would drop with the given loot context
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Entity |
Returns the looted entity of a loot context.
Examples:
set {_entity} to looted entity of {_context}
set {_context} to a loot context at player:
set loot luck value to 10
set looter to player
set looted entity to last spawned pig
set {_context} to a loot context at player:
set loot luck value to 10
set looter to player
set looted entity to last spawned pig
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Player |
Returns the looter of a loot context. Note that setting the looter will read the looter's tool enchantments (e.g. looting) when generating loot.
Examples:
set {_killer} to looter of {_context}
set {_context} to a loot context at player:
set loot luck value to 10
set looter to player
set looted entity to last spawned pig
set {_context} to a loot context at player:
set loot luck value to 10
set looter to player
set looted entity to last spawned pig
| Patterns: |
|
| Since: | 2.1 |
| Return Type: | Text |
An item's lore.
Examples:
set the 1st line of the item's lore to "<orange>Excalibur 2.0"
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Timespan |
The amount of time the animals have been in love for. Using a value of 30 seconds is equivalent to using an item to breed them.
Only works on animals that can be bred and returns '0 seconds' for animals that can't be bred.
Only works on animals that can be bred and returns '0 seconds' for animals that can't be bred.
Examples:
on right click:
send "%event-entity% has been in love for %love time of event-entity% more than you!" to player
send "%event-entity% has been in love for %love time of event-entity% more than you!" to player
| Patterns: | |
| Since: | 2.2-dev34, 2.9.0 (lowest solid block, 'non-air' option removed, additional syntax option) |
| Return Type: | Block |
An expression to obtain the lowest or highest solid (impassable) block at a location.
Note that the y-coordinate of the location is not taken into account for this expression.
Note that the y-coordinate of the location is not taken into account for this expression.
Examples:
teleport the player to the block above the highest block at the player
set the highest solid block at the player's location to the lowest solid block at the player's location
set the highest solid block at the player's location to the lowest solid block at the player's location
| Patterns: |
|
| Since: | 2.10 |
| Return Type: |
Returns the luck of a loot context as a float. This represents the luck potion effect that an entity can have.
Examples:
set {_luck} to loot luck value of {_context}
set {_context} to a loot context at player:
set loot luck value to 10
set looter to player
set looted entity to last spawned pig
set {_context} to a loot context at player:
set loot luck value to 10
set looter to player
set looted entity to last spawned pig
| Patterns: |
|
| Since: | 2.3 |
| Return Type: | Text |
The message of the day in the server list. This can be changed in a server list ping event only.
'default MOTD' returns the default MOTD always and can't be changed.
'default MOTD' returns the default MOTD always and can't be changed.
Examples:
on server list ping:
set the motd to "Join now!"
set the motd to "Join now!"
| Patterns: |
|
| Since: | 2.5, 2.9.0 (change) |
| Requirements: | Minecraft 1.20.5+ (custom amount) |
| Return Type: |
The maximum durability of an item. Changing requires Minecraft 1.20.5+
Note: 'delete' will remove the max durability from the item (making it a non-damageable item). Delete requires Paper 1.21+
Note: 'delete' will remove the max durability from the item (making it a non-damageable item). Delete requires Paper 1.21+
Examples:
maximum durability of diamond sword
if max durability of player's tool is not 0: # Item is damageable
set max durability of player's tool to 5000
add 5 to max durability of player's tool
reset max durability of player's tool
delete max durability of player's tool
if max durability of player's tool is not 0: # Item is damageable
set max durability of player's tool to 5000
add 5 to max durability of player's tool
reset max durability of player's tool
delete max durability of player's tool
| Patterns: |
|
| Since: | 2.0 |
| Usable in events: | damage, death |
| Return Type: | Number |
The maximum health of an entity, e.g. 10 for a player.
Examples:
on join:
set the maximum health of the player to 100
spawn a giant
set the last spawned entity's max health to 1000
set the maximum health of the player to 100
spawn a giant
set the last spawned entity's max health to 1000
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper |
| Return Type: | Timespan |
Returns the max duration an item can be used for before the action completes. E.g. it takes 1.6 seconds to drink a potion, or 1.4 seconds to load an unenchanted crossbow.
Some items, like bows and shields, do not have a limit to their use. They will return 1 hour.
Some items, like bows and shields, do not have a limit to their use. They will return 1 hour.
Examples:
on right click:
broadcast max usage duration of player's tool
broadcast max usage duration of player's tool
| Patterns: |
|
| Since: | 2.3, 2.7 (modify max real players) |
| Requirements: | Paper 1.16+ (modify max real players) |
| Return Type: |
The count of max players. This can be changed in a server list ping event only.
'real max players' returns the real count of max players of the server and can be modified on Paper 1.16 or later.
'real max players' returns the real count of max players of the server and can be modified on Paper 1.16 or later.
Examples:
on server list ping:
set the max players count to (online players count + 1)
set the max players count to (online players count + 1)
| Patterns: | |
| Since: | 2.7 |
| Return Type: | Timespan |
The maximum amount of time an entity can spend in powdered snow before taking damage.
Examples:
difference between player's freeze time and player's max freeze time is less than 1 second:
send "you're about to freeze!" to the player
send "you're about to freeze!" to the player
| Patterns: |
|
| Since: | 2.1, 2.10 (changeable, inventories) |
| Requirements: | Spigot 1.20.5+ (changeable) |
| Return Type: |
The maximum stack size of an item (e.g. 64 for torches, 16 for buckets, 1 for swords, etc.) or inventory.
In 1.20.5+, the maximum stack size of items can be changed to any integer from 1 to 99, and stacked up to the maximum stack size of the inventory they're in.
In 1.20.5+, the maximum stack size of items can be changed to any integer from 1 to 99, and stacked up to the maximum stack size of the inventory they're in.
Examples:
send "You can hold %max stack size of player's tool% of %type of player's tool% in a slot." to player
set the maximum stack size of inventory of all players to 16
add 8 to the maximum stack size of player's tool
reset the maximum stack size of {_gui}
set the maximum stack size of inventory of all players to 16
add 8 to the maximum stack size of player's tool
reset the maximum stack size of {_gui}
| Patterns: |
|
| Since: | 2.1.1 |
| Return Type: | Player |
A 'me' expression that can be used in players' effect commands only.
Examples:
!heal me
!kick myself
!give a diamond axe to me
!kick myself
!give a diamond axe to me
| Patterns: |
|
| Since: | 2.5.1 |
| Return Type: |
The number of durability points an item is to be repaired in a mending event.
Modifying the repair amount will affect how much experience is given to the player after mending.
Modifying the repair amount will affect how much experience is given to the player after mending.
Examples:
on item mend:
set the mending repair amount to 100
set the mending repair amount to 100
| Patterns: |
|
| Since: | 1.4.6 (chat message), 1.4.9 (join & quit messages), 2.0 (death message), 2.9.0 (clear message), 2.10 (broadcasted message) |
| Usable in events: | chat, join, quit, death, broadcast |
| Return Type: | Text |
The (chat) message of a chat event, the join message of a join event, the quit message of a quit event, the death message of a death event or the broadcasted message in a broadcast event. This expression is mostly useful for being changed.
Examples:
on chat:
player has permission "admin"
set message to "&c%message%"
on first join:
set join message to "Welcome %player% to our awesome server!"
on join:
player has played before
set join message to "Welcome back, %player%!"
on quit:
if {vanish::%player's uuid%} is set:
clear quit message
else:
set quit message to "%player% left this awesome server!"
on death:
set the death message to "%player% died!"
on broadcast:
set broadcast message to "&a[BROADCAST] %broadcast message%"
player has permission "admin"
set message to "&c%message%"
on first join:
set join message to "Welcome %player% to our awesome server!"
on join:
player has played before
set join message to "Welcome back, %player%!"
on quit:
if {vanish::%player's uuid%} is set:
clear quit message
else:
set quit message to "%player% left this awesome server!"
on death:
set the death message to "%player% died!"
on broadcast:
set broadcast message to "&a[BROADCAST] %broadcast message%"
| Patterns: |
|
| Since: | 2.2-dev36, 2.10 (add, remove) |
| Return Type: | Object |
Metadata is a way to store temporary data on entities, blocks and more that disappears after a server restart.
Examples:
set metadata value "healer" of player to true
broadcast "%metadata value ""healer"" of player%"
clear metadata value "healer" of player
broadcast "%metadata value ""healer"" of player%"
clear metadata value "healer" of player
| Patterns: | |
| Since: | 2.6.1 |
| Return Type: | Location |
Returns the middle/center of a location. In other words, returns the middle of the X, Z coordinates and the floor value of the Y coordinate of a location.
Examples:
command /stuck:
executable by: players
trigger:
teleport player to the center of player's location
send "You're no longer stuck."
executable by: players
trigger:
teleport player to the center of player's location
send "You're no longer stuck."
| Patterns: | |
| Since: | 2.5.1 |
| Return Type: | Vector |
The velocity of a minecart as soon as it has been derailed or as soon as it starts flying.
Examples:
on right click on minecart:
set derailed velocity of event-entity to vector 2, 10, 2
set derailed velocity of event-entity to vector 2, 10, 2
| Patterns: |
|
| Since: | 2.0, 2.5 (offline players) |
| Requirements: | Vault, an economy plugin that supports Vault |
| Return Type: | Money |
How much virtual money a player has (can be changed).
Examples:
message "You have %player's money%" # the currency name will be added automatically
remove 20$ from the player's balance # replace '$' by whatever currency you use
add 200 to the player's account # or omit the currency altogether
remove 20$ from the player's balance # replace '$' by whatever currency you use
add 200 to the player's account # or omit the currency altogether
| Patterns: | |
| Since: | 2.7 |
| Requirements: | Paper 1.16+ |
| Return Type: | Moon Phase |
The current moon phase of a world.
Examples:
if moon phase of player's world is full moon:
send "Watch for the wolves!"
send "Watch for the wolves!"
| Patterns: |
|
| Since: | 2.2-dev27 |
| Return Type: | Block |
Blocks which are moved in a piston event. Cannot be used outside of piston events.
Examples:
the moved blocks
| Patterns: |
|
| Since: | before 2.1 2.2-dev20 (inventory name) 2.4 (non-living entity support, changeable inventory name) 2.7 (worlds) |
| Return Type: | Text |
Represents the Minecraft account, display or tab list name of a player, or the custom name of an item, entity, block, inventory, gamerule, world, script or function.
Players:
Name: The Minecraft account name of the player. Can't be changed, but 'display name' can be changed.
Display Name: The name of the player that is displayed in messages. This name can be changed freely and can include color codes, and is shared among all plugins (e.g. chat plugins will use the display name).
Entities:
Name: The custom name of the entity. Can be changed. But for living entities, the players will have to target the entity to see its name tag. For non-living entities, the name will not be visible at all. To prevent this, use 'display name'.
Display Name: The custom name of the entity. Can be changed, which will also enable custom name visibility of the entity so name tag of the entity will be visible always.
Items:
Name and Display Name: The custom name of the item (not the Minecraft locale name). Can be changed.
Inventories:
Name and Display Name: The name/title of the inventory. Changing name of an inventory means opening the same inventory with the same contents but with a different name to its current viewers.
Gamerules:
Name: The name of the gamerule. Cannot be changed.
Worlds:
Name: The name of the world. Cannot be changed.
Scripts:
Name: The name of a script, excluding its file extension.
Players:
Name: The Minecraft account name of the player. Can't be changed, but 'display name' can be changed.
Display Name: The name of the player that is displayed in messages. This name can be changed freely and can include color codes, and is shared among all plugins (e.g. chat plugins will use the display name).
Entities:
Name: The custom name of the entity. Can be changed. But for living entities, the players will have to target the entity to see its name tag. For non-living entities, the name will not be visible at all. To prevent this, use 'display name'.
Display Name: The custom name of the entity. Can be changed, which will also enable custom name visibility of the entity so name tag of the entity will be visible always.
Items:
Name and Display Name: The custom name of the item (not the Minecraft locale name). Can be changed.
Inventories:
Name and Display Name: The name/title of the inventory. Changing name of an inventory means opening the same inventory with the same contents but with a different name to its current viewers.
Gamerules:
Name: The name of the gamerule. Cannot be changed.
Worlds:
Name: The name of the world. Cannot be changed.
Scripts:
Name: The name of a script, excluding its file extension.
Examples:
on join:
player has permission "name.red"
set the player's display name to "<red>[admin] <gold>%name of player%"
set the player's tab list name to "<green>%player's name%"
set the name of the player's tool to "Legendary Sword of Awesomeness"
player has permission "name.red"
set the player's display name to "<red>[admin] <gold>%name of player%"
set the player's tab list name to "<green>%player's name%"
set the name of the player's tool to "Legendary Sword of Awesomeness"
| Patterns: |
|
| Since: | 2.0, 2.2-dev34 (inventories) |
| Return Type: | Object |
Directly names an item/inventory, useful for defining a named item/inventory in a script. If you want to (re)name existing items/inventories you can either use this expression or use
set name of <item/inventory> to <text>. Examples:
give a diamond sword of sharpness 100 named "<gold>Excalibur" to the player
set tool of player to the player's tool named "<gold>Wand"
set the name of the player's tool to "<gold>Wand"
open hopper inventory named "Magic Hopper" to player
set tool of player to the player's tool named "<gold>Wand"
set the name of the player's tool to "<gold>Wand"
open hopper inventory named "Magic Hopper" to player
| Patterns: |
|
| Since: | 2.7 |
| Return Type: | Entity |
Gets the entity nearest to a location or another entity.
Examples:
kill the nearest pig and cow relative to player
teleport player to the nearest cow relative to player
teleport player to the nearest entity relative to player
on click:
kill nearest pig
teleport player to the nearest cow relative to player
teleport player to the nearest entity relative to player
on click:
kill nearest pig
| Patterns: |
|
| Since: | 2.5 |
| Return Type: | Text |
Returns a line break separator.
Examples:
send "Hello%nl%Goodbye!" to player
| Patterns: |
|
| Since: | 2.5 |
| Return Type: |
The number of ticks that an entity is invulnerable to damage for.
Examples:
on damage:
set victim's invulnerability ticks to 20 #Victim will not take damage for the next second
set victim's invulnerability ticks to 20 #Victim will not take damage for the next second
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Node |
Returns a node inside a config (or another section-node).
Nodes in Skript configs are written in the format `key: value`.
Section nodes can contain other nodes.
Nodes in Skript configs are written in the format `key: value`.
Section nodes can contain other nodes.
Examples:
set {_node} to node "language" in the skript config if text value of {_node} is "french": broadcast "Bonjour!"
set {_script} to the current script loop nodes of the current script: broadcast name of loop-value
set {_script} to the current script loop nodes of the current script: broadcast name of loop-value
| Patterns: |
|
| Since: | 1.4 |
| Return Type: | Date |
Examples:
broadcast "Current server time: %now%"
| Patterns: | |
| Since: | 2.5 |
| Return Type: |
The number of uppercase, lowercase, or digit characters in a string.
Examples:
#Simple Chat Filter
on chat:
if number of uppercase chars in message / length of message > 0.5
cancel event
send "<red>Your message has to many caps!" to player
on chat:
if number of uppercase chars in message / length of message > 0.5
cancel event
send "<red>Your message has to many caps!" to player
| Patterns: | |
| Since: | 1.4.6 (integers & numbers), 2.5.1 (decimals) |
| Return Type: | Number |
All numbers between two given numbers, useful for looping.
Use 'numbers' if your start is not an integer and you want to keep the fractional part of the start number constant, or use 'integers' if you only want to loop integers.
You may also use 'decimals' if you want to use the decimal precision of the start number.
You may want to use the 'times' expression instead, for instance 'loop 5 times:'
Use 'numbers' if your start is not an integer and you want to keep the fractional part of the start number constant, or use 'integers' if you only want to loop integers.
You may also use 'decimals' if you want to use the decimal precision of the start number.
You may want to use the 'times' expression instead, for instance 'loop 5 times:'
Examples:
loop numbers from 2.5 to 5.5: # loops 2.5, 3.5, 4.5, 5.5
loop integers from 2.9 to 5.1: # same as '3 to 5', i.e. loops 3, 4, 5
loop decimals from 3.94 to 4: # loops 3.94, 3.95, 3.96, 3.97, 3.98, 3.99, 4
loop integers from 2.9 to 5.1: # same as '3 to 5', i.e. loops 3, 4, 5
loop decimals from 3.94 to 4: # loops 3.94, 3.95, 3.96, 3.97, 3.98, 3.99, 4
| Patterns: |
|
| Since: | 2.2-dev35 |
| Return Type: | Offline Player |
All players that have ever joined the server. This includes the players currently online.
Examples:
send "Size of all players who have joined the server: %size of all offline players%"
| Patterns: |
|
| Since: | 2.3 |
| Requirements: | Paper (fake count) |
| Return Type: |
The amount of online players. This can be changed in a server list ping event only to show fake online player amount.
real online player count always return the real count of online players and can't be changed. Examples:
on server list ping:
# This will make the max players count 5 if there are 4 players online.
set the fake max players count to (online player count + 1)
# This will make the max players count 5 if there are 4 players online.
set the fake max players count to (online player count + 1)
| Patterns: | |
| Since: | 2.2-dev24, 2.2-dev35 (Just 'current inventory' works in player events) |
| Return Type: | Inventory |
Return the currently opened inventory of a player.
If no inventory is open, it returns the own player's crafting inventory.
If no inventory is open, it returns the own player's crafting inventory.
Examples:
set slot 1 of player's current inventory to diamond sword
| Patterns: | |
| Since: | 2.0 |
| Return Type: | Object |
Parses text as a given type, or as a given pattern.
This expression can be used in two different ways: One which parses the entire text as a single instance of a type, e.g. as a number, and one that parses the text according to a pattern.
If the given text could not be parsed, this expression will return nothing and the parse error will be set if some information is available.
Some notes about parsing with a pattern:
- The pattern must be a Skript pattern, e.g. percent signs are used to define where to parse which types, e.g. put a %number% or %items% in the pattern if you expect a number or some items there.
- You have to save the expression's value in a list variable, e.g.
- The list variable will contain the parsed values from all %types% in the pattern in order. If a type was plural, e.g. %items%, the variable's value at the respective index will be a list variable, e.g. the values will be stored in {parsed::1::*}, not {parsed::1}.
This expression can be used in two different ways: One which parses the entire text as a single instance of a type, e.g. as a number, and one that parses the text according to a pattern.
If the given text could not be parsed, this expression will return nothing and the parse error will be set if some information is available.
Some notes about parsing with a pattern:
- The pattern must be a Skript pattern, e.g. percent signs are used to define where to parse which types, e.g. put a %number% or %items% in the pattern if you expect a number or some items there.
- You have to save the expression's value in a list variable, e.g.
set {parsed::*} to message parsed as "...".- The list variable will contain the parsed values from all %types% in the pattern in order. If a type was plural, e.g. %items%, the variable's value at the respective index will be a list variable, e.g. the values will be stored in {parsed::1::*}, not {parsed::1}.
Examples:
set {var} to line 1 parsed as number
on chat:
set {var::*} to message parsed as "buying %items% for %money%"
if parse error is set:
message "%parse error%"
else if {var::*} is set:
cancel event
remove {var::2} from the player's balance
give {var::1::*} to the player
on chat:
set {var::*} to message parsed as "buying %items% for %money%"
if parse error is set:
message "%parse error%"
else if {var::*} is set:
cancel event
remove {var::2} from the player's balance
give {var::1::*} to the player
| Patterns: |
|
| Since: | 2.0 |
| Return Type: | Text |
The error which caused the last parse operation to fail, which might not be set if a pattern was used and the pattern didn't match the provided text at all.
Examples:
set {var} to line 1 parsed as integer
if {var} is not set:
parse error is set:
message "<red>Line 1 is invalid: %last parse error%"
else:
message "<red>Please put an integer on line 1!"
if {var} is not set:
parse error is set:
message "<red>Line 1 is invalid: %last parse error%"
else:
message "<red>Please put an integer on line 1!"
| Patterns: | |
| Since: | 2.0, 2.2-dev26 (Multiple passengers for 1.11.2+) |
| Return Type: | Entity |
The passenger of a vehicle, or the rider of a mob.
For 1.11.2 and above, it returns a list of passengers and you can use all changers in it.
See also: vehicle
For 1.11.2 and above, it returns a list of passengers and you can use all changers in it.
See also: vehicle
Examples:
#for 1.11 and lower
passenger of the minecart is a creeper or a cow
the saddled pig's passenger is a player
#for 1.11.2+
passengers of the minecart contains a creeper or a cow
the boat's passenger contains a pig
add a cow and a zombie to passengers of last spawned boat
set passengers of player's vehicle to a pig and a horse
remove all pigs from player's vehicle
clear passengers of boat
passenger of the minecart is a creeper or a cow
the saddled pig's passenger is a player
#for 1.11.2+
passengers of the minecart contains a creeper or a cow
the boat's passenger contains a pig
add a cow and a zombie to passengers of last spawned boat
set passengers of player's vehicle to a pig and a horse
remove all pigs from player's vehicle
clear passengers of boat
| Patterns: | |
| Since: | 2.8.0 |
| Return Type: | Number |
Returns a percentage of one or more numbers.
Examples:
set damage to 10% of victim's health
set damage to 125 percent of damage
set {_result} to {_percent} percent of 999
set {_result::*} to 10% of {_numbers::*}
set experience to 50% of player's total experience
set damage to 125 percent of damage
set {_result} to {_percent} percent of 999
set {_result::*} to 10% of {_numbers::*}
set experience to 50% of player's total experience
| Patterns: |
|
| Since: | 2.7 |
| Return Type: |
Returns the mathematical constant pi. (approx. 3.1415926535)
Examples:
set {_tau} to pi * 2
| Patterns: | |
| Since: | 2.2-dev36 |
| Return Type: |
Pings of players, as Minecraft server knows them. Note that they will almost certainly be different from the ones you'd get from using ICMP echo requests. This expression is only supported on some server software (PaperSpigot).
Examples:
command /ping <player=%player%>:
trigger:
send "%arg-1%'s ping is %arg-1's ping%"
trigger:
send "%arg-1%'s ping is %arg-1's ping%"
| Patterns: |
|
| Since: | 2.6 |
| Return Type: | Item Type |
A plain item is an item with no modifications. It can be used to convert items to their default state or to match with other default items.
Examples:
if the player's tool is a plain diamond: # check if player's tool has no modifications
send "You are holding a plain diamond!"
send "You are holding a plain diamond!"
| Patterns: | |
| Since: | 2.10 |
| Requirements: | Spigot 1.19+ |
| Return Type: | Text |
The custom chat completion suggestions. You can add, set, remove, and clear them. Removing the names of online players with this expression is ineffective.
This expression will not return anything due to Bukkit limitations.
This expression will not return anything due to Bukkit limitations.
Examples:
add "Skript" and "Njol" to chat completions of all players
remove "text" from {_p}'s chat completions
clear player's chat completions
remove "text" from {_p}'s chat completions
clear player's chat completions
| Patterns: | |
| Since: | 2.6.2 |
| Requirements: | Paper 1.12.2 or newer |
| Return Type: |
Player's protocol version. For more information and list of protocol versions visit wiki.vg.
Examples:
command /protocolversion <player>:
trigger:
send "Protocol version of %arg-1%: %protocol version of arg-1%"
trigger:
send "Protocol version of %arg-1%: %protocol version of arg-1%"
| Patterns: |
|
| Since: | 2.0 |
| Return Type: | Item Type |
Gets a skull item representing a player. Skulls for other entities are provided by the aliases.
Examples:
give the victim's skull to the attacker
set the block at the entity to the entity's skull
set the block at the entity to the entity's skull
| Patterns: | |
| Since: | 2.2-dev34 |
| Return Type: | Weather Type |
The weather for a player.
Examples:
set weather of arg-player to rainy
reset player's weather
if arg-player's weather is rainy
reset player's weather
if arg-player's weather is rainy
| Patterns: |
|
| Since: | 2.4 |
| Usable in events: | portal_create |
| Return Type: | Block |
The blocks associated with a portal in the portal creation event.
Examples:
on portal creation:
loop portal blocks:
broadcast "%loop-block% is part of a portal!"
loop portal blocks:
broadcast "%loop-block% is part of a portal!"
| Patterns: | |
| Since: | 2.8.0 |
| Return Type: | Timespan |
The amount of time before an entity can use a portal. By default, it is 15 seconds after exiting a nether portal or end gateway.
Players in survival/adventure get a cooldown of 0.5 seconds, while those in creative get no cooldown.
Resetting will set the cooldown back to the default 15 seconds for non-player entities and 0.5 seconds for players.
Players in survival/adventure get a cooldown of 0.5 seconds, while those in creative get no cooldown.
Resetting will set the cooldown back to the default 15 seconds for non-player entities and 0.5 seconds for players.
Examples:
on portal:
wait 1 tick
set portal cooldown of event-entity to 5 seconds
wait 1 tick
set portal cooldown of event-entity to 5 seconds
| Patterns: |
|
| Since: | 2.5.2 |
| Return Type: | Potion Effect |
Create a new potion effect to apply to an entity or item type. Do note that when applying potion effects
to tipped arrows/lingering potions, Minecraft reduces the timespan.
to tipped arrows/lingering potions, Minecraft reduces the timespan.
Examples:
set {_p} to potion effect of speed of tier 1 without particles for 10 minutes
add {_p} to potion effects of player's tool
add {_p} to potion effects of target entity
add potion effect of speed 1 to potion effects of player
add {_p} to potion effects of player's tool
add {_p} to potion effects of target entity
add potion effect of speed 1 to potion effects of player
| Patterns: |
|
| Since: | 2.7 |
| Return Type: |
An expression to obtain the amplifier of a potion effect applied to an entity.
Examples:
if the amplifier of haste of player >= 3:
| Patterns: |
|
| Since: | 2.5.2 |
| Return Type: | Potion Effect |
Represents the active potion effects of entities and itemtypes.
You can clear all potion effects of an entity/itemtype and add/remove a potion effect/type to/from an entity/itemtype.
Do note you will not be able to clear the base potion effects of a potion item. In that case, just set the item to a water bottle.
When adding a potion effect type (rather than a potion effect), it will default to 15 seconds with tier 1.
You can clear all potion effects of an entity/itemtype and add/remove a potion effect/type to/from an entity/itemtype.
Do note you will not be able to clear the base potion effects of a potion item. In that case, just set the item to a water bottle.
When adding a potion effect type (rather than a potion effect), it will default to 15 seconds with tier 1.
Examples:
set {_p::*} to active potion effects of player
clear all the potion effects of player
clear all the potion effects of player's tool
add potion effects of player to potion effects of player's tool
add speed to potion effects of target entity
remove speed and night vision from potion effects of player
clear all the potion effects of player
clear all the potion effects of player's tool
add potion effects of player to potion effects of player's tool
add speed to potion effects of target entity
remove speed and night vision from potion effects of player
| Patterns: | |
| Since: | 2.0, 2.10 (delete) |
| Requirements: | Vault, a chat plugin that supports Vault |
| Return Type: | Text |
The prefix or suffix as defined in the server's chat plugin.
Examples:
on chat:
cancel event
broadcast "%player's prefix%%player's display name%%player's suffix%: %message%" to the player's world
set the player's prefix to "[<red>Admin<reset>] "
clear player's prefix
cancel event
broadcast "%player's prefix%%player's display name%%player's suffix%: %message%" to the player's world
set the player's prefix to "[<red>Admin<reset>] "
clear player's prefix
| Patterns: |
|
| Since: | 2.5.1 |
| Return Type: | Boolean |
A projectile's critical state. The only currently accepted projectiles are arrows and tridents.
Examples:
on shoot:
event-projectile is an arrow
set projectile critical mode of event-projectile to true
event-projectile is an arrow
set projectile critical mode of event-projectile to true
| Patterns: |
|
| Since: | 2.3 |
| Usable in events: | server list ping |
| Requirements: | Paper 1.12.2 or newer |
| Return Type: |
The protocol version that will be sent as the protocol version of the server in a server list ping event. For more information and list of protocol versions visit wiki.vg.
If this protocol version doesn't match with the protocol version of the client, the client will see the version string.
But please note that, this expression has no visual effect over the version string. For example if the server uses PaperSpigot 1.12.2, and you make the protocol version 107 (1.9),
the version string will not be "Paper 1.9", it will still be "Paper 1.12.2".
But then you can customize the version string as you wish.
Also if the protocol version of the player is higher than protocol version of the server, it will say
"Server out of date!", and if vice-versa "Client out of date!" when you hover on the ping bars.
This can be set in a server list ping event only
(increase and decrease effects cannot be used because that wouldn't make sense).
If this protocol version doesn't match with the protocol version of the client, the client will see the version string.
But please note that, this expression has no visual effect over the version string. For example if the server uses PaperSpigot 1.12.2, and you make the protocol version 107 (1.9),
the version string will not be "Paper 1.9", it will still be "Paper 1.12.2".
But then you can customize the version string as you wish.
Also if the protocol version of the player is higher than protocol version of the server, it will say
"Server out of date!", and if vice-versa "Client out of date!" when you hover on the ping bars.
This can be set in a server list ping event only
(increase and decrease effects cannot be used because that wouldn't make sense).
Examples:
on server list ping:
set the version string to "<light green>Version: <orange>%minecraft version%"
set the protocol version to 0 # 13w41a (1.7) - so the player will see the custom version string almost always
set the version string to "<light green>Version: <orange>%minecraft version%"
set the protocol version to 0 # 13w41a (1.7) - so the player will see the custom version string almost always
| Patterns: |
|
| Since: | 2.10 (experimental) |
| Return Type: | Queue |
Requires the
using queues experimental feature flag to be enabled.Creates a new queue. A queue is a set of elements that can have things removed from the start and added to the end.
Any value can be added to a queue. Adding a non-existent value (e.g. `{variable that isn't set}`) will have no effect. This means that removing an element from the queue will always return a value unless the queue is empty.
Requesting an element from a queue (e.g. `the 1st element of {queue}`) also removes it from the queue.
Examples:
set {queue} to a new queue add "hello" and "there" to {queue} broadcast the first element of {queue} # hello broadcast the first element of {queue} # there # queue is now empty
set {queue} to a new queue of "hello" and "there" broadcast the last element of {queue} # removes 'there' add "world" to {queue} broadcast the first 2 elements of {queue} # removes 'hello', 'world'
set {queue} to a new queue of "hello" and "there" broadcast the last element of {queue} # removes 'there' add "world" to {queue} broadcast the first 2 elements of {queue} # removes 'hello', 'world'
| Patterns: | |
| Since: | 2.10 (experimental) |
| Return Type: | Object |
Requires the
using queues experimental feature flag to be enabled.The first or last element in a queue. Asking for this does not remove the element from the queue.
This is designed for use with the add changer: to add or remove elements from the start or the end of the queue.
Examples:
set {queue} to a new queue add "hello" to {queue} add "foo" to the start of {queue} broadcast the first element of {queue} # foo broadcast the first element of {queue} # hello # queue is now empty
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper 1.16.5+ |
| Return Type: | Quit Reason |
The quit reason as to why a player disconnected in a quit event.
Examples:
on quit:
quit reason was kicked
player is banned
clear {server::player::%uuid of player%::*}
quit reason was kicked
player is banned
clear {server::player::%uuid of player%::*}
| Patterns: | |
| Since: | 2.8.0 |
| Return Type: | Text |
One or more random characters between two given characters. Use 'alphanumeric' if you want only alphanumeric characters.
This expression uses the Unicode numerical code of a character to determine which characters are between the two given characters.
If strings of more than one character are given, only the first character of each is used.
This expression uses the Unicode numerical code of a character to determine which characters are between the two given characters.
If strings of more than one character are given, only the first character of each is used.
Examples:
set {_captcha} to join (5 random characters between "a" and "z") with ""
send 3 random alphanumeric characters between "0" and "z"
send 3 random alphanumeric characters between "0" and "z"
| Patterns: | |
| Since: | 1.4, 2.10 (Multiple random numbers) |
| Return Type: | Number |
A given amount of random numbers or integers between two given numbers. Use 'number' if you want any number with decimal parts, or use use 'integer' if you only want whole numbers.
Please note that the order of the numbers doesn't matter, i.e.
Please note that the order of the numbers doesn't matter, i.e.
random number between 2 and 1 will work as well as random number between 1 and 2. Examples:
set the player's health to a random number between 5 and 10
send "You rolled a %random integer from 1 to 6%!" to the player
set {_chances::*} to 5 random integers between 5 and 96
set {_decimals::*} to 3 random numbers between 2.7 and -1.5
send "You rolled a %random integer from 1 to 6%!" to the player
set {_chances::*} to 5 random integers between 5 and 96
set {_decimals::*} to 3 random numbers between 2.7 and -1.5
| Patterns: |
|
| Since: | 2.5.1 |
| Return Type: | Text |
Returns a random UUID.
Examples:
set {_uuid} to random uuid
| Patterns: |
|
| Since: | unknown (2.2) |
| Return Type: | Text |
The raw Minecraft material name of the given item. Note that this is not guaranteed to give same results on all servers.
Examples:
raw name of tool of player
| Patterns: |
|
| Since: | 2.8.0 |
| Usable in events: | ready arrow |
| Return Type: | Item |
The bow or arrow in a Ready Arrow event.
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: | 2.1 |
| Requirements: | Supported regions plugin |
| Return Type: | Offline Player |
A list of members or owners of a region.
This expression requires a supported regions plugin to be installed.
This expression requires a supported regions plugin to be installed.
Examples:
on entering of a region:
message "You're entering %region% whose owners are %owners of region%"
message "You're entering %region% whose owners are %owners of region%"
| Patterns: | |
| Since: | 2.1 |
| Requirements: | Supported regions plugin |
| Return Type: | Region |
All regions at a particular location.
This expression requires a supported regions plugin to be installed.
This expression requires a supported regions plugin to be installed.
Examples:
On click on a sign:
line 1 of the clicked block is "[region info]"
set {_regions::*} to regions at the clicked block
if {_regions::*} is empty:
message "No regions exist at this sign."
else:
message "Regions containing this sign: <gold>%{_regions::*}%<r>."
line 1 of the clicked block is "[region info]"
set {_regions::*} to regions at the clicked block
if {_regions::*} is empty:
message "No regions exist at this sign."
else:
message "Regions containing this sign: <gold>%{_regions::*}%<r>."
| Patterns: |
|
| Since: | 2.0 |
| Return Type: | Timespan |
How much time a player has left underwater before starting to drown.
Examples:
if the player's remaining air is less than 3 seconds:
send "hurry, get to the surface!" to the player
send "hurry, get to the surface!" to the player
| Patterns: | |
| Since: | 2.9.0 |
| Requirements: | Spigot 1.19.4+ |
| Return Type: | Timespan |
Returns the resonating time of a bell.
A bell will start resonating five game ticks after being rung, and will continue to resonate for 40 game ticks.
A bell will start resonating five game ticks after being rung, and will continue to resonate for 40 game ticks.
Examples:
broadcast "The bell has been resonating for %resonating time of target block%"
| Patterns: |
|
| Since: | 2.2-dev35 |
| Return Type: | Location |
The location that a player should respawn at. This is used within the respawn event.
Examples:
on respawn:
set respawn location to {example::spawn}
set respawn location to {example::spawn}
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Object |
Runs something (like a function) and returns its result.
If the thing is expected to return multiple values, use 'results' instead of 'result'.
If the thing is expected to return multiple values, use 'results' instead of 'result'.
Examples:
set {_function} to the function named "myFunction"
set {_result} to the result of {_function}
set {_list::*} to the results of {_function}
set {_result} to the result of {_function} with arguments 13 and true
set {_result} to the result of {_function}
set {_list::*} to the results of {_function}
set {_result} to the result of {_function} with arguments 13 and true
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Object |
Rotates a quaternion or vector around an axis a set amount of degrees, or around all 3 axes at once.
Vectors can only be rotated around the global X/Y/Z axes, or an arbitrary vector axis.
Quaternions are more flexible, allowing rotation around the global or local X/Y/Z axes, arbitrary vectors, or all 3 local axes at once.
Global axes are the ones in the Minecraft world. Local axes are relative to how the quaternion is already oriented.
Note that rotating a quaternion around a vector results in a rotation around the local vector, so results may not be what you expect. For example, rotating around vector(1, 0, 0) is the same as rotating around the local X axis.
The same applies to rotations by all three axes at once. In addition, rotating around all three axes of a quaternion/display at once will rotate in ZYX order, meaning the Z rotation will be applied first and the X rotation last.
Vectors can only be rotated around the global X/Y/Z axes, or an arbitrary vector axis.
Quaternions are more flexible, allowing rotation around the global or local X/Y/Z axes, arbitrary vectors, or all 3 local axes at once.
Global axes are the ones in the Minecraft world. Local axes are relative to how the quaternion is already oriented.
Note that rotating a quaternion around a vector results in a rotation around the local vector, so results may not be what you expect. For example, rotating around vector(1, 0, 0) is the same as rotating around the local X axis.
The same applies to rotations by all three axes at once. In addition, rotating around all three axes of a quaternion/display at once will rotate in ZYX order, meaning the Z rotation will be applied first and the X rotation last.
Examples:
set {_new} to {_quaternion} rotated around x axis by 10 degrees
set {_new} to {_vector} rotated around vector(1, 1, 1) by 45
set {_new} to {_quaternion} rotated by x 45, y 90, z 135
set {_new} to {_vector} rotated around vector(1, 1, 1) by 45
set {_new} to {_quaternion} rotated by x 45, y 90, z 135
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Object |
Returns the axis or angle that a quaternion will rotate by/around.
All quaternions can be represented by a rotation of some amount around some axis, so this expression provides the ability to get that angle/axis.
All quaternions can be represented by a rotation of some amount around some axis, so this expression provides the ability to get that angle/axis.
Examples:
set {_quaternion} to axisAngle(45, vector(1, 2, 3))
send rotation axis of {_quaternion} # 1, 2, 3
send rotation angle of {_quaternion} # 45
set rotation angle of {_quaternion} to 135
set rotation axis of {_quaternion} to vector(0, 1, 0)
send rotation axis of {_quaternion} # 1, 2, 3
send rotation angle of {_quaternion} # 45
set rotation angle of {_quaternion} to 135
set rotation axis of {_quaternion} to vector(0, 1, 0)
| Patterns: | |
| Since: | 2.0 |
| Return Type: |
Rounds numbers normally, up (ceiling) or down (floor) respectively.
Examples:
set {var} to rounded health of player
set line 1 of the block to rounded "%(1.5 * player's level)%"
add rounded down argument to the player's health
set line 1 of the block to rounded "%(1.5 * player's level)%"
add rounded down argument to the player's health
| Patterns: | |
| Since: | 2.2-Fixes-v10, 2.2-dev35 (fully modifiable), 2.6.2 (syntax pattern changed) |
| Return Type: | Number |
The saturation of a player. If used in a player event, it can be omitted and will default to event-player.
Examples:
set saturation of player to 20
| Patterns: | |
| Since: | 2.3 |
| Return Type: | Text |
Scoreboard tags are simple list of texts stored directly in the data of an entity.
So this is a Minecraft related thing, not Bukkit, so the tags will not get removed when the server stops. You can visit visit Minecraft Wiki for more info.
This is changeable and valid for any type of entity. Also you can use use the Has Scoreboard Tag condition to check whether an entity has the given tags.
Requires Minecraft 1.11+ (actually added in 1.9 to the game, but added in 1.11 to Spigot).
So this is a Minecraft related thing, not Bukkit, so the tags will not get removed when the server stops. You can visit visit Minecraft Wiki for more info.
This is changeable and valid for any type of entity. Also you can use use the Has Scoreboard Tag condition to check whether an entity has the given tags.
Requires Minecraft 1.11+ (actually added in 1.9 to the game, but added in 1.11 to Spigot).
Examples:
on spawn of a monster:
if the spawn reason is mob spawner:
add "spawned by a spawner" to the scoreboard tags of event-entity
on death of a monster:
if the attacker is a player:
if the victim doesn't have the scoreboard tag "spawned by a spawner":
add 1$ to attacker's balance
if the spawn reason is mob spawner:
add "spawned by a spawner" to the scoreboard tags of event-entity
on death of a monster:
if the attacker is a player:
if the victim doesn't have the scoreboard tag "spawned by a spawner":
add 1$ to attacker's balance
| Patterns: | |
| Since: | 2.0 |
| Return Type: | Script |
The current script, or a script from its (file) name.
If the script is enabled or disabled (or reloaded) this reference will become invalid.
Therefore, it is recommended to obtain a script reference when needed.
If the script is enabled or disabled (or reloaded) this reference will become invalid.
Therefore, it is recommended to obtain a script reference when needed.
Examples:
on script load:
broadcast "Loaded %the current script%"
on script load:
set {running::%script%} to true
on script unload:
set {running::%script%} to false
set {script} to the script named "weather.sk"
loop the scripts in directory "quests/":
enable loop-value
broadcast "Loaded %the current script%"
on script load:
set {running::%script%} to true
on script unload:
set {running::%script%} to false
set {script} to the script named "weather.sk"
loop the scripts in directory "quests/":
enable loop-value
| Patterns: | |
| Since: | 2.7 |
| Return Type: |
An expression to obtain or modify data relating to the pickles of a sea pickle block.
Examples:
on block break:
type of block is sea pickle
send "Wow! This stack of sea pickles contained %event-block's sea pickle count% pickles!"
send "It could've contained a maximum of %event-block's maximum sea pickle count% pickles!"
send "It had to have contained at least %event-block's minimum sea pickle count% pickles!"
cancel event
set event-block's sea pickle count to event-block's maximum sea pickle count
send "This bad boy is going to hold so many pickles now!!"
type of block is sea pickle
send "Wow! This stack of sea pickles contained %event-block's sea pickle count% pickles!"
send "It could've contained a maximum of %event-block's maximum sea pickle count% pickles!"
send "It had to have contained at least %event-block's minimum sea pickle count% pickles!"
cancel event
set event-block's sea pickle count to event-block's maximum sea pickle count
send "This bad boy is going to hold so many pickles now!!"
| Patterns: | |
| Since: | 2.10 |
| Return Type: |
Returns the seed of a loot table. Setting the seed of a block or entity that does not have a loot table will not do anything.
Examples:
set {_seed} loot table seed of block
set loot table seed of entity to 123456789
set loot table seed of entity to 123456789
| Patterns: |
|
| Since: | 2.8.0 |
| Usable in events: | send command list |
| Return Type: | Text |
The commands that will be sent to the player in a send commands to player event.
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 |
| Requirements: | Paper 1.12.2 or newer |
| Return Type: | Server Icon |
Icon of the server in the server list. Can be set to an icon that loaded using the
load server icon effect,
or can be reset to the default icon in a server list ping.
'default server icon' returns the default server icon (server-icon.png) always and cannot be changed.
load server icon effect,
or can be reset to the default icon in a server list ping.
'default server icon' returns the default server icon (server-icon.png) always and cannot be changed.
Examples:
on script load:
set {server-icons::default} to the default server icon
set {server-icons::default} to the default server icon
| Patterns: |
|
| Since: | 1.3.7 |
| Return Type: | Living Entity |
The shooter of a projectile.
Examples:
shooter is a skeleton
| Patterns: | |
| Since: | 1.3 |
| Return Type: | Text |
A line of text on a sign. Can be changed, but remember that there is a 16 character limit per line (including color codes that use 2 characters each).
Examples:
on rightclick on sign:
line 2 of the clicked block is "[Heal]":
heal the player
set line 3 to "%player%"
line 2 of the clicked block is "[Heal]":
heal the player
set line 3 to "%player%"
| Patterns: |
|
| Since: | 2.9.0, 2.10 (of items) |
| Return Type: | Offline Player |
The skull owner of a player skull.
Examples:
set {_owner} to the skull owner of event-block
set skull owner of {_block} to "Njol" parsed as offlineplayer
set head owner of player's tool to {_player}
set skull owner of {_block} to "Njol" parsed as offlineplayer
set head owner of player's tool to {_player}
| Patterns: | |
| Since: | 2.2-dev35, 2.8.0 (raw index) |
| Return Type: |
Index of an an inventory slot. Other types of slots may or may not have indices. Note that comparing slots with numbers is also possible; if index of slot is same as the number, comparisonsucceeds. This expression is mainly for the cases where you must for some reason save the slot numbers.
Raw index of slot is unique for the view, see Minecraft Wiki
Raw index of slot is unique for the view, see Minecraft Wiki
Examples:
if index of event-slot is 10:
send "You bought a pie!"
if display name of player's top inventory is "Custom Menu": # 3 rows inventory
if raw index of event-slot > 27: # outside custom inventory
cancel event
send "You bought a pie!"
if display name of player's top inventory is "Custom Menu": # 3 rows inventory
if raw index of event-slot > 27: # outside custom inventory
cancel event
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Minecraft 1.20.2+, Minecraft 1.20.5+ (comparisons) |
| Return Type: | Entity Snapshot |
Gets or sets the entity snapshot that the provided spawn eggs will spawn when used.
Examples:
set {_item} to a zombie spawn egg
broadcast the spawn egg entity of {_item}
spawn a pig at location(0,0,0):
set the max health of entity to 20
set the health of entity to 20
set {_snapshot} to the entity snapshot of entity
clear entity
set the spawn egg entity of {_item} to {_snapshot}
if the spawn egg entity of {_item} is {_snapshot}: # Minecraft 1.20.5+
set the spawn egg entity of {_item} to (random element out of all entities)
set the spawn egg entity of {_item} to a zombie
broadcast the spawn egg entity of {_item}
spawn a pig at location(0,0,0):
set the max health of entity to 20
set the health of entity to 20
set {_snapshot} to the entity snapshot of entity
clear entity
set the spawn egg entity of {_item} to {_snapshot}
if the spawn egg entity of {_item} is {_snapshot}: # Minecraft 1.20.5+
set the spawn egg entity of {_item} to (random element out of all entities)
set the spawn egg entity of {_item} to a zombie
| Patterns: |
|
| Since: | 2.3 |
| Return Type: | Spawn Reason |
The spawn reason in a spawn event.
Examples:
on spawn:
spawn reason is reinforcements or breeding
cancel event
spawn reason is reinforcements or breeding
cancel event
| Patterns: | |
| Since: | 2.4, 2.9.2 (trial spawner) |
| Return Type: | Entity Type |
Retrieves, sets, or resets the spawner's entity type
Examples:
on right click:
if event-block is spawner:
send "Spawner's type is %target block's entity type%"
if event-block is spawner:
send "Spawner's type is %target block's entity type%"
| Patterns: |
|
| Since: | 2.2-dev32d |
| Return Type: | Number |
Special number values, namely NaN, Infinity and -Infinity
Examples:
if {_number} is infinity value:
| Patterns: | |
| Since: | 2.4-alpha4, 2.7 (Paper Spectator Event) |
| Requirements: | Paper |
| Return Type: | Entity |
Grabs the spectator target entity of the players.
Examples:
on player start spectating of player:
message "&c%spectator target% currently has %{game::kills::%spectator target%}% kills!" to the player
on player stop spectating:
past spectator target was a zombie
set spectator target to the nearest skeleton
message "&c%spectator target% currently has %{game::kills::%spectator target%}% kills!" to the player
on player stop spectating:
past spectator target was a zombie
set spectator target to the nearest skeleton
| Patterns: | |
| Since: | unknown (before 2.1) |
| Return Type: | Number |
A player's walking or flying speed. Both can be changed, but values must be between -1 and 1 (excessive values will be changed to -1 or 1 respectively). Negative values reverse directions.
Please note that changing a player's speed will change their FOV just like potions do.
Please note that changing a player's speed will change their FOV just like potions do.
Examples:
set the player's walk speed to 1
increase the argument's fly speed by 0.1
increase the argument's fly speed by 0.1
| Patterns: |
|
| Since: | 2.1, 2.5.2 (character at, multiple strings support) |
| Return Type: | Text |
Extracts part of a text. You can either get the first <x> characters, the last <x> characters, the character at index <x>, or the characters between indices <x> and <y>. The indices <x> and <y> should be between 1 and the length of the text (other values will be fit into this range).
Examples:
set {_s} to the first 5 characters of the text argument
message "%subtext of {_s} from characters 2 to (the length of {_s} - 1)%" # removes the first and last character from {_s} and sends it to the player or console
set {_characters::*} to characters at 1, 2 and 7 in player's display name
send the last character of all players' names
message "%subtext of {_s} from characters 2 to (the length of {_s} - 1)%" # removes the first and last character from {_s} and sends it to the player or console
set {_characters::*} to characters at 1, 2 and 7 in player's display name
send the last character of all players' names
| Patterns: |
|
| Since: | 2.2-dev36 |
| Return Type: | Number |
Returns the 3 most recent TPS readings, like the /tps command. This expression is only supported on some server software (PaperSpigot).
Examples:
broadcast "%tps%"
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Paper (paper tags) |
| Return Type: | Minecraft Tag |
Represents a tag which can be used to classify items, blocks, or entities.
Tags are composed of a value and an optional namespace: "minecraft:oak_logs".
If you omit the namespace, one will be provided for you, depending on what kind of tag you're using. For example, `tag "doors"` will be the tag "minecraft:doors", while `paper tag "doors"` will be "paper:doors".
`minecraft tag` will search through the vanilla tags, `datapack tag` will search for datapack-provided tags (a namespace is required here!), `paper tag` will search for Paper's custom tags if you are running Paper, and `custom tag` will look in the "skript" namespace for custom tags you've registered.
You can also filter by tag types using "item", "block", or "entity".
Tags are composed of a value and an optional namespace: "minecraft:oak_logs".
If you omit the namespace, one will be provided for you, depending on what kind of tag you're using. For example, `tag "doors"` will be the tag "minecraft:doors", while `paper tag "doors"` will be "paper:doors".
`minecraft tag` will search through the vanilla tags, `datapack tag` will search for datapack-provided tags (a namespace is required here!), `paper tag` will search for Paper's custom tags if you are running Paper, and `custom tag` will look in the "skript" namespace for custom tags you've registered.
You can also filter by tag types using "item", "block", or "entity".
Examples:
minecraft tag "dirt" # minecraft:dirt
paper tag "doors" # paper:doors
tag "skript:custom_dirt" # skript:custom_dirt
custom tag "dirt" # skript:dirt
datapack block tag "dirt" # minecraft:dirt
datapack tag "my_pack:custom_dirt" # my_pack:custom_dirt
tag "minecraft:mineable/pickaxe" # minecraft:mineable/pickaxe
custom item tag "blood_magic_sk/can_sacrifice_with" # skript:blood_magic_sk/can_sacrifice_with
paper tag "doors" # paper:doors
tag "skript:custom_dirt" # skript:custom_dirt
custom tag "dirt" # skript:dirt
datapack block tag "dirt" # minecraft:dirt
datapack tag "my_pack:custom_dirt" # my_pack:custom_dirt
tag "minecraft:mineable/pickaxe" # minecraft:mineable/pickaxe
custom item tag "blood_magic_sk/can_sacrifice_with" # skript:blood_magic_sk/can_sacrifice_with
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Text |
The namespaced key of a minecraft tag. This takes the form of "namespace:key", e.g. "minecraft:dirt".
Examples:
broadcast namespaced keys of the tags of player's tool
if the key of {_my-tag} is "minecraft:stone":
return true
if the key of {_my-tag} is "minecraft:stone":
return true
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Object |
Returns all the values that a tag contains.
For item and block tags, this will return items. For entity tags, it will return entity datas (a creeper, a zombie).
For item and block tags, this will return items. For entity tags, it will return entity datas (a creeper, a zombie).
Examples:
broadcast tag values of minecraft tag "dirt"
broadcast (first element of player's tool's block tags)'s tag contents
broadcast (first element of player's tool's block tags)'s tag contents
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Paper (paper tags) |
| Return Type: | Minecraft Tag |
Returns all the tags of an item, block, or entity.
`minecraft tag` will return only the vanilla tags, `datapack tag` will return only datapack-provided tags, `paper tag` will return only Paper's custom tags (if you are running Paper), and `custom tag` will look in the "skript" namespace for custom tags you've registered.
You can also filter by tag types using "item", "block", or "entity".
`minecraft tag` will return only the vanilla tags, `datapack tag` will return only datapack-provided tags, `paper tag` will return only Paper's custom tags (if you are running Paper), and `custom tag` will look in the "skript" namespace for custom tags you've registered.
You can also filter by tag types using "item", "block", or "entity".
Examples:
broadcast minecraft tags of dirt
send true if paper item tags of target block contains paper tag "doors"
broadcast the block tags of player's tool
send true if paper item tags of target block contains paper tag "doors"
broadcast the block tags of player's tool
| Patterns: |
|
| Since: | 2.2-dev25 |
| Return Type: | Player |
The tamer of an entity. Can only be used in entity tame events. You can use 'event-entity' to refer tamed entity itself.
Examples:
on tame:
if the tamer is a player:
send "someone tamed something!" to console
if the tamer is a player:
send "someone tamed something!" to console
| Patterns: |
|
| Since: | 1.4.2, 2.7 (Reset), 2.8.0 (ignore blocks) |
| Return Type: | Entity |
For players this is the entity at the crosshair.
For mobs and experience orbs this is the entity they are attacking/following (if any).
Display entities have a hit box of 0, so you should use 'target display' to collect Display entities
May grab entities in unloaded chunks.
For mobs and experience orbs this is the entity they are attacking/following (if any).
Display entities have a hit box of 0, so you should use 'target display' to collect Display entities
May grab entities in unloaded chunks.
Examples:
on entity target:
if entity's target is a player:
send "You're being followed by an %entity%!" to target of entity
reset target of entity # Makes the entity target-less
delete targeted entity of player # for players it will delete the target
delete target of last spawned zombie # for entities it will make them target-less
if entity's target is a player:
send "You're being followed by an %entity%!" to target of entity
reset target of entity # Makes the entity target-less
delete targeted entity of player # for players it will delete the target
delete target of last spawned zombie # for entities it will make them target-less
| Patterns: |
|
| Since: | 1.0, 2.9.0 (actual/exact) |
| Return Type: | Block |
The block at the crosshair. This regards all blocks that are not air as fully solid, e.g. torches will be like a solid stone block for this expression.
The actual target block will regard the actual hit box of the block.
The actual target block will regard the actual hit box of the block.
Examples:
set target block of player to stone
set target block of player to oak_stairs[waterlogged=true]
break target block of player using player's tool
give player 1 of type of target block
teleport player to location above target block
kill all entities in radius 3 around target block of player
set {_block} to actual target block of player
break actual target block of player
set target block of player to oak_stairs[waterlogged=true]
break target block of player using player's tool
give player 1 of type of target block
teleport player to location above target block
kill all entities in radius 3 around target block of player
set {_block} to actual target block of player
break actual target block of player
| Patterns: |
|
| Since: | 2.2-dev35 |
| Return Type: | Teleport Cause |
The teleport cause within a player teleport event.
Examples:
on teleport:
teleport cause is nether portal, end portal or end gateway
cancel event
teleport cause is nether portal, end portal or end gateway
cancel event
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Display Text Alignment |
Returns or changes the alignment setting of text displays.
Examples:
set text alignment of the last spawned text display to left
| Patterns: | |
| Since: | 2.10 |
| Return Type: |
Returns or changes the line width of text displays. Default is 200.
Examples:
set the line width of the last spawned text display to 300
| Patterns: | |
| Since: | 2.10 |
| Return Type: |
Returns or changes the opacity of text displays.
Values are between -127 and 127. The value of 127 represents it being completely opaque.
Values are between -127 and 127. The value of 127 represents it being completely opaque.
Examples:
set the opacity of the last spawned text display to -1 # Reset
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Text |
Returns or changes the text/string of displays.
Note that currently you can only use Skript chat codes when running Paper.
Note that currently you can only use Skript chat codes when running Paper.
Examples:
set text of the last spawned text display to "example"
| Patterns: |
|
| Since: | 2.7 |
| Usable in events: | Egg Throw |
| Return Type: | Projectile |
The egg thrown in a Player Egg Throw event.
Examples:
spawn an egg at the egg
| Patterns: | |
| Since: | 1.0 |
| Return Type: | Time |
The time of a world.
Use the "minecraft timespan" syntax to change the time according to Minecraft's time intervals.
Since Minecraft uses discrete intervals for time (ticks), changing the time by real-world minutes or real-world seconds only changes it approximately.
Removing an amount of time from a world's time will move the clock forward a day.
Use the "minecraft timespan" syntax to change the time according to Minecraft's time intervals.
Since Minecraft uses discrete intervals for time (ticks), changing the time by real-world minutes or real-world seconds only changes it approximately.
Removing an amount of time from a world's time will move the clock forward a day.
Examples:
set time of world "world" to 2:00
add 2 minecraft hours to time of world "world"
add 54 real seconds to time of world "world" # approximately 1 minecraft hour
add 2 minecraft hours to time of world "world"
add 54 real seconds to time of world "world" # approximately 1 minecraft hour
| Patterns: |
|
| Since: | 2.5, 2.7 (offline players) |
| Requirements: | MC 1.15+ (offline players) |
| Return Type: | Timespan |
The amount of time a player has played for on the server. This info is stored in the player's statistics in the main world's data folder. Changing this will also change the player's stats which can be views in the client's statistics menu.
Using this expression on offline players on Minecraft 1.14 and below will return nothing
Using this expression on offline players on Minecraft 1.14 and below will return nothing
<none>. Examples:
set {_t} to time played of player
if player's time played is greater than 10 minutes:
give player a diamond sword
set player's time played to 0 seconds
if player's time played is greater than 10 minutes:
give player a diamond sword
set player's time played to 0 seconds
| Patterns: | |
| Since: | 2.5, 2.10 (time until) |
| Return Type: | Timespan |
The time since a date has passed or the time until a date will pass.
This expression will return 0 seconds if the time since or time until would be negative, e.g. if one tries to get the time since a future date.
This expression will return 0 seconds if the time since or time until would be negative, e.g. if one tries to get the time since a future date.
Examples:
send "%time since 5 minecraft days ago% has passed since 5 minecraft days ago!" to player
send "%time until {countdown::end}% until the game begins!" to player
send "%time until {countdown::end}% until the game begins!" to player
| Patterns: |
|
| Since: | 2.9.0 |
| Return Type: |
Retrieve specific information of a timespan such as hours/minutes/etc.
Examples:
set {_t} to difference between now and {Payouts::players::%uuid of player%::last-date}
send "It has been %days of {_t}% day(s) since last payout."
send "It has been %days of {_t}% day(s) since last payout."
| Patterns: |
|
| Since: | 1.0 |
| Return Type: | Slot |
The item an entity is holding in their main or off hand.
Examples:
player's tool is a pickaxe
player's off hand tool is a shield
set tool of all players to a diamond sword
set offhand tool of target entity to a bow
player's off hand tool is a shield
set tool of all players to a diamond sword
set offhand tool of target entity to a bow
| Patterns: | |
| Since: | 2.7 |
| Return Type: |
The total experience, in points, of players or experience orbs.
Adding to a player's experience will trigger Mending, but setting their experience will not.
Adding to a player's experience will trigger Mending, but setting their experience will not.
Examples:
set total experience of player to 100
add 100 to player's experience
if player's total experience is greater than 100:
set player's total experience to 0
give player 1 diamond
add 100 to player's experience
if player's total experience is greater than 100:
set player's total experience to 0
give player 1 diamond
| Patterns: |
|
| Since: | 2.8.0 |
| Return Type: | Transform Reason |
The transform reason within an entity entity transform event.
Examples:
on entity transform:
transform reason is infection, drowned or frozen
transform reason is infection, drowned or frozen
| Patterns: | |
| Since: | 2.10 |
| Return Type: | Object |
Transforms (or 'maps') a list's values using a given expression. This is akin to looping over the list and getting a modified version of each value.
Indices cannot be retained with this expression. To retain indices, see the transform effect.
Indices cannot be retained with this expression. To retain indices, see the transform effect.
Examples:
set {_a::*} to (1, 2, and 3) transformed using (input * 2 - 1, input * 2)
# {_a::*} is now 1, 2, 3, 4, 5, and 6
# get a list of the sizes of all clans without manually looping
set {_clan-sizes::*} to indices of {clans::*} transformed using [{clans::%input%::size}]
# {_a::*} is now 1, 2, 3, 4, 5, and 6
# get a list of the sizes of all clans without manually looping
set {_clan-sizes::*} to indices of {clans::*} transformed using [{clans::%input%::size}]
| Patterns: |
|
| Since: | 1.4, 2.5.2 (potion effect), 2.7 (block datas), 2.10 (enchantment type) |
| Return Type: | Object |
Type of a block, item, entity, inventory, potion effect or enchantment type.
Types of items, blocks and block datas are item types similar to them but have amounts
of one, no display names and, on Minecraft 1.13 and newer versions, are undamaged.
Types of entities and inventories are entity types and inventory types known to Skript.
Types of potion effects are potion effect types.
Types of enchantment types are enchantments.
Types of items, blocks and block datas are item types similar to them but have amounts
of one, no display names and, on Minecraft 1.13 and newer versions, are undamaged.
Types of entities and inventories are entity types and inventory types known to Skript.
Types of potion effects are potion effect types.
Types of enchantment types are enchantments.
Examples:
on rightclick on an entity:
message "This is a %type of clicked entity%!"
message "This is a %type of clicked entity%!"
| Patterns: |
|
| Since: | 2.1.2, 2.2 (offline players' UUIDs), 2.2-dev24 (other entities' UUIDs) |
| Return Type: | Text |
The UUID of a player, entity or world.
In the future there will be an option to use a player's UUID instead of the name in variable names (i.e. when %player% is used), but for now this can be used.
Please note that this expression does not work for offline players if you are under 1.8!
In the future there will be an option to use a player's UUID instead of the name in variable names (i.e. when %player% is used), but for now this can be used.
Please note that this expression does not work for offline players if you are under 1.8!
Examples:
# prevents people from joining the server if they use the name of a player
# who has played on this server at least once since this script has been added
on login:
if {uuid::%name of player%} exists:
{uuid::%name of player%} is not uuid of player
kick player due to "Someone with your name has played on this server before"
else:
set {uuid::%name of player%} to uuid of player
# who has played on this server at least once since this script has been added
on login:
if {uuid::%name of player%} exists:
{uuid::%name of player%} is not uuid of player
kick player due to "Someone with your name has played on this server before"
else:
set {uuid::%name of player%} to uuid of player
| Patterns: |
|
| Since: | 2.2-dev13b, 2.9.0 (breakable) |
| Return Type: | Item Type |
Creates breakable or unbreakable copies of given items.
Examples:
set {_item} to unbreakable iron sword
give breakable {_weapon} to all players
give breakable {_weapon} to all players
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Unleash |
| Return Type: | Unleash Reason |
The unleash reason in an unleash event.
Examples:
if the unleash reason is distance:
broadcast "The leash was snapped in half."
broadcast "The leash was snapped in half."
| Patterns: |
|
| Since: | 2.10 (Nodes), 2.10 (Any) |
| Return Type: | Object |
Returns the value of something that has a value, e.g. a node in a config.
The value is automatically converted to the specified type (e.g. text, number) where possible.
The value is automatically converted to the specified type (e.g. text, number) where possible.
Examples:
set {_node} to node "language" in the skript config broadcast the text value of {_node}
set {_node} to node "update check interval" in the skript config broadcast text value of {_node} # text value of {_node} = "12 hours" (text) wait for {_node}'s timespan value # timespan value of {_node} = 12 hours (duration)
set {_node} to node "update check interval" in the skript config broadcast text value of {_node} # text value of {_node} = "12 hours" (text) wait for {_node}'s timespan value # timespan value of {_node} = 12 hours (duration)
| Patterns: | |
| Since: | 2.7 |
| Return Type: | Object |
Gets the value within objects. Usually used with variables to get the value they store rather than the variable itself, or with lists to get the values of a type.
Examples:
set {_entity} to a random entity out of all entities
delete entity within {_entity} # This deletes the entity itself and not the value stored in the variable
set {_list::*} to "something", 10, "test" and a zombie
broadcast the strings within {_list::*} # "something", "test"
delete entity within {_entity} # This deletes the entity itself and not the value stored in the variable
set {_list::*} to "something", 10, "test" and a zombie
broadcast the strings within {_list::*} # "something", "test"
| Patterns: |
|
| Since: | 2.2-dev28, 2.10 (quaternions) |
| Return Type: | Number |
Gets or changes the W, X, Y or Z component of vectors/quaternions.
You cannot use the W component with vectors; it is for quaternions only.
You cannot use the W component with vectors; it is for quaternions only.
Examples:
set {_v} to vector 1, 2, 3
send "%x of {_v}%, %y of {_v}%, %z of {_v}%"
add 1 to x of {_v}
add 2 to y of {_v}
add 3 to z of {_v}
send "%x of {_v}%, %y of {_v}%, %z of {_v}%"
set x component of {_v} to 1
set y component of {_v} to 2
set z component of {_v} to 3
send "%x component of {_v}%, %y component of {_v}%, %z component of {_v}%"
send "%x of {_v}%, %y of {_v}%, %z of {_v}%"
add 1 to x of {_v}
add 2 to y of {_v}
add 3 to z of {_v}
send "%x of {_v}%, %y of {_v}%, %z of {_v}%"
set x component of {_v} to 1
set y component of {_v} to 2
set z component of {_v} to 3
send "%x component of {_v}%, %y component of {_v}%, %z component of {_v}%"
| Patterns: | |
| Since: | 2.2-dev28 |
| Return Type: | Location |
Creates a location from a vector in a world.
Examples:
set {_loc} to {_v} to location in world "world"
set {_loc} to {_v} to location in world "world" with yaw 45 and pitch 90
set {_loc} to location of {_v} in "world" with yaw 45 and pitch 90
set {_loc} to {_v} to location in world "world" with yaw 45 and pitch 90
set {_loc} to location of {_v} in "world" with yaw 45 and pitch 90
| Patterns: |
|
| Since: | 2.8.0 |
| Return Type: | Vector |
Creates vectors from given directions.
Relative directions are relative to the origin, (0, 0, 0). Therefore, the vector from the direction 'forwards' is (0, 0, 1).
Relative directions are relative to the origin, (0, 0, 0). Therefore, the vector from the direction 'forwards' is (0, 0, 1).
Examples:
set {_v} to vector from direction upwards
set {_v} to vector in direction of player
set {_v} to vector in horizontal direction of player
set {_v} to vector from facing of player
set {_v::*} to vectors from north, south, east, and west
set {_v} to vector in direction of player
set {_v} to vector in horizontal direction of player
set {_v} to vector from facing of player
set {_v::*} to vectors from north, south, east, and west
| Patterns: | |
| Since: | 2.2-dev28 |
| Return Type: | Vector |
Forms a 'cylindrical shaped' vector using yaw to manipulate the current point.
Examples:
loop 360 times:
set {_v} to cylindrical vector radius 1, yaw loop-value, height 2
set {_v} to cylindrical vector radius 1, yaw 90, height 2
set {_v} to cylindrical vector radius 1, yaw loop-value, height 2
set {_v} to cylindrical vector radius 1, yaw 90, height 2
| Patterns: | |
| Since: | 2.2-dev28 |
| Return Type: | Number |
Gets or sets the length of a vector.
Examples:
send "%standard length of vector 1, 2, 3%"
set {_v} to vector 1, 2, 3
set standard length of {_v} to 2
send "%standard length of {_v}%"
set {_v} to vector 1, 2, 3
set standard length of {_v} to 2
send "%standard length of {_v}%"
| Patterns: |
|
| Since: | 2.2-dev28, 2.7 (signed components) |
| Return Type: | Vector |
Creates a random unit vector.
Examples:
set {_v} to a random vector
| Patterns: | |
| Since: | 2.2-dev28 |
| Return Type: | Vector |
Forms a 'spherical shaped' vector using yaw and pitch to manipulate the current point.
Examples:
loop 360 times:
set {_v} to spherical vector radius 1, yaw loop-value, pitch loop-value
set {_v} to spherical vector radius 1, yaw 45, pitch 90
set {_v} to spherical vector radius 1, yaw loop-value, pitch loop-value
set {_v} to spherical vector radius 1, yaw 45, pitch 90
| Patterns: |
|
| Since: | 2.0 |
| Return Type: | Text |
The version of Bukkit, Minecraft or Skript respectively.
Examples:
message "This server is running Minecraft %minecraft version% on Bukkit %bukkit version%"
message "This server is powered by Skript %skript version%"
message "This server is powered by Skript %skript version%"
| Patterns: |
|
| Since: | 2.3 |
| Usable in events: | Server List Ping |
| Requirements: | Paper 1.12.2+ |
| Return Type: | Text |
The text to show if the protocol version of the server doesn't match with protocol version of the client. You can check the protocol version expression for more information about this.
This can only be set in a server list ping event.
This can only be set in a server list ping event.
Examples:
on server list ping:
set the protocol version to 0 # 13w41a (1.7), so it will show the version string always
set the version string to "<light green>Version: <orange>%minecraft version%"
set the protocol version to 0 # 13w41a (1.7), so it will show the version string always
set the version string to "<light green>Version: <orange>%minecraft version%"
| Patterns: | |
| Since: | 2.4 |
| Requirements: | Paper |
| Return Type: |
The view distance of a player as set by the server. Can be changed.
NOTE: This is the view distance sent by the server to the player.
This has nothing to do with client side view distance settings
NOTE: This may not work on some versions (such as MC 1.14.x).
The return value in this case will be the view distance set in system.properties.
NOTE: This is the view distance sent by the server to the player.
This has nothing to do with client side view distance settings
NOTE: This may not work on some versions (such as MC 1.14.x).
The return value in this case will be the view distance set in system.properties.
Examples:
set view distance of player to 10
set {_view} to view distance of player
reset view distance of all players
add 2 to view distance of player
set {_view} to view distance of player
reset view distance of all players
add 2 to view distance of player
| Patterns: | |
| Since: | 2.5 |
| Requirements: | 1.13.2+ |
| Return Type: |
The view distance of the client. Can not be changed. This differs from the server side view distance of player as this will retrieve the view distance the player has set on their client.
Examples:
set {_clientView} to the client view distance of player
set view distance of player to client view distance of player
set view distance of player to client view distance of player
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Number |
Represents the level/experience of a villager.
The level will determine which trades are available to players (value between 1 and 5, defaults to 1).
When a villager's level is 1, they may lose their profession if they don't have a workstation.
Experience works along with the leveling system, determining which level the villager will move to.
Experience must be greater than or equal to 0.
Learn more about villager levels on Minecraft Wiki
The level will determine which trades are available to players (value between 1 and 5, defaults to 1).
When a villager's level is 1, they may lose their profession if they don't have a workstation.
Experience works along with the leveling system, determining which level the villager will move to.
Experience must be greater than or equal to 0.
Learn more about villager levels on Minecraft Wiki
Examples:
set {_level} to villager level of {_villager}
set villager level of last spawned villager to 2
add 1 to villager level of target entity
remove 1 from villager level of event-entity
reset villager level of event-entity
set villager experience of last spawned entity to 100
set villager level of last spawned villager to 2
add 1 to villager level of target entity
remove 1 from villager level of event-entity
reset villager level of event-entity
set villager experience of last spawned entity to 100
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Villager Profession |
Represents the profession of a villager/zombie villager.
Examples:
set {_p} to villager profession of event-entity
villager profession of event-entity = nitwit profession
set villager profession of {_villager} to librarian profession
delete villager profession of event-entity
villager profession of event-entity = nitwit profession
set villager profession of {_villager} to librarian profession
delete villager profession of event-entity
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Villager Type |
Represents the type of a villager/zombie villager. This usually represents the biome the villager is from.
Examples:
set {_type} to villager type of {_villager}
villager type of {_villager} = plains
set villager type of event-entity to plains
villager type of {_villager} = plains
set villager type of event-entity to plains
| Patterns: | |
| Since: | 1.0 |
| Usable in events: | weather change |
| Return Type: | Weather Type |
The weather in the given or the current world.
Examples:
set weather to clear
weather in "world" is rainy
weather in "world" is rainy
| Patterns: |
|
| Since: | 2.9.0 |
| Return Type: | Boolean |
A shorthand for returning the result of a condition (true or false). This is functionally identical to using `true if else false`.
Examples:
set {fly} to whether player can fly
broadcast "Flying: %whether player is flying%"
broadcast "Flying: %whether player is flying%"
| Patterns: |
|
| Since: | 2.5.2, 2.9.0 (delete) |
| Return Type: | Offline Player |
An expression for obtaining and modifying the server's whitelist.
Players may be added and removed from the whitelist.
The whitelist can be enabled or disabled by setting the whitelist to true or false respectively.
Players may be added and removed from the whitelist.
The whitelist can be enabled or disabled by setting the whitelist to true or false respectively.
Examples:
set the whitelist to false
add all players to whitelist
reset the whitelist
add all players to whitelist
reset the whitelist
| Patterns: | |
| Since: | 2.9.0 |
| Requirements: | Spigot 1.20.5+ |
| Return Type: | Item Type |
Creates a copy of an item with (or without) fire resistance.
Examples:
set {_x} to diamond sword with fire resistance
equip player with netherite helmet without fire resistance
drop fire resistant stone at player
equip player with netherite helmet without fire resistance
drop fire resistant stone at player
| Patterns: | |
| Since: | 1.0 |
| Return Type: | World |
The world the event occurred in.
Examples:
world is "world_nether"
teleport the player to the world's spawn
set the weather in the player's world to rain
set {_world} to world of event-chunk
teleport the player to the world's spawn
set the weather in the player's world to rain
set {_world} to world of event-chunk
| Patterns: | |
| Since: | 2.7 |
| Return Type: | World Environment |
The environment of a world
Examples:
if environment of player's world is nether:
apply fire resistance to player for 10 minutes
apply fire resistance to player for 10 minutes
| Patterns: |
|
| Since: | 1.0 |
| Return Type: | World |
All worlds of the server, useful for looping.
Examples:
loop all worlds:
broadcast "You're in %loop-world%" to loop-world
broadcast "You're in %loop-world%" to loop-world
| Patterns: |
|
| Since: | 1.4.6 |
| Return Type: |
Integers between 1 and X, used in loops to loop X times.
Examples:
loop 20 times:
broadcast "%21 - loop-number% seconds left.."
wait 1 second
broadcast "%21 - loop-number% seconds left.."
wait 1 second
| Patterns: |
|
| Since: | 1.2 |
| Return Type: | Object |
An expression to be able to use a certain amount of items where the amount can be any expression. Please note that this expression is not stable and might be replaced in the future.
Examples:
give level of player of pickaxes to the player
| Patterns: | |
| Since: | 2.0, 2.2-dev28 (vector yaw/pitch), 2.9.0 (entity changers) |
| Requirements: | Paper 1.19+ (player changers) |
| Return Type: |
The yaw or pitch of a location or vector.
A yaw of 0 or 360 represents the positive z direction. Adding a positive number to the yaw of a player will rotate it clockwise.
A pitch of 90 represents the negative y direction, or downward facing. A pitch of -90 represents upward facing. Adding a positive number to the pitch will rotate the direction downwards.
Only Paper 1.19+ users may directly change the yaw/pitch of players.
A yaw of 0 or 360 represents the positive z direction. Adding a positive number to the yaw of a player will rotate it clockwise.
A pitch of 90 represents the negative y direction, or downward facing. A pitch of -90 represents upward facing. Adding a positive number to the pitch will rotate the direction downwards.
Only Paper 1.19+ users may directly change the yaw/pitch of players.
Examples:
log "%player%: %location of player%, %player's yaw%, %player's pitch%" to "playerlocs.log"
set {_yaw} to yaw of player
set {_p} to pitch of target entity
set pitch of player to -90 # Makes the player look upwards, Paper 1.19+ only
add 180 to yaw of target of player # Makes the target look behind themselves
set {_yaw} to yaw of player
set {_p} to pitch of target entity
set pitch of player to -90 # Makes the player look upwards, Paper 1.19+ only
add 180 to yaw of target of player # Makes the target look behind themselves
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Unleash |
Allows or prevents the leash from being dropped in an unleash event.
Examples:
on unleash:
if player is not set:
prevent the leash from dropping
else if player is op:
allow the leash to drop
if player is not set:
prevent the leash from dropping
else if player is op:
allow the leash to drop
| Patterns: |
|
| Since: | 2.10 |
Sets whether or not living entities will be able to age.
Examples:
on spawn of animal:
allow aging of entity
allow aging of entity
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Fishing |
Sets whether the lure enchantment should be applied, which reduces the wait time.
Examples:
on fishing line cast:
apply lure enchantment bonus
apply lure enchantment bonus
| Patterns: |
|
| Since: | 1.4, 2.1.1 (ban reason), 2.5 (timespan), 2.9.0 (kick) |
Bans or unbans a player or an IP address.
If a reason is given, it will be shown to the player when they try to join the server while banned.
A length of ban may also be given to apply a temporary ban. If it is absent for any reason, a permanent ban will be used instead.
We recommend that you test your scripts so that no accidental permanent bans are applied.
Note that banning people does not kick them from the server.
You can optionally use 'and kick' or consider using the kick effect after applying a ban.
If a reason is given, it will be shown to the player when they try to join the server while banned.
A length of ban may also be given to apply a temporary ban. If it is absent for any reason, a permanent ban will be used instead.
We recommend that you test your scripts so that no accidental permanent bans are applied.
Note that banning people does not kick them from the server.
You can optionally use 'and kick' or consider using the kick effect after applying a ban.
Examples:
unban player
ban "127.0.0.1"
IP-ban the player because "he is an idiot"
ban player due to "inappropriate language" for 2 days
ban and kick player due to "inappropriate language" for 2 days
ban "127.0.0.1"
IP-ban the player because "he is an idiot"
ban player due to "inappropriate language" for 2 days
ban and kick player due to "inappropriate language" for 2 days
| Patterns: | |
| Since: | 2.4 |
Breaks the block and spawns items as if a player had mined it
You can add a tool, which will spawn items based on how that tool would break the block
(ie: When using a hand to break stone, it drops nothing, whereas with a pickaxe it drops cobblestone)
You can add a tool, which will spawn items based on how that tool would break the block
(ie: When using a hand to break stone, it drops nothing, whereas with a pickaxe it drops cobblestone)
Examples:
on right click:
break clicked block naturally
loop blocks in radius 10 around player:
break loop-block using player's tool
loop blocks in radius 10 around player:
break loop-block naturally using diamond pickaxe
break clicked block naturally
loop blocks in radius 10 around player:
break loop-block using player's tool
loop blocks in radius 10 around player:
break loop-block naturally using diamond pickaxe
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper 1.16+ |
Interrupts the action entities may be trying to complete.
For example, interrupting eating, or drawing back a bow.
For example, interrupting eating, or drawing back a bow.
Examples:
on damage of player:
if the victim's active tool is a bow:
interrupt the usage of the player's active item
if the victim's active tool is a bow:
interrupt the usage of the player's active item
| Patterns: |
|
| Since: | 2.2-dev34 |
Only usable in commands. Makes it so the current command usage isn't counted towards the cooldown.
Examples:
command /nick <text>:
executable by: players
cooldown: 10 seconds
trigger:
if length of arg-1 is more than 16:
# Makes it so that invalid arguments don't make you wait for the cooldown again
cancel the cooldown
send "Your nickname may be at most 16 characters."
stop
set the player's display name to arg-1
executable by: players
cooldown: 10 seconds
trigger:
if length of arg-1 is more than 16:
# Makes it so that invalid arguments don't make you wait for the cooldown again
cancel the cooldown
send "Your nickname may be at most 16 characters."
stop
set the player's display name to arg-1
| Patterns: |
|
| Since: | 2.4 |
| Usable in events: | death, break / mine |
| Requirements: | 1.12.2 or newer (cancelling item drops of blocks) |
Cancels drops of items or experiences in a death or block break event. Please note that this doesn't keep items or experiences of a dead player. If you want to do that, use the Keep Inventory / Experience effect.
Examples:
on death of a zombie:
if name of the entity is "&cSpecial":
cancel drops of items
on break of a coal ore:
cancel the experience drops
if name of the entity is "&cSpecial":
cancel drops of items
on break of a coal ore:
cancel the experience drops
| Patterns: |
|
| Since: | 1.0 |
Cancels the event (e.g. prevent blocks from being placed, or damage being taken).
Examples:
on damage:
victim is a player
victim has the permission "skript.god"
cancel the event
victim is a player
victim has the permission "skript.god"
cancel the event
| Patterns: | |
| Since: | 1.0 (set, add, remove, delete), 2.0 (remove all) |
A very general effect that can change many expressions. Many expressions can only be set and/or deleted, while some can have things added to or removed from them.
Examples:
# set:
Set the player's display name to "<red>%name of player%"
set the block above the victim to lava
# add:
add 2 to the player's health # preferably use '<a href='#EffHealth'>heal</a>' for this
add argument to {blacklist::*}
give a diamond pickaxe of efficiency 5 to the player
increase the data value of the clicked block by 1
# remove:
remove 2 pickaxes from the victim
subtract 2.5 from {points::%uuid of player%}
# remove all:
remove every iron tool from the player
remove all minecarts from {entitylist::*}
# delete:
delete the block below the player
clear drops
delete {variable}
# reset:
reset walk speed of player
reset chunk at the targeted block
Set the player's display name to "<red>%name of player%"
set the block above the victim to lava
# add:
add 2 to the player's health # preferably use '<a href='#EffHealth'>heal</a>' for this
add argument to {blacklist::*}
give a diamond pickaxe of efficiency 5 to the player
increase the data value of the clicked block by 1
# remove:
remove 2 pickaxes from the victim
subtract 2.5 from {points::%uuid of player%}
# remove all:
remove every iron tool from the player
remove all minecarts from {entitylist::*}
# delete:
delete the block below the player
clear drops
delete {variable}
# reset:
reset walk speed of player
reset chunk at the targeted block
| Patterns: |
|
| Since: | 2.0, 2.2-dev26 (maps and potions) |
Colors items in a given color. You can also use RGB codes if you feel limited with the 16 default colors. RGB codes are three numbers from 0 to 255 in the order
(red, green, blue), where (0,0,0) is black and (255,255,255) is white. Armor is colorable for all Minecraft versions. With Minecraft 1.11 or newer you can also color potions and maps. Note that the colors might not look exactly how you'd expect. Examples:
dye player's helmet blue
color the player's tool red
color the player's tool red
| Patterns: |
|
| Since: | 1.0, 2.8.0 (bungeecord command) |
Executes a command. This can be useful to use other plugins in triggers.
If the command is a bungeecord side command, you can use the [bungeecord] option to execute command on the proxy.
If the command is a bungeecord side command, you can use the [bungeecord] option to execute command on the proxy.
Examples:
make player execute command "/home"
execute console command "/say Hello everyone!"
execute player bungeecord command "/alert &6Testing Announcement!"
execute console command "/say Hello everyone!"
execute player bungeecord command "/alert &6Testing Announcement!"
| Patterns: |
|
| Since: | 2.10 |
Sets whether the provided command blocks are conditional or not.
Examples:
make command block {_block} conditional
make command block {_block} unconditional if {_block} is conditional
make command block {_block} unconditional if {_block} is conditional
| Patterns: | |
| Since: | 2.3, 2.10 (transfer) |
Connect a player to a server running on your proxy, or any server supporting transfers. Read below for more information.
If the server is running Minecraft 1.20.5 or above, you may specify an IP and Port to transfer a player over to that server.
When transferring players using an IP, the transfer will not complete if the `accepts-transfers` option isn't enabled in `server.properties` for the server specified.
If the port is not provided, it will default to `25565`.
If the server is running Minecraft 1.20.5 or above, you may specify an IP and Port to transfer a player over to that server.
When transferring players using an IP, the transfer will not complete if the `accepts-transfers` option isn't enabled in `server.properties` for the server specified.
If the port is not provided, it will default to `25565`.
Examples:
connect all players to proxy server "hub"
transfer player to server "my.server.com"
transfer player to server "localhost" on port 25566
transfer player to server "my.server.com"
transfer player to server "localhost" on port 25566
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Paper |
Prevent the firework used in an 'elytra boost' event to be consumed.
Examples:
on elytra boost:
if the used firework will be consumed:
prevent the used firework from being consume
if the used firework will be consumed:
prevent the used firework from being consume
| Patterns: |
|
| Since: | 2.2-dev37, 2.7 (while loops), 2.8.0 (outer loops) |
Moves the loop to the next iteration. You may also continue an outer loop from an inner one. The loops are labelled from 1 until the current loop, starting with the outermost one.
Examples:
# Broadcast online moderators
loop all players:
if loop-value does not have permission "moderator":
continue # filter out non moderators
broadcast "%loop-player% is a moderator!" # Only moderators get broadcast
# Game starting counter
set {_counter} to 11
while {_counter} > 0:
remove 1 from {_counter}
wait a second
if {_counter} != 1, 2, 3, 5 or 10:
continue # only print when counter is 1, 2, 3, 5 or 10
broadcast "Game starting in %{_counter}% second(s)"
loop all players:
if loop-value does not have permission "moderator":
continue # filter out non moderators
broadcast "%loop-player% is a moderator!" # Only moderators get broadcast
# Game starting counter
set {_counter} to 11
while {_counter} > 0:
remove 1 from {_counter}
wait a second
if {_counter} != 1, 2, 3, 5 or 10:
continue # only print when counter is 1, 2, 3, 5 or 10
broadcast "Game starting in %{_counter}% second(s)"
| Patterns: | |
| Since: | 2.8.0 |
Copies objects into a variable. When copying a list over to another list, the source list and its sublists are also copied over.
Note: Copying a value into a variable/list will overwrite the existing data.
Note: Copying a value into a variable/list will overwrite the existing data.
Examples:
set {_foo::bar} to 1
set {_foo::sublist::foobar} to "hey"
copy {_foo::*} to {_copy::*}
broadcast indices of {_copy::*} # bar, sublist
broadcast {_copy::bar} # 1
broadcast {_copy::sublist::foobar} # "hey!"
set {_foo::sublist::foobar} to "hey"
copy {_foo::*} to {_copy::*}
broadcast indices of {_copy::*} # bar, sublist
broadcast {_copy::bar} # 1
broadcast {_copy::sublist::foobar} # "hey!"
| Patterns: |
|
| Since: | 1.0, 2.10 (damage cause) |
| Requirements: | Spigot 1.20.4+ (for damage cause) |
Damage, heal, or repair an entity or item.
Servers running Spigot 1.20.4+ can optionally choose to specify a fake damage cause.
Servers running Spigot 1.20.4+ can optionally choose to specify a fake damage cause.
Examples:
damage player by 5 hearts
damage player by 3 hearts with fake cause fall
heal the player
repair tool of player
damage player by 3 hearts with fake cause fall
heal the player
repair tool of player
| Patterns: |
|
| Since: | 1.4 |
Delays the script's execution by a given timespan. Please note that delays are not persistent, e.g. trying to create a tempban script with
ban player → wait 7 days → unban player will not work if you restart your server anytime within these 7 days. You also have to be careful even when using small delays! Examples:
wait 2 minutes
halt for 5 minecraft hours
wait a tick
halt for 5 minecraft hours
wait a tick
| Patterns: |
|
| Since: | 2.10 |
Immediately detonates an entity. Accepted entities are fireworks, TNT minecarts, primed TNT, wind charges and creepers.
Examples:
detonate last launched firework
| Patterns: |
|
| Since: | 2.3 |
Execute an effect if a condition is true.
Examples:
on join:
give a diamond to the player if the player has permission "rank.vip"
give a diamond to the player if the player has permission "rank.vip"
| Patterns: |
|
| Since: | 1.0 |
Drops one or more items.
Examples:
on death of creeper:
drop 1 TNT
drop 1 TNT
| Patterns: | |
| Since: | 2.4, 2.10 (unloading) |
Enables, disables, unloads, or reloads a script.
Disabling a script unloads it and prepends - to its name so it will not be loaded the next time the server restarts. If the script reflection experiment is enabled: unloading a script terminates it and removes it from memory, but does not alter the file.
Examples:
reload script "test"
enable script file "testing"
unload script file "script.sk"
set {_script} to the script "MyScript.sk"
reload {_script}
enable script file "testing"
unload script file "script.sk"
set {_script} to the script "MyScript.sk"
reload {_script}
| Patterns: |
|
| Since: | 2.0 |
Enchant or disenchant an existing item.
Examples:
enchant the player's tool with sharpness 5
disenchant the player's tool
disenchant the player's tool
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | MC 1.17+ |
Enforces or un-enforce a server's whitelist.
All non-whitelisted players will be kicked upon enforcing the whitelist.
All non-whitelisted players will be kicked upon enforcing the whitelist.
Examples:
enforce the whitelist
unenforce the whitelist
unenforce the whitelist
| Patterns: | |
| Since: | 2.3, 2.10 (entities) |
| Requirements: | Minecraft 1.19+ (entities) |
Change visibility of the given entities for the given players.
If no players are given, will hide the entities from all online players.
When reveal is used in combination of the hidden players expression and the viewers are not specified, this will default it to the given player in the hidden players expression.
Note: all previously hidden entities (including players) will be visible when a player leaves and rejoins.
If no players are given, will hide the entities from all online players.
When reveal is used in combination of the hidden players expression and the viewers are not specified, this will default it to the given player in the hidden players expression.
Note: all previously hidden entities (including players) will be visible when a player leaves and rejoins.
Examples:
on spawn:
if event-entity is a chicken:
hide event-entity
reveal hidden players of players
if event-entity is a chicken:
hide event-entity
reveal hidden players of players
| Patterns: |
|
| Since: | 1.0, 2.7 (multiple entities, unequip), 2.10 (wolves) |
Equips or unequips an entity with the given itemtypes (usually armor).
This effect will replace any armor that the entity is already wearing.
This effect will replace any armor that the entity is already wearing.
Examples:
equip player with diamond helmet
equip player with all diamond armor
unequip diamond chestplate from player
unequip all armor from player
unequip player's armor
equip player with all diamond armor
unequip diamond chestplate from player
unequip all armor from player
unequip player's armor
| Patterns: |
|
| Since: | unknown (before 2.1) |
Exits a given amount of loops and conditionals, or the entire trigger.
Examples:
if player has any ore:
stop
message "%player% has no ores!"
loop blocks above the player:
loop-block is not air:
exit 2 sections
set loop-block to water
stop
message "%player% has no ores!"
loop blocks above the player:
loop-block is not air:
exit 2 sections
set loop-block to water
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | Paper 1.13 or newer/Spigot 1.14 or newer. Ignition can be stopped on Paper 1.13 or newer. |
Starts the explosion process of a creeper or instantly explodes it.
Examples:
start explosion of the last spawned creeper
stop ignition of the last spawned creeper
stop ignition of the last spawned creeper
| Patterns: |
|
| Since: | 1.0 |
Creates an explosion of a given force. The Minecraft Wiki has an article on explosions which lists the explosion forces of TNT, creepers, etc.
Hint: use a force of 0 to create a fake explosion that does no damage whatsoever, or use the explosion effect introduced in Skript 2.0.
Starting with Bukkit 1.4.5 and Skript 2.0 you can use safe explosions which will damage entities but won't destroy any blocks.
Hint: use a force of 0 to create a fake explosion that does no damage whatsoever, or use the explosion effect introduced in Skript 2.0.
Starting with Bukkit 1.4.5 and Skript 2.0 you can use safe explosions which will damage entities but won't destroy any blocks.
Examples:
create an explosion of force 10 at the player
create an explosion of force 0 at the victim
create an explosion of force 0 at the victim
| Patterns: |
|
| Since: | 2.5.1 |
| Requirements: | Minecraft 1.15.2+ |
Makes a living entity attack an entity with a melee attack.
Examples:
spawn a wolf at player's location
make last spawned wolf attack player
make last spawned wolf attack player
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Spigot 1.20.5+ |
Forces the items to glint or not, or removes its existing enchantment glint enforcement.
Examples:
force {_items::*} to glint
force the player's tool to stop glinting
force the player's tool to stop glinting
| Patterns: |
|
| Since: | 2.2-dev21 |
Forces player(s) to respawn if they are dead. If this is called without delay from death event, one tick is waited before respawn attempt.
Examples:
on death of player:
force event-player to respawn
force event-player to respawn
| Patterns: |
|
| Since: | 2.10 |
Generates the loot in the specified inventories from a loot table using a loot context. Not specifying a loot context will use a loot context with a location at the world's origin.
Note that if the inventory is full, it will cause warnings in the console due to over-filling the inventory.
Note that if the inventory is full, it will cause warnings in the console due to over-filling the inventory.
Examples:
generate loot of loot table "minecraft:chests/simple_dungeon" using loot context at player in {_inventory}
generate loot using "minecraft:chests/shipwreck_supply" in {_inventory}
generate loot using "minecraft:chests/shipwreck_supply" in {_inventory}
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper 1.17.1+ |
Make mobs left or right-handed. This does not affect players.
Examples:
spawn skeleton at spawn of world "world":
make entity left handed
make all zombies in radius 10 of player right handed
make entity left handed
make all zombies in radius 10 of player right handed
| Patterns: | |
| Since: | 2.3 |
Hides a player from the hover list and decreases the online players count (only if the player count wasn't changed before).
Examples:
on server list ping:
hide {vanished::*} from the server list
hide {vanished::*} from the server list
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Spigot 1.20.5+ |
Show or hide the tooltip of an item.
If changing the 'entire' tooltip of an item, nothing will show up when a player hovers over it.
If changing the 'additional' tooltip, only specific parts (which change per item) will be hidden.
If changing the 'entire' tooltip of an item, nothing will show up when a player hovers over it.
If changing the 'additional' tooltip, only specific parts (which change per item) will be hidden.
Examples:
hide the entire tooltip of player's tool
hide {_item}'s additional tool tip
hide {_item}'s additional tool tip
| Patterns: |
|
| Since: | 2.4 |
| Usable in events: | death |
Keeps the inventory or/and experiences of the dead player in a death event.
Examples:
on death of a player:
if the victim is an op:
keep the inventory and experiences
if the victim is an op:
keep the inventory and experiences
| Patterns: |
|
| Since: | 1.0, 2.10 (ignoring totem of undying) |
Kills an entity.
Examples:
kill the player
kill all creepers in the player's world
kill all endermen, witches and bats
kill all creepers in the player's world
kill all endermen, witches and bats
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper 1.19.2+ |
Apply the same velocity as a knockback to living entities in a direction. Mechanics such as knockback resistance will be factored in.
Examples:
knockback player north
knock victim (vector from attacker to victim) with strength 10
knock victim (vector from attacker to victim) with strength 10
| Patterns: |
|
| Since: | 2.4 |
Launch firework effects at the given location(s).
Examples:
launch ball large colored red, purple and white fading to light green and black at player's location with duration 1
| Patterns: |
|
| Since: | 2.3 |
Leash living entities to other entities. When trying to leash an Ender Dragon, Wither, Player, or a Bat, this effect will not work.
See Spigot's Javadocs for more info.
See Spigot's Javadocs for more info.
Examples:
on right click:
leash event-entity to player
send "&aYou leashed &2%event-entity%!" to player
leash event-entity to player
send "&aYou leashed &2%event-entity%!" to player
| Patterns: |
|
| Since: | 1.4 |
Strike lightning at a given location. Can use 'lightning effect' to create a lightning that does not harm entities or start fires.
Examples:
strike lightning at the player
strike lightning effect at the victim
strike lightning effect at the victim
| Patterns: |
|
| Since: | 2.3 |
| Requirements: | Paper 1.12.2 or newer |
Loads server icons from the given files. You can get the loaded icon using the
last loaded server icon expression.
Please note that the image must be 64x64 and the file path starts from the server folder.
last loaded server icon expression.
Please note that the image must be 64x64 and the file path starts from the server folder.
Examples:
on load:
clear {server-icons::*}
loop 5 times:
load server icon from file "icons/%loop-number%.png"
add the last loaded server icon to {server-icons::*}
on server list ping:
set the icon to a random server icon out of {server-icons::*}
clear {server-icons::*}
loop 5 times:
load server icon from file "icons/%loop-number%.png"
add the last loaded server icon to {server-icons::*}
on server list ping:
set the icon to a random server icon out of {server-icons::*}
| Patterns: |
|
| Since: | 2.8.0 |
Load your worlds or unload your worlds
The load effect will create a new world if world doesn't already exist.
When attempting to load a normal vanilla world you must define it's environment i.e "world_nether" must be loaded with nether environment
The load effect will create a new world if world doesn't already exist.
When attempting to load a normal vanilla world you must define it's environment i.e "world_nether" must be loaded with nether environment
Examples:
load world "world_nether" with environment nether
load the world "myCustomWorld"
unload "world_nether"
unload "world_the_end" without saving
unload all worlds
load the world "myCustomWorld"
unload "world_nether"
unload "world_the_end" without saving
unload all worlds
| Patterns: |
|
| Since: | 2.3 |
Suppresses target warnings from the current script.
Examples:
locally suppress missing conjunction warnings
suppress the variable save warnings
suppress the variable save warnings
| Patterns: | |
| Since: | 2.0, 2.9.0 (severities) |
Writes text into a .log file. Skript will write these files to /plugins/Skript/logs.
NB: Using 'server.log' as the log file will write to the default server log. Omitting the log file altogether will log the message as '[Skript] [<script>.sk] <message>' in the server log.
NB: Using 'server.log' as the log file will write to the default server log. Omitting the log file altogether will log the message as '[Skript] [<script>.sk] <message>' in the server log.
Examples:
on join:
log "%player% has just joined the server!"
on world change:
log "Someone just went to %event-world%!" to file "worldlog/worlds.log"
on command:
log "%player% just executed %full command%!" to file "server/commands.log" with a severity of warning
log "%player% has just joined the server!"
on world change:
log "Someone just went to %event-world%!" to file "worldlog/worlds.log"
on command:
log "%player% just executed %full command%!" to file "server/commands.log" with a severity of warning
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper 1.17+, Paper 1.19.1+ (Players & Look Anchors) |
Forces the mob(s) or player(s) to look at an entity, vector or location. Vanilla max head pitches range from 10 to 50.
Examples:
force the player to look towards event-entity's feet
on entity explosion:
set {_player} to the nearest player
{_player} is set
distance between {_player} and the event-location is less than 15
make {_player} look towards vector from the {_player} to location of the event-entity
force {_enderman} to face the block 3 meters above {_location} at head rotation speed 100.5 and max head pitch -40
on entity explosion:
set {_player} to the nearest player
{_player} is set
distance between {_player} and the event-location is less than 15
make {_player} look towards vector from the {_player} to location of the event-entity
force {_enderman} to face the block 3 meters above {_location} at head rotation speed 100.5 and max head pitch -40
| Patterns: |
|
| Since: | 2.10 |
Force a animal to become an adult or baby.
Examples:
on spawn of mob:
entity is not an adult
make entity an adult
entity is not an adult
make entity an adult
| Patterns: |
|
| Since: | 2.10 |
Sets whether or not entities will be able to breed. Only works on animals.
Examples:
on spawn of animal:
make entity unbreedable
make entity unbreedable
| Patterns: |
|
| Since: | 2.7 |
| Usable in events: | Egg Throw |
Makes the egg hatch in a Player Egg Throw event.
Examples:
on player egg throw:
# EGGS FOR DAYZ!
make the egg hatch
# EGGS FOR DAYZ!
make the egg hatch
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Spigot 1.20.5+ |
Makes items fire resistant.
Examples:
make player's tool fire resistant:
make {_items::*} not resistant to fire
make {_items::*} not resistant to fire
| Patterns: | |
| Since: | 2.5 |
Sets if an entity's explosion will leave behind fire. This effect is also usable in an explosion prime event.
Examples:
on explosion prime:
make the explosion fiery
make the explosion fiery
| Patterns: |
|
| Since: | 2.7 |
Makes a living entity visible/invisible. This is not a potion and therefore does not have features such as a time limit or particles.
When setting an entity to invisible while using an invisibility potion on it, the potion will be overridden and when it runs out the entity keeps its invisibility.
When setting an entity to invisible while using an invisibility potion on it, the potion will be overridden and when it runs out the entity keeps its invisibility.
Examples:
make target entity invisible
| Patterns: | |
| Since: | 2.3 |
Forces a player to send a message to the chat. If the message starts with a slash it will force the player to use command.
Examples:
make the player say "Hello."
force all players to send the message "I love this server"
force all players to send the message "I love this server"
| Patterns: |
|
| Since: | 2.8.0 |
Makes a sign (either a block or item) have glowing text or normal text
Examples:
make target block of player have glowing text
| Patterns: |
|
| Since: | 1.0, 2.2-dev26 (advanced features), 2.5.2 (optional sender), 2.6 (sending objects) |
| Requirements: | Minecraft 1.16.4+ for optional sender |
Sends a message to the given player. Only styles written
in given string or in formatted expressions will be parsed.
Adding an optional sender allows the messages to be sent as if a specific player sent them.
This is useful with Minecraft 1.16.4's new chat ignore system, in which players can choose to ignore other players,
but for this to work, the message needs to be sent from a player.
in given string or in formatted expressions will be parsed.
Adding an optional sender allows the messages to be sent as if a specific player sent them.
This is useful with Minecraft 1.16.4's new chat ignore system, in which players can choose to ignore other players,
but for this to work, the message needs to be sent from a player.
Examples:
message "A wild %player% appeared!"
message "This message is a distraction. Mwahaha!"
send "Your kill streak is %{kill streak::%uuid of player%}%." to player
if the targeted entity exists:
message "You're currently looking at a %type of the targeted entity%!"
on chat:
cancel event
send "[%player%] >> %message%" to all players from player
message "This message is a distraction. Mwahaha!"
send "Your kill streak is %{kill streak::%uuid of player%}%." to player
if the targeted entity exists:
message "You're currently looking at a %type of the targeted entity%!"
on chat:
cancel event
send "[%player%] >> %message%" to all players from player
| Patterns: |
|
| Since: | 2.0, 2.1.1 (closing), 2.2-Fixes-V10 (anvil), 2.4 (hopper, dropper, dispenser |
Opens an inventory to a player. The player can then access and modify the inventory as if it was a chest that he just opened.
Please note that currently 'show' and 'open' have the same effect, but 'show' will eventually show an unmodifiable view of the inventory in the future.
Please note that currently 'show' and 'open' have the same effect, but 'show' will eventually show an unmodifiable view of the inventory in the future.
Examples:
show the victim's inventory to the player
open the player's inventory for the player
open the player's inventory for the player
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper |
Make an entity pathfind towards a location or another entity. Not all entities can pathfind. If the pathfinding target is another entity, the entities may or may not continuously follow the target.
Examples:
make all creepers pathfind towards player
make all cows stop pathfinding
make event-entity pathfind towards player at speed 1
make all cows stop pathfinding
make event-entity pathfind towards player at speed 1
| Patterns: |
|
| Since: | 2.1 |
Plays a visual effect at a given location or on a given entity.
Please note that some effects can only be played on entities, e.g. wolf hearts or the hurt effect, and that these are always visible to all players.
Please note that some effects can only be played on entities, e.g. wolf hearts or the hurt effect, and that these are always visible to all players.
Examples:
play wolf hearts on the clicked wolf
show mob spawner flames at the targeted block to the player
show mob spawner flames at the targeted block to the player
| Patterns: |
|
| Since: | 2.2-dev28, 2.4 (sound categories), 2.9 (sound seed & entity emitter) |
| Requirements: | Minecraft 1.18.1+ (entity emitters), Paper 1.19.4+ or Adventure API 4.12.0+ (sound seed) |
Plays a sound at given location for everyone or just for given players, or plays a sound to specified players. Both Minecraft sound names and Spigot sound names are supported. Playing resource pack sounds are supported too. The sound category is 'master' by default.
When running 1.19+, playing a sound from an entity directly will result in the sound coming from said entity, even while moving.
If the sound is custom, a location emitter will follow the entity. Do note that pitch and volume
are reflected based on the entity, and Minecraft may not use the values from this syntax.
If using Paper 1.19.4+ or Adventure API 4.12.0+ you can utilize sound seeds. Minecraft sometimes have a set of sounds under one sound ID
that will randomly play, to counter this, you can directly state which seed to use.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
When running 1.19+, playing a sound from an entity directly will result in the sound coming from said entity, even while moving.
If the sound is custom, a location emitter will follow the entity. Do note that pitch and volume
are reflected based on the entity, and Minecraft may not use the values from this syntax.
If using Paper 1.19.4+ or Adventure API 4.12.0+ you can utilize sound seeds. Minecraft sometimes have a set of sounds under one sound ID
that will randomly play, to counter this, you can directly state which seed to use.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
play sound "block.note_block.pling"
play sound "entity.experience_orb.pickup" with volume 0.5 to the player
play sound "custom.music.1" in jukebox category at {speakerBlock}
play sound "BLOCK_AMETHYST_BLOCK_RESONATE" with seed 1 on target entity for the player #1.20.1+
play sound "entity.experience_orb.pickup" with volume 0.5 to the player
play sound "custom.music.1" in jukebox category at {speakerBlock}
play sound "BLOCK_AMETHYST_BLOCK_RESONATE" with seed 1 on target entity for the player #1.20.1+
| Patterns: |
|
| Since: | 2.3 |
| Usable in events: | server list ping |
| Requirements: | Paper 1.12.2 or newer |
Sets whether all player related information is hidden in the server list.
The Vanilla Minecraft client will display ??? (dark gray) instead of player counts and will not show the
hover hist when hiding player info.
The version string can override the ???.
Also the Online Players Count and
Max Players expressions will return -1 when hiding player info.
The Vanilla Minecraft client will display ??? (dark gray) instead of player counts and will not show the
hover hist when hiding player info.
The version string can override the ???.
Also the Online Players Count and
Max Players expressions will return -1 when hiding player info.
Examples:
hide player info
hide player related information in the server list
reveal all player related info
hide player related information in the server list
reveal all player related info
| Patterns: |
|
| Since: | 1.3.2 |
Poison or cure a creature.
Examples:
poison the player
poison the victim for 20 seconds
cure the player from poison
poison the victim for 20 seconds
cure the player from poison
| Patterns: |
|
| Since: | 2.0, 2.2-dev27 (ambient and particle-less potion effects), 2.5 (replacing existing effect), 2.5.2 (potion effects), 2.7 (icon and infinite) |
Apply or remove potion effects to/from entities.
Examples:
apply ambient swiftness 2 to the player
remove haste from the victim
on join:
apply infinite potion of strength of tier {strength::%uuid of player%} to the player
apply potion of strength of tier {strength::%uuid of player%} to the player for 999 days # Before 1.19.4
apply potion effects of player's tool to player
apply haste potion of tier 3 without any particles whilst hiding the potion icon to the player # Hide potions
remove haste from the victim
on join:
apply infinite potion of strength of tier {strength::%uuid of player%} to the player
apply potion of strength of tier {strength::%uuid of player%} to the player for 999 days # Before 1.19.4
apply potion effects of player's tool to player
apply haste potion of tier 3 without any particles whilst hiding the potion icon to the player # Hide potions
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Fishing |
Pull the hooked entity to the player.
Examples:
on fishing state of caught entity:
pull in hooked entity
pull in hooked entity
| Patterns: |
|
| Since: | 2.10 |
Registers a new tag containing either items or entity datas. Note that items will NOT keep any information other than their type, so adding `diamond sword named "test"` to a tag is the same as adding `diamond sword`
Item tags should be used for contexts where the item is not placed down, while block tags should be used for contexts where the item is placed. For example, and item tag could be "skript:edible", while a block tag would be "skript:needs_water_above".
All custom tags will be given the namespace "skript", followed by the name you give it. The name must only include the characters A to Z, 0 to 9, and '/', '.', '_', and '-'. Otherwise, the tag will not register.
Please note that two tags can share a name if they are of different types. Registering a new tag of the same name and type will overwrite the existing tag. Tags will reset on server shutdown.
Item tags should be used for contexts where the item is not placed down, while block tags should be used for contexts where the item is placed. For example, and item tag could be "skript:edible", while a block tag would be "skript:needs_water_above".
All custom tags will be given the namespace "skript", followed by the name you give it. The name must only include the characters A to Z, 0 to 9, and '/', '.', '_', and '-'. Otherwise, the tag will not register.
Please note that two tags can share a name if they are of different types. Registering a new tag of the same name and type will overwrite the existing tag. Tags will reset on server shutdown.
Examples:
register a new custom entity tag named "fish" using cod, salmon, tropical fish, and pufferfish
register an item tag named "skript:wasp_weapons/swords" containing diamond sword and netherite sword
register block tag named "pokey" containing sweet berry bush and bamboo sapling
on player move:
block at player is tagged as tag "skript:pokey"
damage the player by 1 heart
register an item tag named "skript:wasp_weapons/swords" containing diamond sword and netherite sword
register block tag named "pokey" containing sweet berry bush and bamboo sapling
on player move:
block at player is tagged as tag "skript:pokey"
damage the player by 1 heart
| Patterns: |
|
| Since: | 2.0, 2.2-dev24 (multiple strings, items in inventory), 2.5 (replace first, case sensitivity), 2.10 (regex) |
Replaces all occurrences of a given text or regex with another text. Please note that you can only change variables and a few expressions, e.g. a message or a line of a sign.
Examples:
replace "<item>" in {_msg} with "[%name of player's tool%]"
replace every "&" with "§" in line 1 of targeted block
# Very simple chat censor
on chat:
replace all "idiot" and "noob" with "****" in the message
regex replace "\b(idiot|noob)\b" with "****" in the message # Regex version using word boundaries for better results
replace all stone and dirt in player's inventory and player's top inventory with diamond
replace every "&" with "§" in line 1 of targeted block
# Very simple chat censor
on chat:
replace all "idiot" and "noob" with "****" in the message
regex replace "\b(idiot|noob)\b" with "****" in the message # Regex version using word boundaries for better results
replace all stone and dirt in player's inventory and player's top inventory with diamond
| Patterns: |
|
| Since: | 2.2, 2.8.0 (returns aliases) |
Makes a trigger or a section (e.g. a function) return a value
Examples:
function double(i: number) :: number:
return 2 * {_i}
function divide(i: number) returns number:
return {_i} / 2
return 2 * {_i}
function divide(i: number) returns number:
return {_i} / 2
| Patterns: | |
| Since: | 2.9.0 |
| Requirements: | Spigot 1.19.4+ |
Causes a bell to ring.
Optionally, the entity that rang the bell and the direction the bell should ring can be specified.
A bell can only ring in two directions, and the direction is determined by which way the bell is facing.
By default, the bell will ring in the direction it is facing.
Optionally, the entity that rang the bell and the direction the bell should ring can be specified.
A bell can only ring in two directions, and the direction is determined by which way the bell is facing.
By default, the bell will ring in the direction it is facing.
Examples:
make player ring target-block
| Patterns: |
|
| Since: | 2.2-dev28, 2.10 (quaternions, displays) |
Rotates displays, quaternions, or vectors around an axis a set amount of degrees, or around all 3 axes at once.
Vectors can only be rotated around the global X/Y/Z axes, or an arbitrary vector axis.
Quaternions are more flexible, allowing rotation around the global or local X/Y/Z axes, arbitrary vectors, or all 3 local axes at once.
Global axes are the ones in the Minecraft world. Local axes are relative to how the quaternion is already oriented.
Rotating a display is a shortcut for rotating its left rotation. If the right rotation needs to be modified, it should be acquired, rotated, and re-set.
Note that rotating a quaternion/display around a vector results in a rotation around the local vector, so results may not be what you expect. For example, rotating quaternions/displays around vector(1, 0, 0) is the same as rotating around the local X axis.
The same applies to rotations by all three axes at once. In addition, rotating around all three axes of a quaternion/display at once will rotate in ZYX order, meaning the Z rotation will be applied first and the X rotation last.
Vectors can only be rotated around the global X/Y/Z axes, or an arbitrary vector axis.
Quaternions are more flexible, allowing rotation around the global or local X/Y/Z axes, arbitrary vectors, or all 3 local axes at once.
Global axes are the ones in the Minecraft world. Local axes are relative to how the quaternion is already oriented.
Rotating a display is a shortcut for rotating its left rotation. If the right rotation needs to be modified, it should be acquired, rotated, and re-set.
Note that rotating a quaternion/display around a vector results in a rotation around the local vector, so results may not be what you expect. For example, rotating quaternions/displays around vector(1, 0, 0) is the same as rotating around the local X axis.
The same applies to rotations by all three axes at once. In addition, rotating around all three axes of a quaternion/display at once will rotate in ZYX order, meaning the Z rotation will be applied first and the X rotation last.
Examples:
rotate {_quaternion} around x axis by 10 degrees
rotate last spawned block display around y axis by 10 degrees
rotate {_vector} around vector(1, 1, 1) by 45
rotate {_quaternion} by x 45, y 90, z 135
rotate last spawned block display around y axis by 10 degrees
rotate {_vector} around vector(1, 1, 1) by 45
rotate {_quaternion} by x 45, y 90, z 135
| Patterns: |
|
| Since: | 2.10 |
Executes a task (a function). Any returned result is discarded.
Examples:
set {_function} to the function named "myFunction"
run {_function}
run {_function} with arguments {_things::*}
run {_function}
run {_function} with arguments {_things::*}
| Patterns: |
|
| Since: | 2.8.0 |
Save all worlds or a given world manually.
Note: saving many worlds at once may possibly cause the server to freeze.
Note: saving many worlds at once may possibly cause the server to freeze.
Examples:
save "world_nether"
save all worlds
save all worlds
| Patterns: |
|
| Since: | 2.2-dev37c, 2.5.1 (block data support) |
Makes a player see a block as something it really isn't. BlockData support is only for MC 1.13+
Examples:
make player see block at player as dirt
make player see target block as campfire[facing=south]
make player see target block as campfire[facing=south]
| Patterns: | |
| Since: | 2.4 |
Request that the player's client download and switch resource packs. The client will download
the resource pack in the background, and will automatically switch to it once the download is complete.
The URL must be a direct download link.
The hash is used for caching, the player won't have to re-download the resource pack that way.
The hash must be SHA-1, you can get SHA-1 hash of your resource pack using
this online tool.
The resource pack request action can be used to check
status of the sent resource pack request.
the resource pack in the background, and will automatically switch to it once the download is complete.
The URL must be a direct download link.
The hash is used for caching, the player won't have to re-download the resource pack that way.
The hash must be SHA-1, you can get SHA-1 hash of your resource pack using
this online tool.
The resource pack request action can be used to check
status of the sent resource pack request.
Examples:
on join:
send the resource pack from "URL" with hash "hash" to the player
send the resource pack from "URL" with hash "hash" to the player
| Patterns: |
|
| Since: | 2.0 (cows, sheep & snowmen), 2.8.0 (all shearable entities) |
| Requirements: | Paper 1.19.4+ (all shearable entities) |
Shears or un-shears a shearable entity with drops by shearing and a 'sheared' sound. Using with 'force' will force this effect despite the entity's 'shear state'.
Please note that..:
- If your server is not running with Paper 1.19.4 or higher, this effect will only change its 'shear state', and the 'force' effect is unavailable
- Force-shearing or un-shearing on a sheared mushroom cow is not possible
Please note that..:
- If your server is not running with Paper 1.19.4 or higher, this effect will only change its 'shear state', and the 'force' effect is unavailable
- Force-shearing or un-shearing on a sheared mushroom cow is not possible
Examples:
on rightclick on a sheep holding a sword:
shear the clicked sheep
chance of 10%
force shear the clicked sheep
shear the clicked sheep
chance of 10%
force shear the clicked sheep
| Patterns: |
|
| Since: | 2.9.0, 2.10 (sort order) |
Sorts a list variable using either the natural ordering of the contents or the results of the given expression. Be warned, this will overwrite the indices of the list variable.
When using the full sort %~objects% (by|based on) <expression> pattern, the input expression can be used to refer to the current item being sorted. (See input expression for more information.)
Examples:
set {_words::*} to "pineapple", "banana", "yoghurt", and "apple"
sort {_words::*} # alphabetical sort
sort {_words::*} by length of input # shortest to longest
sort {_words::*} in descending order by length of input # longest to shortest
sort {_words::*} based on {tastiness::%input%} # sort based on custom value
sort {_words::*} # alphabetical sort
sort {_words::*} by length of input # shortest to longest
sort {_words::*} in descending order by length of input # longest to shortest
sort {_words::*} based on {tastiness::%input%} # sort based on custom value
| Patterns: |
|
| Since: | 2.5 |
Stops or restarts the server. If restart is used when the restart-script spigot.yml option isn't defined, the server will stop instead.
Examples:
stop the server
restart server
restart server
| Patterns: |
|
| Since: | 2.4, 2.7 (stop all sounds) |
| Requirements: | MC 1.17.1 (stop all sounds) |
Stops specific or all sounds from playing to a group of players. Both Minecraft sound names and Spigot sound names are supported. Resource pack sounds are supported too. The sound category is 'master' by default. A sound can't be stopped from a different category.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
stop sound "block.chest.open" for the player
stop playing sounds "ambient.underwater.loop" and "ambient.underwater.loop.additions" to the player
stop all sounds for all players
stop sound in the record category
stop playing sounds "ambient.underwater.loop" and "ambient.underwater.loop.additions" to the player
stop all sounds for all players
stop sound in the record category
| Patterns: |
|
| Since: | 2.5.1 |
| Requirements: | Minecraft 1.15.2+ |
Makes an entity swing their hand. This does nothing if the entity does not have an animation for swinging their hand.
Examples:
make player swing their main hand
| Patterns: |
|
| Since: | 2.10 |
Tame a tameable entity (horse, parrot, cat, etc.).
Examples:
tame {_horse}
untame {_horse}
untame {_horse}
| Patterns: |
|
| Since: | 1.0, 2.10 (flags) |
| Requirements: | Paper 1.19+ (teleport flags) |
Teleport an entity to a specific location.
This effect is delayed by default on Paper, meaning certain syntax such as the return effect for functions cannot be used after this effect.
The keyword 'force' indicates this effect will not be delayed,
which may cause lag spikes or server crashes when using this effect to teleport entities to unloaded chunks.
Teleport flags are settings to retain during a teleport. Such as direction, passengers, x coordinate, etc.
This effect is delayed by default on Paper, meaning certain syntax such as the return effect for functions cannot be used after this effect.
The keyword 'force' indicates this effect will not be delayed,
which may cause lag spikes or server crashes when using this effect to teleport entities to unloaded chunks.
Teleport flags are settings to retain during a teleport. Such as direction, passengers, x coordinate, etc.
Examples:
teleport the player to {home::%uuid of player%}
teleport the attacker to the victim
on dismount:
cancel event
teleport the player to {server::spawn} retaining vehicle and passengers
teleport the attacker to the victim
on dismount:
cancel event
teleport the player to {server::spawn} retaining vehicle and passengers
| Patterns: | |
| Since: | 2.10 |
Applies or removes drop shadow from the displayed text on a text display.
Examples:
apply drop shadow to last spawned text display
if {_display} has drop shadow:
remove drop shadow from the text of {_display}
if {_display} has drop shadow:
remove drop shadow from the text of {_display}
| Patterns: | |
| Since: | 2.10 |
Forces a text display to either be or not be visible through blocks.
Examples:
force last spawned text display to be visible through walls
prevent all text displays from being visible through walls
prevent all text displays from being visible through walls
| Patterns: | |
| Since: | 2.3 |
Sends a title/subtitle to the given player(s) with optional fadein/stay/fadeout times for Minecraft versions 1.11 and above.
If you're sending only the subtitle, it will be shown only if there's a title displayed at the moment, otherwise it will be sent with the next title. To show only the subtitle, use:
Note: if no input is given for the times, it will keep the ones from the last title sent, use the reset title effect to restore the default values.
If you're sending only the subtitle, it will be shown only if there's a title displayed at the moment, otherwise it will be sent with the next title. To show only the subtitle, use:
send title " " with subtitle "yourtexthere" to player.Note: if no input is given for the times, it will keep the ones from the last title sent, use the reset title effect to restore the default values.
Examples:
send title "Competition Started" with subtitle "Have fun, Stay safe!" to player for 5 seconds
send title "Hi %player%" to player
send title "Loot Drop" with subtitle "starts in 3 minutes" to all players
send title "Hello %player%!" with subtitle "Welcome to our server" to player for 5 seconds with fadein 1 second and fade out 1 second
send subtitle "Party!" to all players
send title "Hi %player%" to player
send title "Loot Drop" with subtitle "starts in 3 minutes" to all players
send title "Hello %player%!" with subtitle "Welcome to our server" to player for 5 seconds with fadein 1 second and fade out 1 second
send subtitle "Party!" to all players
| Patterns: |
|
| Since: | 2.8.0 |
Determines whether living entities are able to pick up items or not
Examples:
forbid player from picking up items
send "You can no longer pick up items!" to player
on drop:
if player can't pick up items:
allow player to pick up items
send "You can no longer pick up items!" to player
on drop:
if player can't pick up items:
allow player to pick up items
| Patterns: |
|
| Since: | 2.10 |
Transforms (or 'maps') a list's values using a given expression. This is akin to looping over the list and setting each value to a modified version of itself.
Evaluates the given expression for each element in the list, replacing the original element with the expression's result.
If the given expression returns a single value, the indices of the list will not change. If the expression returns multiple values, then then indices will be reset as a single index cannot contain multiple values.
Only variable lists can be transformed with this effect. For other lists, see the transform expression.
Evaluates the given expression for each element in the list, replacing the original element with the expression's result.
If the given expression returns a single value, the indices of the list will not change. If the expression returns multiple values, then then indices will be reset as a single index cannot contain multiple values.
Only variable lists can be transformed with this effect. For other lists, see the transform expression.
Examples:
set {_a::*} to 1, 2, and 3
transform {_a::*} using input * 2
# {_a::*} is now 2, 4, and 6
# get a list of the sizes of all clans without manually looping
set {_clan-sizes::*} to indices of {clans::*}
transform {_clan-sizes::*} using {clans::%input%::size}
# set all existing values of a list to 0:
transform {_list::*} to 0
transform {_a::*} using input * 2
# {_a::*} is now 2, 4, and 6
# get a list of the sizes of all clans without manually looping
set {_clan-sizes::*} to indices of {clans::*}
transform {_clan-sizes::*} using {clans::%input%::size}
# set all existing values of a list to 0:
transform {_list::*} to 0
| Patterns: |
|
| Since: | 1.0 |
Creates a tree.
This may require that there is enough space above the given location and that the block below is dirt/grass, but it is possible that the tree will just grow anyways, possibly replacing every block in its path.
This may require that there is enough space above the given location and that the block below is dirt/grass, but it is possible that the tree will just grow anyways, possibly replacing every block in its path.
Examples:
grow a tall redwood tree above the clicked block
| Patterns: |
|
| Since: | 2.10 |
Updates the blocks by setting them to a selected block
Using 'without physics' will not send updates to the surrounding blocks of the blocks being set.
Example: Updating a block next to a sand block in the air 'without physics' will not cause the sand block to fall.
Using 'without physics' will not send updates to the surrounding blocks of the blocks being set.
Example: Updating a block next to a sand block in the air 'without physics' will not cause the sand block to fall.
Examples:
update {_blocks::*} as gravel
update {_blocks::*} to be sand without physics updates
update {_blocks::*} as stone without neighbouring updates
update {_blocks::*} to be sand without physics updates
update {_blocks::*} as stone without neighbouring updates
| Patterns: |
|
| Since: | 2.0 |
Makes an entity ride another entity, e.g. a minecart, a saddled pig, an arrow, etc.
Examples:
make the player ride a saddled pig
make the attacker ride the victim
make the attacker ride the victim
| Patterns: |
|
| Since: | 1.0 |
Grant/revoke a user operator state.
Examples:
op the player
deop all players
deop all players
| Patterns: |
|
| Since: | 2.10 |
Shoots a projectile (or any other entity) from a given entity or location.
Examples:
shoot arrow from all players at speed 2
shoot a pig from all players:
add event-entity to {_projectiles::*}
shoot a pig from all players:
add event-entity to {_projectiles::*}
| Patterns: |
|
| Since: | 1.0, 2.6.1 (with section), 2.8.6 (dropped items), 2.10 (entity snapshots) |
| Requirements: | Minecraft 1.20.2+ (entity snapshots) |
Spawns entities. This can be used as an effect and as a section.
If it is used as a section, the section is run before the entity is added to the world.
You can modify the entity in this section, using for example 'event-entity' or 'cow'.
Do note that other event values, such as 'player', won't work in this section.
If you're spawning a display and want it to be empty on initialization, like not having a block display be stone, set hidden config node 'spawn empty displays' to true.
Note that when spawning an entity via entity snapshots, the code within the section will not run instantaneously as compared to spawning normally (via 'a zombie').
If it is used as a section, the section is run before the entity is added to the world.
You can modify the entity in this section, using for example 'event-entity' or 'cow'.
Do note that other event values, such as 'player', won't work in this section.
If you're spawning a display and want it to be empty on initialization, like not having a block display be stone, set hidden config node 'spawn empty displays' to true.
Note that when spawning an entity via entity snapshots, the code within the section will not run instantaneously as compared to spawning normally (via 'a zombie').
Examples:
spawn 3 creepers at the targeted block
spawn a ghast 5 meters above the player
spawn a zombie at the player:
set name of the zombie to ""
spawn a block display of a ladder[waterlogged=true] at location above player:
set billboard of event-display to center # allows the display to rotate around the center axis
spawn a ghast 5 meters above the player
spawn a zombie at the player:
set name of the zombie to ""
spawn a block display of a ladder[waterlogged=true] at location above player:
set billboard of event-display to center # allows the display to rotate around the center axis
| Patterns: | |
| Since: | 2.9.0 |
| Requirements: | Spigot 1.19.4+ |
Checks to see if a bell is currently resonating.
A bell will start resonating five game ticks after being rung, and will continue to resonate for 40 game ticks.
A bell will start resonating five game ticks after being rung, and will continue to resonate for 40 game ticks.
Examples:
target block is resonating
| Patterns: |
|
| Since: | 2.10 |
Checks whether or not an entity will be able to age/grow up.
Examples:
on breeding:
entity can't age
broadcast "An immortal has been born!" to player
entity can't age
broadcast "An immortal has been born!" to player
| Patterns: |
|
| Since: | 2.10 |
Checks whether or not a living entity can be bred.
Examples:
on right click on living entity:
event-entity can't breed
send "Turns out %event-entity% is not breedable. Must be a Skript user!" to player
event-entity can't breed
send "Turns out %event-entity% is not breedable. Must be a Skript user!" to player
| Patterns: |
|
| Since: | 2.0 |
| Requirements: | Supported regions plugin |
Tests whether a player is allowed to build at a certain location.
This condition requires a supported regions plugin to be installed.
This condition requires a supported regions plugin to be installed.
Examples:
command /setblock <material>:
description: set the block at your crosshair to a different type
trigger:
player cannot build at the targeted block:
message "You do not have permission to change blocks there!"
stop
set the targeted block to argument
description: set the block at your crosshair to a different type
trigger:
player cannot build at the targeted block:
message "You do not have permission to change blocks there!"
stop
set the targeted block to argument
| Patterns: |
|
| Since: | 1.0 |
Tests whether a player or a chest can hold the given item.
Examples:
block can hold 200 cobblestone
player has enough space for 64 feathers
player has enough space for 64 feathers
| Patterns: |
|
| Since: | 2.8.0 |
Whether living entities are able to pick up items off the ground or not.
Examples:
if player can pick items up:
send "You can pick up items!" to player
on drop:
if player can't pick up items:
send "Be careful, you won't be able to pick that up!" to player
send "You can pick up items!" to player
on drop:
if player can't pick up items:
send "Be careful, you won't be able to pick that up!" to player
| Patterns: | |
| Since: | 2.3, 2.10 (entities) |
| Requirements: | Minecraft 1.19+ (entities) |
Checks whether the given players can see the provided entities.
Examples:
if sender can't see the player-argument:
message "who dat?"
if the player can see the last spawned entity:
message "hello there!"
message "who dat?"
if the player can see the last spawned entity:
message "hello there!"
| Patterns: | |
| Since: | 2.10 |
| Requirements: | Paper |
Checks whether a player can see chat colors.
Examples:
if player can see chat colors:
send "Find the red word in <red>this<reset> message."
else:
send "You cannot partake in finding the colored word."
send "Find the red word in <red>this<reset> message."
else:
send "You cannot partake in finding the colored word."
| Patterns: | |
| Since: | 2.10 |
| Requirements: | Paper |
Checks whether a player can see specific message types in chat.
Examples:
if player can see all messages:
send "You can see all messages."
if player can only see commands:
send "This game doesn't work with commands-only chat."
if player can't see any messages:
send action bar "Server shutting down in 5 minutes!"
send "You can see all messages."
if player can only see commands:
send "This game doesn't work with commands-only chat."
if player can't see any messages:
send action bar "Server shutting down in 5 minutes!"
| Patterns: |
|
| Since: | 1.0 |
A condition that randomly succeeds or fails.
Valid values are between 0% and 100%, or if the percent sign is omitted between 0 and 1.
Valid values are between 0% and 100%, or if the percent sign is omitted between 0 and 1.
Examples:
chance of 50%:
drop a diamond
chance of {chance}% # {chance} between 0 and 100
chance of {chance} # {chance} between 0 and 1
drop a diamond
chance of {chance}% # {chance} between 0 and 100
chance of {chance} # {chance} between 0 and 1
| Patterns: |
|
| Since: | 1.0 |
A very general condition, it simply compares two values. Usually you can only compare for equality (e.g. block is/isn't of <type>), but some values can also be compared using greater than/less than. In that case you can also test for whether an object is between two others.
Note: This is the only element where not all patterns are shown. It has actually another two sets of similar patters, but with
Note: This is the only element where not all patterns are shown. It has actually another two sets of similar patters, but with
(was|were) or will be instead of (is|are) respectively, which check different time states of the first expression. Examples:
the clicked block is a stone slab or a double stone slab
time in the player's world is greater than 8:00
the creature is not an enderman or an ender dragon
time in the player's world is greater than 8:00
the creature is not an enderman or an ender dragon
| Patterns: |
|
| Since: | 1.0 |
Checks whether an inventory contains an item, a text contains another piece of text, a container contains something, or a list (e.g. {list variable::*} or 'drops') contains another object.
Examples:
block contains 20 cobblestone
player has 4 flint and 2 iron ingots
{list::*} contains 5
player has 4 flint and 2 iron ingots
{list::*} contains 5
| Patterns: |
|
| Since: | 2.0 |
Tests what kind of damage caused a damage event. Refer to the Damage Cause type for a list of all possible causes.
Examples:
# make players use their potions of fire resistance whenever they take any kind of fire damage
on damage:
damage was caused by lava, fire or burning
victim is a player
victim has a potion of fire resistance
cancel event
apply fire resistance to the victim for 30 seconds
remove 1 potion of fire resistance from the victim
# prevent mobs from dropping items under certain circumstances
on death:
entity is not a player
damage wasn't caused by a block explosion, an attack, a projectile, a potion, fire, burning, thorns or poison
clear drops
on damage:
damage was caused by lava, fire or burning
victim is a player
victim has a potion of fire resistance
cancel event
apply fire resistance to the victim for 30 seconds
remove 1 potion of fire resistance from the victim
# prevent mobs from dropping items under certain circumstances
on death:
entity is not a player
damage wasn't caused by a block explosion, an attack, a projectile, a potion, fire, burning, thorns or poison
clear drops
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Minecraft 1.16+ |
Checks whether or not respawn anchors work in a world.
Examples:
respawn anchors work in world "world_nether"
| Patterns: |
|
| Since: | 2.7 |
| Usable in events: | Egg Throw |
Whether the egg will hatch in a Player Egg Throw event.
Examples:
on player egg throw:
if an entity won't hatch:
send "Better luck next time!" to the player
if an entity won't hatch:
send "Better luck next time!" to the player
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | MC 1.13+ (cows, sheep & snowmen), Paper 1.19.4+ (all shearable entities) |
Checks whether entities are sheared. This condition only works on cows, sheep and snowmen for versions below 1.19.4.
Examples:
if targeted entity of player is sheared:
send "This entity has nothing left to shear!" to player
send "This entity has nothing left to shear!" to player
| Patterns: | |
| Since: | 2.6.1 |
| Requirements: | Minecraft 1.16+ (in water), Paper 1.16+ (in rain, lava and bubble column) |
Checks whether an entity is in rain, lava, water or a bubble column.
Examples:
if player is in rain:
if player is in water:
player is in lava:
player is in bubble column
if player is in water:
player is in lava:
player is in bubble column
| Patterns: |
|
| Since: | 2.2-dev36 |
Checks whether or not the event is cancelled.
Examples:
on click:
if event is cancelled:
broadcast "no clicks allowed!"
if event is cancelled:
broadcast "no clicks allowed!"
| Patterns: | |
| Since: | 1.2 |
Checks whether a given expression or variable is set.
Examples:
{teams::%player's uuid%::preferred-team} is not set
on damage:
projectile exists
broadcast "%attacker% used a %projectile% to attack %victim%!"
on damage:
projectile exists
broadcast "%attacker% used a %projectile% to attack %victim%!"
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Fishing |
Checks if the lure enchantment is applied to the current fishing event.
Examples:
on fishing line cast:
if lure enchantment is applied:
cancel event
if lure enchantment is applied:
cancel event
| Patterns: |
|
| Since: | 2.5 |
Checks whether an entity has AI.
Examples:
target entity has ai
| Patterns: | |
| Since: | 2.10 |
| Requirements: | Paper |
Checks whether a player has chat filtering enabled.
Examples:
if player doesn't have chat filtering enabled:
send "<gray>This server may contain mature chat messages. You have been warned!" to player
send "<gray>This server may contain mature chat messages. You have been warned!" to player
| Patterns: | |
| Since: | 2.3 |
Checks whether the given players have a custom client weather
Examples:
if the player has custom weather:
message "Your custom weather is %player's weather%"
message "Your custom weather is %player's weather%"
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | 1.14+ |
Check if an item has a custom model data tag
Examples:
player's tool has custom model data
| Patterns: |
|
| Since: | 2.8.0 |
Checks whether a sign (either a block or an item) has glowing text
Examples:
if target block has glowing text
| Patterns: |
|
| Since: | 2.8.0 |
Check whether a cooldown is active on the specified material for a specific player.
Examples:
if player has player's tool on cooldown:
send "You can't use this item right now. Wait %item cooldown of player's tool for player%"
send "You can't use this item right now. Wait %item cooldown of player's tool for player%"
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Spigot 1.20.5+ |
Whether the entire or additional tooltip of an item is shown or hidden.
The 'entire tooltip' is what shows to the player when they hover an item (i.e. name, lore, etc.).
The 'additional tooltip' hides certain information from certain items (potions, maps, books, fireworks, and banners).
The 'entire tooltip' is what shows to the player when they hover an item (i.e. name, lore, etc.).
The 'additional tooltip' hides certain information from certain items (potions, maps, books, fireworks, and banners).
Examples:
send true if entire tooltip of player's tool is shown
if additional tooltip of {_item} is hidden:
if additional tooltip of {_item} is hidden:
| Patterns: |
|
| Since: | 2.8.0 |
Checks whether living entities have an unobstructed line of sight to other entities or locations.
Examples:
player has direct line of sight to location 5 blocks to the right of player
victim has line of sight to attacker
player has no line of sight to location 100 blocks in front of player
victim has line of sight to attacker
player has no line of sight to location 100 blocks in front of player
| Patterns: | |
| Since: | 2.10 |
Checks whether an entity or block has a loot table. The loot tables of chests will be deleted when the chest is opened or broken.
Examples:
set event-block to chest
if event-block has a loot table:
# this will never happen, because it doesn't have a loot table.
set loot table of event-block to "minecraft:chests/simple_dungeon"
if event-block has a loot table:
# this will happen, because it now has a loot table.
if event-block has a loot table:
# this will never happen, because it doesn't have a loot table.
set loot table of event-block to "minecraft:chests/simple_dungeon"
if event-block has a loot table:
# this will happen, because it now has a loot table.
| Patterns: |
|
| Since: | 2.2-dev36 |
Checks whether a metadata holder has a metadata tag.
Examples:
if player has metadata value "healer":
| Patterns: |
|
| Since: | 1.0 |
Test whether a player has a certain permission.
Examples:
player has permission "skript.tree"
victim has the permission "admin":
send "You're attacking an admin!" to attacker
victim has the permission "admin":
send "You're attacking an admin!" to attacker
| Patterns: |
|
| Since: | 1.4, 2.7 (multiple players) |
Checks whether a player has played on this server before. You can also use on first join if you want to make triggers for new players.
Examples:
player has played on this server before
player hasn't played before
player hasn't played before
| Patterns: |
|
| Since: | 2.6.1 |
Checks whether the given living entities have specific potion effects.
Examples:
if player has potion speed:
send "You are sonic!"
if all players have potion effects speed and haste:
broadcast "You are ready to MINE!"
send "You are sonic!"
if all players have potion effects speed and haste:
broadcast "You are ready to MINE!"
| Patterns: | |
| Since: | 2.4 |
| Requirements: | Paper 1.9 or newer |
Checks whether the given players have a server resource pack loaded. Please note that this can't detect player's own resource pack, only the resource pack that sent by the server.
Examples:
if the player has a resource pack loaded:
| Patterns: | |
| Since: | 2.3 |
Checks whether the given entities has the given scoreboard tags.
Examples:
if the targeted armor stand has the scoreboard tag "test tag":
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | Paper 1.13 or newer |
Checks if a creeper is going to explode.
Examples:
if the last spawned creeper is going to explode:
loop all players in radius 3 of the last spawned creeper
send "RUN!!!" to the loop-player
loop all players in radius 3 of the last spawned creeper
send "RUN!!!" to the loop-player
| Patterns: | |
| Since: | 2.10 |
Checks whether a date is in the past or future.
Note that using the 'now' expression will not be in the past or future when used directly in the condition.
Note that using the 'now' expression will not be in the past or future when used directly in the condition.
Examples:
set {_date} to now
wait 5 seconds
if {_date} is in the past:
# this will be true
if now is in the future:
# this will be false
set {_dates::*} to 1 day from now, 12 days from now, and 1 year from now
if {_dates::*} are in the future:
# this will be true
if {_dates::*} have passed:
# this will be false
wait 5 seconds
if {_date} is in the past:
# this will be true
if now is in the future:
# this will be false
set {_dates::*} to 1 day from now, 12 days from now, and 1 year from now
if {_dates::*} are in the future:
# this will be true
if {_dates::*} have passed:
# this will be false
| Patterns: |
|
| Since: | 2.10 |
Checks whether or not a living entity is an adult.
Examples:
on drink:
event-entity is not an adult
kill event-entity
event-entity is not an adult
kill event-entity
| Patterns: | |
| Since: | 2.0, 2.4-alpha4 (non-living entity support) |
Checks whether an entity is alive. Works for non-living entities too.
Examples:
if {villager-buddy::%player's uuid%} is not dead:
on shoot:
while the projectile is alive:
on shoot:
while the projectile is alive:
| Patterns: |
|
| Since: | 2.10 |
Checks whether or not a living entity is a baby.
Examples:
on drink:
event-entity is a baby
kill event-entity
event-entity is a baby
kill event-entity
| Patterns: |
|
| Since: | 1.4 |
Checks whether a player or IP is banned.
Examples:
player is banned
victim is not IP-banned
"127.0.0.1" is banned
victim is not IP-banned
"127.0.0.1" is banned
| Patterns: |
|
| Since: | 2.7 |
| Usable in events: | respawn |
| Requirements: | Minecraft 1.16+ |
Checks what the respawn location of a player in the respawn event is.
Examples:
on respawn:
the respawn location is a bed
broadcast "%player% is respawning in their bed! So cozy!"
the respawn location is a bed
broadcast "%player% is respawning in their bed! So cozy!"
| Patterns: |
|
| Since: | 2.4 |
Checks whether an item is a block.
Examples:
player's held item is a block
{list::*} are blocks
{list::*} are blocks
| Patterns: | |
| Since: | 2.5 |
Checks if a block is indirectly or directly powered by redstone
Examples:
if clicked block is redstone powered:
send "This block is well-powered by redstone!"
if clicked block is indirectly redstone powered:
send "This block is indirectly redstone powered."
send "This block is well-powered by redstone!"
if clicked block is indirectly redstone powered:
send "This block is indirectly redstone powered."
| Patterns: | |
| Since: | unknown (before 2.1) |
Checks whether a player is blocking with their shield.
Examples:
on damage of player:
victim is blocking
damage attacker by 0.5 hearts
victim is blocking
damage attacker by 0.5 hearts
| Patterns: | |
| Since: | 1.4.4 |
Checks whether an entity is on fire, e.g. a zombie due to being in sunlight, or any entity after falling into lava.
Examples:
# increased attack against burning targets
victim is burning:
increase damage by 2
victim is burning:
increase damage by 2
| Patterns: | |
| Since: | 2.5, 2.10 (withers, wither skulls) |
Checks if a creeper, wither, or wither skull is charged (powered).
Examples:
if the last spawned creeper is charged:
broadcast "A charged creeper is at %location of last spawned creeper%"
broadcast "A charged creeper is at %location of last spawned creeper%"
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Minecraft 1.17+ |
Whether a living entity is climbing, such as a spider up a wall or a player on a ladder.
Examples:
spawn a spider at location of spawn
wait a second
if the last spawned spider is climbing:
message"The spider is now climbing!"
wait a second
if the last spawned spider is climbing:
message"The spider is now climbing!"
| Patterns: | |
| Since: | 2.10 |
Checks if an entity's custom name is visible.
Examples:
send true if target's custom name is visible
| Patterns: |
|
| Since: | 2.2-dev36 |
Checks whether an item is edible.
Examples:
steak is edible
player's tool is edible
player's tool is edible
| Patterns: |
|
| Since: | unknown (before 2.1) |
Checks whether an inventory, an inventory slot, a queue, or a text is empty.
Examples:
player's inventory is empty
| Patterns: |
|
| Since: | 1.4.6 |
Checks whether an item is enchanted.
Examples:
tool of the player is enchanted with efficiency 2
helm, chestplate, leggings or boots are enchanted
helm, chestplate, leggings or boots are enchanted
| Patterns: | |
| Since: | 2.10 |
Check if a number is evenly divisible by another number.
Examples:
if 5 is evenly divisible by 5:
if 11 cannot be evenly divided by 10:
if 11 cannot be evenly divided by 10:
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Spigot 1.20.5+ |
Checks whether an item is fire resistant.
Examples:
if player's tool is fire resistant:
if {_items::*} aren't resistant to fire:
if {_items::*} aren't resistant to fire:
| Patterns: | |
| Since: | 2.10 |
| Usable in events: | Fishing |
Checks whether the fish hook is in open water.
Open water is defined by a 5x4x5 area of water, air and lily pads. If in open water, treasure items may be caught.
Open water is defined by a 5x4x5 area of water, air and lily pads. If in open water, treasure items may be caught.
Examples:
on fish catch:
if fish hook is in open water:
send "You will catch a shark soon!"
if fish hook is in open water:
send "You will catch a shark soon!"
| Patterns: |
|
| Since: | 2.2-dev36 |
Checks whether an item is flammable.
Examples:
wood is flammable
player's tool is flammable
player's tool is flammable
| Patterns: | |
| Since: | 2.10 |
| Requirements: | PaperMC |
Checks if an entity was spawned from a mob spawner.
Examples:
send whether target is from a mob spawner
| Patterns: |
|
| Since: | 2.5.1 |
| Requirements: | Minecraft 1.11.2+ |
Checks whether an item can be used as fuel in a furnace.
Examples:
on right click on furnace:
if player's tool is not fuel:
send "Please hold a valid fuel item in your hand"
cancel event
if player's tool is not fuel:
send "Please hold a valid fuel item in your hand"
cancel event
| Patterns: |
|
| Since: | 2.7 |
Checks whether a living entity is gliding.
Examples:
if player is gliding
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper |
Checks whether an entity has one or both of their hands raised.
Hands are raised when an entity is using an item (eg: blocking, drawing a bow, eating).
Hands are raised when an entity is using an item (eg: blocking, drawing a bow, eating).
Examples:
on damage of player:
if victim's main hand is raised:
drop player's tool at player
set player's tool to air
if victim's main hand is raised:
drop player's tool at player
set player's tool to air
| Patterns: |
|
| Since: | 1.0 |
Checks whether a player is holding a specific item. Cannot be used with endermen, use 'entity is [not] an enderman holding <item type>' instead.
Examples:
player is holding a stick
victim isn't holding a sword of sharpness
victim isn't holding a sword of sharpness
| Patterns: |
|
| Since: | 2.10 |
Checks whether or not a living entity is in love.
Examples:
on spawn of living entity:
if entity is in love:
broadcast "That was quick!"
if entity is in love:
broadcast "That was quick!"
| Patterns: | |
| Since: | 2.5 |
Checks if an entity will create fire when it explodes. This condition is also usable in an explosion prime event.
Examples:
on explosion prime:
if the explosion is fiery:
broadcast "A fiery explosive has been ignited!"
if the explosion is fiery:
broadcast "A fiery explosive has been ignited!"
| Patterns: |
|
| Since: | 2.7 |
Checks whether potion effects are infinite.
Examples:
all of the active potion effects of the player are infinite
| Patterns: |
|
| Since: | 2.5.2 |
| Requirements: | Minecraft 1.13+ |
Checks wether or not a block is interactable.
Examples:
on block break:
if event-block is interactable:
cancel event
send "You cannot break interactable blocks!"
if event-block is interactable:
cancel event
send "You cannot break interactable blocks!"
| Patterns: |
|
| Since: | 2.7 |
Checks whether a living entity is invisible.
Examples:
target entity is invisible
| Patterns: | |
| Since: | 2.5, 2.10 (gamemode) |
| Requirements: | Paper 1.20.6+ (gamemodes) |
Checks whether an entity or a gamemode is invulnerable. For gamemodes, Paper and Minecraft 1.20.6 are required
Examples:
target entity is invulnerable
loop all gamemodes:
if loop-value is not invulnerable:
broadcast "the gamemode %loop-value% is vulnerable!"
loop all gamemodes:
if loop-value is not invulnerable:
broadcast "the gamemode %loop-value% is vulnerable!"
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper 1.15+ |
Checks whether a living entity is jumping. This condition does not work on players.
Examples:
on spawn of zombie:
while event-entity is not jumping:
wait 5 ticks
push event-entity upwards
while event-entity is not jumping:
wait 5 ticks
push event-entity upwards
| Patterns: |
|
| Since: | 2.5 |
Checks to see if an entity is currently leashed.
Examples:
target entity is leashed
| Patterns: | |
| Since: | 2.3, 2.5 (revamp with chunk at location/coords), 2.10 (Scripts) |
Checks whether a world, chunk or script is loaded.
'chunk at 1, 1' uses chunk coordinates, which are location coords divided by 16.
'chunk at 1, 1' uses chunk coordinates, which are location coords divided by 16.
Examples:
if chunk at {home::%player's uuid%} is loaded:
if chunk 1, 10 in world "world" is loaded:
if world("lobby") is loaded:
if script named "MyScript.sk" is loaded:
if chunk 1, 10 in world "world" is loaded:
if world("lobby") is loaded:
if script named "MyScript.sk" is loaded:
| Patterns: | |
| Since: | 2.10 |
Checks whether an entity or block is lootable. Lootables are entities or blocks that can have a loot table.
Examples:
spawn a pig at event-location
set {_pig} to last spawned entity
if {_pig} is lootable:
set loot table of {_pig} to "minecraft:entities/cow"
# the pig will now drop the loot of a cow when killed, because it is indeed a lootable entity.
set block at event-location to chest
if block at event-location is lootable:
set loot table of block at event-location to "minecraft:chests/simple_dungeon"
# the chest will now generate the loot of a simple dungeon when opened, because it is indeed a lootable block.
set block at event-location to wool block
if block at event-location is lootable:
# uh oh, nothing will happen because a wool is not a lootable block.
set {_pig} to last spawned entity
if {_pig} is lootable:
set loot table of {_pig} to "minecraft:entities/cow"
# the pig will now drop the loot of a cow when killed, because it is indeed a lootable entity.
set block at event-location to chest
if block at event-location is lootable:
set loot table of block at event-location to "minecraft:chests/simple_dungeon"
# the chest will now generate the loot of a simple dungeon when opened, because it is indeed a lootable block.
set block at event-location to wool block
if block at event-location is lootable:
# uh oh, nothing will happen because a wool is not a lootable block.
| Patterns: |
|
| Since: | 2.1 |
| Requirements: | Supported regions plugin |
Checks whether a player is a member or owner of a particular region.
This condition requires a supported regions plugin to be installed.
This condition requires a supported regions plugin to be installed.
Examples:
on region enter:
player is the owner of the region
message "Welcome back to %region%!"
send "%player% just entered %region%!" to all members of the region
player is the owner of the region
message "Welcome back to %region%!"
send "%player% just entered %region%!" to all members of the region
| Patterns: |
|
| Since: | 2.5.1 |
Checks whether an item is a block and completely blocks vision.
Examples:
player's tool is occluding
| Patterns: |
|
| Since: | 1.4 |
| Requirements: | Paper 1.20+ (Connected) |
Checks whether a player is online. The 'connected' pattern will return false once this player leaves the server, even if they rejoin. Be aware that using the 'connected' pattern with a variable will not have this special behavior. Use the direct event-player or other non-variable expression for best results.
Examples:
player is online
player-argument is offline
while player is connected:
wait 60 seconds
send "hello!" to player
# The following will act like `{_player} is online`.
# Using variables with `is connected` will not behave the same as with non-variables.
while {_player} is connected:
broadcast "online!"
wait 1 tick
player-argument is offline
while player is connected:
wait 60 seconds
send "hello!" to player
# The following will act like `{_player} is online`.
# Using variables with `is connected` will not behave the same as with non-variables.
while {_player} is connected:
broadcast "online!"
wait 1 tick
| Patterns: |
|
| Since: | 2.7 |
Checks whether a player is a server operator.
Examples:
player is an operator
| Patterns: | |
| Since: | 2.5.1 |
| Requirements: | Minecraft 1.13.2+ |
Checks whether a block is passable.
A block is passable if it has no colliding parts that would prevent players from moving through it.
Blocks like tall grass, flowers, signs, etc. are passable, but open doors, fence gates, trap doors, etc. are not because they still have parts that can be collided with.
A block is passable if it has no colliding parts that would prevent players from moving through it.
Blocks like tall grass, flowers, signs, etc. are passable, but open doors, fence gates, trap doors, etc. are not because they still have parts that can be collided with.
Examples:
if player's targeted block is passable
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Paper |
Checks whether living entities are pathfinding.
Can only be a living entity that is a Mob.
Can only be a living entity that is a Mob.
Examples:
make {_entity} pathfind to {_location} at speed 2
while {_entity} is pathfinding
wait a second
launch flickering trailing burst firework colored red at location of {_entity}
subtract 10 from {defence::tower::health}
clear entity within {_entity}
while {_entity} is pathfinding
wait a second
launch flickering trailing burst firework colored red at location of {_entity}
subtract 10 from {defence::tower::health}
clear entity within {_entity}
| Patterns: | |
| Since: | 2.6 |
Check if a plugin is enabled/disabled on the server.
Plugin names can be found in the plugin's 'plugin.yml' file or by using the '/plugins' command, they are NOT the name of the plugin's jar file.
When checking if a plugin is not enabled, this will return true if the plugin is either disabled or not on the server.
When checking if a plugin is disabled, this will return true if the plugin is on the server and is disabled.
Plugin names can be found in the plugin's 'plugin.yml' file or by using the '/plugins' command, they are NOT the name of the plugin's jar file.
When checking if a plugin is not enabled, this will return true if the plugin is either disabled or not on the server.
When checking if a plugin is disabled, this will return true if the plugin is on the server and is disabled.
Examples:
if plugin "Vault" is enabled:
if plugin "WorldGuard" is not enabled:
if plugins "Essentials" and "Vault" are enabled:
if plugin "MyBrokenPlugin" is disabled:
if plugin "WorldGuard" is not enabled:
if plugins "Essentials" and "Vault" are enabled:
if plugin "MyBrokenPlugin" is disabled:
| Patterns: |
|
| Since: | 1.4.4 |
Checks whether an entity is poisoned.
Examples:
player is poisoned:
cure the player from poison
message "You have been cured!"
cure the player from poison
message "You have been cured!"
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | 1.16.5+, Paper 1.19.2+ (blockdata) |
Checks whether an item is the preferred tool for a block. A preferred tool is one that will drop the block's item when used. For example, a wooden pickaxe is a preferred tool for grass and stone blocks, but not for iron ore.
Examples:
on left click:
event-block is set
if player's tool is the preferred tool for event-block:
break event-block naturally using player's tool
else:
cancel event
event-block is set
if player's tool is the preferred tool for event-block:
break event-block naturally using player's tool
else:
cancel event
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Minecraft 1.21.2+ |
Checks if a player is pressing a certain input key.
Examples:
on player input:
if player is pressing forward movement key:
send "You are moving forward!"
if player is pressing forward movement key:
send "You are moving forward!"
| Patterns: |
|
| Since: | 2.0 |
Tests whether an entity is riding another or is in a vehicle.
Examples:
player is riding a saddled pig
| Patterns: |
|
| Since: | 2.5 |
Checks to see if an entity is currently using the Riptide enchantment.
Examples:
target entity is riptiding
| Patterns: |
|
| Since: | 2.10 |
Checks whether a given entity (horse or steerable) is saddled.
If 'properly' is used, this will only return true if the entity is wearing specifically a saddle item.
If 'properly' is used, this will only return true if the entity is wearing specifically a saddle item.
Examples:
send whether {_horse} is saddled
| Patterns: | |
| Since: | 2.3 |
Tests whether a chunk is a so-called slime chunk.
Slimes can generally spawn in the swamp biome and in slime chunks.
For more info, see the Minecraft wiki.
Slimes can generally spawn in the swamp biome and in slime chunks.
For more info, see the Minecraft wiki.
Examples:
command /slimey:
trigger:
if chunk at player is a slime chunk:
send "Yeah, it is!"
else:
send "Nope, it isn't"
trigger:
if chunk at player is a slime chunk:
send "Yeah, it is!"
else:
send "Nope, it isn't"
| Patterns: | |
| Since: | 1.4.4 |
Checks whether a player is sneaking.
Examples:
# prevent mobs from seeing sneaking players if they are at least 4 meters apart
on target:
target is sneaking
distance of target and the entity is bigger than 4
cancel the event
on target:
target is sneaking
distance of target and the entity is bigger than 4
cancel the event
| Patterns: |
|
| Since: | 2.2-dev36 |
Checks whether an item is solid.
Examples:
grass block is solid
player's tool isn't solid
player's tool isn't solid
| Patterns: |
|
| Since: | 2.7 |
Checks whether an item is stackable.
Examples:
diamond axe is stackable
birch wood is stackable
torch is stackable
birch wood is stackable
torch is stackable
| Patterns: |
|
| Since: | 2.3 |
| Requirements: | 1.13 or newer |
Checks whether a living entity is swimming.
Examples:
player is swimming
| Patterns: |
|
| Since: | 2.10 |
Checks whether an item, block, entity, or entitydata is tagged with the given tag.
Examples:
if player's tool is tagged with minecraft tag "enchantable/sharp_weapon":
enchant player's tool with sharpness 1
if all logs are tagged with tag "minecraft:logs"
enchant player's tool with sharpness 1
if all logs are tagged with tag "minecraft:logs"
| Patterns: |
|
| Since: | 2.5 |
Check if an entity is tameable.
Examples:
on damage:
if victim is tameable:
cancel event
if victim is tameable:
cancel event
| Patterns: |
|
| Since: | 2.2-dev36 |
Checks whether an item is transparent. Note that this condition may not work for all blocks, due to the transparency list used by Spigot not being completely accurate.
Examples:
player's tool is transparent.
| Patterns: |
|
| Since: | 2.5.1, 2.9.0 (breakable) |
Checks whether an item is unbreakable.
Examples:
if event-item is unbreakable:
send "This item is unbreakable!" to player
if tool of {_p} is breakable:
send "Your tool is breakable!" to {_p}
send "This item is unbreakable!" to player
if tool of {_p} is breakable:
send "Your tool is breakable!" to {_p}
| Patterns: | |
| Since: | 2.9.0 |
Checks whether a script is using an experimental feature by name.
Examples:
the script is using "example feature"
on load:
if the script is using "example feature":
broadcast "You're using an experimental feature!"
on load:
if the script is using "example feature":
broadcast "You're using an experimental feature!"
| Patterns: | |
| Since: | 2.7, 2.10 (Scripts & Configs) |
Checks whether something (an entity, a script, a config, etc.) is valid.
An invalid entity may have died or de-spawned for some other reason.
An invalid script reference may have been reloaded, moved or disabled since.
An invalid entity may have died or de-spawned for some other reason.
An invalid script reference may have been reloaded, moved or disabled since.
Examples:
if event-entity is valid
| Patterns: |
|
| Since: | 1.0 |
Checks whether an entity is wearing some items (usually armor).
Examples:
player is wearing an iron chestplate and iron leggings
player is wearing all diamond armour
target is wearing wolf armor
player is wearing all diamond armour
target is wearing wolf armor
| Patterns: |
|
| Since: | 2.5.2, 2.9.0 (enforce, offline players) |
| Requirements: | MC 1.17+ (enforce) |
Whether or not the server or a player is whitelisted, or the server is whitelist enforced.
Examples:
if the player is whitelisted:
if the server is whitelisted:
if the server whitelist is enforced:
if the server is whitelisted:
if the server whitelist is enforced:
| Patterns: | |
| Since: | 2.7 |
| Requirements: | MC 1.17+ (within block) |
Whether a location is within something else. The "something" can be a block, an entity, a chunk, a world, or a cuboid formed by two other locations.
Note that using the is between condition will refer to a straight line between locations, while this condition will refer to the cuboid between locations.
Note that using the is between condition will refer to a straight line between locations, while this condition will refer to the cuboid between locations.
Examples:
if player's location is within {_loc1} and {_loc2}:
send "You are in a PvP zone!" to player
if player is in world("world"):
send "You are in the overworld!" to player
if attacker's location is inside of victim:
cancel event
send "Back up!" to attacker and victim
send "You are in a PvP zone!" to player
if player is in world("world"):
send "You are in the overworld!" to player
if attacker's location is inside of victim:
cancel event
send "Back up!" to attacker and victim
| Patterns: | |
| Since: | 2.7 |
Checks whether a location is within a certain radius of another location.
Examples:
on damage:
if attacker's location is within 10 blocks around {_spawn}:
cancel event
send "You can't PVP in spawn."
if attacker's location is within 10 blocks around {_spawn}:
cancel event
send "You can't PVP in spawn."
| Patterns: |
|
| Since: | 1.4 |
Checks whether an item or an entity is of the given type. This is mostly useful for variables, as you can use the general 'is' condition otherwise (e.g. 'victim is a creeper').
Examples:
tool is of type {selected type}
victim is of type {villager type}
victim is of type {villager type}
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Spigot 1.20.5+ |
Checks whether an item has the enchantment glint overridden, or is forced to glint or not.
Examples:
if the player's tool has the enchantment glint override
send "Your tool has the enchantment glint override." to player
if {_item} is forced to glint:
send "This item is forced to glint." to player
else if {_item} is forced to not glint:
send "This item is forced to not glint." to player
else:
send "This item does not have any glint override." to player
send "Your tool has the enchantment glint override." to player
if {_item} is forced to glint:
send "This item is forced to glint." to player
else if {_item} is forced to not glint:
send "This item is forced to not glint." to player
else:
send "This item does not have any glint override." to player
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Spigot 1.20.5+ |
Checks whether an item has the enchantment glint overridden, or is forced to glint or not.
Examples:
if the player's tool has the enchantment glint override
send "Your tool has the enchantment glint override." to player
if {_item} is forced to glint:
send "This item is forced to glint." to player
else if {_item} is forced to not glint:
send "This item is forced to not glint." to player
else:
send "This item does not have any glint override." to player
send "Your tool has the enchantment glint override." to player
if {_item} is forced to glint:
send "This item is forced to glint." to player
else if {_item} is forced to not glint:
send "This item is forced to not glint." to player
else:
send "This item does not have any glint override." to player
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Unleash |
| Requirements: | Paper 1.16+ |
Checks whether the leash item will drop during the leash detaching in an unleash event.
Examples:
on unleash:
if the leash will drop:
prevent the leash from dropping
else:
allow the leash to drop
if the leash will drop:
prevent the leash from dropping
else:
allow the leash to drop
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper 1.17.1+ (entities) |
Checks if living entities or players are left or right-handed. Armor stands are neither right nor left-handed.
Paper 1.17.1+ is required for non-player entities.
Paper 1.17.1+ is required for non-player entities.
Examples:
on damage of player:
if victim is left handed:
cancel event
if victim is left handed:
cancel event
| Patterns: | |
| Since: | 2.10 |
Check to see whether lidded blocks (chests, shulkers, etc.) are open or closed.
Examples:
if the lid of {_chest} is closed:
open the lid of {_block}
open the lid of {_block}
| Patterns: | |
| Since: | 2.5.2 |
Checks whether the defined strings match the input regexes (Regular expressions).
Examples:
on chat:
if message partially matches "\d":
send "Message contains a digit!"
if message doesn't match "[A-Za-z]+":
send "Message doesn't only contain letters!"
if message partially matches "\d":
send "Message contains a digit!"
if message doesn't match "[A-Za-z]+":
send "Message doesn't only contain letters!"
| Patterns: |
|
| Since: | 2.1 |
| Requirements: | Supported regions plugin |
Checks whether a location is contained in a particular region.
This condition requires a supported regions plugin to be installed.
This condition requires a supported regions plugin to be installed.
Examples:
player is in the region {regions::3}
on region enter:
region contains {flags.%world%.red}
message "The red flag is near!"
on region enter:
region contains {flags.%world%.red}
message "The red flag is near!"
| Patterns: |
|
| Since: | 2.4 |
| Usable in events: | resource pack request response |
Checks state of the resource pack in a resource pack request response event.
Examples:
on resource pack response:
if the resource pack wasn't accepted:
kick the player due to "You have to install the resource pack to play in this server!"
if the resource pack wasn't accepted:
kick the player due to "You have to install the resource pack to play in this server!"
| Patterns: |
|
| Since: | 2.5 |
Checks if current Minecraft version is given version or newer.
Examples:
running minecraft "1.14"
| Patterns: | |
| Since: | 2.10 |
Returns whether the text of a display has drop shadow applied.
Examples:
if {_display} has drop shadow:
remove drop shadow from the text of {_display}
remove drop shadow from the text of {_display}
| Patterns: | |
| Since: | 2.10 |
Returns whether text displays can be seen through blocks or not.
Examples:
if last spawned text display is visible through walls:
prevent last spawned text display from being visible through walls
prevent last spawned text display from being visible through walls
| Patterns: | |
| Since: | 2.0 |
Examples:
command /command-with-cooldown:
trigger:
{command::%player's uuid%::last-usage} was less than a minute ago:
message "Please wait a minute between uses of this command."
stop
set {command::%player's uuid%::last-usage} to now
# ... actual command trigger here ...
trigger:
{command::%player's uuid%::last-usage} was less than a minute ago:
message "Please wait a minute between uses of this command."
stop
set {command::%player's uuid%::last-usage} to now
# ... actual command trigger here ...
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Paper |
Checks to see if the firework used in an 'elytra boost' event will be consumed.
Examples:
on elytra boost:
if the used firework will be consumed:
prevent the used firework from being consume
if the used firework will be consumed:
prevent the used firework from being consume
| Patterns: |
|
| Since: | 1.0 |
Conditional sections
if: executed when its condition is true
else if: executed if all previous chained conditionals weren't executed, and its condition is true
else: executed if all previous chained conditionals weren't executed
parse if: a special case of 'if' condition that its code will not be parsed if the condition is not true
else parse if: another special case of 'else if' condition that its code will not be parsed if all previous chained conditionals weren't executed, and its condition is true
if: executed when its condition is true
else if: executed if all previous chained conditionals weren't executed, and its condition is true
else: executed if all previous chained conditionals weren't executed
parse if: a special case of 'if' condition that its code will not be parsed if the condition is not true
else parse if: another special case of 'else if' condition that its code will not be parsed if all previous chained conditionals weren't executed, and its condition is true
Examples:
if player's health is greater than or equal to 4:
send "Your health is okay so far but be careful!"
else if player's health is greater than 2:
send "You need to heal ASAP, your health is very low!"
else: # Less than 2 hearts
send "You are about to DIE if you don't heal NOW. You have only %player's health% heart(s)!"
parse if plugin "SomePluginName" is enabled: # parse if %condition%
# This code will only be executed if the condition used is met otherwise Skript will not parse this section therefore will not give any errors/info about this section
send "Your health is okay so far but be careful!"
else if player's health is greater than 2:
send "You need to heal ASAP, your health is very low!"
else: # Less than 2 hearts
send "You are about to DIE if you don't heal NOW. You have only %player's health% heart(s)!"
parse if plugin "SomePluginName" is enabled: # parse if %condition%
# This code will only be executed if the condition used is met otherwise Skript will not parse this section therefore will not give any errors/info about this section
| Patterns: |
|
| Since: | 2.10 |
Filters a variable list based on the supplied conditions. Unlike the filter expression, this effect maintains the indices of the filtered list.
It also supports filtering based on meeting any of the given criteria, rather than all, like multi-line if statements.
It also supports filtering based on meeting any of the given criteria, rather than all, like multi-line if statements.
Examples:
set {_a::*} to integers between -10 and 10
filter {_a::*} to match:
input is a number
mod(input, 2) = 0
input > 0
send {_a::*} # sends 2, 4, 6, 8, and 10
filter {_a::*} to match:
input is a number
mod(input, 2) = 0
input > 0
send {_a::*} # sends 2, 4, 6, 8, and 10
| Patterns: | |
| Since: | 2.10 |
A specialised loop section run for each element in a list. Unlike the basic loop, this is designed for extracting the key & value from pairs. The loop element's key/index and value can be stored in a variable for convenience.
When looping a simple (non-indexed) set of values, e.g. all players, the index will be the loop counter number.
Examples:
for each {_player} in players:
send "Hello %{_player}%!" to {_player}
loop {_item} in {list of items::*}:
broadcast {_item}'s name
for each key {_index} in {list of items::*}:
broadcast {_index}
loop key {_index} and value {_value} in {list of items::*}:
broadcast "%{_index}% = %{_value}%"
for each {_index}, {_value} in {my list::*}:
broadcast "%{_index}% = %{_value}%"
send "Hello %{_player}%!" to {_player}
loop {_item} in {list of items::*}:
broadcast {_item}'s name
for each key {_index} in {list of items::*}:
broadcast {_index}
loop key {_index} and value {_value} in {list of items::*}:
broadcast "%{_index}% = %{_value}%"
for each {_index}, {_value} in {my list::*}:
broadcast "%{_index}% = %{_value}%"
| Patterns: |
|
| Since: | 1.0 |
Loop sections repeat their code with multiple values.
A loop will loop through all elements of the given expression, e.g. all players, worlds, items, etc. The conditions & effects inside the loop will be executed for every of those elements, which can be accessed with ‘loop-’, e.g.
Loopable Values
All expressions that represent more than one value, e.g. ‘all players’, ‘worlds’, etc., as well as list variables, can be looped. You can also use a list of expressions, e.g.
List Variables
When looping list variables, you can also use
A loop will loop through all elements of the given expression, e.g. all players, worlds, items, etc. The conditions & effects inside the loop will be executed for every of those elements, which can be accessed with ‘loop-
send "hello" to loop-player. When a condition inside a loop is not fulfilled the loop will start over with the next element of the loop. You can however use stop loop to exit the loop completely and resume code execution after the end of the loop.Loopable Values
All expressions that represent more than one value, e.g. ‘all players’, ‘worlds’, etc., as well as list variables, can be looped. You can also use a list of expressions, e.g.
loop the victim and the attacker, to execute the same code for only a few values.List Variables
When looping list variables, you can also use
loop-index in addition to loop-value inside the loop. loop-value is the value of the currently looped variable, and loop-index is the last part of the variable's name (the part where the list variable has its asterisk *). Examples:
loop all players:
send "Hello %loop-player%!" to loop-player
loop items in player's inventory:
if loop-item is dirt:
set loop-item to air
loop 10 times:
send title "%11 - loop-value%" and subtitle "seconds left until the game begins" to player for 1 second # 10, 9, 8 etc.
wait 1 second
loop {Coins::*}:
set {Coins::%loop-index%} to loop-value + 5 # Same as "add 5 to {Coins::%loop-index%}" where loop-index is the uuid of the player and loop-value is the number of coins for the player
loop shuffled (integers between 0 and 8):
if all:
previous loop-value = 1
loop-value = 4
next loop-value = 8
then:
kill all players
send "Hello %loop-player%!" to loop-player
loop items in player's inventory:
if loop-item is dirt:
set loop-item to air
loop 10 times:
send title "%11 - loop-value%" and subtitle "seconds left until the game begins" to player for 1 second # 10, 9, 8 etc.
wait 1 second
loop {Coins::*}:
set {Coins::%loop-index%} to loop-value + 5 # Same as "add 5 to {Coins::%loop-index%}" where loop-index is the uuid of the player and loop-value is the number of coins for the player
loop shuffled (integers between 0 and 8):
if all:
previous loop-value = 1
loop-value = 4
next loop-value = 8
then:
kill all players
| Patterns: |
|
| Since: | 2.0, 2.6 (do while) |
While Loop sections are loops that will just keep repeating as long as a condition is met.
Examples:
while size of all players < 5:
send "More players are needed to begin the adventure" to all players
wait 5 seconds
set {_counter} to 1
do while {_counter} > 1: # false but will increase {_counter} by 1 then get out
add 1 to {_counter}
# Be careful when using while loops with conditions that are almost
# always true for a long time without using 'wait %timespan%' inside it,
# otherwise it will probably hang and crash your server.
while player is online:
give player 1 dirt
wait 1 second # without using a delay effect the server will crash
send "More players are needed to begin the adventure" to all players
wait 5 seconds
set {_counter} to 1
do while {_counter} > 1: # false but will increase {_counter} by 1 then get out
add 1 to {_counter}
# Be careful when using while loops with conditions that are almost
# always true for a long time without using 'wait %timespan%' inside it,
# otherwise it will probably hang and crash your server.
while player is online:
give player 1 dirt
wait 1 second # without using a delay effect the server will crash
| Patterns: | |
| Since: | 1.3.4 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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: | 2.10 |
| Requirements: | Paper |
Called when a player changes the effects of a beacon.
Examples:
on beacon effect change:
broadcast event-player
broadcast event-block
broadcast primary beacon effect
broadcast secondary beacon effect
on beacon change effect:
on player change beacon effect:
broadcast event-player
broadcast event-block
broadcast primary beacon effect
broadcast secondary beacon effect
on beacon change effect:
on player change beacon effect:
| Patterns: |
|
| Since: | Unknown |
| Requirements: |
Missing description.
Examples:
Missing examples.
| Patterns: |
|
| Since: | Unknown |
| Requirements: |
Missing description.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
Called when a player starts sleeping.
Examples:
on bed enter:
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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 |
| Requirements: |
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.10 |
| Requirements: |
Called when a block broken by a player drops something.
If the breaking of the block leads to others being broken, such as torches, they will appearin "event-items" and "event-entities".
- event-player: The player that broke the block
- past event-block: The block that was broken
- event-block: The block after being broken
- event-items (or drops): The drops of the block
- event-entities: The entities of the dropped items
If the breaking of the block leads to others being broken, such as torches, they will appearin "event-items" and "event-entities".
Examples:
on block drop:
broadcast event-player
broadcast past event-block
broadcast event-block
broadcast event-items
broadcast event-entities
on block drop of oak log:
broadcast event-player
broadcast past event-block
broadcast event-block
broadcast event-items
broadcast event-entities
on block drop of oak 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 |
| Requirements: |
Called when a crop grows. Alternative to new form of generic grow event.
Examples:
on crop growth:
| Patterns: |
|
| Since: | 2.2-dev31 |
| Requirements: |
Called when a player edits a book.
Examples:
on book edit:
| Patterns: |
|
| Since: | 2.2-dev31 |
| Requirements: |
Called when a player signs a book.
Examples:
on book sign:
| Patterns: |
|
| Since: | 1.0 (break), unknown (mine), 2.6 (BlockData support) |
| Requirements: |
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: | 2.10 |
| Requirements: |
Called when a message is broadcasted.
Examples:
on broadcast:
set broadcast-message to "&c[BROADCAST] %broadcasted message%"
set broadcast-message to "&c[BROADCAST] %broadcasted message%"
| Patterns: |
|
| Since: | Unknown |
| Requirements: |
Missing description.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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 |
| Requirements: |
Called when a player fills a bucket.
Examples:
on player filling a bucket:
| Patterns: |
|
| Since: | 1.0, 2.6 (BlockData support) |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
Called after a new chunk was generated.
Examples:
on chunk generate:
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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 |
| Requirements: |
Called when a chunk is unloaded due to not being near any player.
Examples:
on chunk unload:
| Patterns: |
|
| Since: | 1.0, 2.10 (blockdata) |
| Requirements: |
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 click on chest[facing=north]:
on click on campfire[lit=true]:
on rightclick holding a fishing rod:
on leftclick on a stone or obsidian:
on rightclick on a creeper:
on click with a sword:
on click on chest[facing=north]:
on click on campfire[lit=true]:
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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) |
| Requirements: |
Called when a player crafts an item.
Examples:
on craft:
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
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) |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
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.10 |
| Requirements: | Paper |
Called when a player uses a firework to boost their fly speed when flying with an elytra.
Examples:
on elytra boost:
if the used firework will be consumed:
prevent the used firework from being consume
if the used firework will be consumed:
prevent the used firework from being consume
| Patterns: |
|
| Since: | 2.5 |
| Requirements: |
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 |
| Requirements: |
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) |
| Requirements: |
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.10 |
| Requirements: |
Called whenever two animals begin to conceive a child. The type can be specified.
Examples:
on breeding of llamas:
send "When a %breeding mother% and %breeding father% love each other very much they make %offspring%" to breeder
send "When a %breeding mother% and %breeding father% love each other very much they make %offspring%" to breeder
| Patterns: |
|
| Since: | 2.2-dev13b |
| Requirements: |
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 |
| Requirements: |
Called when entity starts riding another.
Examples:
on mount:
cancel event
cancel event
| Patterns: |
|
| Since: | 2.5.3 |
| Requirements: |
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.10 |
| Requirements: |
Called when an entity's potion effect is modified.
This modification can include adding, removing or changing their potion effect.
This modification can include adding, removing or changing their potion effect.
Examples:
on entity potion effect modification:
broadcast "A potion effect was added to %event-entity%!"
on entity potion effect modification of night vision:
broadcast "A potion effect was added to %event-entity%!"
on entity potion effect modification of night vision:
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: |
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 |
| Requirements: |
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.10 |
| Requirements: |
Called when a player's experience cooldown changes.
Experience cooldown is how long until a player can pick up another orb of experience.
Experience cooldown is how long until a player can pick up another orb of experience.
Examples:
on player experience cooldown change:
broadcast event-player
broadcast event-timespan
broadcast past event-timespan
broadcast xp cooldown change reason
broadcast event-player
broadcast event-timespan
broadcast past event-timespan
broadcast xp cooldown change reason
| Patterns: |
|
| Since: | 2.0 |
| Requirements: |
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 |
| Requirements: |
Called when an entity (a primed TNT or a creeper) explodes.
Examples:
on explosion:
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
Called when a firework explodes.
Examples:
on firework explode:
if event-colors contains red:
on firework exploding colored red, light green and black:
on firework explosion colored rgb 0, 255, 0:
broadcast "A firework colored %colors% was exploded at %location%!"
if event-colors contains red:
on firework exploding colored red, light green and black:
on firework explosion colored rgb 0, 255, 0:
broadcast "A firework colored %colors% was exploded at %location%!"
| Patterns: |
|
| Since: | 1.3.7 |
| Requirements: |
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: | 2.10 |
| Requirements: | Paper (bobber lured) |
Called when a player triggers a fishing event.
An entity hooked event is triggered when an entity gets caught by a fishing rod.
A fish escape event is called when the player fails to click on time, and the fish escapes.
A fish approaching event is when the bobber is waiting to be hooked, and a fish is approaching.
An entity hooked event is triggered when an entity gets caught by a fishing rod.
A fish escape event is called when the player fails to click on time, and the fish escapes.
A fish approaching event is when the bobber is waiting to be hooked, and a fish is approaching.
Examples:
on fishing line cast:
send "You caught a fish!" to player
on fishing state of caught entity:
push event-entity vector from entity to player
send "You caught a fish!" to player
on fishing state of caught entity:
push event-entity vector from entity to player
| Patterns: |
|
| Since: | 2.2-dev36 |
| Requirements: |
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 |
| Requirements: |
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) |
| Requirements: |
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, 2.10 (specific item) |
| Requirements: |
Called when a furnace burns an item from its fuel slot.
Examples:
on fuel burning:
broadcast fuel burned
if burned fuel is coal:
add 20 seconds to burn time
broadcast fuel burned
if burned fuel is coal:
add 20 seconds to burn time
| Patterns: |
|
| Since: | 2.10 |
| Requirements: |
Called when a player takes any item out of the furnace.
Examples:
on furnace extract:
if event-items is an iron ingot:
remove event-items from event-player's inventory
if event-items is an iron ingot:
remove event-items from event-player's inventory
| Patterns: |
|
| Since: | 2.2-dev21 |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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: | 2.10 |
| Requirements: |
Called when an entity is leashed or unleashed. Cancelling these events will prevent the leashing or unleashing from occurring.
Examples:
on player leash of a sheep:
send "Baaaaa--" to player
on player leash:
send "<%event-entity%> Let me go!" to player
on unleash:
broadcast "<%event-entity%> I'm free"
on player unleash:
send "<%event-entity%> Thanks for freeing me!" to player
send "Baaaaa--" to player
on player leash:
send "<%event-entity%> Let me go!" to player
on unleash:
broadcast "<%event-entity%> I'm free"
on player unleash:
send "<%event-entity%> Thanks for freeing me!" to player
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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) |
| Requirements: |
Called when a player's level changes, e.g. by gathering experience or by enchanting something.
Examples:
on level change:
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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.10 |
| Requirements: |
Called whenever an entity enters a state of being in love.
Examples:
on love mode enter:
cancel event # No one is allowed love here
cancel event # No one is allowed love here
| 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 |
| Requirements: |
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 |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
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: | 2.10 |
| Requirements: | Minecraft 1.16+ |
Called when a piglin finishes bartering. A piglin may start bartering after picking up an item on its bartering list.
Cancelling will prevent piglins from dropping items, but will still make them pick up the input.
Cancelling will prevent piglins from dropping items, but will still make them pick up the input.
Examples:
on piglin barter:
if barter drops contain diamond:
send "Diamonds belong in the money pit!" to player
cancel event
if barter drops contain diamond:
send "Diamonds belong in the money pit!" to player
cancel event
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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 |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
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.10 |
| Requirements: | Minecraft 1.21.3+ |
Called when a player sends an updated input to the server.
Note: The input keys event value is the set of keys the player is currently pressing, not the keys that were pressed or released.
Note: The input keys event value is the set of keys the player is currently pressing, not the keys that were pressed or released.
Examples:
on any input key press:
send "You are pressing: %event-inputkeys%" to player
send "You are pressing: %event-inputkeys%" 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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
Called when a projectile hits an entity or a block.
Examples:
on projectile hit:
if victim's health <= 3:
delete event-projectile
if victim's health <= 3:
delete event-projectile
| Patterns: |
|
| Since: | 1.0 (simple disconnection) |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
Called when sheep regrows its sheared wool back.
Examples:
on sheep grow wool:
cancel event
cancel event
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
Called when a slime splits. Usually this happens when a big slime dies.
Examples:
on slime split:
| Patterns: |
|
| Since: | 1.0, 2.10 (specific item) |
| Requirements: |
Called when a furnace smelts an item in its input slot.
Examples:
on smelt:
clear the smelted item
on smelt of raw iron:
broadcast smelted item
set the smelted item to iron block
clear the smelted item
on smelt of raw iron:
broadcast smelted item
set the smelted item to iron block
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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.10 |
| Requirements: |
Called when a furnace starts smelting an item in its ore slot.
Examples:
on smelting start:
if the smelting item is raw iron:
set total cook time to 1 second
on smelting start of raw iron:
add 20 seconds to total cook time
if the smelting item is raw iron:
set total cook time to 1 second
on smelting start of raw iron:
add 20 seconds to total cook time
| 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 |
| Requirements: |
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 |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
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: | 2.10 |
| Requirements: |
Called when a vehicle collides with a block or entity.
Examples:
on vehicle collision:
on vehicle collision with obsidian:
on vehicle collision with a zombie:
on vehicle collision with obsidian:
on vehicle collision with a zombie:
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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 |
| Requirements: |
Called when a vehicle gets damage. Too much damage will destroy the vehicle.
Examples:
on vehicle damage:
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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: | 2.10 |
| Requirements: |
Called when a vehicle moves.
Please note that using this event can cause lag if there are multiple vehicle entities, i.e. Horse, Pig, Boat, Minecart
Please note that using this event can cause lag if there are multiple vehicle entities, i.e. Horse, Pig, Boat, Minecart
Examples:
on vehicle move:
broadcast past event-location
broadcast event-location
broadcast past event-location
broadcast event-location
| Patterns: |
|
| Since: | 1.0 |
| Requirements: |
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) |
| Requirements: |
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) |
| Requirements: |
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) |
| Requirements: |
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) |
| Requirements: |
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 |
| Requirements: |
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 |
| Requirements: |
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:
| Patterns: | |
| Since: | 1.0 |
| Requirements: |
An event that is called periodically.
Examples:
every 2 seconds in "world":
every minecraft hour in "flatworld":
every tick in "world": # can cause lag depending on the code inside the event
every minecraft days in "plots":
every minecraft hour in "flatworld":
every tick in "world": # can cause lag depending on the code inside the event
every minecraft days in "plots":
| Patterns: |
|
| Since: | 2.10 |
Something that has a name (e.g. an item).
Examples:
{thing}'s name
| Patterns: |
|
| Since: | 2.10 |
Something that has an amount or size.
Examples:
the size of {thing}
the amount of {thing}
the amount of {thing}
| Patterns: |
|
| Since: | 2.10 |
Something that has a value.
Examples:
the text of {node}
| Patterns: |
|
| Since: | 2.10 |
Something that contains other things.
Examples:
{a} contains {b}
| Patterns: |
|
| Since: | 2.5 |
Represents the type of an attribute. Note that this type does not contain any numerical values.See attribute types for more info.
NOTE: Minecraft namespaces are supported, ex: 'minecraft:generic.attack_damage'.
NOTE: Minecraft namespaces are supported, ex: 'minecraft:generic.attack_damage'.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
Represents a banner pattern.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
Represents the various banner patterns that can be applied to a banner.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.4.4 |
All possible biomes Minecraft uses to generate a world.
NOTE: Minecraft namespaces are supported, ex: 'minecraft:basalt_deltas'.
NOTE: Minecraft namespaces are supported, ex: 'minecraft:basalt_deltas'.
Examples:
biome at the player is desert
| Patterns: |
|
| Since: | 2.5 |
Block data is the detailed information about a block, referred to in Minecraft as BlockStates, allowing for the manipulation of different aspects of the block, including shape, waterlogging, direction the block is facing, and so much more. Information regarding each block's optional data can be found on Minecraft's Wiki. Find the block you're looking for and scroll down to 'Block States'. Different states must be separated by a semicolon (see examples). The 'minecraft:' namespace is optional, as well as are underscores.
Examples:
set block at player to campfire[lit=false]
set target block of player to oak stairs[facing=north;waterlogged=true]
set block at player to grass_block[snowy=true]
set loop-block to minecraft:chest[facing=north]
set block above player to oak_log[axis=y]
set target block of player to minecraft:oak_leaves[distance=2;persistent=false]
set target block of player to oak stairs[facing=north;waterlogged=true]
set block at player to grass_block[snowy=true]
set loop-block to minecraft:chest[facing=north]
set block above player to oak_log[axis=y]
set target block of player to minecraft:oak_leaves[distance=2;persistent=false]
| Patterns: |
|
| Since: | 1.0 |
A boolean is a value that is either true or false. Other accepted names are 'on' and 'yes' for true, and 'off' and 'no' for false.
Examples:
set {config.%player%.use mod} to false
| Patterns: |
|
| Since: | 2.4 |
| Requirements: | Minecraft 1.14 or newer |
Represents the race/type of a cat entity.
NOTE: Minecraft namespaces are supported, ex: 'minecraft:british_shorthair'.
NOTE: Minecraft namespaces are supported, ex: 'minecraft:british_shorthair'.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.0 |
A chunk is a cuboid of 16×16×128 (x×z×y) blocks. Chunks are spread on a fixed rectangular grid in their world.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.2-dev16b, 2.2-dev35 (renamed to click type) |
Click type, mostly for inventory events. Tells exactly which keys/buttons player pressed, assuming that default keybindings are used in client side.
Examples:
Missing examples.
| Patterns: |
|
| Since: | Unknown |
Wool, dye and chat colors.
Examples:
color of the sheep is red or black
set the color of the block to green
message "You're holding a &amp;amp;amp;amp;amp;amp;lt;%color of tool%&amp;amp;amp;amp;amp;amp;gt;%color of tool%&amp;amp;amp;amp;amp;amp;lt;reset&amp;amp;amp;amp;amp;amp;gt; wool block"
set the color of the block to green
message "You're holding a &amp;amp;amp;amp;amp;amp;lt;%color of tool%&amp;amp;amp;amp;amp;amp;gt;%color of tool%&amp;amp;amp;amp;amp;amp;lt;reset&amp;amp;amp;amp;amp;amp;gt; wool block"
| Patterns: |
|
| Since: | 1.0 |
A player or the console.
Examples:
command /push [&amp;amp;amp;amp;amp;amp;amp;lt;player&amp;amp;amp;amp;amp;amp;amp;gt;]:
trigger:
if arg-1 is not set:
if command sender is console:
send "You can't push yourself as a console :\" to sender
stop
push sender upwards with force 2
send "Yay!"
else:
push arg-1 upwards with force 2
send "Yay!" to sender and arg-1
trigger:
if arg-1 is not set:
if command sender is console:
send "You can't push yourself as a console :\" to sender
stop
push sender upwards with force 2
send "Yay!"
else:
push arg-1 upwards with force 2
send "Yay!" to sender and arg-1
| Patterns: |
|
| Since: | 2.10 |
A configuration (or code) loaded by Skript, such as the config.sk or aliases.
Configs can be reloaded or navigated to find options.
Configs can be reloaded or navigated to find options.
Examples:
the skript config
| Patterns: |
|
| Since: | 2.0 |
The cause/type of a damage event, e.g. lava, fall, fire, drowning, explosion, poison, etc.
Please note that support for this type is very rudimentary, e.g. lava, fire and burning, as well as projectile and attack are considered different types.
Please note that support for this type is very rudimentary, e.g. lava, fire and burning, as well as projectile and attack are considered different types.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.4 |
A date is a certain point in the real world's time which can be obtained with now expression, unix date expression and date function.
See time and timespan for the other time types of Skript.
See time and timespan for the other time types of Skript.
Examples:
set {_yesterday} to now
subtract a day from {_yesterday}
# now {_yesterday} represents the date 24 hours before now
subtract a day from {_yesterday}
# now {_yesterday} represents the date 24 hours before now
| Patterns: |
|
| Since: | 2.3 |
The difficulty of a world.
Examples:
Missing examples.
| Patterns: | |
| Since: | 2.0 |
A direction, e.g. north, east, behind, 5 south east, 1.3 meters to the right, etc.
Locations and some blocks also have a direction, but without a length.
Please note that directions have changed extensively in the betas and might not work perfectly. They can also not be used as command arguments.
Locations and some blocks also have a direction, but without a length.
Please note that directions have changed extensively in the betas and might not work perfectly. They can also not be used as command arguments.
Examples:
set the block below the victim to a chest
loop blocks from the block infront of the player to the block 10 below the player:
set the block behind the loop-block to water
loop blocks from the block infront of the player to the block 10 below the player:
set the block behind the loop-block to water
| Patterns: |
|
| Since: | 2.10 |
Represents the billboard setting of a display.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
A text, block or item display entity.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
Represents the text alignment setting of a text display.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.4.6 |
An enchantment, e.g. 'sharpness' or 'fortune'. Unlike enchantment type this type has no level, but you usually don't need to use this type anyway.
NOTE: Minecraft namespaces are supported, ex: 'minecraft:basalt_deltas'.
As of Minecraft 1.21 this will also support custom enchantments using namespaces, ex: 'myenchants:explosive'.
NOTE: Minecraft namespaces are supported, ex: 'minecraft:basalt_deltas'.
As of Minecraft 1.21 this will also support custom enchantments using namespaces, ex: 'myenchants:explosive'.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.5 |
The enchantmentoffer in an enchant prepare event.
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: | 1.4.6 |
An enchantment with an optional level, e.g. 'sharpness 2' or 'fortune'.
Examples:
enchant the player's tool with sharpness 5
helmet is enchanted with waterbreathing
helmet is enchanted with waterbreathing
| Patterns: |
|
| Since: | 1.0 |
An entity is something in a world that's not a block, e.g. a player, a skeleton, or a zombie, but also projectiles like arrows, fireballs or thrown potions, or special entities like dropped items, falling blocks or paintings.
Examples:
entity is a zombie or creeper
player is an op
projectile is an arrow
shoot a fireball from the player
player is an op
projectile is an arrow
shoot a fireball from the player
| Patterns: |
|
| Since: | 2.10 |
Represents the cause of the action of a potion effect on an entity, e.g. arrow, command
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Minecraft 1.20.2+ |
Represents a snapshot of an entity's data.
This includes all of the data associated with an entity (its name, health, attributes, etc.), at the time this expression is used. Essentially, these are a way to create templates for entities.
Individual attributes of a snapshot cannot be modified or retrieved.
This includes all of the data associated with an entity (its name, health, attributes, etc.), at the time this expression is used. Essentially, these are a way to create templates for entities.
Individual attributes of a snapshot cannot be modified or retrieved.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.3 |
The type of an entity, e.g. player, wolf, powered creeper, etc.
Examples:
victim is a cow
spawn a creeper
spawn a creeper
| Patterns: |
|
| Since: | 1.3 |
An entity type with an amount, e.g. '2 zombies'. I might remove this type in the future and make a more general 'type' type, i.e. a type that has a number and a type.
Examples:
spawn 5 creepers behind the player
| Patterns: |
|
| Since: | 2.10 |
Something that can be executed (run) and may accept arguments, e.g. a function.
This may also return a result.
This may also return a result.
Examples:
run {_function} with arguments 1 and true
| Patterns: |
|
| Since: | 2.0 |
Experience points. Please note that Bukkit only allows to give XP, but not remove XP from players. You can however change a player's level and level progress freely.
Examples:
give 10 xp to the player
| Patterns: |
|
| Since: | 2.10 |
Represents a change reason of an experience cooldown change event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.4 |
A configuration of effects that defines the firework when exploded
which can be used in the launch firework effect.
See the firework effect expression for detailed patterns.
which can be used in the launch firework effect.
See the firework effect expression for detailed patterns.
Examples:
launch flickering trailing burst firework colored blue and green at player
launch trailing flickering star colored purple, yellow, blue, green and red fading to pink at target entity
launch ball large colored red, purple and white fading to light green and black at player's location with duration 1
launch trailing flickering star colored purple, yellow, blue, green and red fading to pink at target entity
launch ball large colored red, purple and white fading to light green and black at player's location with duration 1
| Patterns: |
|
| Since: | 2.4 |
The type of a fireworkeffect.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
A function loaded by Skript.
This can be executed (with arguments) and may return a result.
This can be executed (with arguments) and may return a result.
Examples:
run {_function} with arguments 1 and true
set {_result} to the result of {_function}
set {_result} to the result of {_function}
| Patterns: |
|
| Since: | 1.0 |
The game modes survival, creative, adventure and spectator.
Examples:
player's gamemode is survival
set the player argument's game mode to creative
set the player argument's game mode to creative
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | Minecraft 1.13 or newer |
A gamerule
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.5 |
A wrapper for the value of a gamerule for a world.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.4 |
| Requirements: | Minecraft 1.14 or newer |
Represents a Panda's main or hidden gene. See genetics for more info.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.5 |
The health regain reason in a heal event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Minecraft 1.21.3+ |
Represents a movement input key that is pressed by a player.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0 |
An inventory of a player or block. Inventories have many effects and conditions regarding the items contained.
An inventory has a fixed amount of slots which represent a specific place in the inventory, e.g. the helmet slot for players (Please note that slot support is still very limited but will be improved eventually).
An inventory has a fixed amount of slots which represent a specific place in the inventory, e.g. the helmet slot for players (Please note that slot support is still very limited but will be improved eventually).
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.2-dev16 |
What player just did in inventory event. Note that when in creative game mode, most actions do not work correctly.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper |
The inventory close reason in an inventory close event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.2-dev32 |
Minecraft has several different inventory types with their own use cases.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0 |
An item, e.g. a stack of torches, a furnace, or a wooden sword of sharpness 2. Unlike item type an item can only represent exactly one item (e.g. an upside-down cobblestone stair facing west), while an item type can represent a whole range of items (e.g. any cobble stone stairs regardless of direction).
You don't usually need this type except when you want to make a command that only accepts an exact item.
Please note that currently 'material' is exactly the same as 'item', i.e. can have an amount & enchantments.
You don't usually need this type except when you want to make a command that only accepts an exact item.
Please note that currently 'material' is exactly the same as 'item', i.e. can have an amount & enchantments.
Examples:
set {_item} to type of the targeted block
{_item} is a torch
{_item} is a torch
| Patterns: |
|
| Since: | 2.10 |
Represents the transform setting of an item display.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
Represents flags that may be applied to hide certain attributes of an item.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0 |
An item type is an alias, e.g. 'a pickaxe', 'all plants', etc., and can result in different items when added to an inventory, and unlike items they are well suited for checking whether an inventory contains a certain item or whether a certain item is of a certain type.
An item type can also have one or more enchantments with or without a specific level defined, and can optionally start with 'all' or 'every' to make this item type represent all types that the alias represents, including data ranges.
An item type can also have one or more enchantments with or without a specific level defined, and can optionally start with 'all' or 'every' to make this item type represent all types that the alias represents, including data ranges.
Examples:
give 4 torches to the player
add all slabs to the inventory of the block
player's tool is a diamond sword of sharpness
remove a pickaxes of fortune 4 from {stored items::*}
set {_item} to 10 of every upside-down stair
block is dirt or farmland
add all slabs to the inventory of the block
player's tool is a diamond sword of sharpness
remove a pickaxes of fortune 4 from {stored items::*}
set {_item} to 10 of every upside-down stair
block is dirt or farmland
| Patterns: |
|
| Since: | 1.0 |
Examples:
spawn 5 powered creepers
shoot a zombie from the creeper
shoot a zombie from the creeper
| Patterns: |
|
| Since: | 2.10 |
Represents additional information a loot table can use to modify its generated loot.
Some loot tables will require some values (i.e. looter, location, looted entity) in a loot context when generating loot whereas others may not.
For example, the loot table of a simple dungeon chest will only require a location, whereas the loot table of a cow will require a looting player, looted entity, and location.
You can find more information about this in https://minecraft.wiki/w/Loot_context
Some loot tables will require some values (i.e. looter, location, looted entity) in a loot context when generating loot whereas others may not.
For example, the loot table of a simple dungeon chest will only require a location, whereas the loot table of a cow will require a looting player, looted entity, and location.
You can find more information about this in https://minecraft.wiki/w/Loot_context
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
Loot tables represent what items should be in naturally generated containers, what items should be dropped when killing a mob, or what items can be fished.
You can find more information about this in https://minecraft.wiki/w/Loot_table
You can find more information about this in https://minecraft.wiki/w/Loot_table
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.2-dev36 |
Something that can hold metadata (e.g. an entity or block)
Examples:
set metadata value "super cool" of player to true
| Patterns: |
|
| Since: | 2.10 |
A tag that classifies a material, or entity.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.0 |
| Requirements: | Vault, an economy plugin that supports Vault |
A certain amount of money. Please note that this differs from numbers as it includes a currency symbol or name, but usually the two are interchangeable, e.g. you can both
add 100$ to the player's balance and add 100 to the player's balance. Examples:
add 10£ to the player's account
remove Fr. 9.95 from the player's money
set the victim's money to 0
increase the attacker's balance by the level of the victim * 100
remove Fr. 9.95 from the player's money
set the victim's money to 0
increase the attacker's balance by the level of the victim * 100
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper 1.16+ |
Represents the phase of a moon.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
A node (entry) from a script config file.
This may have navigable children.
This may have navigable children.
Examples:
the current script
| Patterns: |
|
| Since: | 1.0 |
A number, e.g. 2.5, 3, -9812454, 30 degrees or 3.14 radians.
Please note that many expressions only need integers, i.e. will discard any fractional parts of any numbers without producing an error.
Radians will be converted to degrees.
Please note that many expressions only need integers, i.e. will discard any fractional parts of any numbers without producing an error.
Radians will be converted to degrees.
Examples:
set the player's health to 5.5
set {_temp} to 2*{_temp} - 2.5
set {_angle} to 3.14 in radians # will be converted to degrees
set {_temp} to 2*{_temp} - 2.5
set {_angle} to 3.14 in radians # will be converted to degrees
| Patterns: |
|
| Since: | 1.0 |
The supertype of all types, meaning that if %object% is used in e.g. a condition it will accept all kinds of expressions.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.0 beta 8 |
A player that is possibly offline. See player for more information. Please note that while all effects and conditions that require a player can be used with an offline player as well, they will not work if the player is not actually online.
Examples:
set {_p} to "Notch" parsed as an offlineplayer # returns Notch even if they're offline
| Patterns: |
|
| Since: | 1.0 |
A player. Depending on whether a player is online or offline several actions can be performed with them, though you won't get any errors when using effects that only work if the player is online (e.g. changing their inventory) on an offline player.
You have two possibilities to use players as command arguments: <player> and <offline player>. The first requires that the player is online and also accepts only part of the name, while the latter doesn't require that the player is online, but the player's name has to be entered exactly.
You have two possibilities to use players as command arguments: <player> and <offline player>. The first requires that the player is online and also accepts only part of the name, while the latter doesn't require that the player is online, but the player's name has to be entered exactly.
Examples:
set {_p} to "Notch" parsed as a player # returns &amp;amp;amp;amp;amp;amp;lt;none&amp;amp;amp;amp;amp;amp;gt; unless Notch is actually online or starts with Notch like Notchan
set {_p} to "N" parsed as a player # returns Notch if Notch is online because their name starts with 'N' (case insensitive) however, it would return nothing if no player whose name starts with 'N' is online.
set {_p} to "N" parsed as a player # returns Notch if Notch is online because their name starts with 'N' (case insensitive) however, it would return nothing if no player whose name starts with 'N' is online.
| Patterns: |
|
| Since: | 2.5.2 |
A potion effect, including the potion effect type, tier and duration.
Examples:
Missing examples.
| Patterns: |
|
| Since: | Unknown |
A potion effect type, e.g. 'strength' or 'swiftness'.
Examples:
apply swiftness 5 to the player
apply potion of speed 2 to the player for 60 seconds
remove invisibility from the victim
apply potion of speed 2 to the player for 60 seconds
remove invisibility from the victim
| Patterns: |
|
| Since: | 1.0 |
A projectile, e.g. an arrow, snowball or thrown potion.
Examples:
projectile is a snowball
shoot an arrow at speed 5 from the player
shoot an arrow at speed 5 from the player
| Patterns: |
|
| Since: | 2.10 |
Quaternions are four dimensional vectors, often used for representing rotations.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
A queued list of values. Entries are removed from a queue when they are queried.
Examples:
set {queue} to a new queue
add "hello" to {queue}
broadcast the 1st element of {queue}
add "hello" to {queue}
broadcast the 1st element of {queue}
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper 1.16.5+ |
Represents a quit reason from a player quit server event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.1 |
| Requirements: | Supported regions plugin |
A region of a regions plugin. Skript currently supports WorldGuard, Factions, GriefPrevention and PreciousStones.
Please note that some regions plugins do not have named regions, some use numerical ids to identify regions, and some may have regions with the same name in different worlds, thus using regions like "region name" in scripts may or may not work.
Please note that some regions plugins do not have named regions, some use numerical ids to identify regions, and some may have regions with the same name in different worlds, thus using regions like "region name" in scripts may or may not work.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.4 |
The state in a resource pack request response event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
A script loaded by Skript.
Disabled scripts will report as being empty since their content has not been loaded.
Disabled scripts will report as being empty since their content has not been loaded.
Examples:
the current script
| Patterns: |
|
| Since: | 2.3 |
A server icon that was loaded using the load server icon effect.
Examples:
Missing examples.
| Patterns: |
|
| Since: | Unknown |
Represents a single slot of an inventory. Notable slots are the armour slots and furnace slots.
The most important property that distinguishes a slot from an item is its ability to be changed, e.g. it can be set, deleted, enchanted, etc. (Some item expressions can be changed as well, e.g. items stored in variables. For that matter: slots are never saved to variables, only the items they represent at the time when the variable is set).
Please note that tool can be regarded a slot, but it can actually change it's position, i.e. doesn't represent always the same slot.
The most important property that distinguishes a slot from an item is its ability to be changed, e.g. it can be set, deleted, enchanted, etc. (Some item expressions can be changed as well, e.g. items stored in variables. For that matter: slots are never saved to variables, only the items they represent at the time when the variable is set).
Please note that tool can be regarded a slot, but it can actually change it's position, i.e. doesn't represent always the same slot.
Examples:
set tool of player to dirt
delete helmet of the victim
set the color of the player's tool to green
enchant the player's chestplate with projectile protection 5
delete helmet of the victim
set the color of the player's tool to green
enchant the player's chestplate with projectile protection 5
| Patterns: |
|
| Since: | 2.4 |
The category of a sound, they are used for sound options of Minecraft. See the play sound and stop sound effects.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.3 |
The spawn reason in a spawn event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.2-dev35 |
The teleport cause in a teleport event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Paper 1.19+ |
Teleport Flags are settings to retain during a teleport.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0 |
Text is simply text, i.e. a sequence of characters, which can optionally contain expressions which will be replaced with a meaningful representation (e.g. %player% will be replaced with the player's name).
Because scripts are also text, you have to put text into double quotes to tell Skript which part of the line is an effect/expression and which part is the text.
Please read the article on Texts and Variable Names to learn more.
Because scripts are also text, you have to put text into double quotes to tell Skript which part of the line is an effect/expression and which part is the text.
Please read the article on Texts and Variable Names to learn more.
Examples:
broadcast "Hello World!"
message "Hello %player%"
message "The id of ""%type of tool%"" is %id of tool%."
message "Hello %player%"
message "The id of ""%type of tool%"" is %id of tool%."
| Patterns: |
|
| Since: | 1.0 |
A period of time between two times. Mostly useful since you can use this to test for whether it's day, night, dusk or dawn in a specific world.
This type might be removed in the future as you can use 'time of world is between x and y' as a replacement.
This type might be removed in the future as you can use 'time of world is between x and y' as a replacement.
Examples:
time in world is night
| Patterns: |
|
| Since: | 1.0, 2.6.1 (weeks, months, years) |
A timespan is a difference of two different dates or times, e.g '10 minutes'. Timespans are always displayed as real life time, but can be defined as minecraft time, e.g. '5 minecraft days and 12 hours'.
NOTE: Months always have the value of 30 days, and years of 365 days.
See date and time for the other time types of Skript.
NOTE: Months always have the value of 30 days, and years of 365 days.
See date and time for the other time types of Skript.
Examples:
every 5 minecraft days:
wait a minecraft second and 5 ticks
every 10 mc days and 12 hours:
halt for 12.7 irl minutes, 12 hours and 120.5 seconds
wait a minecraft second and 5 ticks
every 10 mc days and 12 hours:
halt for 12.7 irl minutes, 12 hours and 120.5 seconds
| Patterns: |
|
| Since: | 2.8.0 |
Represents a transform reason of an entity transform event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | Unknown |
A tree type represents a tree species or a huge mushroom species. These can be generated in a world with the generate tree effect.
Examples:
grow any regular tree at the block
grow a huge red mushroom above the block
grow a huge red mushroom above the block
| Patterns: |
|
| Since: | 2.0 |
Represents a type, e.g. number, object, item type, location, block, world, entity type, etc.
This is mostly used for expressions like 'event-<type>', '<type>-argument', 'loop-<type>', etc., e.g. event-world, number-argument and loop-player.
This is mostly used for expressions like 'event-<type>', '<type>-argument', 'loop-<type>', etc., e.g. event-world, number-argument and loop-player.
Examples:
{variable} is a number # check whether the variable contains a number, e.g. -1 or 5.5
{variable} is a type # check whether the variable contains a type, e.g. number or player
{variable} is an object # will always succeed if the variable is set as everything is an object, even types.
disable PvP in the event-world
kill the loop-entity
{variable} is a type # check whether the variable contains a type, e.g. number or player
{variable} is an object # will always succeed if the variable is set as everything is an object, even types.
disable PvP in the event-world
kill the loop-entity
| Patterns: |
|
| Since: | 2.10 |
Represents an unleash reason of an unleash event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.2-dev23 |
Vector is a collection of numbers. In Minecraft, 3D vectors are used to express velocities of entities.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
Represents the different professions of villagers.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.10 |
Represents the different types of villagers. These are usually the biomes a villager can be from.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.1 |
A visible effect, e.g. particles.
Examples:
show wolf hearts on the clicked wolf
play mob spawner flames at the targeted block to the player
play mob spawner flames at the targeted block to the player
| Patterns: |
|
| Since: | 1.0 |
The weather types sunny, rainy, and thundering.
Examples:
is raining
is sunny in the player's world
message "It is %weather in the argument's world% in %world of the argument%"
is sunny in the player's world
message "It is %weather in the argument's world% in %world of the argument%"
| Patterns: |
|
| Since: | @VERSION |
| Requirements: | Minecraft 1.21+ |
Represents the variant of a wolf entity.
NOTE: Minecraft namespaces are supported, ex: 'minecraft:ashen'.
NOTE: Minecraft namespaces are supported, ex: 'minecraft:ashen'.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0, 2.2 (alternate syntax) |
One of the server's worlds. Worlds can be put into scripts by surrounding their name with double quotes, e.g. "world_nether", but this might not work reliably as text uses the same syntax.
Examples:
broadcast "Hello!" to the world "world_nether"
| Patterns: |
|
| Since: | 2.7 |
Represents the environment of a world.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
Returns the absolute value of the argument, i.e. makes the argument positive.
Examples:
abs(3) = 3
abs(-2) = 2
abs(-2) = 2
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
Similar to atan, but requires two coordinates and returns values from -180 to 180.
The returned angle is measured counterclockwise in a standard mathematical coordinate system (x to the right, y to the top).
The returned angle is measured counterclockwise in a standard mathematical coordinate system (x to the right, y to the top).
Examples:
atan2(0, 1) = 0
atan2(10, 0) = 90
atan2(-10, 5) = -63.4349
atan2(10, 0) = 90
atan2(-10, 5) = -63.4349
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Quaternion |
Returns a quaternion from the given angle (in degrees) and axis (as a vector). This represents a rotation around the given axis by the given angle.
Examples:
axisangle(90, (vector from player's facing))
| Patterns: |
|
| Since: | 2.2-dev32 |
| Return Type: |
Calculates the total amount of experience needed to achieve given level from scratch in Minecraft.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.5 |
| Return Type: | Boolean |
Checks if the contents of a list of strings are strictly equal with case sensitivity.
Examples:
caseEquals("hi", "Hi") = false
caseEquals("text", "text", "text") = true
caseEquals({some list variable::*})
caseEquals("text", "text", "text") = true
caseEquals({some list variable::*})
| Patterns: |
|
| Since: | 2.2 |
| Return Type: |
Rounds a number up, i.e. returns the closest integer larger than or equal to the argument.
Examples:
ceil(2.34) = 3
ceil(2) = 2
ceil(2.99) = 3
ceil(2) = 2
ceil(2.99) = 3
| Patterns: |
|
| Since: | 2.2 |
| Return Type: |
Alias of ceil.
Examples:
ceiling(2.34) = 3
ceiling(2) = 2
ceiling(2.99) = 3
ceiling(2) = 2
ceiling(2.99) = 3
| Patterns: |
|
| Since: | 2.8.0 |
| Return Type: | Number |
Clamps one or more values between two numbers.
Examples:
clamp(5, 0, 10) = 5
clamp(5.5, 0, 5) = 5
clamp(0.25, 0, 0.5) = 0.25
clamp(5, 7, 10) = 7
clamp((5, 0, 10, 9, 13), 7, 10) = (7, 7, 10, 9, 10)
set {_clamped::*} to clamp({_values::*}, 0, 10)
clamp(5.5, 0, 5) = 5
clamp(0.25, 0, 0.5) = 0.25
clamp(5, 7, 10) = 7
clamp((5, 0, 10, 9, 13), 7, 10) = (7, 7, 10, 9, 10)
set {_clamped::*} to clamp({_values::*}, 0, 10)
| Patterns: |
|
| Since: | 2.9.0 |
| Return Type: | Text |
Joins the provided texts (and other things) into a single text.
Examples:
concat("hello ", "there") # hello there
concat("foo ", 100, " bar") # foo 100 bar
concat("foo ", 100, " bar") # foo 100 bar
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Date |
Creates a date from a year, month, and day, and optionally also from hour, minute, second and millisecond.
A time zone and DST offset can be specified as well (in minutes), if they are left out the server's time zone and DST offset are used (the created date will not retain this information).
A time zone and DST offset can be specified as well (in minutes), if they are left out the server's time zone and DST offset are used (the created date will not retain this information).
Examples:
date(2014, 10, 1) # 0:00, 1st October 2014
date(1990, 3, 5, 14, 30) # 14:30, 5th May 1990
date(1999, 12, 31, 23, 59, 59, 999, -3*60, 0) # almost year 2000 in parts of Brazil (-3 hours offset, no DST)
date(1990, 3, 5, 14, 30) # 14:30, 5th May 1990
date(1999, 12, 31, 23, 59, 59, 999, -3*60, 0) # almost year 2000 in parts of Brazil (-3 hours offset, no DST)
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
The exponential function. You probably don't need this if you don't know what this is.
Examples:
exp(0) = 1
exp(1) = 2.7183
exp(1) = 2.7183
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Text |
Returns the real (platform-dependent) file separator: typically / for UN*X or \ for Windows.
Examples:
file_separator() = "/"
| Patterns: |
|
| Since: | 2.2 |
| Return Type: |
Rounds a number down, i.e. returns the closest integer smaller than or equal to the argument.
Examples:
floor(2.34) = 2
floor(2) = 2
floor(2.99) = 2
floor(2) = 2
floor(2.99) = 2
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Text |
Converts numbers to human-readable format. By default, '###,###' (e.g. '123,456,789') will be used for whole numbers and '###,###.##' (e.g. '123,456,789.00) will be used for decimal numbers. A hashtag '#' represents a digit, a comma ',' is used to separate numbers, and a period '.' is used for decimals.
Will return none if the format is invalid.
For further reference, see this article.
Will return none if the format is invalid.
For further reference, see this article.
Examples:
command /balance:
aliases: bal
executable by: players
trigger:
set {_money} to formatNumber({money::%sender's uuid%})
send "Your balance: %{_money}%" to sender
aliases: bal
executable by: players
trigger:
set {_money} to formatNumber({money::%sender's uuid%})
send "Your balance: %{_money}%" to sender
| Patterns: |
|
| Since: | 2.8.0 |
| Return Type: | Boolean |
Returns true if the input is NaN (not a number).
Examples:
isNaN(0) # false
isNaN(0/0) # true
isNaN(sqrt(-1)) # true
isNaN(0/0) # true
isNaN(sqrt(-1)) # true
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Text |
Returns the real (platform-dependent) line separator: typically line feed for UN*X or carriage return line feed for Windows.
Examples:
broadcast "hello" + line_separator() + "world"
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
The natural logarithm. You probably don't need this if you don't know what this is.
Returns NaN (not a number) if the argument is negative.
Returns NaN (not a number) if the argument is negative.
Examples:
ln(1) = 0
ln(exp(5)) = 5
ln(2) = 0.6931
ln(exp(5)) = 5
ln(2) = 0.6931
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Location |
Creates a location from a world and 3 coordinates, with an optional yaw and pitch.
If for whatever reason the world is not found, it will fallback to the server's main world.
If for whatever reason the world is not found, it will fallback to the server's main world.
Examples:
# TELEPORTING
teleport player to location(1,1,1, world "world")
teleport player to location(1,1,1, world "world", 100, 0)
teleport player to location(1,1,1, world "world", yaw of player, pitch of player)
teleport player to location(1,1,1, world of player)
teleport player to location(1,1,1, world("world"))
teleport player to location({_x}, {_y}, {_z}, {_w}, {_yaw}, {_pitch})
# SETTING BLOCKS
set block at location(1,1,1, world "world") to stone
set block at location(1,1,1, world "world", 100, 0) to stone
set block at location(1,1,1, world of player) to stone
set block at location(1,1,1, world("world")) to stone
set block at location({_x}, {_y}, {_z}, {_w}) to stone
# USING VARIABLES
set {_l1} to location(1,1,1)
set {_l2} to location(10,10,10)
set blocks within {_l1} and {_l2} to stone
if player is within {_l1} and {_l2}:
# OTHER
kill all entities in radius 50 around location(1,65,1, world "world")
delete all entities in radius 25 around location(50,50,50, world "world_nether")
ignite all entities in radius 25 around location(1,1,1, world of player)
teleport player to location(1,1,1, world "world")
teleport player to location(1,1,1, world "world", 100, 0)
teleport player to location(1,1,1, world "world", yaw of player, pitch of player)
teleport player to location(1,1,1, world of player)
teleport player to location(1,1,1, world("world"))
teleport player to location({_x}, {_y}, {_z}, {_w}, {_yaw}, {_pitch})
# SETTING BLOCKS
set block at location(1,1,1, world "world") to stone
set block at location(1,1,1, world "world", 100, 0) to stone
set block at location(1,1,1, world of player) to stone
set block at location(1,1,1, world("world")) to stone
set block at location({_x}, {_y}, {_z}, {_w}) to stone
# USING VARIABLES
set {_l1} to location(1,1,1)
set {_l2} to location(10,10,10)
set blocks within {_l1} and {_l2} to stone
if player is within {_l1} and {_l2}:
# OTHER
kill all entities in radius 50 around location(1,65,1, world "world")
delete all entities in radius 25 around location(50,50,50, world "world_nether")
ignite all entities in radius 25 around location(1,1,1, world of player)
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
A logarithm, with base 10 if none is specified. This is the inverse operation to exponentiation (for positive bases only), i.e.
Another useful equation is
Please note that due to how numbers are represented in computers, these equations do not hold for all numbers, as the computed values may slightly differ from the correct value.
Returns NaN (not a number) if any of the arguments are negative.
log(base ^ exponent, base) = exponent for any positive number 'base' and any number 'exponent'.Another useful equation is
base ^ log(a, base) = a for any numbers 'base' and 'a'.Please note that due to how numbers are represented in computers, these equations do not hold for all numbers, as the computed values may slightly differ from the correct value.
Returns NaN (not a number) if any of the arguments are negative.
Examples:
log(100) = 2 # 10^2 = 100
log(16, 2) = 4 # 2^4 = 16
log(16, 2) = 4 # 2^4 = 16
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
Returns the maximum number from a list of numbers.
Examples:
max(1) = 1
max(1, 2, 3, 4) = 4
max({some list variable::*})
max(1, 2, 3, 4) = 4
max({some list variable::*})
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
Returns the minimum number from a list of numbers.
Examples:
min(1) = 1
min(1, 2, 3, 4) = 1
min({some list variable::*})
min(1, 2, 3, 4) = 1
min({some list variable::*})
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
Returns the modulo of the given arguments, i.e. the remainder of the division
The returned value is always positive. Returns NaN (not a number) if the second argument is zero.
d/m, where d and m are the arguments of this function.The returned value is always positive. Returns NaN (not a number) if the second argument is zero.
Examples:
mod(3, 2) = 1
mod(256436, 100) = 36
mod(-1, 10) = 9
mod(256436, 100) = 36
mod(-1, 10) = 9
| Patterns: |
|
| Since: | 2.8.0, 2.9.0 (prevent lookups) |
| Return Type: | Offline Player |
Returns a offline player from their name or UUID. This function will still return the player if they're online. If Paper 1.16.5+ is used, the 'allowLookup' parameter can be set to false to prevent this function from doing a web lookup for players who have not joined before. Lookups can cause lag spikes of up to multiple seconds, so use offline players with caution.
Examples:
set {_p} to offlineplayer("Notch")
set {_p} to offlineplayer("069a79f4-44e9-4726-a5be-fca90e38aaf5")
set {_p} to offlineplayer("Notch", false)
set {_p} to offlineplayer("069a79f4-44e9-4726-a5be-fca90e38aaf5")
set {_p} to offlineplayer("Notch", false)
| Patterns: |
|
| Since: | 2.8.0 |
| Return Type: | Player |
Returns an online player from their name or UUID, if player is offline function will return nothing.
Setting 'getExactPlayer' parameter to true will return the player whose name is exactly equal to the provided name instead of returning a player that their name starts with the provided name.
Setting 'getExactPlayer' parameter to true will return the player whose name is exactly equal to the provided name instead of returning a player that their name starts with the provided name.
Examples:
set {_p} to player("Notch") # will return an online player whose name is or starts with 'Notch'
set {_p} to player("Notch", true) # will return the only online player whose name is 'Notch'
set {_p} to player("069a79f4-44e9-4726-a5be-fca90e38aaf5") # &amp;amp;lt;none&amp;amp;gt; if player is offline
set {_p} to player("Notch", true) # will return the only online player whose name is 'Notch'
set {_p} to player("069a79f4-44e9-4726-a5be-fca90e38aaf5") # &amp;amp;lt;none&amp;amp;gt; if player is offline
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
Calculates the product of a list of numbers.
Examples:
product(1) = 1
product(2, 3, 4) = 24
product({some list variable::*})
product(2, {_v::*}, and the player's y-coordinate)
product(2, 3, 4) = 24
product({some list variable::*})
product(2, {_v::*}, and the player's y-coordinate)
| Patterns: |
|
| Since: | 2.10 |
| Return Type: | Quaternion |
Returns a quaternion from the given W, X, Y and Z parameters.
Examples:
quaternion(1, 5.6, 45.21, 10)
| Patterns: |
|
| Since: | 2.5, 2.10 (alpha) |
| Return Type: | Color |
Returns a RGB color from the given red, green and blue parameters. Alpha values can be added optionally, but these only take affect in certain situations, like text display backgrounds.
Examples:
dye player's leggings rgb(120, 30, 45)
set the colour of a text display to rgb(10, 50, 100, 50)
set the colour of a text display to rgb(10, 50, 100, 50)
| Patterns: |
|
| Since: | 2.2, 2.7 (decimal placement) |
| Return Type: | Number |
Rounds a number, i.e. returns the closest integer to the argument. Place a second argument to define the decimal placement.
Examples:
round(2.34) = 2
round(2) = 2
round(2.99) = 3
round(2.5) = 3
round(2) = 2
round(2.99) = 3
round(2.5) = 3
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
The sine function. It starts at 0° with a value of 0, goes to 1 at 90°, back to 0 at 180°, to -1 at 270° and then repeats every 360°. Uses degrees, not radians.
Examples:
sin(90) = 1
sin(60) = 0.866
sin(60) = 0.866
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
The square root, which is the inverse operation to squaring a number (for positive numbers only). This is the same as
Returns NaN (not a number) if the argument is negative.
(argument) ^ (1/2) – other roots can be calculated via number ^ (1/root), e.g. set {_l} to {_volume}^(1/3).Returns NaN (not a number) if the argument is negative.
Examples:
sqrt(4) = 2
sqrt(2) = 1.4142
sqrt(-1) = NaN
sqrt(2) = 1.4142
sqrt(-1) = NaN
| Patterns: |
|
| Since: | 2.2 |
| Return Type: | Number |
Sums a list of numbers.
Examples:
sum(1) = 1
sum(2, 3, 4) = 9
sum({some list variable::*})
sum(2, {_v::*}, and the player's y-coordinate)
sum(2, 3, 4) = 9
sum({some list variable::*})
sum(2, {_v::*}, and the player's y-coordinate)
| Patterns: |
|
| Since: | 2.2-dev23 |
| Return Type: | Vector |
Creates a new vector, which can be used with various expressions, effects and functions.
Examples:
vector(0, 0, 0)