| 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.
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.
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.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: | 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: |
The amount of something. 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.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.
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.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.
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.
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 (Armour) |
| Return Type: | Slot |
Equipment of living entities, i.e. the boots, leggings, chestplate or helmet.
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.
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.
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.0 |
| 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.0 |
| 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.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.
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).
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'.
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'.
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.0 (block displays) |
| Return Type: | Block Data |
Get the block data associated with a block. 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.0 |
| 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.
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.
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.
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.
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.0 |
| 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.
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.0 (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.
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.
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.0 |
| 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%
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: | 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.
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: | 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'.
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.
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: | 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.0 |
| 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'.
Examples:
set billboard of the last spawned text display to center
| Patterns: | |
| Since: | 2.10.0 |
| 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.
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.0 |
| 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.
Examples:
set display height of the last spawned text display to 2.5
| Patterns: | |
| Since: | 2.10.0 |
| 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.
Examples:
set interpolation delay of the last spawned text display to 2 ticks
| Patterns: | |
| Since: | 2.10.0 |
| 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.
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.0 |
| 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.
Examples:
set left transformation rotation of last spawned block display to quaternion(1, 0, 0, 0) # reset block display
| Patterns: | |
| Since: | 2.10.0 |
| 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.
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. 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::*}
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::*}
| 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.
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.
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.
Examples:
set cost of enchantment offer 1 to 50
| Patterns: |
|
| Since: | 1.2.1, 2.5 (chunks), 2.10.0 (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.
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.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.0 |
| 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.0 (breeding event) |
| 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
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
| Patterns: |
|
| Since: | 2.10.0 |
| Return Type: | Experience Cooldown Change Reason |
The experience change reason within in anexperience 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.0 |
| 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.
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.
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
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
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 |
| 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.
Examples:
send "congrats on being staff!" to all players where [player input has permission "staff"]
| 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.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.
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: | 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. Remember to use 'block' and not
furnace, as furnace is not an existing expression. Note that the result and the result slot refer to separate things. the result is the product in a smelt event and the result slot is the output slot of a furnace (where the result will end up). Note that if the result in a smelt event is changed to an item that differs in type from the items currently in the result slot, the smelting will fail to complete (the item will attempt to smelt itself again). Note that if values other than the result are changed, event values may not accurately reflect the actual items in a furnace. Thus you may wish to use the event block in this case (e.g. the fuel slot of the event-block) to get accurate values if needed. Examples:
set the fuel slot of the clicked block to a lava bucket
set the block's ore slot to 64 iron ore
give the result of the block to the player
clear the result slot of the block
set the block's ore slot to 64 iron ore
give the result of the block to the player
clear the result slot of the block
| 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.
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.
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.
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.0 |
| 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).
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.
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.
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.
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.
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.
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.0 |
| 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.2-dev35, 2.2-dev36 (improved), 2.5.2 (throwable projectiles), 2.10.0 (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.
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.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.
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.
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.0 (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.
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.0 |
| 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.
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.
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.
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.
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) |
| Return Type: | Object |
Returns the currently 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 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%"
| 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
send "You hit the jackpot!!"
chance of %10
add 64 diamonds
send "You hit the jackpot!!"
| 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.0 |
| 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.
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.
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.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.
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+
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.
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.
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 |
| Return Type: |
The maximum stack size of the specified material, e.g. 64 for torches, 16 for buckets, and 1 for swords.
Examples:
send "You can only pick up %max stack size of player's tool% of %type of (player's tool)%" to player
| 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.
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.0 (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.0 (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 or world.
- 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 (1.13+)
- Name: The name of the gamerule. Cannot be changed.
- Worlds
- Name: The name of the world. Cannot be changed.
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: | 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 or world.
- 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 (1.13+)
- Name: The name of the gamerule. Cannot be changed.
- Worlds
- Name: The name of the world. Cannot be changed.
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: | 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:'
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.
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.
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
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.0 |
| 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.
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.
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.
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.
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.0 (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).
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.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.
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.0 (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.
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.
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.
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.
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.0 |
| 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.
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.0 |
| 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.
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).
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 |
| Usable in events: | Script Load/Unload |
| Return Type: | Text |
Holds the current script's name (the file name without '.sk').
Examples:
on script load:
set {running::%script%} to true
on script unload:
set {running::%script%} to false
set {running::%script%} to true
on script unload:
set {running::%script%} to false
| 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.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.
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.
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 |
| 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 skull owner of {_block} to "Njol" parsed as offlineplayer
| 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
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.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.
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.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.
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.
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.0 |
| 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.0 |
| 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.0 |
| 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.
Examples:
set the opacity of the last spawned text display to -1 # Reset
| Patterns: | |
| Since: | 2.10.0 |
| Return Type: | Text |
Returns or changes the text/string of displays. 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.
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
<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.0 (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.
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.
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: | 1.4, 2.5.2 (potion effect), 2.7 (block datas) |
| Return Type: | Object |
Type of a block, item, entity, inventory or potion effect. 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.
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!
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.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.0 (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.
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).
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.
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.
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: | 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.
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.
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