| Patterns: |
|
| Since: | 2.5 |
Represents the type of an attribute. Note that this type does not contain any numerical values.See attribute types for more info. NOTE: Minecraft namespaces are supported, ex: 'minecraft:generic.attack_damage'.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.4.4 |
All possible biomes Minecraft uses to generate a world. NOTE: Minecraft namespaces are supported, ex: 'minecraft:basalt_deltas'.
Examples:
biome at the player is desert
| Patterns: |
|
| Since: | 2.5 |
Block data is the detailed information about a block, referred to in Minecraft as BlockStates, allowing for the manipulation of different aspects of the block, including shape, waterlogging, direction the block is facing, and so much more. Information regarding each block's optional data can be found on Minecraft's Wiki. Find the block you're looking for and scroll down to 'Block States'. Different states must be separated by a semicolon (see examples). The 'minecraft:' namespace is optional, as well as are underscores.
Examples:
set block at player to campfire[lit=false]
set target block of player to oak stairs[facing=north;waterlogged=true]
set block at player to grass_block[snowy=true]
set loop-block to minecraft:chest[facing=north]
set block above player to oak_log[axis=y]
set target block of player to minecraft:oak_leaves[distance=2;persistent=false]
set target block of player to oak stairs[facing=north;waterlogged=true]
set block at player to grass_block[snowy=true]
set loop-block to minecraft:chest[facing=north]
set block above player to oak_log[axis=y]
set target block of player to minecraft:oak_leaves[distance=2;persistent=false]
| Patterns: |
|
| Since: | 1.0 |
A boolean is a value that is either true or false. Other accepted names are 'on' and 'yes' for true, and 'off' and 'no' for false.
Examples:
set {config.%player%.use mod} to false
| Patterns: |
|
| Since: | 2.4 |
| Requirements: | Minecraft 1.14 or newer |
Represents the race/type of a cat entity. NOTE: Minecraft namespaces are supported, ex: 'minecraft:british_shorthair'.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.0 |
A chunk is a cuboid of 16×16×128 (x×z×y) blocks. Chunks are spread on a fixed rectangular grid in their world.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.2-dev16b, 2.2-dev35 (renamed to click type) |
Click type, mostly for inventory events. Tells exactly which keys/buttons player pressed, assuming that default keybindings are used in client side.
Examples:
Missing examples.
| Patterns: |
|
| Since: | Unknown |
Wool, dye and chat colors.
Examples:
color of the sheep is red or black
set the color of the block to green
message "You're holding a <%color of tool%>%color of tool%<reset> wool block"
set the color of the block to green
message "You're holding a <%color of tool%>%color of tool%<reset> wool block"
| Patterns: |
|
| Since: | 1.0 |
A player or the console.
Examples:
command /push [<player>]:
trigger:
if arg-1 is not set:
if command sender is console:
send "You can't push yourself as a console :\" to sender
stop
push sender upwards with force 2
send "Yay!"
else:
push arg-1 upwards with force 2
send "Yay!" to sender and arg-1
trigger:
if arg-1 is not set:
if command sender is console:
send "You can't push yourself as a console :\" to sender
stop
push sender upwards with force 2
send "Yay!"
else:
push arg-1 upwards with force 2
send "Yay!" to sender and arg-1
| Patterns: |
|
| Since: | 2.0 |
The cause/type of a damage event, e.g. lava, fall, fire, drowning, explosion, poison, etc. Please note that support for this type is very rudimentary, e.g. lava, fire and burning, as well as projectile and attack are considered different types.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.4 |
A date is a certain point in the real world's time which can be obtained with now expression, unix date expression and date function. See time and timespan for the other time types of Skript.
Examples:
set {_yesterday} to now
subtract a day from {_yesterday}
# now {_yesterday} represents the date 24 hours before now
subtract a day from {_yesterday}
# now {_yesterday} represents the date 24 hours before now
| Patterns: |
|
| Since: | 2.3 |
The difficulty of a world.
Examples:
Missing examples.
| Patterns: | |
| Since: | 2.0 |
A direction, e.g. north, east, behind, 5 south east, 1.3 meters to the right, etc. Locations and some blocks also have a direction, but without a length. Please note that directions have changed extensively in the betas and might not work perfectly. They can also not be used as command arguments.
Examples:
set the block below the victim to a chest
loop blocks from the block infront of the player to the block 10 below the player:
set the block behind the loop-block to water
loop blocks from the block infront of the player to the block 10 below the player:
set the block behind the loop-block to water
| Patterns: |
|
| Since: | 1.4.6 |
An enchantment, e.g. 'sharpness' or 'fortune'. Unlike enchantment type this type has no level, but you usually don't need to use this type anyway. NOTE: Minecraft namespaces are supported, ex: 'minecraft:basalt_deltas'. As of Minecraft 1.21 this will also support custom enchantments using namespaces, ex: 'myenchants:explosive'.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.5 |
The enchantmentoffer in an enchant prepare event.
Examples:
on enchant prepare:
set enchant offer 1 to sharpness 1
set the cost of enchant offer 1 to 10 levels
set enchant offer 1 to sharpness 1
set the cost of enchant offer 1 to 10 levels
| Patterns: |
|
| Since: | 1.4.6 |
An enchantment with an optional level, e.g. 'sharpness 2' or 'fortune'.
Examples:
enchant the player's tool with sharpness 5
helmet is enchanted with waterbreathing
helmet is enchanted with waterbreathing
| Patterns: |
|
| Since: | 1.0 |
An entity is something in a world that's not a block, e.g. a player, a skeleton, or a zombie, but also projectiles like arrows, fireballs or thrown potions, or special entities like dropped items, falling blocks or paintings.
Examples:
entity is a zombie or creeper
player is an op
projectile is an arrow
shoot a fireball from the player
player is an op
projectile is an arrow
shoot a fireball from the player
| Patterns: |
|
| Since: | 1.3 |
The type of an entity, e.g. player, wolf, powered creeper, etc.
Examples:
victim is a cow
spawn a creeper
spawn a creeper
| Patterns: |
|
| Since: | 1.3 |
An entity type with an amount, e.g. '2 zombies'. I might remove this type in the future and make a more general 'type' type, i.e. a type that has a number and a type.
Examples:
spawn 5 creepers behind the player
| Patterns: |
|
| Since: | 2.0 |
Experience points. Please note that Bukkit only allows to give XP, but not remove XP from players. You can however change a player's level and level progress freely.
Examples:
give 10 xp to the player
| Patterns: |
|
| Since: | 2.4 |
A configuration of effects that defines the firework when exploded which can be used in the launch firework effect. See the firework effect expression for detailed patterns.
Examples:
launch flickering trailing burst firework colored blue and green at player
launch trailing flickering star colored purple, yellow, blue, green and red fading to pink at target entity
launch ball large colored red, purple and white fading to light green and black at player's location with duration 1
launch trailing flickering star colored purple, yellow, blue, green and red fading to pink at target entity
launch ball large colored red, purple and white fading to light green and black at player's location with duration 1
| Patterns: |
|
| Since: | 2.4 |
The type of a fireworkeffect.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0 |
The game modes survival, creative, adventure and spectator.
Examples:
player's gamemode is survival
set the player argument's game mode to creative
set the player argument's game mode to creative
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | Minecraft 1.13 or newer |
A gamerule
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.5 |
A wrapper for the value of a gamerule for a world.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.4 |
| Requirements: | Minecraft 1.14 or newer |
Represents a Panda's main or hidden gene. See genetics for more info.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.5 |
The health regain reason in a heal event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0 |
An inventory of a player or block. Inventories have many effects and conditions regarding the items contained. An inventory has a fixed amount of slots which represent a specific place in the inventory, e.g. the helmet slot for players (Please note that slot support is still very limited but will be improved eventually).
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.2-dev16 |
What player just did in inventory event. Note that when in creative game mode, most actions do not work correctly.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper |
The inventory close reason in an inventory close event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.2-dev32 |
Minecraft has several different inventory types with their own use cases.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0 |
An item, e.g. a stack of torches, a furnace, or a wooden sword of sharpness 2. Unlike item type an item can only represent exactly one item (e.g. an upside-down cobblestone stair facing west), while an item type can represent a whole range of items (e.g. any cobble stone stairs regardless of direction). You don't usually need this type except when you want to make a command that only accepts an exact item. Please note that currently 'material' is exactly the same as 'item', i.e. can have an amount & enchantments.
Examples:
set {_item} to type of the targeted block
{_item} is a torch
{_item} is a torch
| Patterns: |
|
| Since: | 1.0 |
An item type is an alias, e.g. 'a pickaxe', 'all plants', etc., and can result in different items when added to an inventory, and unlike items they are well suited for checking whether an inventory contains a certain item or whether a certain item is of a certain type. An item type can also have one or more enchantments with or without a specific level defined, and can optionally start with 'all' or 'every' to make this item type represent all types that the alias represents, including data ranges.
Examples:
give 4 torches to the player
add all slabs to the inventory of the block
player's tool is a diamond sword of sharpness
remove a pickaxes of fortune 4 from {stored items::*}
set {_item} to 10 of every upside-down stair
block is dirt or farmland
add all slabs to the inventory of the block
player's tool is a diamond sword of sharpness
remove a pickaxes of fortune 4 from {stored items::*}
set {_item} to 10 of every upside-down stair
block is dirt or farmland
| Patterns: |
|
| Since: | 1.0 |
Examples:
spawn 5 powered creepers
shoot a zombie from the creeper
shoot a zombie from the creeper
| Patterns: |
|
| Since: | 2.2-dev36 |
Something that can hold metadata (e.g. an entity or block)
Examples:
set metadata value "super cool" of player to true
| Patterns: |
|
| Since: | 2.0 |
| Requirements: | Vault, an economy plugin that supports Vault |
A certain amount of money. Please note that this differs from numbers as it includes a currency symbol or name, but usually the two are interchangeable, e.g. you can both
add 100$ to the player's balance and add 100 to the player's balance. Examples:
add 10£ to the player's account
remove Fr. 9.95 from the player's money
set the victim's money to 0
increase the attacker's balance by the level of the victim * 100
remove Fr. 9.95 from the player's money
set the victim's money to 0
increase the attacker's balance by the level of the victim * 100
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper 1.16+ |
Represents the phase of a moon.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0 |
A number, e.g. 2.5, 3, or -9812454. Please note that many expressions only need integers, i.e. will discard any fractional parts of any numbers without producing an error.
Examples:
set the player's health to 5.5
set {_temp} to 2*{_temp} - 2.5
set {_temp} to 2*{_temp} - 2.5
| Patterns: |
|
| Since: | 1.0 |
The supertype of all types, meaning that if %object% is used in e.g. a condition it will accept all kinds of expressions.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.0 beta 8 |
A player that is possibly offline. See player for more information. Please note that while all effects and conditions that require a player can be used with an offline player as well, they will not work if the player is not actually online.
Examples:
set {_p} to "Notch" parsed as an offlineplayer # returns Notch even if they're offline
| Patterns: |
|
| Since: | 1.0 |
A player. Depending on whether a player is online or offline several actions can be performed with them, though you won't get any errors when using effects that only work if the player is online (e.g. changing their inventory) on an offline player. You have two possibilities to use players as command arguments: <player> and <offline player>. The first requires that the player is online and also accepts only part of the name, while the latter doesn't require that the player is online, but the player's name has to be entered exactly.
Examples:
set {_p} to "Notch" parsed as a player # returns &amp;amp;amp;amp;amp;amp;lt;none&amp;amp;amp;amp;amp;amp;gt; unless Notch is actually online or starts with Notch like Notchan
set {_p} to "N" parsed as a player # returns Notch if Notch is online because their name starts with 'N' (case insensitive) however, it would return nothing if no player whose name starts with 'N' is online.
set {_p} to "N" parsed as a player # returns Notch if Notch is online because their name starts with 'N' (case insensitive) however, it would return nothing if no player whose name starts with 'N' is online.
| Patterns: |
|
| Since: | 2.5.2 |
A potion effect, including the potion effect type, tier and duration.
Examples:
Missing examples.
| Patterns: |
|
| Since: | Unknown |
A potion effect type, e.g. 'strength' or 'swiftness'.
Examples:
apply swiftness 5 to the player
apply potion of speed 2 to the player for 60 seconds
remove invisibility from the victim
apply potion of speed 2 to the player for 60 seconds
remove invisibility from the victim
| Patterns: |
|
| Since: | 1.0 |
A projectile, e.g. an arrow, snowball or thrown potion.
Examples:
projectile is a snowball
shoot an arrow at speed 5 from the player
shoot an arrow at speed 5 from the player
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper 1.16.5+ |
Represents a quit reason from a player quit server event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.1 |
| Requirements: | Supported regions plugin |
A region of a regions plugin. Skript currently supports WorldGuard, Factions, GriefPrevention and PreciousStones. Please note that some regions plugins do not have named regions, some use numerical ids to identify regions, and some may have regions with the same name in different worlds, thus using regions like "region name" in scripts may or may not work.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.4 |
The state in a resource pack request response event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.3 |
A server icon that was loaded using the load server icon effect.
Examples:
Missing examples.
| Patterns: |
|
| Since: | Unknown |
Represents a single slot of an inventory. Notable slots are the armour slots and furnace slots. The most important property that distinguishes a slot from an item is its ability to be changed, e.g. it can be set, deleted, enchanted, etc. (Some item expressions can be changed as well, e.g. items stored in variables. For that matter: slots are never saved to variables, only the items they represent at the time when the variable is set). Please note that tool can be regarded a slot, but it can actually change it's position, i.e. doesn't represent always the same slot.
Examples:
set tool of player to dirt
delete helmet of the victim
set the color of the player's tool to green
enchant the player's chestplate with projectile protection 5
delete helmet of the victim
set the color of the player's tool to green
enchant the player's chestplate with projectile protection 5
| Patterns: |
|
| Since: | 2.4 |
The category of a sound, they are used for sound options of Minecraft. See the play sound and stop sound effects.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.3 |
The spawn reason in a spawn event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.2-dev35 |
The teleport cause in a teleport event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 1.0 |
Text is simply text, i.e. a sequence of characters, which can optionally contain expressions which will be replaced with a meaningful representation (e.g. %player% will be replaced with the player's name). Because scripts are also text, you have to put text into double quotes to tell Skript which part of the line is an effect/expression and which part is the text. Please read the article on Texts and Variable Names to learn more.
Examples:
broadcast "Hello World!"
message "Hello %player%"
message "The id of ""%type of tool%"" is %id of tool%."
message "Hello %player%"
message "The id of ""%type of tool%"" is %id of tool%."
| Patterns: |
|
| Since: | 1.0 |
A period of time between two times. Mostly useful since you can use this to test for whether it's day, night, dusk or dawn in a specific world. This type might be removed in the future as you can use 'time of world is between x and y' as a replacement.
Examples:
time in world is night
| Patterns: |
|
| Since: | 1.0, 2.6.1 (weeks, months, years) |
A timespan is a difference of two different dates or times, e.g '10 minutes'. Timespans are always displayed as real life time, but can be defined as minecraft time, e.g. '5 minecraft days and 12 hours'. NOTE: Months always have the value of 30 days, and years of 365 days. See date and time for the other time types of Skript.
Examples:
every 5 minecraft days:
wait a minecraft second and 5 ticks
every 10 mc days and 12 hours:
halt for 12.7 irl minutes, 12 hours and 120.5 seconds
wait a minecraft second and 5 ticks
every 10 mc days and 12 hours:
halt for 12.7 irl minutes, 12 hours and 120.5 seconds
| Patterns: |
|
| Since: | 2.8.0 |
Represents a transform reason of an entity transform event.
Examples:
Missing examples.
| Patterns: |
|
| Since: | Unknown |
A tree type represents a tree species or a huge mushroom species. These can be generated in a world with the generate tree effect.
Examples:
grow any regular tree at the block
grow a huge red mushroom above the block
grow a huge red mushroom above the block
| Patterns: |
|
| Since: | 2.0 |
Represents a type, e.g. number, object, item type, location, block, world, entity type, etc. This is mostly used for expressions like 'event-<type>', '<type>-argument', 'loop-<type>', etc., e.g. event-world, number-argument and loop-player.
Examples:
{variable} is a number # check whether the variable contains a number, e.g. -1 or 5.5
{variable} is a type # check whether the variable contains a type, e.g. number or player
{variable} is an object # will always succeed if the variable is set as everything is an object, even types.
disable PvP in the event-world
kill the loop-entity
{variable} is a type # check whether the variable contains a type, e.g. number or player
{variable} is an object # will always succeed if the variable is set as everything is an object, even types.
disable PvP in the event-world
kill the loop-entity
| Patterns: |
|
| Since: | 2.2-dev23 |
Vector is a collection of numbers. In Minecraft, 3D vectors are used to express velocities of entities.
Examples:
Missing examples.
| Patterns: |
|
| Since: | 2.1 |
A visible effect, e.g. particles.
Examples:
show wolf hearts on the clicked wolf
play mob spawner flames at the targeted block to the player
play mob spawner flames at the targeted block to the player
| Patterns: |
|
| Since: | 1.0 |
The weather types sunny, rainy, and thundering.
Examples:
is raining
is sunny in the player's world
message "It is %weather in the argument's world% in %world of the argument%"
is sunny in the player's world
message "It is %weather in the argument's world% in %world of the argument%"
| Patterns: |
|
| Since: | 1.0, 2.2 (alternate syntax) |
One of the server's worlds. Worlds can be put into scripts by surrounding their name with double quotes, e.g. "world_nether", but this might not work reliably as text uses the same syntax.
Examples:
broadcast "Hello!" to the world "world_nether"
| Patterns: |
|
| Since: | 2.7 |
Represents the environment of a world.
Examples:
Missing examples.