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]
lmb, number key, mmb, rmb, drop item, drop key, window border using left mouse button, unknown, window border using right mouse, shift+rmb, unsupported, shift+lmb, ctrl+q, swap shield, left mouse button, left mouse with shift, left mouse, 0-9, double click, double click using mouse, border using rmb, right mouse button, right mouse button with shift, border using lmb, middle mouse, drop key with control, window border using right mouse button, swap offhand, custom, q, right mouse with shift, middle mouse button, drop stack, left mouse button with shift, right mouse, creative action
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.
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"
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
sweep attack, thorns, the void, magma, a lightning, drowning, dragonfire, an attack, drown, an entity attack, melt, freeze, falling block, contact, fire, an entity explosion, lightning, a fall, entity explosion, void, a lightning strike, suffocation, suicide, wither effect, a plugin, lightning strike, entity attack, a potion, a wither, sweeping, melting, a falling block, unknown, starvation, lava, fall, hot floor, attack, a block explosion, dryout, burn, hitting wall while flying, potion, world border, flying into a wall, cramming, poison, sonic boom, suffocate, custom, kill, killed, a fire, burning, a projectile, plugin, wither potion effect, block explosion, projectile, wither, dragon's breath
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.
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
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
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.
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.
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
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).
drop stack from slot, swap items with hotbar, swap cursor stack, pickup single item, pickup some, drop all from cursor, move to other inventory, drop cursor stack, pickup all, swap with hotbar, nothing, drop all from slot, swap cursor, drop cursor, pickup all items, drop slot item, place all, drop cursor item, drop slot stack, drop single item from slot, swap with cursor, place some, pickup one item, drop single item from cursor, collect items to cursor, unknown, clone stack, drop stack from cursor, drop one item from slot, drop one item from cursor, unsupported, do nothing, drop one from cursor, pickup half, drop items from slot, swap stack with cursor, place all items, collect to cursor, pickup some items, drop slot, drop items from cursor, hotbar move and readd, shift move, custom, pickup single, place one item, hotbar swap items, drop one from slot, place some items, place one, pickup half stack, instant move, hotbar swap
Since:
2.2-dev16
What player just did in inventory event. Note that when in creative game mode, most actions do not work correctly.
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
barrel inventory, a loom inventory, a blast furnace inventory, workbench inventory, ender chest inventory, loom inventory, a workbench inventory, hopper inventory, a merchant inventory, a hopper inventory, chiseled bookshelf, an ender chest inventory, new smithing table, bookshelf, a jukebox, beacon inventory, shulker box inventory, a barrel inventory, a shulker box inventory, lectern inventory, chest inventory, a villager inventory, a smoker inventory, a brewing stand inventory, a smithing inventory, grindstone inventory, a crafting table inventory, a player inventory, furnace inventory, a creative inventory, blast furnace inventory, upgrade gear, a composter inventory, an enchanting table inventory, jukebox, a dropper inventory, a cartography table inventory, a upgrade gear, smoker inventory, composter inventory, a chest inventory, upgrade gear table, a upgrade gear table, dispenser inventory, player inventory, stonecutter inventory, a stonecutter inventory, a lectern inventory, merchant inventory, cartography table inventory, a chiseled bookshelf, a new smithing table, a furnace inventory, anvil inventory, a dispenser inventory, a grindstone inventory, smithing inventory, dropper inventory, brewing stand inventory, villager inventory, enchanting table inventory, a beacon inventory, a bookshelf, creative inventory, crafting table inventory, an anvil inventory
Since:
2.2-dev32
Minecraft has several different inventory types with their own use cases.
[<number> [of]] <alias> [of <enchantment> <level>], Where <alias> must be an alias that represents exactly one item (i.e cannot be a general alias like 'sword' or 'plant')
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
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
A location in a world. Locations are world-specific and even store a direction, e.g. if you save a location and later teleport to it you will face the exact same direction you did when you saved the location.
<number> $ or $ <number>, where '$' is your server's currency, e.g. '10 rupees' or '£5.00'
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
[-]###[.###] (any amount of digits; very large numbers will be truncated though)
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
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.
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.
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.
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%."
A time is a point in a minecraft day's time (i.e. ranges from 0:00 to 23:59), which can vary per world. See date and timespan for the other time types of Skript.
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.
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
See the type name patterns of all types - including this one
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
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.
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]
lmb, number key, mmb, rmb, drop item, drop key, window border using left mouse button, unknown, window border using right mouse, shift+rmb, unsupported, shift+lmb, ctrl+q, swap shield, left mouse button, left mouse with shift, left mouse, 0-9, double click, double click using mouse, border using rmb, right mouse button, right mouse button with shift, border using lmb, middle mouse, drop key with control, window border using right mouse button, swap offhand, custom, q, right mouse with shift, middle mouse button, drop stack, left mouse button with shift, right mouse, creative action
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.
color of the sheep is red or black set the color of the block to green message "You're holding a &amp;amp;amp;amp;lt;%color of tool%&amp;amp;amp;amp;gt;%color of tool%&amp;amp;amp;amp;lt;reset&amp;amp;amp;amp;gt; wool block"
command /push [&amp;amp;amp;amp;amp;lt;player&amp;amp;amp;amp;amp;gt;]: trigger: if arg-1 is not set: if command sender is console: send "You can't push yourself as a console :\" to sender stop push sender upwards with force 2 send "Yay!" else: push arg-1 upwards with force 2 send "Yay!" to sender and arg-1
sweep attack, thorns, the void, magma, a lightning, drowning, dragonfire, an attack, drown, an entity attack, melt, freeze, falling block, contact, fire, an entity explosion, lightning, a fall, entity explosion, void, a lightning strike, suffocation, suicide, wither effect, a plugin, lightning strike, entity attack, a potion, a wither, sweeping, melting, a falling block, unknown, starvation, lava, fall, hot floor, attack, a block explosion, dryout, burn, hitting wall while flying, potion, world border, flying into a wall, cramming, poison, sonic boom, suffocate, custom, kill, killed, a fire, burning, a projectile, plugin, wither potion effect, block explosion, projectile, wither, dragon's breath
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.
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
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
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.
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.
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
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).
drop stack from slot, swap items with hotbar, swap cursor stack, pickup single item, pickup some, drop all from cursor, move to other inventory, drop cursor stack, pickup all, swap with hotbar, nothing, drop all from slot, swap cursor, drop cursor, pickup all items, drop slot item, place all, drop cursor item, drop slot stack, drop single item from slot, swap with cursor, place some, pickup one item, drop single item from cursor, collect items to cursor, unknown, clone stack, drop stack from cursor, drop one item from slot, drop one item from cursor, unsupported, do nothing, drop one from cursor, pickup half, drop items from slot, swap stack with cursor, place all items, collect to cursor, pickup some items, drop slot, drop items from cursor, hotbar move and readd, shift move, custom, pickup single, place one item, hotbar swap items, drop one from slot, place some items, place one, pickup half stack, instant move, hotbar swap
Since:
2.2-dev16
What player just did in inventory event. Note that when in creative game mode, most actions do not work correctly.
barrel inventory, a loom inventory, a blast furnace inventory, workbench inventory, ender chest inventory, loom inventory, a workbench inventory, hopper inventory, a merchant inventory, a hopper inventory, chiseled bookshelf, an ender chest inventory, new smithing table, bookshelf, a jukebox, beacon inventory, shulker box inventory, a barrel inventory, a shulker box inventory, lectern inventory, chest inventory, a villager inventory, a smoker inventory, a brewing stand inventory, a smithing inventory, grindstone inventory, a crafting table inventory, a player inventory, furnace inventory, a creative inventory, blast furnace inventory, upgrade gear, a composter inventory, an enchanting table inventory, jukebox, a dropper inventory, a cartography table inventory, a upgrade gear, smoker inventory, composter inventory, a chest inventory, upgrade gear table, a upgrade gear table, dispenser inventory, player inventory, stonecutter inventory, a stonecutter inventory, a lectern inventory, merchant inventory, cartography table inventory, a chiseled bookshelf, a new smithing table, a furnace inventory, anvil inventory, a dispenser inventory, a grindstone inventory, smithing inventory, dropper inventory, brewing stand inventory, villager inventory, enchanting table inventory, a beacon inventory, a bookshelf, creative inventory, crafting table inventory, an anvil inventory
Since:
2.2-dev32
Minecraft has several different inventory types with their own use cases.
[<number> [of]] <alias> [of <enchantment> <level>], Where <alias> must be an alias that represents exactly one item (i.e cannot be a general alias like 'sword' or 'plant')
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
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
A location in a world. Locations are world-specific and even store a direction, e.g. if you save a location and later teleport to it you will face the exact same direction you did when you saved the location.
<number> $ or $ <number>, where '$' is your server's currency, e.g. '10 rupees' or '£5.00'
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
[-]###[.###] (any amount of digits; very large numbers will be truncated though)
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
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.
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.
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.
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
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%."
A time is a point in a minecraft day's time (i.e. ranges from 0:00 to 23:59), which can vary per world. See date and timespan for the other time types of Skript.
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.
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
See the type name patterns of all types - including this one
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
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.
Tests whether a player is allowed to build at a certain location. This condition requires a supported regions plugin to be installed.
Examples:
command /setblock <material>: description: set the block at your crosshair to a different type trigger: player cannot build at the targeted block: message "You do not have permission to change blocks there!" stop set the targeted block to argument
A very general condition, it simply compares two values. Usually you can only compare for equality (e.g. block is/isn't of <type>), but some values can also be compared using greater than/less than. In that case you can also test for whether an object is between two others. Note: This is the only element where not all patterns are shown. It has actually another two sets of similar patters, but with (was|were) or will be instead of (is|are) respectively, which check different time states of the first expression.
Examples:
the clicked block is a stone slab or a double stone slab time in the player's world is greater than 8:00 the creature is not an enderman or an ender dragon
Checks whether an inventory contains an item, a text contains another piece of text, or a list (e.g. {list variable::*} or 'drops') contains another object.
Examples:
block contains 20 cobblestone player has 4 flint and 2 iron ingots {list::*} contains 5
[the] damage (was|is|has)[n('|o)t] [been] (caused|done|made) by %damage cause%
Since:
2.0
Tests what kind of damage caused a damage event. Refer to the Damage Cause type for a list of all possible causes.
Examples:
# make players use their potions of fire resistance whenever they take any kind of fire damage on damage: damage was caused by lava, fire or burning victim is a player victim has a potion of fire resistance cancel event apply fire resistance to the victim for 30 seconds remove 1 potion of fire resistance from the victim # prevent mobs from dropping items under certain circumstances on death: entity is not a player damage wasn't caused by a block explosion, an attack, a projectile, a potion, fire, burning, thorns or poison clear drops
Checks whether living entities have an unobstructed line of sight to other entities or locations.
Examples:
player has direct line of sight to location 5 blocks to the right of player victim has line of sight to attacker player has no line of sight to location 100 blocks in front of player
%players% (doesn't|does not|do not|don't) have [a] resource pack [(loaded|installed)]
Since:
2.4
Requirements:
Paper 1.9 or newer
Checks whether the given players have a server resource pack loaded. Please note that this can't detect player's own resource pack, only the resource pack that sent by the server.
Checks if a block is indirectly or directly powered by redstone
Examples:
if clicked block is redstone powered: send "This block is well-powered by redstone!" if clicked block is indirectly redstone powered: send "This block is indirectly redstone powered."
Checks whether a player is a member or owner of a particular region. This condition requires a supported regions plugin to be installed.
Examples:
on region enter: player is the owner of the region message "Welcome back to %region%!" send "%player% just entered %region%!" to all members of the region
Checks whether a block is passable. A block is passable if it has no colliding parts that would prevent players from moving through it. Blocks like tall grass, flowers, signs, etc. are passable, but open doors, fence gates, trap doors, etc. are not because they still have parts that can be collided with.
Check if a plugin is enabled/disabled on the server. Plugin names can be found in the plugin's 'plugin.yml' file or by using the '/plugins' command, they are NOT the name of the plugin's jar file. When checking if a plugin is not enabled, this will return true if the plugin is either disabled or not on the server. When checking if a plugin is disabled, this will return true if the plugin is on the server and is disabled.
Examples:
if plugin "Vault" is enabled: if plugin "WorldGuard" is not enabled: if plugins "Essentials" and "Vault" are enabled: if plugin "MyBrokenPlugin" is disabled:
Checks whether an item is the preferred tool for a block. A preferred tool is one that will drop the block's item when used. For example, a wooden pickaxe is a preferred tool for grass and stone blocks, but not for iron ore.
Examples:
on left click: event-block is set if player's tool is the preferred tool for event-block: break event-block naturally using player's tool else: cancel event
Tests whether a chunk is a so-called slime chunk. Slimes can generally spawn in the swamp biome and in slime chunks. For more info, see the Minecraft wiki.
Examples:
command /slimey: trigger: if chunk at player is a slime chunk: send "Yeah, it is!" else: send "Nope, it isn't"
# prevent mobs from seeing sneaking players if they are at least 4 meters apart on target: target is sneaking distance of target and the entity is bigger than 4 cancel the event
Checks whether an item is transparent. Note that this condition may not work for all blocks, due to the transparency list used by Spigot not being completely accurate.
Whether a location is within something else. The "something" can be a block, an entity, a chunk, a world, or a cuboid formed by two other locations. Note that using the is between condition will refer to a straight line between locations, while this condition will refer to the cuboid between locations.
Examples:
if player's location is within {_loc1} and {_loc2}: send "You are in a PvP zone!" to player
if player is in world("world"): send "You are in the overworld!" to player
if attacker's location is inside of victim: cancel event send "Back up!" to attacker and victim
Checks whether an item of an entity is of the given type. This is mostly useful for variables, as you can use the general 'is' condition otherwise (e.g. 'victim is a creeper').
Examples:
tool is of type {selected type} victim is of type {villager type}
Checks if living entities or players are left or right-handed. Armor stands are neither right nor left-handed. Paper 1.17.1+ is required for non-player entities.
Examples:
on damage of player: if victim is left handed: cancel event
Checks whether the defined strings match the input regexes (Regular expressions).
Examples:
on chat: if message partially matches "\d": send "Message contains a digit!" if message doesn't match "[A-Za-z]+": send "Message doesn't only contain letters!"
on resource pack response: if the resource pack wasn't accepted: kick the player due to "You have to install the resource pack to play in this server!"
%date% (was|were)( more|(n't| not) less) than %time span% [ago]
%date% (was|were)((n't| not) more| less) than %time span% [ago]
Since:
2.0
Tests whether a given real time was more or less than some time span ago.
Examples:
command /command-with-cooldown: trigger: {command::%player's uuid%::last-usage} was less than a minute ago: message "Please wait a minute between uses of this command." stop set {command::%player's uuid%::last-usage} to now # ... actual command trigger here ...
\ No newline at end of file
+ Skript Documentation - 2.8.0-dev-nightly-235b97a
Tests whether a player is allowed to build at a certain location. This condition requires a supported regions plugin to be installed.
Examples:
command /setblock <material>: description: set the block at your crosshair to a different type trigger: player cannot build at the targeted block: message "You do not have permission to change blocks there!" stop set the targeted block to argument
A very general condition, it simply compares two values. Usually you can only compare for equality (e.g. block is/isn't of <type>), but some values can also be compared using greater than/less than. In that case you can also test for whether an object is between two others. Note: This is the only element where not all patterns are shown. It has actually another two sets of similar patters, but with (was|were) or will be instead of (is|are) respectively, which check different time states of the first expression.
Examples:
the clicked block is a stone slab or a double stone slab time in the player's world is greater than 8:00 the creature is not an enderman or an ender dragon
Checks whether an inventory contains an item, a text contains another piece of text, or a list (e.g. {list variable::*} or 'drops') contains another object.
Examples:
block contains 20 cobblestone player has 4 flint and 2 iron ingots {list::*} contains 5
[the] damage (was|is|has)[n('|o)t] [been] (caused|done|made) by %damage cause%
Since:
2.0
Tests what kind of damage caused a damage event. Refer to the Damage Cause type for a list of all possible causes.
Examples:
# make players use their potions of fire resistance whenever they take any kind of fire damage on damage: damage was caused by lava, fire or burning victim is a player victim has a potion of fire resistance cancel event apply fire resistance to the victim for 30 seconds remove 1 potion of fire resistance from the victim # prevent mobs from dropping items under certain circumstances on death: entity is not a player damage wasn't caused by a block explosion, an attack, a projectile, a potion, fire, burning, thorns or poison clear drops
Checks whether living entities have an unobstructed line of sight to other entities or locations.
Examples:
player has direct line of sight to location 5 blocks to the right of player victim has line of sight to attacker player has no line of sight to location 100 blocks in front of player
%players% (doesn't|does not|do not|don't) have [a] resource pack [(loaded|installed)]
Since:
2.4
Requirements:
Paper 1.9 or newer
Checks whether the given players have a server resource pack loaded. Please note that this can't detect player's own resource pack, only the resource pack that sent by the server.
Checks if a block is indirectly or directly powered by redstone
Examples:
if clicked block is redstone powered: send "This block is well-powered by redstone!" if clicked block is indirectly redstone powered: send "This block is indirectly redstone powered."
Checks whether a player is a member or owner of a particular region. This condition requires a supported regions plugin to be installed.
Examples:
on region enter: player is the owner of the region message "Welcome back to %region%!" send "%player% just entered %region%!" to all members of the region
Checks whether a block is passable. A block is passable if it has no colliding parts that would prevent players from moving through it. Blocks like tall grass, flowers, signs, etc. are passable, but open doors, fence gates, trap doors, etc. are not because they still have parts that can be collided with.
Check if a plugin is enabled/disabled on the server. Plugin names can be found in the plugin's 'plugin.yml' file or by using the '/plugins' command, they are NOT the name of the plugin's jar file. When checking if a plugin is not enabled, this will return true if the plugin is either disabled or not on the server. When checking if a plugin is disabled, this will return true if the plugin is on the server and is disabled.
Examples:
if plugin "Vault" is enabled: if plugin "WorldGuard" is not enabled: if plugins "Essentials" and "Vault" are enabled: if plugin "MyBrokenPlugin" is disabled:
Checks whether an item is the preferred tool for a block. A preferred tool is one that will drop the block's item when used. For example, a wooden pickaxe is a preferred tool for grass and stone blocks, but not for iron ore.
Examples:
on left click: event-block is set if player's tool is the preferred tool for event-block: break event-block naturally using player's tool else: cancel event
Tests whether a chunk is a so-called slime chunk. Slimes can generally spawn in the swamp biome and in slime chunks. For more info, see the Minecraft wiki.
Examples:
command /slimey: trigger: if chunk at player is a slime chunk: send "Yeah, it is!" else: send "Nope, it isn't"
# prevent mobs from seeing sneaking players if they are at least 4 meters apart on target: target is sneaking distance of target and the entity is bigger than 4 cancel the event
Checks whether an item is transparent. Note that this condition may not work for all blocks, due to the transparency list used by Spigot not being completely accurate.
Whether a location is within something else. The "something" can be a block, an entity, a chunk, a world, or a cuboid formed by two other locations. Note that using the is between condition will refer to a straight line between locations, while this condition will refer to the cuboid between locations.
Examples:
if player's location is within {_loc1} and {_loc2}: send "You are in a PvP zone!" to player
if player is in world("world"): send "You are in the overworld!" to player
if attacker's location is inside of victim: cancel event send "Back up!" to attacker and victim
Checks whether an item of an entity is of the given type. This is mostly useful for variables, as you can use the general 'is' condition otherwise (e.g. 'victim is a creeper').
Examples:
tool is of type {selected type} victim is of type {villager type}
Checks if living entities or players are left or right-handed. Armor stands are neither right nor left-handed. Paper 1.17.1+ is required for non-player entities.
Examples:
on damage of player: if victim is left handed: cancel event
Checks whether the defined strings match the input regexes (Regular expressions).
Examples:
on chat: if message partially matches "\d": send "Message contains a digit!" if message doesn't match "[A-Za-z]+": send "Message doesn't only contain letters!"
on resource pack response: if the resource pack wasn't accepted: kick the player due to "You have to install the resource pack to play in this server!"
%date% (was|were)( more|(n't| not) less) than %time span% [ago]
%date% (was|were)((n't| not) more| less) than %time span% [ago]
Since:
2.0
Tests whether a given real time was more or less than some time span ago.
Examples:
command /command-with-cooldown: trigger: {command::%player's uuid%::last-usage} was less than a minute ago: message "Please wait a minute between uses of this command." stop set {command::%player's uuid%::last-usage} to now # ... actual command trigger here ...
\ No newline at end of file
diff --git a/docs/nightly/fix/command-cooldown-storage/docs.html b/docs/nightly/fix/command-cooldown-storage/docs.html
index e58d5a9d04..2c3af20fbd 100644
--- a/docs/nightly/fix/command-cooldown-storage/docs.html
+++ b/docs/nightly/fix/command-cooldown-storage/docs.html
@@ -1 +1 @@
- Skript Documentation - 2.8.0-dev-nightly-173935c
command /broadcast <string>: usage: A command for broadcasting a message to all players. permission: skript.command.broadcast permission message: You don't have permission to broadcast messages aliases: /bc executable by: players and console cooldown: 15 seconds cooldown message: You last broadcast a message %elapsed time% ago. You can broadcast another message in %remaining time%. cooldown bypass: skript.command.broadcast.admin cooldown storage: {cooldown::%player%} trigger: broadcast the argument
[local] function <([\p{IsAlphabetic}][\p{IsAlphabetic}\p{IsDigit}_]*)\((.*)\)(\s*(::| returns )\s*(.+))?>
Since:
2.2, 2.7 (local functions)
Functions are structures that can be executed with arguments/parameters to run code. They can also return a value to the trigger that is executing the function. Note that local functions come before global functions execution
Examples:
function sayMessage(message: text): broadcast {_message} # our message argument is available in '{_message}'
local function giveApple(amount: number) :: item: return {_amount} of apple
function getPoints(p: player) returns number: return {points::%{_p}%}
Options are used for replacing parts of a script with something else. For example, an option may represent a message that appears in multiple locations. Take a look at the example below that showcases this.
Examples:
options: no_permission: You're missing the required permission to execute this command!
Used for defining variables present within a script. This section is not required, but it ensures that a variable has a value if it doesn't exist when the script is loaded.
Examples:
variables: {joins} = 0 {balance::%player%} = 0
on join: add 1 to {joins} message "Your balance is %{balance::%player%}%"
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
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
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.
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!"
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
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
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!"
A part of a player's armour, 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
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
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
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
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
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
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
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
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
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
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"
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?
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
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
main name 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
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"
# 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%}
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%}
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
How much damage is done in a damage event, possibly ignoring armour, criticals and/or enchantments. Can be changed (remember that in Skript '1' is one full heart, not half a heart).
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
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!"
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
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.
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.
All entities in all worlds, in a specific world, in a chunk or in a radius around a certain location, 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
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!" set victim's attack speed attribute to 2
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
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%
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
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
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
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"]
Represents the input in a filter expression. 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.
Examples:
send "congrats on being staff!" to all players where [input has permission "staff"]
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
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
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
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.
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
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
Returns the hanging entity or remover in hanging break and place events.
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
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!"
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:
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).
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
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
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}
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
on inventory item move: if holder of event-initiator-inventory is a chest: broadcast "Item transport requested at %location at holder of event-initiator-inventory%..."
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
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
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
An item associated with an entity. For dropped item entities, it gets, obviously, the item that was dropped. For item frames, the item inside the frame is returned. For throwable projectiles (snowballs, enderpearls etc.),it gets the displayed item. Other entities do not have items associated with them.
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
All 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
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 with "" | ""%" # %all players% would use the default "x, y, and z" set {_s::*} to the string argument split at ","
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.
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
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."
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
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
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%."
# 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%"
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.
[the] [(real|default)|(fake|shown|displayed)] max[imum] (count|amount|number|size) of players
Since:
2.3, 2.7 (modify max real players)
Requirements:
Paper 1.16+ (modify max real players)
Return Type:
integer
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)
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
The (chat) message of a chat event, the join message of a join event, the quit message of a quit event, or the death message on a death 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: set quit message to "%player% left this awesome server!"
on death: set the death message to "%player% died!"
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."
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
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"
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"
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
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
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
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
[the] [((real|default)|(fake|shown|displayed))] [online] player (count|amount|number)
[the] [((real|default)|(fake|shown|displayed))] (count|amount|number|size) of online players
Since:
2.3
Return Type:
long
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 returns the real count of online players and can't be changed.
Fake online player count requires PaperSpigot 1.12.2+.
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 players count + 1)
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
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!"
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
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%"
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
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
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
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
A random number or integer 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
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>."
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
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!!"
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
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.
Examples:
if index of event-slot is 10: send "You bought a pie!"
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
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
For players this is the entity at the crosshair. For mobs and experience orbs this is the entity they are attacking/following (if any).
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
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.
Examples:
# A command to set the block a player looks at to a specific type: command /setblock <material>: trigger: set targeted block to argument
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
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
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%!"
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
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"
set {_v} to vector 1, 2, 3 // 5 set {_v} to {_v} ++ {_v} set {_v} to {_v} ++ 5 set {_v} to {_v} -- {_v} set {_v} to {_v} -- 5 set {_v} to {_v} ** {_v} set {_v} to {_v} ** 5 set {_v} to {_v} // {_v} set {_v} to {_v} // 5
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
Gets or changes the x, y or z component of a vector.
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}%"
The vehicle an entity is in, if any. This can actually be any entity, e.g. spider jockeys are skeletons that ride on a spider, so the spider is the 'vehicle' of the skeleton. See also: passenger
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%"
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
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
A server's whitelist.This expression can be used to add/remove players to/from the whitelist, to enable it and disable it (set whitelist to true / set whitelist to false), and to empty it (reset whitelist)
Examples:
set whitelist to false add all players to whitelist reset the whitelist
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.
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
Bans or unbans a player or an IP address. If a reason is given, it will be shown to the player when they try to join the server while banned. A length of ban may also be given to apply a temporary ban. If it is absent for any reason, a permanent ban will be used instead. We recommend that you test your scripts so that no accidental permanent bans are applied.
Note that banning people does not kick them from the server. Consider using the kick effect after applying a ban.
Examples:
unban player ban "127.0.0.1" IP-ban the player because "he is an idiot" ban player due to "inappropriate language" for 2 days
Breaks the block and spawns items as if a player had mined it
You can add a tool, which will spawn items based on how that tool would break the block (ie: When using a hand to break stone, it drops nothing, whereas with a pickaxe it drops cobblestone)
Examples:
on right click: break clicked block naturally loop blocks in radius 10 around player: break loop-block using player's tool loop blocks in radius 10 around player: break loop-block naturally using diamond pickaxe
Only usable in commands. Makes it so the current command usage isn't counted towards the cooldown.
Examples:
command /nick <text>: executable by: players cooldown: 10 seconds trigger: if length of arg-1 is more than 16: # Makes it so that invalid arguments don't make you wait for the cooldown again cancel the cooldown send "Your nickname may be at most 16 characters." stop set the player's display name to arg-1
Cancels drops of items or experiences in a death or block break event. Please note that this doesn't keep items or experiences of a dead player. If you want to do that, use the Keep Inventory / Experience effect.
Examples:
on death of a zombie: if name of the entity is "&cSpecial": cancel drops of items
on break of a coal ore: cancel the experience drops
A very general effect that can change many expressions. Many expressions can only be set and/or deleted, while some can have things added to or removed from them.
Examples:
# set: Set the player's display name to "<red>%name of player%" set the block above the victim to lava # add: add 2 to the player's health # preferably use '<a href='#EffHealth'>heal</a>' for this add argument to {blacklist::*} give a diamond pickaxe of efficiency 5 to the player increase the data value of the clicked block by 1 # remove: remove 2 pickaxes from the victim subtract 2.5 from {points::%uuid of player%} # remove all: remove every iron tool from the player remove all minecarts from {entitylist::*} # delete: delete the block below the player clear drops delete {variable} # reset: reset walk speed of player reset chunk at the targeted block
Colors items in a given color. You can also use RGB codes if you feel limited with the 16 default colors. RGB codes are three numbers from 0 to 255 in the order (red, green, blue), where (0,0,0) is black and (255,255,255) is white. Armor is colorable for all Minecraft versions. With Minecraft 1.11 or newer you can also color potions and maps. Note that the colors might not look exactly how you'd expect.
Examples:
dye player's helmet blue color the player's tool red
Executes a command. This can be useful to use other plugins in triggers. If the command is a bungeecord side command, you can use the [bungeecord] option to execute command on the proxy.
Examples:
make player execute command "/home" execute console command "/say Hello everyone!" execute player bungeecord command "/alert &6Testing Announcement!"
Immediately moves the (while) loop on to the next iteration.
Examples:
# Broadcast online moderators loop all players: if loop-value does not have permission "moderator": continue # filter out non moderators broadcast "%loop-player% is a moderator!" # Only moderators get broadcast
# Game starting counter set {_counter} to 11 while {_counter} > 0: remove 1 from {_counter} wait a second if {_counter} != 1, 2, 3, 5 or 10: continue # only print when counter is 1, 2, 3, 5 or 10 broadcast "Game starting in %{_counter}% second(s)"
Delays the script's execution by a given timespan. Please note that delays are not persistent, e.g. trying to create a tempban script with ban player → wait 7 days → unban player will not work if you restart your server anytime within these 7 days. You also have to be careful even when using small delays!
Examples:
wait 2 minutes halt for 5 minecraft hours wait a tick
Equips or unequips an entity with some given armor. This will replace any armor that the entity is wearing.
Examples:
equip player with diamond helmet equip player with all diamond armor unequip diamond chestplate from player unequip all armor from player unequip player's armor
Exits a given amount of loops and conditionals, or the entire trigger.
Examples:
if player has any ore: stop message "%player% has no ores!" loop blocks above the player: loop-block is not air: exit 2 sections set loop-block to water
Creates an explosion of a given force. The Minecraft Wiki has an article on explosions which lists the explosion forces of TNT, creepers, etc. Hint: use a force of 0 to create a fake explosion that does no damage whatsoever, or use the explosion effect introduced in Skript 2.0. Starting with Bukkit 1.4.5 and Skript 2.0 you can use safe explosions which will damage entities but won't destroy any blocks.
Examples:
create an explosion of force 10 at the player create an explosion of force 0 at the victim
Kills an entity. Note: This effect does not set the entity's health to 0 (which causes issues), but damages the entity by 100 times its maximum health.
Examples:
kill the player kill all creepers in the player's world kill all endermen, witches and bats
load [the] server icon (from|of) [the] [image] [file] %text%
Since:
2.3
Requirements:
Paper 1.12.2 or newer
Loads server icons from the given files. You can get the loaded icon using the last loaded server icon expression. Please note that the image must be 64x64 and the file path starts from the server folder.
Examples:
on load: clear {server-icons::*} loop 5 times: load server icon from file "icons/%loop-number%.png" add the last loaded server icon to {server-icons::*}
on server list ping: set the icon to a random server icon out of {server-icons::*}
Writes text into a .log file. Skript will write these files to /plugins/Skript/logs. NB: Using 'server.log' as the log file will write to the default server log. Omitting the log file altogether will log the message as '[Skript] [<script>.sk] <message>' in the server log.
Examples:
on place of TNT: log "%player% placed TNT in %world% at %location of block%" to "tnt/placement.log"
Paper 1.17+, Paper 1.19.1+ (Players & Look Anchors)
Forces the mob(s) or player(s) to look at an entity, vector or location. Vanilla max head pitches range from 10 to 50.
Examples:
force the head of the player to look towards event-entity's feet
on entity explosion: set {_player} to the nearest player {_player} is set distance between {_player} and the event-location is less than 15 make {_player} look towards vector from the {_player} to location of the event-entity
force {_enderman} to face the block 3 meters above {_location} at head rotation speed 100.5 and max head pitch -40
Makes a living entity visible/invisible. This is not a potion and therefore does not have features such as a time limit or particles. When setting an entity to invisible while using an invisibility potion on it, the potion will be overridden and when it runs out the entity keeps its invisibility.
Sends a message to the given player. Only styles written in given string or in formatted expressions will be parsed. Adding an optional sender allows the messages to be sent as if a specific player sent them. This is useful with Minecraft 1.16.4's new chat ignore system, in which players can choose to ignore other players, but for this to work, the message needs to be sent from a player.
Examples:
message "A wild %player% appeared!" message "This message is a distraction. Mwahaha!" send "Your kill streak is %{kill streak::%uuid of player%}%." to player if the targeted entity exists: message "You're currently looking at a %type of the targeted entity%!" on chat: cancel event send "[%player%] >> %message%" to all players from player
Opens an inventory to a player. The player can then access and modify the inventory as if it was a chest that he just opened. Please note that currently 'show' and 'open' have the same effect, but 'show' will eventually show an unmodifiable view of the inventory in the future.
Examples:
show the victim's inventory to the player open the player's inventory for the player
Make an entity pathfind towards a location or another entity. Not all entities can pathfind. If the pathfinding target is another entity, the entities may or may not continuously follow the target.
Examples:
make all creepers pathfind towards player make all cows stop pathfinding make event-entity pathfind towards player at speed 1
Plays a visual effect at a given location or on a given entity. Please note that some effects can only be played on entities, e.g. wolf hearts or the hurt effect, and that these are always visible to all players.
Examples:
play wolf hearts on the clicked wolf show mob spawner flames at the targeted block to the player
Plays a sound at given location for everyone or just for given players, or plays a sound to specified players. Both Minecraft sound names and Spigot sound names are supported. Playing resource pack sounds are supported too. The sound category is 'master' by default.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
play sound "block.note_block.pling" # It is block.note.pling in 1.12.2 play sound "entity.experience_orb.pickup" with volume 0.5 to the player play sound "custom.music.1" in jukebox category at {speakerBlock}
Sets whether all player related information is hidden in the server list. The Vanilla Minecraft client will display ??? (dark gray) instead of player counts and will not show the hover hist when hiding player info. The version string can override the ???. Also the Online Players Count and Max Players expressions will return -1 when hiding player info.
Examples:
hide player info hide player related information in the server list reveal all player related info
Change visibility of a player for the given players. When reveal is used in combination of the hidden players expression and the viewers are not specified, this will default it to the given player in the hidden players expression.
Note: if a player was hidden and relogs, this player will be visible again.
Examples:
on join: if {vanished::%player's uuid%} is true: hide the player from all players
apply swiftness 2 to the player remove haste from the victim on join: apply potion of strength of tier {strength.%player%} to the player for 999 days apply potion effects of player's tool to player
2.0, 2.2-dev24 (replace in multiple strings and replace items in inventory), 2.5 (replace first, case sensitivity)
Replaces all occurrences of a given text with another text. Please note that you can only change variables and a few expressions, e.g. a message or a line of a sign.
Examples:
replace "<item>" in {textvar} with "%item%" replace every "&" with "§" in line 1 # The following acts as a simple chat censor, but it will e.g. censor mass, hassle, assassin, etc. as well: on chat: replace all "kys", "idiot" and "noob" with "****" in the message
replace all stone and dirt in player's inventory and player's top inventory with diamond
send [the] resource pack [from [[the] URL]] %text% to %players%
send [the] resource pack [from [[the] URL]] %text% with hash %text% to %players%
Since:
2.4
Request that the player's client download and switch resource packs. The client will download the resource pack in the background, and will automatically switch to it once the download is complete. The URL must be a direct download link.
The hash is used for caching, the player won't have to re-download the resource pack that way. The hash must be SHA-1, you can get SHA-1 hash of your resource pack using this online tool.
Stops specific or all sounds from playing to a group of players. Both Minecraft sound names and Spigot sound names are supported. Resource pack sounds are supported too. The sound category is 'master' by default. A sound can't be stopped from a different category.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
stop sound "block.chest.open" for the player stop playing sounds "ambient.underwater.loop" and "ambient.underwater.loop.additions" to the player stop all sound for all players stop sound in record category
Teleport an entity to a specific location. This effect is delayed by default on Paper, meaning certain syntax such as the return effect for functions cannot be used after this effect. The keyword 'force' indicates this effect will not be delayed, which may cause lag spikes or server crashes when using this effect to teleport entities to unloaded chunks.
Examples:
teleport the player to {homes.%player%} teleport the attacker to the victim
Sends a title/subtitle to the given player(s) with optional fadein/stay/fadeout times for Minecraft versions 1.11 and above.
If you're sending only the subtitle, it will be shown only if there's a title displayed at the moment, otherwise it will be sent with the next title. To show only the subtitle, use: send title " " with subtitle "yourtexthere" to player.
Note: if no input is given for the times, it will keep the ones from the last title sent, use the reset title effect to restore the default values.
Examples:
send title "Competition Started" with subtitle "Have fun, Stay safe!" to player for 5 seconds send title "Hi %player%" to player send title "Loot Drop" with subtitle "starts in 3 minutes" to all players send title "Hello %player%!" with subtitle "Welcome to our server" to player for 5 seconds with fadein 1 second and fade out 1 second send subtitle "Party!" to all players
Creates a tree. This may require that there is enough space above the given location and that the block below is dirt/grass, but it is possible that the tree will just grow anyways, possibly replacing every block in its path.
Spawn a creature. This can be used as an effect and as a section. If it is used as a section, the section is run before the entity is added to the world. You can modify the entity in this section, using for example 'event-entity' or 'cow'. Do note that other event values, such as 'player', won't work in this section.
Examples:
spawn 3 creepers at the targeted block spawn a ghast 5 meters above the player spawn a zombie at the player: set name of the zombie to ""
Tests whether a player is allowed to build at a certain location. This condition requires a supported regions plugin to be installed.
Examples:
command /setblock <material>: description: set the block at your crosshair to a different type trigger: player cannot build at the targeted block: message "You do not have permission to change blocks there!" stop set the targeted block to argument
A very general condition, it simply compares two values. Usually you can only compare for equality (e.g. block is/isn't of <type>), but some values can also be compared using greater than/less than. In that case you can also test for whether an object is between two others. Note: This is the only element where not all patterns are shown. It has actually another two sets of similar patters, but with (was|were) or will be instead of (is|are) respectively, which check different time states of the first expression.
Examples:
the clicked block is a stone slab or a double stone slab time in the player's world is greater than 8:00 the creature is not an enderman or an ender dragon
Checks whether an inventory contains an item, a text contains another piece of text, or a list (e.g. {list variable::*} or 'drops') contains another object.
Examples:
block contains 20 cobblestone player has 4 flint and 2 iron ingots {list::*} contains 5
[the] damage (was|is|has)[n('|o)t] [been] (caused|done|made) by %damage cause%
Since:
2.0
Tests what kind of damage caused a damage event. Refer to the Damage Cause type for a list of all possible causes.
Examples:
# make players use their potions of fire resistance whenever they take any kind of fire damage on damage: damage was caused by lava, fire or burning victim is a player victim has a potion of fire resistance cancel event apply fire resistance to the victim for 30 seconds remove 1 potion of fire resistance from the victim # prevent mobs from dropping items under certain circumstances on death: entity is not a player damage wasn't caused by a block explosion, an attack, a projectile, a potion, fire, burning, thorns or poison clear drops
Checks whether living entities have an unobstructed line of sight to other entities or locations.
Examples:
player has direct line of sight to location 5 blocks to the right of player victim has line of sight to attacker player has no line of sight to location 100 blocks in front of player
%players% (doesn't|does not|do not|don't) have [a] resource pack [(loaded|installed)]
Since:
2.4
Requirements:
Paper 1.9 or newer
Checks whether the given players have a server resource pack loaded. Please note that this can't detect player's own resource pack, only the resource pack that sent by the server.
Checks if a block is indirectly or directly powered by redstone
Examples:
if clicked block is redstone powered: send "This block is well-powered by redstone!" if clicked block is indirectly redstone powered: send "This block is indirectly redstone powered."
Checks whether a player is a member or owner of a particular region. This condition requires a supported regions plugin to be installed.
Examples:
on region enter: player is the owner of the region message "Welcome back to %region%!" send "%player% just entered %region%!" to all members of the region
Checks whether a block is passable. A block is passable if it has no colliding parts that would prevent players from moving through it. Blocks like tall grass, flowers, signs, etc. are passable, but open doors, fence gates, trap doors, etc. are not because they still have parts that can be collided with.
Check if a plugin is enabled/disabled on the server. Plugin names can be found in the plugin's 'plugin.yml' file or by using the '/plugins' command, they are NOT the name of the plugin's jar file. When checking if a plugin is not enabled, this will return true if the plugin is either disabled or not on the server. When checking if a plugin is disabled, this will return true if the plugin is on the server and is disabled.
Examples:
if plugin "Vault" is enabled: if plugin "WorldGuard" is not enabled: if plugins "Essentials" and "Vault" are enabled: if plugin "MyBrokenPlugin" is disabled:
Checks whether an item is the preferred tool for a block. A preferred tool is one that will drop the block's item when used. For example, a wooden pickaxe is a preferred tool for grass and stone blocks, but not for iron ore.
Examples:
on left click: event-block is set if player's tool is the preferred tool for event-block: break event-block naturally using player's tool else: cancel event
Tests whether a chunk is a so-called slime chunk. Slimes can generally spawn in the swamp biome and in slime chunks. For more info, see the Minecraft wiki.
Examples:
command /slimey: trigger: if chunk at player is a slime chunk: send "Yeah, it is!" else: send "Nope, it isn't"
# prevent mobs from seeing sneaking players if they are at least 4 meters apart on target: target is sneaking distance of target and the entity is bigger than 4 cancel the event
Checks whether an item is transparent. Note that this condition may not work for all blocks, due to the transparency list used by Spigot not being completely accurate.
Whether a location is within something else. The "something" can be a block, an entity, a chunk, a world, or a cuboid formed by two other locations. Note that using the is between condition will refer to a straight line between locations, while this condition will refer to the cuboid between locations.
Examples:
if player's location is within {_loc1} and {_loc2}: send "You are in a PvP zone!" to player
if player is in world("world"): send "You are in the overworld!" to player
if attacker's location is inside of victim: cancel event send "Back up!" to attacker and victim
Checks whether an item of an entity is of the given type. This is mostly useful for variables, as you can use the general 'is' condition otherwise (e.g. 'victim is a creeper').
Examples:
tool is of type {selected type} victim is of type {villager type}
Checks if living entities or players are left or right-handed. Armor stands are neither right nor left-handed. Paper 1.17.1+ is required for non-player entities.
Examples:
on damage of player: if victim is left handed: cancel event
Checks whether the defined strings match the input regexes (Regular expressions).
Examples:
on chat: if message partially matches "\d": send "Message contains a digit!" if message doesn't match "[A-Za-z]+": send "Message doesn't only contain letters!"
on resource pack response: if the resource pack wasn't accepted: kick the player due to "You have to install the resource pack to play in this server!"
%date% (was|were)( more|(n't| not) less) than %time span% [ago]
%date% (was|were)((n't| not) more| less) than %time span% [ago]
Since:
2.0
Tests whether a given real time was more or less than some time span ago.
Examples:
command /command-with-cooldown: trigger: {command::%player's uuid%::last-usage} was less than a minute ago: message "Please wait a minute between uses of this command." stop set {command::%player's uuid%::last-usage} to now # ... actual command trigger here ...
Conditional sections if: executed when its condition is true else if: executed if all previous chained conditionals weren't executed, and its condition is true else: executed if all previous chained conditionals weren't executed
parse if: a special case of 'if' condition that its code will not be parsed if the condition is not true else parse if: another special case of 'else if' condition that its code will not be parsed if all previous chained conditionals weren't executed, and its condition is true
Examples:
if player's health is greater than or equal to 4: send "Your health is okay so far but be careful!"
else if player's health is greater than 2: send "You need to heal ASAP, your health is very low!"
else: # Less than 2 hearts send "You are about to DIE if you don't heal NOW. You have only %player's health% heart(s)!"
parse if plugin "SomePluginName" is enabled: # parse if %condition% # This code will only be executed if the condition used is met otherwise Skript will not parse this section therefore will not give any errors/info about this section
Loop sections repeat their code with multiple values.
A loop will loop through all elements of the given expression, e.g. all players, worlds, items, etc. The conditions & effects inside the loop will be executed for every of those elements, which can be accessed with ‘loop-’, e.g. send "hello" to loop-player. When a condition inside a loop is not fulfilled the loop will start over with the next element of the loop. You can however use stop loop to exit the loop completely and resume code execution after the end of the loop.
Loopable Values All expressions that represent more than one value, e.g. ‘all players’, ‘worlds’, etc., as well as list variables, can be looped. You can also use a list of expressions, e.g. loop the victim and the attacker, to execute the same code for only a few values.
List Variables When looping list variables, you can also use loop-index in addition to loop-value inside the loop. loop-value is the value of the currently looped variable, and loop-index is the last part of the variable's name (the part where the list variable has its asterisk *).
Examples:
loop all players: send "Hello %loop-player%!" to loop-player
loop items in player's inventory: if loop-item is dirt: set loop-item to air
loop 10 times: send title "%11 - loop-value%" and subtitle "seconds left until the game begins" to player for 1 second # 10, 9, 8 etc. wait 1 second
loop {Coins::*}: set {Coins::%loop-index%} to loop-value + 5 # Same as "add 5 to {Coins::%loop-index%}" where loop-index is the uuid of the player and loop-value is the actually coins value such as 200
While Loop sections are loops that will just keep repeating as long as a condition is met.
Examples:
while size of all players < 5: send "More players are needed to begin the adventure" to all players wait 5 seconds
set {_counter} to 1 do while {_counter} > 1: # false but will increase {_counter} by 1 then get out add 1 to {_counter}
# Be careful when using while loops with conditions that are almost # always true for a long time without using 'wait %timespan%' inside it, # otherwise it will probably hang and crash your server. while player is online: give player 1 dirt wait 1 second # without using a delay effect the server will crash
Called when an item is put in a slot for repair by an anvil. Please note that this event is called multiple times in a single item slot move.
Examples:
on anvil prepare: event-item is set # result item chance of 5%: set repair cost to repair cost * 50% send "You're LUCKY! You got 50% discount." to player
Called when a player rightclicks on a block while holding a block or a placeable item. You can either cancel the event to prevent the block from being built, or uncancel it to allow it. Please note that the data value of the block to be placed is not available in this event, only its ID.
Called whenever a player chats. Use chat format to change message format. Use chat recipients to edit chat recipients.
Examples:
on chat: if player has permission "owner": set chat format to "&lt;red&gt;[player]&lt;light gray&gt;: &lt;light red&gt;[message]" else if player has permission "admin": set chat format to "&lt;light red&gt;[player]&lt;light gray&gt;: &lt;orange&gt;[message]" else: #default message format set chat format to "&lt;orange&gt;[player]&lt;light gray&gt;: &lt;white&gt;[message]"
Called when a user clicks on a block, an entity or air with or without an item in their hand. Please note that rightclick events with an empty hand while not looking at a block are not sent to the server, so there's no way to detect them. Also note that a leftclick on an entity is an attack and thus not covered by the 'click' event, but the 'damage' event.
Examples:
on click: on rightclick holding a fishing rod: on leftclick on a stone or obsidian: on rightclick on a creeper: on click with a sword:
Called when a player enters a command (not necessarily a Skript command) but you can check if command is a skript command, see Is a Skript command condition.
Examples:
on command: on command "/stop": on command "pm Njol ":
Called when the player connects to the server. This event is called before the player actually joins the server, so if you want to prevent players from joining you should prefer this event over on join.
Examples:
on connect: player doesn't have permission "VIP" number of players is greater than 15 kick the player due to "The last 5 slots are reserved for VIP players."
Called when a player throws an egg and it lands. You can just use the shoot event in most cases. However, this event allows modification of properties like the hatched entity type and the number of entities to hatch.
Called when a player puts an item into enchantment table. This event may be called multiple times. To get the enchant item, see the enchant item expression
Examples:
on enchant prepare: set enchant offer 1 to sharpness 1 set the cost of enchant offer 1 to 10 levels
Called when an enderman places or picks up a block, a sheep eats grass, a silverfish boops into/out of a block or a falling block lands and turns into a block respectively.
Examples:
on sheep eat: kill event-entity broadcast "A sheep stole some grass!"
on falling block land: event-entity is a falling dirt cancel event
Called when an explosive is primed, i.e. an entity will explode shortly. Creepers can abort the explosion if the player gets too far away, while TNT will explode for sure after a short time.
on firework explode on firework exploding colored red, light green and black on firework explosion colored light green: broadcast "A firework colored %colors% was exploded at %location%!"
Called when a block is created, but not by a player, e.g. snow forms due to snowfall, water freezes in cold biomes. This isn't called when block spreads (mushroom growth, water physics etc.), as it has its own event (see spread event).
Called whenever a player swaps the items in their main- and offhand slots. Works also when one or both of the slots are empty. The event is called before the items are actually swapped, so when you use the player's tool or player's offtool expressions, they will return the values before the swap - this enables you to cancel the event before anything happens.
Examples:
on swap hand items: event-player's tool is a diamond sword cancel event
Called when an entity is healed, e.g. by eating (players), being fed (pets), or by the effect of a potion of healing (overworld mobs) or harm (nether mobs).
Called when a block starts burning, i.e. a fire block is placed next to it and this block is flammable. The burn event will be called when the block is about do be destroyed by the fire.
Examples:
on block ignite: if event-block is a ladder: cancel event
Called when an entity or block (e.g. hopper) tries to move items directly from one inventory to another. When this event is called, the initiator may have already removed the item from the source inventory and is ready to move it into the destination inventory. If this event is cancelled, the items will be returned to the source inventory.
Examples:
on inventory item move: broadcast "%holder of past event-inventory% is transporting %event-item% to %holder of event-inventory%!"
Called when dropped items merge into a single stack. event-entity will be the entity which is trying to merge, and future event-entity will be the entity which is being merged into.
Called whenever an item stack is spawned in a world, e.g. as drop of a block or mob, a player throwing items out of their inventory, or a dispenser dispensing an item (not shooting it).
Examples:
on item spawn of iron sword: broadcast "Someone dropped an iron sword!"
Called when the player joins the server. The player is already in a world when this event is called, so if you want to prevent players from joining you should prefer on connect over this event.
Examples:
on join: message "Welcome on our awesome server!" broadcast "%player% just joined the server!"
Called after a player changed their language in the game settings. You can use the language expression to get the current language of the player. This event requires Minecraft 1.12+.
Examples:
on language change: if player's language starts with "en": send "Hello!"
Called when a player or entity moves. NOTE: Move event will only be called when the entity/player moves position, not orientation (ie: looking around). NOTE: These events can be performance heavy as they are called quite often. If you use these events, and later remove them, a server restart is recommended to clear registered events from Skript.
Examples:
on player move: if player does not have permission "player.can.move": cancel event on skeleton move: if event-entity is not in world "world": kill event-entity
Called when a physics check is done on a block. By cancelling this event you can prevent some things from happening, e.g. sand falling, dirt turning into grass, torches dropping if their supporting block is destroyed, etc.Please note that using this event might cause quite some lag since it gets called extremely often.
Examples:
# prevents sand from falling on block physics: block is sand cancel event
Called when a player has slept long enough to count as passing the night/storm. Cancelling this event will prevent the player from being counted as deeply sleeping unless they exit and re-enter the bed.
Called when a portal is created, either by a player or mob lighting an obsidian frame on fire, or by a nether portal creating its teleportation target in the nether/overworld. In Minecraft 1.14+, you can use the player in this event. Please note that there may not always be a player (or other entity) in this event.
Called when a projectile hits an entity or a block. Use the damage event with a check for a projectile to be able to use the entity that got hit in the case when the projectile hit a living entity. A damage event will even be fired if the damage is 0, e.g. when throwing snowballs at non-nether mobs.
Examples:
on projectile hit: event-projectile is arrow delete event-projectile
Called when a player takes action on a resource pack request sent via the send resource pack effect. The resource pack condition can be used to check the resource pack state.
This event will be triggered once when the player accepts or declines the resource pack request, and once when the resource pack is successfully installed or failed to download.
Examples:
on resource pack request response: if the resource pack was declined or failed to download:
on resource pack deny: kick the player due to "You have to install the resource pack to play in this server!"
Called when the player activates the riptide enchantment, using their trident to propel them through the air. Note: the riptide action is performed client side, so manipulating the player in this event may have undesired effects.
Called directly after the trigger is loaded, or directly before the whole script is unloaded. The keyword 'async' indicates the trigger can be ran asynchronously,
Examples:
on load: set {running::%script%} to true on unload: set {running::%script%} to false
Called when a server list ping is coming in, generally when a Minecraft client pings the server to show its information in the server list. The IP expression can be used to get the IP adress of the pinger. This event can be cancelled on PaperSpigot 1.12.2+ only and this means the player will see the server as offline (but still can join).
on server list ping: set the motd to "Welcome %{player-by-IP::%ip%}%! Join now!" if {player-by-IP::%ip%} is set, else "Join now!" set the fake max players count to (online players count + 1) set the shown icon to a random server icon out of {server-icons::*}
Called whenever a player changes their held item by selecting a different slot (e.g. the keys 1-9 or the mouse wheel), not by dropping or replacing the item in the current slot.
Called when a world is initialised. As all default worlds are initialised before any scripts are loaded, this event is only called for newly created worlds. World management plugins might change the behaviour of this event though.
every 2 seconds in "world": every minecraft hour in "flatworld": every tick in "world": # can cause lag depending on the code inside the event every minecraft days in "plots":
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]
lmb, number key, mmb, rmb, drop item, drop key, window border using left mouse button, unknown, window border using right mouse, shift+rmb, unsupported, shift+lmb, ctrl+q, swap shield, left mouse button, left mouse with shift, left mouse, 0-9, double click, double click using mouse, border using rmb, right mouse button, right mouse button with shift, border using lmb, middle mouse, drop key with control, window border using right mouse button, swap offhand, custom, q, right mouse with shift, middle mouse button, drop stack, left mouse button with shift, right mouse, creative action
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.
color of the sheep is red or black set the color of the block to green message "You're holding a &lt;%color of tool%&gt;%color of tool%&lt;reset&gt; wool block"
command /push [&amp;lt;player&amp;gt;]: trigger: if arg-1 is not set: if command sender is console: send "You can't push yourself as a console :\" to sender stop push sender upwards with force 2 send "Yay!" else: push arg-1 upwards with force 2 send "Yay!" to sender and arg-1
sweep attack, thorns, the void, magma, a lightning, drowning, dragonfire, an attack, drown, an entity attack, melt, freeze, falling block, contact, fire, an entity explosion, lightning, a fall, entity explosion, void, a lightning strike, suffocation, suicide, wither effect, a plugin, lightning strike, entity attack, a potion, a wither, sweeping, melting, a falling block, unknown, starvation, lava, fall, hot floor, attack, a block explosion, dryout, burn, hitting wall while flying, potion, world border, flying into a wall, cramming, poison, sonic boom, suffocate, custom, kill, killed, a fire, burning, a projectile, plugin, wither potion effect, block explosion, projectile, wither, dragon's breath
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.
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
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
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.
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.
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
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).
drop stack from slot, swap items with hotbar, swap cursor stack, pickup single item, pickup some, drop all from cursor, move to other inventory, drop cursor stack, pickup all, swap with hotbar, nothing, drop all from slot, swap cursor, drop cursor, pickup all items, drop slot item, place all, drop cursor item, drop slot stack, drop single item from slot, swap with cursor, place some, pickup one item, drop single item from cursor, collect items to cursor, unknown, clone stack, drop stack from cursor, drop one item from slot, drop one item from cursor, unsupported, do nothing, drop one from cursor, pickup half, drop items from slot, swap stack with cursor, place all items, collect to cursor, pickup some items, drop slot, drop items from cursor, hotbar move and readd, shift move, custom, pickup single, place one item, hotbar swap items, drop one from slot, place some items, place one, pickup half stack, instant move, hotbar swap
Since:
2.2-dev16
What player just did in inventory event. Note that when in creative game mode, most actions do not work correctly.
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
barrel inventory, a loom inventory, a blast furnace inventory, workbench inventory, ender chest inventory, loom inventory, a workbench inventory, hopper inventory, a merchant inventory, a hopper inventory, chiseled bookshelf, an ender chest inventory, new smithing table, bookshelf, a jukebox, beacon inventory, shulker box inventory, a barrel inventory, a shulker box inventory, lectern inventory, chest inventory, a villager inventory, a smoker inventory, a brewing stand inventory, a smithing inventory, grindstone inventory, a crafting table inventory, a player inventory, furnace inventory, a creative inventory, blast furnace inventory, upgrade gear, a composter inventory, an enchanting table inventory, jukebox, a dropper inventory, a cartography table inventory, a upgrade gear, smoker inventory, composter inventory, a chest inventory, upgrade gear table, a upgrade gear table, dispenser inventory, player inventory, stonecutter inventory, a stonecutter inventory, a lectern inventory, merchant inventory, cartography table inventory, a chiseled bookshelf, a new smithing table, a furnace inventory, anvil inventory, a dispenser inventory, a grindstone inventory, smithing inventory, dropper inventory, brewing stand inventory, villager inventory, enchanting table inventory, a beacon inventory, a bookshelf, creative inventory, crafting table inventory, an anvil inventory
Since:
2.2-dev32
Minecraft has several different inventory types with their own use cases.
[<number> [of]] <alias> [of <enchantment> <level>], Where <alias> must be an alias that represents exactly one item (i.e cannot be a general alias like 'sword' or 'plant')
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
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
A location in a world. Locations are world-specific and even store a direction, e.g. if you save a location and later teleport to it you will face the exact same direction you did when you saved the location.
<number> $ or $ <number>, where '$' is your server's currency, e.g. '10 rupees' or '£5.00'
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
[-]###[.###] (any amount of digits; very large numbers will be truncated though)
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
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.
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.
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.
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%."
A time is a point in a minecraft day's time (i.e. ranges from 0:00 to 23:59), which can vary per world. See date and timespan for the other time types of Skript.
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.
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
See the type name patterns of all types - including this one
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
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.
Similar to atan, but requires two coordinates and returns values from -180 to 180. The returned angle is measured counterclockwise in a standard mathematical coordinate system (x to the right, y to the top).
date(year: number, month: number, day: number, hour: number = [[integer:0]], minute: number = [[integer:0]], second: number = [[integer:0]], millisecond: number = [[integer:0]], zone_offset: number = [[double:NaN]], dst_offset: number = [[double:NaN]])
Creates a date from a year, month, and day, and optionally also from hour, minute, second and millisecond. A time zone and DST offset can be specified as well (in minutes), if they are left out the server's time zone and DST offset are used (the created date will not retain this information).
Examples:
date(2014, 10, 1) # 0:00, 1st October 2014 date(1990, 3, 5, 14, 30) # 14:30, 5th May 1990 date(1999, 12, 31, 23, 59, 59, 999, -3*60, 0) # almost year 2000 in parts of Brazil (-3 hours offset, no DST)
Creates a location from a world and 3 coordinates, with an optional yaw and pitch. If for whatever reason the world is not found, it will fallback to the server's main world.
A logarithm, with base 10 if none is specified. This is the inverse operation to exponentiation (for positive bases only), i.e. log(base ^ exponent, base) = exponent for any positive number 'base' and any number 'exponent'. Another useful equation is base ^ log(a, base) = a for any numbers 'base' and 'a'. Please note that due to how numbers are represented in computers, these equations do not hold for all numbers, as the computed values may slightly differ from the correct value. Returns NaN (not a number) if any of the arguments are negative.
Returns the modulo of the given arguments, i.e. the remainder of the division d/m, where d and m are the arguments of this function. The returned value is always positive. Returns NaN (not a number) if the second argument is zero.
Returns an online player from their name or UUID, if player is offline function will return nothing. Setting 'getExactPlayer' parameter to true will return the player whose name is exactly equal to the provided name instead of returning a player that their name starts with the provided name.
Examples:
set {_p} to player("Notch") # will return an online player whose name is or starts with 'Notch' set {_p} to player("Notch", true) # will return the only online player whose name is 'Notch' set {_p} to player("069a79f4-44e9-4726-a5be-fca90e38aaf5") # &amp;lt;none&amp;gt; if player is offline
The sine function. It starts at 0° with a value of 0, goes to 1 at 90°, back to 0 at 180°, to -1 at 270° and then repeats every 360°. Uses degrees, not radians.
The square root, which is the inverse operation to squaring a number (for positive numbers only). This is the same as (argument) ^ (1/2) – other roots can be calculated via number ^ (1/root), e.g. set {_l} to {_volume}^(1/3). Returns NaN (not a number) if the argument is negative.
command /broadcast <string>: usage: A command for broadcasting a message to all players. permission: skript.command.broadcast permission message: You don't have permission to broadcast messages aliases: /bc executable by: players and console cooldown: 15 seconds cooldown message: You last broadcast a message %elapsed time% ago. You can broadcast another message in %remaining time%. cooldown bypass: skript.command.broadcast.admin cooldown storage: {cooldown::%player%} trigger: broadcast the argument
[local] function <([\p{IsAlphabetic}][\p{IsAlphabetic}\p{IsDigit}_]*)\((.*)\)(\s*(::| returns )\s*(.+))?>
Since:
2.2, 2.7 (local functions)
Functions are structures that can be executed with arguments/parameters to run code. They can also return a value to the trigger that is executing the function. Note that local functions come before global functions execution
Examples:
function sayMessage(message: text): broadcast {_message} # our message argument is available in '{_message}'
local function giveApple(amount: number) :: item: return {_amount} of apple
function getPoints(p: player) returns number: return {points::%{_p}%}
Options are used for replacing parts of a script with something else. For example, an option may represent a message that appears in multiple locations. Take a look at the example below that showcases this.
Examples:
options: no_permission: You're missing the required permission to execute this command!
Used for defining variables present within a script. This section is not required, but it ensures that a variable has a value if it doesn't exist when the script is loaded.
Examples:
variables: {joins} = 0 {balance::%player%} = 0
on join: add 1 to {joins} message "Your balance is %{balance::%player%}%"
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
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
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.
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!"
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
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
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!"
A part of a player's armour, 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
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
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
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
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
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
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
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
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
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
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"
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?
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
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
main name 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
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"
# 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%}
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%}
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
How much damage is done in a damage event, possibly ignoring armour, criticals and/or enchantments. Can be changed (remember that in Skript '1' is one full heart, not half a heart).
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
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!"
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
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.
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.
All entities in all worlds, in a specific world, in a chunk or in a radius around a certain location, 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
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
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
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%
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
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
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
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"]
Represents the input in a filter expression. 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.
Examples:
send "congrats on being staff!" to all players where [input has permission "staff"]
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
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
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
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.
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
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
Returns the hanging entity or remover in hanging break and place events.
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
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!"
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:
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).
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
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
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}
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
on inventory item move: if holder of event-initiator-inventory is a chest: broadcast "Item transport requested at %location at holder of event-initiator-inventory%..."
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
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
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
An item associated with an entity. For dropped item entities, it gets, obviously, the item that was dropped. For item frames, the item inside the frame is returned. For throwable projectiles (snowballs, enderpearls etc.),it gets the displayed item. Other entities do not have items associated with them.
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
All 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
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 with "" | ""%" # %all players% would use the default "x, y, and z" set {_s::*} to the string argument split at ","
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.
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
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."
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
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
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%."
# 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%"
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.
[the] [(real|default)|(fake|shown|displayed)] max[imum] (count|amount|number|size) of players
Since:
2.3, 2.7 (modify max real players)
Requirements:
Paper 1.16+ (modify max real players)
Return Type:
integer
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)
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
The (chat) message of a chat event, the join message of a join event, the quit message of a quit event, or the death message on a death 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: set quit message to "%player% left this awesome server!"
on death: set the death message to "%player% died!"
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."
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
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"
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"
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
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
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
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
[the] [((real|default)|(fake|shown|displayed))] [online] player (count|amount|number)
[the] [((real|default)|(fake|shown|displayed))] (count|amount|number|size) of online players
Since:
2.3
Return Type:
long
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 returns the real count of online players and can't be changed.
Fake online player count requires PaperSpigot 1.12.2+.
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 players count + 1)
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
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!"
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
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
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%"
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
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
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
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
A random number or integer 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
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>."
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
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!!"
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
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
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
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
For players this is the entity at the crosshair. For mobs and experience orbs this is the entity they are attacking/following (if any).
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
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.
Examples:
# A command to set the block a player looks at to a specific type: command /setblock <material>: trigger: set targeted block to argument
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
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
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%!"
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
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"
set {_v} to vector 1, 2, 3 // 5 set {_v} to {_v} ++ {_v} set {_v} to {_v} ++ 5 set {_v} to {_v} -- {_v} set {_v} to {_v} -- 5 set {_v} to {_v} ** {_v} set {_v} to {_v} ** 5 set {_v} to {_v} // {_v} set {_v} to {_v} // 5
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
Gets or changes the x, y or z component of a vector.
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}%"
The vehicle an entity is in, if any. This can actually be any entity, e.g. spider jockeys are skeletons that ride on a spider, so the spider is the 'vehicle' of the skeleton. See also: passenger
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%"
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
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
A server's whitelist.This expression can be used to add/remove players to/from the whitelist, to enable it and disable it (set whitelist to true / set whitelist to false), and to empty it (reset whitelist)
Examples:
set whitelist to false add all players to whitelist reset the whitelist
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.
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
Bans or unbans a player or an IP address. If a reason is given, it will be shown to the player when they try to join the server while banned. A length of ban may also be given to apply a temporary ban. If it is absent for any reason, a permanent ban will be used instead. We recommend that you test your scripts so that no accidental permanent bans are applied.
Note that banning people does not kick them from the server. Consider using the kick effect after applying a ban.
Examples:
unban player ban "127.0.0.1" IP-ban the player because "he is an idiot" ban player due to "inappropriate language" for 2 days
Breaks the block and spawns items as if a player had mined it
You can add a tool, which will spawn items based on how that tool would break the block (ie: When using a hand to break stone, it drops nothing, whereas with a pickaxe it drops cobblestone)
Examples:
on right click: break clicked block naturally loop blocks in radius 10 around player: break loop-block using player's tool loop blocks in radius 10 around player: break loop-block naturally using diamond pickaxe
Only usable in commands. Makes it so the current command usage isn't counted towards the cooldown.
Examples:
command /nick <text>: executable by: players cooldown: 10 seconds trigger: if length of arg-1 is more than 16: # Makes it so that invalid arguments don't make you wait for the cooldown again cancel the cooldown send "Your nickname may be at most 16 characters." stop set the player's display name to arg-1
Cancels drops of items or experiences in a death or block break event. Please note that this doesn't keep items or experiences of a dead player. If you want to do that, use the Keep Inventory / Experience effect.
Examples:
on death of a zombie: if name of the entity is "&cSpecial": cancel drops of items
on break of a coal ore: cancel the experience drops
A very general effect that can change many expressions. Many expressions can only be set and/or deleted, while some can have things added to or removed from them.
Examples:
# set: Set the player's display name to "<red>%name of player%" set the block above the victim to lava # add: add 2 to the player's health # preferably use '<a href='#EffHealth'>heal</a>' for this add argument to {blacklist::*} give a diamond pickaxe of efficiency 5 to the player increase the data value of the clicked block by 1 # remove: remove 2 pickaxes from the victim subtract 2.5 from {points::%uuid of player%} # remove all: remove every iron tool from the player remove all minecarts from {entitylist::*} # delete: delete the block below the player clear drops delete {variable} # reset: reset walk speed of player reset chunk at the targeted block
Colors items in a given color. You can also use RGB codes if you feel limited with the 16 default colors. RGB codes are three numbers from 0 to 255 in the order (red, green, blue), where (0,0,0) is black and (255,255,255) is white. Armor is colorable for all Minecraft versions. With Minecraft 1.11 or newer you can also color potions and maps. Note that the colors might not look exactly how you'd expect.
Examples:
dye player's helmet blue color the player's tool red
Executes a command. This can be useful to use other plugins in triggers. If the command is a bungeecord side command, you can use the [bungeecord] option to execute command on the proxy.
Examples:
make player execute command "/home" execute console command "/say Hello everyone!" execute player bungeecord command "/alert &6Testing Announcement!"
Immediately moves the (while) loop on to the next iteration.
Examples:
# Broadcast online moderators loop all players: if loop-value does not have permission "moderator": continue # filter out non moderators broadcast "%loop-player% is a moderator!" # Only moderators get broadcast
# Game starting counter set {_counter} to 11 while {_counter} > 0: remove 1 from {_counter} wait a second if {_counter} != 1, 2, 3, 5 or 10: continue # only print when counter is 1, 2, 3, 5 or 10 broadcast "Game starting in %{_counter}% second(s)"
Delays the script's execution by a given timespan. Please note that delays are not persistent, e.g. trying to create a tempban script with ban player → wait 7 days → unban player will not work if you restart your server anytime within these 7 days. You also have to be careful even when using small delays!
Examples:
wait 2 minutes halt for 5 minecraft hours wait a tick
Equips or unequips an entity with some given armor. This will replace any armor that the entity is wearing.
Examples:
equip player with diamond helmet equip player with all diamond armor unequip diamond chestplate from player unequip all armor from player unequip player's armor
Exits a given amount of loops and conditionals, or the entire trigger.
Examples:
if player has any ore: stop message "%player% has no ores!" loop blocks above the player: loop-block is not air: exit 2 sections set loop-block to water
Creates an explosion of a given force. The Minecraft Wiki has an article on explosions which lists the explosion forces of TNT, creepers, etc. Hint: use a force of 0 to create a fake explosion that does no damage whatsoever, or use the explosion effect introduced in Skript 2.0. Starting with Bukkit 1.4.5 and Skript 2.0 you can use safe explosions which will damage entities but won't destroy any blocks.
Examples:
create an explosion of force 10 at the player create an explosion of force 0 at the victim
Kills an entity. Note: This effect does not set the entity's health to 0 (which causes issues), but damages the entity by 100 times its maximum health.
Examples:
kill the player kill all creepers in the player's world kill all endermen, witches and bats
load [the] server icon (from|of) [the] [image] [file] %text%
Since:
2.3
Requirements:
Paper 1.12.2 or newer
Loads server icons from the given files. You can get the loaded icon using the last loaded server icon expression. Please note that the image must be 64x64 and the file path starts from the server folder.
Examples:
on load: clear {server-icons::*} loop 5 times: load server icon from file "icons/%loop-number%.png" add the last loaded server icon to {server-icons::*}
on server list ping: set the icon to a random server icon out of {server-icons::*}
Writes text into a .log file. Skript will write these files to /plugins/Skript/logs. NB: Using 'server.log' as the log file will write to the default server log. Omitting the log file altogether will log the message as '[Skript] [<script>.sk] <message>' in the server log.
Examples:
on place of TNT: log "%player% placed TNT in %world% at %location of block%" to "tnt/placement.log"
Paper 1.17+, Paper 1.19.1+ (Players & Look Anchors)
Forces the mob(s) or player(s) to look at an entity, vector or location. Vanilla max head pitches range from 10 to 50.
Examples:
force the head of the player to look towards event-entity's feet
on entity explosion: set {_player} to the nearest player {_player} is set distance between {_player} and the event-location is less than 15 make {_player} look towards vector from the {_player} to location of the event-entity
force {_enderman} to face the block 3 meters above {_location} at head rotation speed 100.5 and max head pitch -40
Makes a living entity visible/invisible. This is not a potion and therefore does not have features such as a time limit or particles. When setting an entity to invisible while using an invisibility potion on it, the potion will be overridden and when it runs out the entity keeps its invisibility.
Sends a message to the given player. Only styles written in given string or in formatted expressions will be parsed. Adding an optional sender allows the messages to be sent as if a specific player sent them. This is useful with Minecraft 1.16.4's new chat ignore system, in which players can choose to ignore other players, but for this to work, the message needs to be sent from a player.
Examples:
message "A wild %player% appeared!" message "This message is a distraction. Mwahaha!" send "Your kill streak is %{kill streak::%uuid of player%}%." to player if the targeted entity exists: message "You're currently looking at a %type of the targeted entity%!" on chat: cancel event send "[%player%] >> %message%" to all players from player
Opens an inventory to a player. The player can then access and modify the inventory as if it was a chest that he just opened. Please note that currently 'show' and 'open' have the same effect, but 'show' will eventually show an unmodifiable view of the inventory in the future.
Examples:
show the victim's inventory to the player open the player's inventory for the player
Make an entity pathfind towards a location or another entity. Not all entities can pathfind. If the pathfinding target is another entity, the entities may or may not continuously follow the target.
Examples:
make all creepers pathfind towards player make all cows stop pathfinding make event-entity pathfind towards player at speed 1
Plays a visual effect at a given location or on a given entity. Please note that some effects can only be played on entities, e.g. wolf hearts or the hurt effect, and that these are always visible to all players.
Examples:
play wolf hearts on the clicked wolf show mob spawner flames at the targeted block to the player
Plays a sound at given location for everyone or just for given players, or plays a sound to specified players. Both Minecraft sound names and Spigot sound names are supported. Playing resource pack sounds are supported too. The sound category is 'master' by default.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
play sound "block.note_block.pling" # It is block.note.pling in 1.12.2 play sound "entity.experience_orb.pickup" with volume 0.5 to the player play sound "custom.music.1" in jukebox category at {speakerBlock}
Sets whether all player related information is hidden in the server list. The Vanilla Minecraft client will display ??? (dark gray) instead of player counts and will not show the hover hist when hiding player info. The version string can override the ???. Also the Online Players Count and Max Players expressions will return -1 when hiding player info.
Examples:
hide player info hide player related information in the server list reveal all player related info
Change visibility of a player for the given players. When reveal is used in combination of the hidden players expression and the viewers are not specified, this will default it to the given player in the hidden players expression.
Note: if a player was hidden and relogs, this player will be visible again.
Examples:
on join: if {vanished::%player's uuid%} is true: hide the player from all players
2.0, 2.2-dev27 (ambient and particle-less potion effects), 2.5 (replacing existing effect), 2.5.2 (potion effects), INSERT VERSION (icon and infinite)
Apply or remove potion effects to/from entities.
Examples:
apply ambient swiftness 2 to the player remove haste from the victim
on join: apply infinite potion of strength of tier {strength::%uuid of player%} to the player apply potion of strength of tier {strength::%uuid of player%} to the player for 999 days # Before 1.19.4
apply potion effects of player's tool to player apply haste potion of tier 3 without any particles to the player whilst hiding the potion icon # Hide potions
2.0, 2.2-dev24 (replace in multiple strings and replace items in inventory), 2.5 (replace first, case sensitivity)
Replaces all occurrences of a given text with another text. Please note that you can only change variables and a few expressions, e.g. a message or a line of a sign.
Examples:
replace "<item>" in {textvar} with "%item%" replace every "&" with "§" in line 1 # The following acts as a simple chat censor, but it will e.g. censor mass, hassle, assassin, etc. as well: on chat: replace all "kys", "idiot" and "noob" with "****" in the message
replace all stone and dirt in player's inventory and player's top inventory with diamond
send [the] resource pack [from [[the] URL]] %text% to %players%
send [the] resource pack [from [[the] URL]] %text% with hash %text% to %players%
Since:
2.4
Request that the player's client download and switch resource packs. The client will download the resource pack in the background, and will automatically switch to it once the download is complete. The URL must be a direct download link.
The hash is used for caching, the player won't have to re-download the resource pack that way. The hash must be SHA-1, you can get SHA-1 hash of your resource pack using this online tool.
Stops specific or all sounds from playing to a group of players. Both Minecraft sound names and Spigot sound names are supported. Resource pack sounds are supported too. The sound category is 'master' by default. A sound can't be stopped from a different category.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
stop sound "block.chest.open" for the player stop playing sounds "ambient.underwater.loop" and "ambient.underwater.loop.additions" to the player stop all sounds for all players stop sound in the record category
Teleport an entity to a specific location. This effect is delayed by default on Paper, meaning certain syntax such as the return effect for functions cannot be used after this effect. The keyword 'force' indicates this effect will not be delayed, which may cause lag spikes or server crashes when using this effect to teleport entities to unloaded chunks.
Examples:
teleport the player to {homes.%player%} teleport the attacker to the victim
Sends a title/subtitle to the given player(s) with optional fadein/stay/fadeout times for Minecraft versions 1.11 and above.
If you're sending only the subtitle, it will be shown only if there's a title displayed at the moment, otherwise it will be sent with the next title. To show only the subtitle, use: send title " " with subtitle "yourtexthere" to player.
Note: if no input is given for the times, it will keep the ones from the last title sent, use the reset title effect to restore the default values.
Examples:
send title "Competition Started" with subtitle "Have fun, Stay safe!" to player for 5 seconds send title "Hi %player%" to player send title "Loot Drop" with subtitle "starts in 3 minutes" to all players send title "Hello %player%!" with subtitle "Welcome to our server" to player for 5 seconds with fadein 1 second and fade out 1 second send subtitle "Party!" to all players
Creates a tree. This may require that there is enough space above the given location and that the block below is dirt/grass, but it is possible that the tree will just grow anyways, possibly replacing every block in its path.
Spawn a creature. This can be used as an effect and as a section. If it is used as a section, the section is run before the entity is added to the world. You can modify the entity in this section, using for example 'event-entity' or 'cow'. Do note that other event values, such as 'player', won't work in this section.
Examples:
spawn 3 creepers at the targeted block spawn a ghast 5 meters above the player spawn a zombie at the player: set name of the zombie to ""
Tests whether a player is allowed to build at a certain location. This condition requires a supported regions plugin to be installed.
Examples:
command /setblock <material>: description: set the block at your crosshair to a different type trigger: player cannot build at the targeted block: message "You do not have permission to change blocks there!" stop set the targeted block to argument
A very general condition, it simply compares two values. Usually you can only compare for equality (e.g. block is/isn't of <type>), but some values can also be compared using greater than/less than. In that case you can also test for whether an object is between two others. Note: This is the only element where not all patterns are shown. It has actually another two sets of similar patters, but with (was|were) or will be instead of (is|are) respectively, which check different time states of the first expression.
Examples:
the clicked block is a stone slab or a double stone slab time in the player's world is greater than 8:00 the creature is not an enderman or an ender dragon
Checks whether an inventory contains an item, a text contains another piece of text, or a list (e.g. {list variable::*} or 'drops') contains another object.
Examples:
block contains 20 cobblestone player has 4 flint and 2 iron ingots {list::*} contains 5
[the] damage (was|is|has)[n('|o)t] [been] (caused|done|made) by %damage cause%
Since:
2.0
Tests what kind of damage caused a damage event. Refer to the Damage Cause type for a list of all possible causes.
Examples:
# make players use their potions of fire resistance whenever they take any kind of fire damage on damage: damage was caused by lava, fire or burning victim is a player victim has a potion of fire resistance cancel event apply fire resistance to the victim for 30 seconds remove 1 potion of fire resistance from the victim # prevent mobs from dropping items under certain circumstances on death: entity is not a player damage wasn't caused by a block explosion, an attack, a projectile, a potion, fire, burning, thorns or poison clear drops
Checks whether living entities have an unobstructed line of sight to other entities or locations.
Examples:
player has direct line of sight to location 5 blocks to the right of player victim has line of sight to attacker player has no line of sight to location 100 blocks in front of player
%players% (doesn't|does not|do not|don't) have [a] resource pack [(loaded|installed)]
Since:
2.4
Requirements:
Paper 1.9 or newer
Checks whether the given players have a server resource pack loaded. Please note that this can't detect player's own resource pack, only the resource pack that sent by the server.
Checks if a block is indirectly or directly powered by redstone
Examples:
if clicked block is redstone powered: send "This block is well-powered by redstone!" if clicked block is indirectly redstone powered: send "This block is indirectly redstone powered."
Checks whether a player is a member or owner of a particular region. This condition requires a supported regions plugin to be installed.
Examples:
on region enter: player is the owner of the region message "Welcome back to %region%!" send "%player% just entered %region%!" to all members of the region
Checks whether a block is passable. A block is passable if it has no colliding parts that would prevent players from moving through it. Blocks like tall grass, flowers, signs, etc. are passable, but open doors, fence gates, trap doors, etc. are not because they still have parts that can be collided with.
Check if a plugin is enabled/disabled on the server. Plugin names can be found in the plugin's 'plugin.yml' file or by using the '/plugins' command, they are NOT the name of the plugin's jar file. When checking if a plugin is not enabled, this will return true if the plugin is either disabled or not on the server. When checking if a plugin is disabled, this will return true if the plugin is on the server and is disabled.
Examples:
if plugin "Vault" is enabled: if plugin "WorldGuard" is not enabled: if plugins "Essentials" and "Vault" are enabled: if plugin "MyBrokenPlugin" is disabled:
Checks whether an item is the preferred tool for a block. A preferred tool is one that will drop the block's item when used. For example, a wooden pickaxe is a preferred tool for grass and stone blocks, but not for iron ore.
Examples:
on left click: event-block is set if player's tool is the preferred tool for event-block: break event-block naturally using player's tool else: cancel event
Tests whether a chunk is a so-called slime chunk. Slimes can generally spawn in the swamp biome and in slime chunks. For more info, see the Minecraft wiki.
Examples:
command /slimey: trigger: if chunk at player is a slime chunk: send "Yeah, it is!" else: send "Nope, it isn't"
# prevent mobs from seeing sneaking players if they are at least 4 meters apart on target: target is sneaking distance of target and the entity is bigger than 4 cancel the event
Checks whether an item is transparent. Note that this condition may not work for all blocks, due to the transparency list used by Spigot not being completely accurate.
Whether a location is within something else. The "something" can be a block, an entity, a chunk, a world, or a cuboid formed by two other locations. Note that using the is between condition will refer to a straight line between locations, while this condition will refer to the cuboid between locations.
Examples:
if player's location is within {_loc1} and {_loc2}: send "You are in a PvP zone!" to player
if player is in world("world"): send "You are in the overworld!" to player
if attacker's location is inside of victim: cancel event send "Back up!" to attacker and victim
Checks whether an item of an entity is of the given type. This is mostly useful for variables, as you can use the general 'is' condition otherwise (e.g. 'victim is a creeper').
Examples:
tool is of type {selected type} victim is of type {villager type}
Checks if living entities or players are left or right-handed. Armor stands are neither right nor left-handed. Paper 1.17.1+ is required for non-player entities.
Examples:
on damage of player: if victim is left handed: cancel event
Checks whether the defined strings match the input regexes (Regular expressions).
Examples:
on chat: if message partially matches "\d": send "Message contains a digit!" if message doesn't match "[A-Za-z]+": send "Message doesn't only contain letters!"
on resource pack response: if the resource pack wasn't accepted: kick the player due to "You have to install the resource pack to play in this server!"
%date% (was|were)( more|(n't| not) less) than %time span% [ago]
%date% (was|were)((n't| not) more| less) than %time span% [ago]
Since:
2.0
Tests whether a given real time was more or less than some time span ago.
Examples:
command /command-with-cooldown: trigger: {command::%player's uuid%::last-usage} was less than a minute ago: message "Please wait a minute between uses of this command." stop set {command::%player's uuid%::last-usage} to now # ... actual command trigger here ...
Conditional sections if: executed when its condition is true else if: executed if all previous chained conditionals weren't executed, and its condition is true else: executed if all previous chained conditionals weren't executed
parse if: a special case of 'if' condition that its code will not be parsed if the condition is not true else parse if: another special case of 'else if' condition that its code will not be parsed if all previous chained conditionals weren't executed, and its condition is true
Examples:
if player's health is greater than or equal to 4: send "Your health is okay so far but be careful!"
else if player's health is greater than 2: send "You need to heal ASAP, your health is very low!"
else: # Less than 2 hearts send "You are about to DIE if you don't heal NOW. You have only %player's health% heart(s)!"
parse if plugin "SomePluginName" is enabled: # parse if %condition% # This code will only be executed if the condition used is met otherwise Skript will not parse this section therefore will not give any errors/info about this section
Loop sections repeat their code with multiple values.
A loop will loop through all elements of the given expression, e.g. all players, worlds, items, etc. The conditions & effects inside the loop will be executed for every of those elements, which can be accessed with ‘loop-’, e.g. send "hello" to loop-player. When a condition inside a loop is not fulfilled the loop will start over with the next element of the loop. You can however use stop loop to exit the loop completely and resume code execution after the end of the loop.
Loopable Values All expressions that represent more than one value, e.g. ‘all players’, ‘worlds’, etc., as well as list variables, can be looped. You can also use a list of expressions, e.g. loop the victim and the attacker, to execute the same code for only a few values.
List Variables When looping list variables, you can also use loop-index in addition to loop-value inside the loop. loop-value is the value of the currently looped variable, and loop-index is the last part of the variable's name (the part where the list variable has its asterisk *).
Examples:
loop all players: send "Hello %loop-player%!" to loop-player
loop items in player's inventory: if loop-item is dirt: set loop-item to air
loop 10 times: send title "%11 - loop-value%" and subtitle "seconds left until the game begins" to player for 1 second # 10, 9, 8 etc. wait 1 second
loop {Coins::*}: set {Coins::%loop-index%} to loop-value + 5 # Same as "add 5 to {Coins::%loop-index%}" where loop-index is the uuid of the player and loop-value is the actually coins value such as 200
While Loop sections are loops that will just keep repeating as long as a condition is met.
Examples:
while size of all players < 5: send "More players are needed to begin the adventure" to all players wait 5 seconds
set {_counter} to 1 do while {_counter} > 1: # false but will increase {_counter} by 1 then get out add 1 to {_counter}
# Be careful when using while loops with conditions that are almost # always true for a long time without using 'wait %timespan%' inside it, # otherwise it will probably hang and crash your server. while player is online: give player 1 dirt wait 1 second # without using a delay effect the server will crash
Called when an item is put in a slot for repair by an anvil. Please note that this event is called multiple times in a single item slot move.
Examples:
on anvil prepare: event-item is set # result item chance of 5%: set repair cost to repair cost * 50% send "You're LUCKY! You got 50% discount." to player
Called when a player rightclicks on a block while holding a block or a placeable item. You can either cancel the event to prevent the block from being built, or uncancel it to allow it. Please note that the data value of the block to be placed is not available in this event, only its ID.
Called whenever a player chats. Use chat format to change message format. Use chat recipients to edit chat recipients.
Examples:
on chat: if player has permission "owner": set chat format to "&lt;red&gt;[player]&lt;light gray&gt;: &lt;light red&gt;[message]" else if player has permission "admin": set chat format to "&lt;light red&gt;[player]&lt;light gray&gt;: &lt;orange&gt;[message]" else: #default message format set chat format to "&lt;orange&gt;[player]&lt;light gray&gt;: &lt;white&gt;[message]"
Called when a user clicks on a block, an entity or air with or without an item in their hand. Please note that rightclick events with an empty hand while not looking at a block are not sent to the server, so there's no way to detect them. Also note that a leftclick on an entity is an attack and thus not covered by the 'click' event, but the 'damage' event.
Examples:
on click: on rightclick holding a fishing rod: on leftclick on a stone or obsidian: on rightclick on a creeper: on click with a sword:
Called when a player enters a command (not necessarily a Skript command) but you can check if command is a skript command, see Is a Skript command condition.
Examples:
on command: on command "/stop": on command "pm Njol ":
Called when the player connects to the server. This event is called before the player actually joins the server, so if you want to prevent players from joining you should prefer this event over on join.
Examples:
on connect: player doesn't have permission "VIP" number of players is greater than 15 kick the player due to "The last 5 slots are reserved for VIP players."
Called when a player throws an egg and it lands. You can just use the shoot event in most cases. However, this event allows modification of properties like the hatched entity type and the number of entities to hatch.
Called when a player puts an item into enchantment table. This event may be called multiple times. To get the enchant item, see the enchant item expression
Examples:
on enchant prepare: set enchant offer 1 to sharpness 1 set the cost of enchant offer 1 to 10 levels
Called when an enderman places or picks up a block, a sheep eats grass, a silverfish boops into/out of a block or a falling block lands and turns into a block respectively.
Examples:
on sheep eat: kill event-entity broadcast "A sheep stole some grass!"
on falling block land: event-entity is a falling dirt cancel event
Called when an explosive is primed, i.e. an entity will explode shortly. Creepers can abort the explosion if the player gets too far away, while TNT will explode for sure after a short time.
on firework explode on firework exploding colored red, light green and black on firework explosion colored light green: broadcast "A firework colored %colors% was exploded at %location%!"
Called when a block is created, but not by a player, e.g. snow forms due to snowfall, water freezes in cold biomes. This isn't called when block spreads (mushroom growth, water physics etc.), as it has its own event (see spread event).
Called whenever a player swaps the items in their main- and offhand slots. Works also when one or both of the slots are empty. The event is called before the items are actually swapped, so when you use the player's tool or player's offtool expressions, they will return the values before the swap - this enables you to cancel the event before anything happens.
Examples:
on swap hand items: event-player's tool is a diamond sword cancel event
Called when an entity is healed, e.g. by eating (players), being fed (pets), or by the effect of a potion of healing (overworld mobs) or harm (nether mobs).
Called when a block starts burning, i.e. a fire block is placed next to it and this block is flammable. The burn event will be called when the block is about do be destroyed by the fire.
Examples:
on block ignite: if event-block is a ladder: cancel event
Called when an entity or block (e.g. hopper) tries to move items directly from one inventory to another. When this event is called, the initiator may have already removed the item from the source inventory and is ready to move it into the destination inventory. If this event is cancelled, the items will be returned to the source inventory.
Examples:
on inventory item move: broadcast "%holder of past event-inventory% is transporting %event-item% to %holder of event-inventory%!"
Called when dropped items merge into a single stack. event-entity will be the entity which is trying to merge, and future event-entity will be the entity which is being merged into.
Called whenever an item stack is spawned in a world, e.g. as drop of a block or mob, a player throwing items out of their inventory, or a dispenser dispensing an item (not shooting it).
Examples:
on item spawn of iron sword: broadcast "Someone dropped an iron sword!"
Called when the player joins the server. The player is already in a world when this event is called, so if you want to prevent players from joining you should prefer on connect over this event.
Examples:
on join: message "Welcome on our awesome server!" broadcast "%player% just joined the server!"
Called after a player changed their language in the game settings. You can use the language expression to get the current language of the player. This event requires Minecraft 1.12+.
Examples:
on language change: if player's language starts with "en": send "Hello!"
Called when a player or entity moves. NOTE: Move event will only be called when the entity/player moves position, not orientation (ie: looking around). NOTE: These events can be performance heavy as they are called quite often. If you use these events, and later remove them, a server restart is recommended to clear registered events from Skript.
Examples:
on player move: if player does not have permission "player.can.move": cancel event on skeleton move: if event-entity is not in world "world": kill event-entity
Called when a physics check is done on a block. By cancelling this event you can prevent some things from happening, e.g. sand falling, dirt turning into grass, torches dropping if their supporting block is destroyed, etc.Please note that using this event might cause quite some lag since it gets called extremely often.
Examples:
# prevents sand from falling on block physics: block is sand cancel event
Called when a player has slept long enough to count as passing the night/storm. Cancelling this event will prevent the player from being counted as deeply sleeping unless they exit and re-enter the bed.
Called when a portal is created, either by a player or mob lighting an obsidian frame on fire, or by a nether portal creating its teleportation target in the nether/overworld. In Minecraft 1.14+, you can use the player in this event. Please note that there may not always be a player (or other entity) in this event.
Called when a projectile hits an entity or a block. Use the damage event with a check for a projectile to be able to use the entity that got hit in the case when the projectile hit a living entity. A damage event will even be fired if the damage is 0, e.g. when throwing snowballs at non-nether mobs.
Examples:
on projectile hit: event-projectile is arrow delete event-projectile
Called when a player takes action on a resource pack request sent via the send resource pack effect. The resource pack condition can be used to check the resource pack state.
This event will be triggered once when the player accepts or declines the resource pack request, and once when the resource pack is successfully installed or failed to download.
Examples:
on resource pack request response: if the resource pack was declined or failed to download:
on resource pack deny: kick the player due to "You have to install the resource pack to play in this server!"
Called when the player activates the riptide enchantment, using their trident to propel them through the air. Note: the riptide action is performed client side, so manipulating the player in this event may have undesired effects.
Called directly after the trigger is loaded, or directly before the whole script is unloaded. The keyword 'async' indicates the trigger can be ran asynchronously,
Examples:
on load: set {running::%script%} to true on unload: set {running::%script%} to false
Called when a server list ping is coming in, generally when a Minecraft client pings the server to show its information in the server list. The IP expression can be used to get the IP adress of the pinger. This event can be cancelled on PaperSpigot 1.12.2+ only and this means the player will see the server as offline (but still can join).
on server list ping: set the motd to "Welcome %{player-by-IP::%ip%}%! Join now!" if {player-by-IP::%ip%} is set, else "Join now!" set the fake max players count to (online players count + 1) set the shown icon to a random server icon out of {server-icons::*}
Called whenever a player changes their held item by selecting a different slot (e.g. the keys 1-9 or the mouse wheel), not by dropping or replacing the item in the current slot.
Called when a world is initialised. As all default worlds are initialised before any scripts are loaded, this event is only called for newly created worlds. World management plugins might change the behaviour of this event though.
every 2 seconds in "world": every minecraft hour in "flatworld": every tick in "world": # can cause lag depending on the code inside the event every minecraft days in "plots":
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]
lmb, number key, mmb, rmb, drop item, drop key, window border using left mouse button, unknown, window border using right mouse, shift+rmb, unsupported, shift+lmb, ctrl+q, swap shield, left mouse button, left mouse with shift, left mouse, 0-9, double click, double click using mouse, border using rmb, right mouse button, right mouse button with shift, border using lmb, middle mouse, drop key with control, window border using right mouse button, swap offhand, custom, q, right mouse with shift, middle mouse button, drop stack, left mouse button with shift, right mouse, creative action
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.
color of the sheep is red or black set the color of the block to green message "You're holding a &lt;%color of tool%&gt;%color of tool%&lt;reset&gt; wool block"
command /push [&amp;lt;player&amp;gt;]: trigger: if arg-1 is not set: if command sender is console: send "You can't push yourself as a console :\" to sender stop push sender upwards with force 2 send "Yay!" else: push arg-1 upwards with force 2 send "Yay!" to sender and arg-1
sweep attack, thorns, the void, magma, a lightning, drowning, dragonfire, an attack, drown, an entity attack, melt, freeze, falling block, contact, fire, an entity explosion, lightning, a fall, entity explosion, void, a lightning strike, suffocation, suicide, wither effect, a plugin, lightning strike, entity attack, a potion, a wither, sweeping, melting, a falling block, unknown, starvation, lava, fall, hot floor, attack, a block explosion, dryout, burn, hitting wall while flying, potion, world border, flying into a wall, cramming, poison, sonic boom, suffocate, custom, kill, killed, a fire, burning, a projectile, plugin, wither potion effect, block explosion, projectile, wither, dragon's breath
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.
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
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
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.
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.
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
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).
drop stack from slot, swap items with hotbar, swap cursor stack, pickup single item, pickup some, drop all from cursor, move to other inventory, drop cursor stack, pickup all, swap with hotbar, nothing, drop all from slot, swap cursor, drop cursor, pickup all items, drop slot item, place all, drop cursor item, drop slot stack, drop single item from slot, swap with cursor, place some, pickup one item, drop single item from cursor, collect items to cursor, unknown, clone stack, drop stack from cursor, drop one item from slot, drop one item from cursor, unsupported, do nothing, drop one from cursor, pickup half, drop items from slot, swap stack with cursor, place all items, collect to cursor, pickup some items, drop slot, drop items from cursor, hotbar move and readd, shift move, custom, pickup single, place one item, hotbar swap items, drop one from slot, place some items, place one, pickup half stack, instant move, hotbar swap
Since:
2.2-dev16
What player just did in inventory event. Note that when in creative game mode, most actions do not work correctly.
barrel inventory, a loom inventory, a blast furnace inventory, workbench inventory, ender chest inventory, loom inventory, a workbench inventory, hopper inventory, a merchant inventory, a hopper inventory, chiseled bookshelf, an ender chest inventory, new smithing table, bookshelf, a jukebox, beacon inventory, shulker box inventory, a barrel inventory, a shulker box inventory, lectern inventory, chest inventory, a villager inventory, a smoker inventory, a brewing stand inventory, a smithing inventory, grindstone inventory, a crafting table inventory, a player inventory, furnace inventory, a creative inventory, blast furnace inventory, upgrade gear, a composter inventory, an enchanting table inventory, jukebox, a dropper inventory, a cartography table inventory, a upgrade gear, smoker inventory, composter inventory, a chest inventory, upgrade gear table, a upgrade gear table, dispenser inventory, player inventory, stonecutter inventory, a stonecutter inventory, a lectern inventory, merchant inventory, cartography table inventory, a chiseled bookshelf, a new smithing table, a furnace inventory, anvil inventory, a dispenser inventory, a grindstone inventory, smithing inventory, dropper inventory, brewing stand inventory, villager inventory, enchanting table inventory, a beacon inventory, a bookshelf, creative inventory, crafting table inventory, an anvil inventory
Since:
2.2-dev32
Minecraft has several different inventory types with their own use cases.
[<number> [of]] <alias> [of <enchantment> <level>], Where <alias> must be an alias that represents exactly one item (i.e cannot be a general alias like 'sword' or 'plant')
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
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
A location in a world. Locations are world-specific and even store a direction, e.g. if you save a location and later teleport to it you will face the exact same direction you did when you saved the location.
<number> $ or $ <number>, where '$' is your server's currency, e.g. '10 rupees' or '£5.00'
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
[-]###[.###] (any amount of digits; very large numbers will be truncated though)
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
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.
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.
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.
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
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%."
A time is a point in a minecraft day's time (i.e. ranges from 0:00 to 23:59), which can vary per world. See date and timespan for the other time types of Skript.
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.
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
See the type name patterns of all types - including this one
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
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.
Similar to atan, but requires two coordinates and returns values from -180 to 180. The returned angle is measured counterclockwise in a standard mathematical coordinate system (x to the right, y to the top).
date(year: number, month: number, day: number, hour: number = [[integer:0]], minute: number = [[integer:0]], second: number = [[integer:0]], millisecond: number = [[integer:0]], zone_offset: number = [[double:NaN]], dst_offset: number = [[double:NaN]])
Creates a date from a year, month, and day, and optionally also from hour, minute, second and millisecond. A time zone and DST offset can be specified as well (in minutes), if they are left out the server's time zone and DST offset are used (the created date will not retain this information).
Examples:
date(2014, 10, 1) # 0:00, 1st October 2014 date(1990, 3, 5, 14, 30) # 14:30, 5th May 1990 date(1999, 12, 31, 23, 59, 59, 999, -3*60, 0) # almost year 2000 in parts of Brazil (-3 hours offset, no DST)
Creates a location from a world and 3 coordinates, with an optional yaw and pitch. If for whatever reason the world is not found, it will fallback to the server's main world.
A logarithm, with base 10 if none is specified. This is the inverse operation to exponentiation (for positive bases only), i.e. log(base ^ exponent, base) = exponent for any positive number 'base' and any number 'exponent'. Another useful equation is base ^ log(a, base) = a for any numbers 'base' and 'a'. Please note that due to how numbers are represented in computers, these equations do not hold for all numbers, as the computed values may slightly differ from the correct value. Returns NaN (not a number) if any of the arguments are negative.
Returns the modulo of the given arguments, i.e. the remainder of the division d/m, where d and m are the arguments of this function. The returned value is always positive. Returns NaN (not a number) if the second argument is zero.
Returns an online player from their name or UUID, if player is offline function will return nothing. Setting 'getExactPlayer' parameter to true will return the player whose name is exactly equal to the provided name instead of returning a player that their name starts with the provided name.
Examples:
set {_p} to player("Notch") # will return an online player whose name is or starts with 'Notch' set {_p} to player("Notch", true) # will return the only online player whose name is 'Notch' set {_p} to player("069a79f4-44e9-4726-a5be-fca90e38aaf5") # <none> if player is offline
The sine function. It starts at 0° with a value of 0, goes to 1 at 90°, back to 0 at 180°, to -1 at 270° and then repeats every 360°. Uses degrees, not radians.
The square root, which is the inverse operation to squaring a number (for positive numbers only). This is the same as (argument) ^ (1/2) – other roots can be calculated via number ^ (1/root), e.g. set {_l} to {_volume}^(1/3). Returns NaN (not a number) if the argument is negative.
\ No newline at end of file
diff --git a/docs/nightly/fix/command-cooldown-storage/docs.json b/docs/nightly/fix/command-cooldown-storage/docs.json
index b49218bda2..4742cf37a8 100644
--- a/docs/nightly/fix/command-cooldown-storage/docs.json
+++ b/docs/nightly/fix/command-cooldown-storage/docs.json
@@ -1,5 +1,5 @@
{
- "skriptVersion" : "2.8.0-dev-nightly-173935c",
+ "skriptVersion" : "2.8.0-dev-nightly-235b97a",
"classes" : [
{
@@ -108,7 +108,7 @@
],
"since" : "Unknown",
"description" : "Wool, dye and chat colors.",
- "examples" : "color of the sheep is red or black\\nset the color of the block to green\\nmessage \"You're holding a &amp;amp;amp;lt;%color of tool%&amp;amp;amp;gt;%color of tool%&amp;amp;amp;lt;reset&amp;amp;amp;gt; wool block\""
+ "examples" : "color of the sheep is red or black\\nset the color of the block to green\\nmessage \"You're holding a &amp;amp;amp;amp;amp;amp;amp;lt;%color of tool%&amp;amp;amp;amp;amp;amp;amp;gt;%color of tool%&amp;amp;amp;amp;amp;amp;amp;lt;reset&amp;amp;amp;amp;amp;amp;amp;gt; wool block\""
},
{
"id" : "commandsender",
@@ -121,7 +121,7 @@
],
"since" : "1.0",
"description" : "A player or the console.",
- "examples" : "command /push [&amp;amp;amp;amp;lt;player&amp;amp;amp;amp;gt;]:\\n trigger:\\n if arg-1 is not set:\\n if command sender is console:\\n send \"You can't push yourself as a console :\\\" to sender\\n stop\\n push sender upwards with force 2\\n send \"Yay!\"\\n else:\\n push arg-1 upwards with force 2\\n send \"Yay!\" to sender and arg-1"
+ "examples" : "command /push [&amp;amp;amp;amp;amp;amp;amp;amp;lt;player&amp;amp;amp;amp;amp;amp;amp;amp;gt;]:\\n trigger:\\n if arg-1 is not set:\\n if command sender is console:\\n send \"You can't push yourself as a console :\\\" to sender\\n stop\\n push sender upwards with force 2\\n send \"Yay!\"\\n else:\\n push arg-1 upwards with force 2\\n send \"Yay!\" to sender and arg-1"
},
{
"id" : "damagecause",
@@ -375,18 +375,6 @@
"description" : "The inventory close reason in an inventory close event.",
"examples" : "Missing examples."
},
-{
- "id" : "slot",
- "name" : "Inventory Slot",
- "patterns" : [
- "Missing patterns.",
-
- "pattern_end"
- ],
- "since" : "Unknown",
- "description" : "Represents a single slot of an inventory. Notable slots are the armour slots and furnace slots. \\nThe 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).\\nPlease 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\\ndelete helmet of the victim\\nset the color of the player's tool to green\\nenchant the player's chestplate with projectile protection 5"
-},
{
"id" : "inventorytype",
"name" : "Inventory Type",
@@ -615,6 +603,18 @@
"description" : "A server icon that was loaded using the load server icon effect.",
"examples" : "Missing examples."
},
+{
+ "id" : "slot",
+ "name" : "Slot",
+ "patterns" : [
+ "Missing patterns.",
+
+ "pattern_end"
+ ],
+ "since" : "Unknown",
+ "description" : "Represents a single slot of an inventory. Notable slots are the armour slots and furnace slots. \\nThe 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).\\nPlease 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\\ndelete helmet of the victim\\nset the color of the player's tool to green\\nenchant the player's chestplate with projectile protection 5"
+},
{
"id" : "soundcategory",
"name" : "Sound Category",
@@ -1445,6 +1445,19 @@ Note: This is the only element where not all patterns are shown. It has actually
"description" : "Checks if an entity will create fire when it explodes. This condition is also usable in an explosion prime event.",
"examples" : "on explosion prime:\\n if the explosion is fiery:\\n broadcast \"A fiery explosive has been ignited!\""
},
+{
+ "id" : "CondIsInfinite",
+ "name" : "Is Infinite",
+ "patterns" : [
+ "%potion effects% (is|are) infinite",
+"%potion effects% (isn't|is not|aren't|are not) infinite",
+
+ "pattern_end"
+ ],
+ "since" : "INSERT VERSION",
+ "description" : "Checks whether potion effects are infinite.",
+ "examples" : "all of the active potion effects of the player are infinite"
+},
{
"id" : "CondIsInteractable",
"name" : "Is Interactable",
@@ -1968,18 +1981,6 @@ Paper 1.17.1+ is required for non-player entities.",
"description" : "Checks whether the defined strings match the input regexes (Regular expressions).",
"examples" : "on chat:\\n if message partially matches \"\\d\":\\n send \"Message contains a digit!\"\\n if message doesn't match \"[A-Za-z]+\":\\n send \"Message doesn't only contain letters!\""
},
-{
- "id" : "CondMethodExists",
- "name" : "Method Exists",
- "patterns" : [
- "method[s] %texts% [do(esn't|n't)] exist[s]",
-
- "pattern_end"
- ],
- "since" : "2.7",
- "description" : "Checks if a method exists",
- "examples" : "if method \"org.bukkit.Bukkit#getPluginCommand(java.lang.String)"
-},
{
"id" : "CondProjectileCanBounce",
"name" : "Projectile Can Bounce",
@@ -2035,18 +2036,6 @@ This condition requires a supported regions plugin to be installed.",
"description" : "Checks state of the resource pack in a resource pack request response event.",
"examples" : "on resource pack response:\\n if the resource pack wasn't accepted:\\n kick the player due to \"You have to install the resource pack to play in this server!\""
},
-{
- "id" : "CondMinecraftVersion",
- "name" : "Running Minecraft",
- "patterns" : [
- "running [below] minecraft %text%",
-
- "pattern_end"
- ],
- "since" : "2.5",
- "description" : "Checks if current Minecraft version is given version or newer.",
- "examples" : "running minecraft \"1.14\""
-},
{
"id" : "CondStartsEndsWith",
"name" : "Starts/Ends With",
@@ -2090,6 +2079,18 @@ This condition requires a supported regions plugin to be installed.",
"description" : "Sends an action bar message to the given player(s).",
"examples" : "send action bar \"Hello player!\" to player"
},
+{
+ "id" : "EffApplyBoneMeal",
+ "name" : "Apply Bone Meal",
+ "patterns" : [
+ "apply [%number%] bone[ ]meal[s] [to %blocks%]",
+
+ "pattern_end"
+ ],
+ "since" : "INSERT VERSION",
+ "description" : "Applies bone meal to a crop, sapling, or composter",
+ "examples" : "apply 3 bone meal to event-block"
+},
{
"id" : "EffBan",
"name" : "Ban",
@@ -2189,7 +2190,7 @@ You can add a tool, which will spawn items based on how that tool would break th
"set %~objects% to %objects%",
"remove (all|every) %objects% from %~objects%",
"(remove|subtract) %objects% from %~objects%",
-"reduce %~objects% by %objects%",
+"(reduce|decrease) %~objects% by %objects%",
"(delete|clear) %~objects%",
"reset %~objects%",
@@ -2836,15 +2837,14 @@ Note: if a player was hidden and relogs, this player will be visible again.",
"name" : "Potion Effects",
"patterns" : [
"apply %potion effects% to %living entities%",
-"apply [potion of] %potions% [potion] [[[of] tier] %number%] to %living entities% [for %time span%] [(replacing [the] existing effect)]",
-"apply ambient [potion of] %potions% [potion] [[[of] tier] %number%] to %living entities% [for %time span%] [(replacing [the] existing effect)]",
-"apply [potion of] %potions% [potion] [[[of] tier] %number%] without [any] particles to %living entities% [for %time span%] [(replacing [the] existing effect)]",
+"apply infinite [ambient] [potion of] %potions% [potion] [[[of] tier] %number%] [without [any] particles] [(whilst hiding [the]|without (the|a)) [potion] icon] to %living entities% [replacing [the] existing effect]",
+"apply [ambient] [potion of] %potions% [potion] [[[of] tier] %number%] [without [any] particles] [(whilst hiding [the]|without (the|a)) [potion] icon] to %living entities% [for %time span%] [replacing [the] existing effect]",
"pattern_end"
],
- "since" : "2.0, 2.2-dev27 (ambient and particle-less potion effects), 2.5 (replacing existing effect), 2.5.2 (potion effects)",
+ "since" : "2.0, 2.2-dev27 (ambient and particle-less potion effects), 2.5 (replacing existing effect), 2.5.2 (potion effects), INSERT VERSION (icon and infinite)",
"description" : "Apply or remove potion effects to/from entities.",
- "examples" : "apply swiftness 2 to the player\\nremove haste from the victim\\non join:\\n apply potion of strength of tier {strength.%player%} to the player for 999 days\\napply potion effects of player's tool to player"
+ "examples" : "apply ambient swiftness 2 to the player\\nremove haste from the victim\\n\\non join:\\n apply infinite potion of strength of tier {strength::%uuid of player%} to the player\\n apply potion of strength of tier {strength::%uuid of player%} to the player for 999 days # Before 1.19.4\\n\\napply potion effects of player's tool to player\\napply haste potion of tier 3 without any particles to the player whilst hiding the potion icon # Hide potions"
},
{
"id" : "EffPush",
@@ -2992,8 +2992,8 @@ status of the sent resource pack request.",
"id" : "EffStopSound",
"name" : "Stop Sound",
"patterns" : [
- "stop (all sound[s]|sound[s] %texts%) [(in|from) %sound category%] [(from playing to|for) %players%]",
-"stop playing sound[s] %texts% [(in|from) %sound category%] [(to|for) %players%]",
+ "stop (all sound[s]|sound[s] %texts%) [(in [the]|from) %sound category%] [(from playing to|for) %players%]",
+"stop playing sound[s] %texts% [(in [the]|from) %sound category%] [(to|for) %players%]",
"pattern_end"
],
@@ -3001,7 +3001,7 @@ status of the sent resource pack request.",
"description" : "Stops specific or all sounds from playing to a group of players. Both Minecraft sound names and Spigot sound names are supported. Resource pack sounds are supported too. The sound category is 'master' by default. A sound can't be stopped from a different category.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.",
- "examples" : "stop sound \"block.chest.open\" for the player\\nstop playing sounds \"ambient.underwater.loop\" and \"ambient.underwater.loop.additions\" to the player\\nstop all sound for all players\\nstop sound in record category"
+ "examples" : "stop sound \"block.chest.open\" for the player\\nstop playing sounds \"ambient.underwater.loop\" and \"ambient.underwater.loop.additions\" to the player\\nstop all sounds for all players\\nstop sound in the record category"
},
{
"id" : "EffSwingHand",
@@ -3416,7 +3416,7 @@ Do note that other event values, such as 'player', won't work in this section.",
],
"since" : "1.4.1",
"description" : "Called whenever a player chats.\\nUse chat format to change message format.\\nUse chat recipients to edit chat recipients.",
- "examples" : "on chat:\\n if player has permission \"owner\":\\n set chat format to \"&amp;lt;red&amp;gt;[player]&amp;lt;light gray&amp;gt;: &amp;lt;light red&amp;gt;[message]\"\\n else if player has permission \"admin\":\\n set chat format to \"&amp;lt;light red&amp;gt;[player]&amp;lt;light gray&amp;gt;: &amp;lt;orange&amp;gt;[message]\"\\n else: #default message format\\n set chat format to \"&amp;lt;orange&amp;gt;[player]&amp;lt;light gray&amp;gt;: &amp;lt;white&amp;gt;[message]\""
+ "examples" : "on chat:\\n if player has permission \"owner\":\\n set chat format to \"&amp;amp;amp;lt;red&amp;amp;amp;gt;[player]&amp;amp;amp;lt;light gray&amp;amp;amp;gt;: &amp;amp;amp;lt;light red&amp;amp;amp;gt;[message]\"\\n else if player has permission \"admin\":\\n set chat format to \"&amp;amp;amp;lt;light red&amp;amp;amp;gt;[player]&amp;amp;amp;lt;light gray&amp;amp;amp;gt;: &amp;amp;amp;lt;orange&amp;amp;amp;gt;[message]\"\\n else: #default message format\\n set chat format to \"&amp;amp;amp;lt;orange&amp;amp;amp;gt;[player]&amp;amp;amp;lt;light gray&amp;amp;amp;gt;: &amp;amp;amp;lt;white&amp;amp;amp;gt;[message]\""
},
{
"id" : "chunk_generate",
@@ -4286,8 +4286,8 @@ Do note that other event values, such as 'player', won't work in this section.",
"examples" : "on place:\\non place of a furnace, workbench or chest:\\non break of chest[type=right] or chest[type=left]"
},
{
- "id" : "player_chunk_enters",
- "name" : "On Player Chunk Enters",
+ "id" : "player_chunk_enter",
+ "name" : "On Player Chunk Enter",
"patterns" : [
"[on] [player] (enter[s] [a] chunk|chunk enter[ing])",
@@ -4295,7 +4295,7 @@ Do note that other event values, such as 'player', won't work in this section.",
],
"since" : "2.7",
"description" : "Called when a player enters a chunk. Note that this event is based on 'player move' event, and may be called frequent internally.",
- "examples" : "on player enters a chunk:\\n send \"You entered a chunk: %past event-chunk% -&gt; %event-chunk%!\" to player"
+ "examples" : "on player enters a chunk:\\n send \"You entered a chunk: %past event-chunk% -&amp;amp;gt; %event-chunk%!\" to player"
},
{
"id" : "player_deep_sleep",
@@ -4590,7 +4590,7 @@ Do note that other event values, such as 'player', won't work in this section.",
],
"since" : "1.0",
"description" : "As signs are placed empty, this event is called when a player is done editing a sign.",
- "examples" : "on sign change:\\n line 2 is empty\\n set line 1 to \"&amp;lt;red&amp;gt;%line 1%\""
+ "examples" : "on sign change:\\n line 2 is empty\\n set line 1 to \"&amp;amp;amp;lt;red&amp;amp;amp;gt;%line 1%\""
},
{
"id" : "slime_split",
@@ -4755,18 +4755,6 @@ Do note that other event values, such as 'player', won't work in this section.",
"description" : "Called whenever a player is teleported, either by a nether/end portal or other means (e.g. by plugins).",
"examples" : "on teleport:"
},
-{
- "id" : "test_case",
- "name" : "On Test Case",
- "patterns" : [
- "[on] test %text% [when <.+>]",
-
- "pattern_end"
- ],
- "since" : "2.5",
- "description" : "Contents represent one test case.",
- "examples" : "Missing examples."
-},
{
"id" : "tool_change",
"name" : "On Tool Change",
@@ -6069,7 +6057,7 @@ To change the number of levels removed, use the enchant event.",
"description" : "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:\\n send \"You are wounded!\"\\n set victim's attack speed attribute to 2"
+ "examples" : "on damage of player:\\n send \"You are wounded!\" to victim\\n set victim's attack speed attribute to 2"
},
{
"id" : "ExprFireTicks",
@@ -6322,6 +6310,18 @@ Note: The past, future and present states of an expression are sometimes called
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:\\n former world was \"world_nether\" # or 'world was'\\n world will be \"world\" # or 'world after the event is'\\non tool change:\\n past tool is an axe\\n the tool after the event will be air\\non weather change:\\n set {weather::%world%::old} to past weather\\n set {weather::%world%::current} to the new weather"
},
+{
+ "id" : "ExprMemory",
+ "name" : "Free / Max / Total Memory",
+ "patterns" : [
+ "[the] [server] (free|max[imum]|total) (memory|ram)",
+
+ "pattern_end"
+ ],
+ "since" : "INSERT VERSION",
+ "description" : "The free, max or total memory of the server in Megabytes.",
+ "examples" : "while player is online:\\n send action bar \"Memory left: %free memory%/%max memory%MB\" to player\\n wait 5 ticks"
+},
{
"id" : "ExprFreezeTicks",
"name" : "Freeze Time",
@@ -7664,6 +7664,18 @@ For 1.11.2 and above, it returns a list of passengers and you can use all change
See also: vehicle",
"examples" : "#for 1.11 and lower\\npassenger of the minecart is a creeper or a cow\\nthe saddled pig's passenger is a player\\n#for 1.11.2+\\npassengers of the minecart contains a creeper or a cow\\nthe boat's passenger contains a pig\\nadd a cow and a zombie to passengers of last spawned boat\\nset passengers of player's vehicle to a pig and a horse\\nremove all pigs from player's vehicle\\nclear passengers of boat"
},
+{
+ "id" : "ExprPercent",
+ "name" : "Percent of",
+ "patterns" : [
+ "%number%(\\%| percent) of %numbers%",
+
+ "pattern_end"
+ ],
+ "since" : "INSERT VERSION",
+ "description" : "Returns a percentage of one or more numbers.",
+ "examples" : "set damage to 10% of victim's health\\nset damage to 125 percent of damage\\nset {_result} to {_percent} percent of 999\\nset {_result::*} to 10% of {_numbers::*}\\nset experience to 50% of player's total experience"
+},
{
"id" : "LitPi",
"name" : "Pi",
@@ -8223,14 +8235,16 @@ or can be reset to the default icon in a
"id" : "ExprSlotIndex",
"name" : "Slot Index",
"patterns" : [
- "[the] index of %slots%",
-"%slots%'[s] index",
+ "[the] [(raw|unique)] index of %slots%",
+"%slots%'[s] [(raw|unique)] index",
"pattern_end"
],
- "since" : "2.2-dev35",
- "description" : "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.",
- "examples" : "if index of event-slot is 10:\\n send \"You bought a pie!\""
+ "since" : "2.2-dev35, INSERT VERSION (raw index)",
+ "description" : "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:\\n send \"You bought a pie!\"\\n\\nif display name of player's top inventory is \"Custom Menu\": # 3 rows inventory\\n if raw index of event-slot > 27: # outside custom inventory\\n cancel event"
},
{
"id" : "ExprSortedList",
diff --git a/docs/nightly/fix/command-cooldown-storage/effects.html b/docs/nightly/fix/command-cooldown-storage/effects.html
index c96b6a5a09..8e7f3f00d5 100644
--- a/docs/nightly/fix/command-cooldown-storage/effects.html
+++ b/docs/nightly/fix/command-cooldown-storage/effects.html
@@ -1 +1 @@
- Skript Documentation - 2.8.0-dev-nightly-173935c
Bans or unbans a player or an IP address. If a reason is given, it will be shown to the player when they try to join the server while banned. A length of ban may also be given to apply a temporary ban. If it is absent for any reason, a permanent ban will be used instead. We recommend that you test your scripts so that no accidental permanent bans are applied.
Note that banning people does not kick them from the server. Consider using the kick effect after applying a ban.
Examples:
unban player ban "127.0.0.1" IP-ban the player because "he is an idiot" ban player due to "inappropriate language" for 2 days
Breaks the block and spawns items as if a player had mined it
You can add a tool, which will spawn items based on how that tool would break the block (ie: When using a hand to break stone, it drops nothing, whereas with a pickaxe it drops cobblestone)
Examples:
on right click: break clicked block naturally loop blocks in radius 10 around player: break loop-block using player's tool loop blocks in radius 10 around player: break loop-block naturally using diamond pickaxe
Only usable in commands. Makes it so the current command usage isn't counted towards the cooldown.
Examples:
command /nick <text>: executable by: players cooldown: 10 seconds trigger: if length of arg-1 is more than 16: # Makes it so that invalid arguments don't make you wait for the cooldown again cancel the cooldown send "Your nickname may be at most 16 characters." stop set the player's display name to arg-1
Cancels drops of items or experiences in a death or block break event. Please note that this doesn't keep items or experiences of a dead player. If you want to do that, use the Keep Inventory / Experience effect.
Examples:
on death of a zombie: if name of the entity is "&cSpecial": cancel drops of items
on break of a coal ore: cancel the experience drops
A very general effect that can change many expressions. Many expressions can only be set and/or deleted, while some can have things added to or removed from them.
Examples:
# set: Set the player's display name to "<red>%name of player%" set the block above the victim to lava # add: add 2 to the player's health # preferably use '<a href='#EffHealth'>heal</a>' for this add argument to {blacklist::*} give a diamond pickaxe of efficiency 5 to the player increase the data value of the clicked block by 1 # remove: remove 2 pickaxes from the victim subtract 2.5 from {points::%uuid of player%} # remove all: remove every iron tool from the player remove all minecarts from {entitylist::*} # delete: delete the block below the player clear drops delete {variable} # reset: reset walk speed of player reset chunk at the targeted block
Colors items in a given color. You can also use RGB codes if you feel limited with the 16 default colors. RGB codes are three numbers from 0 to 255 in the order (red, green, blue), where (0,0,0) is black and (255,255,255) is white. Armor is colorable for all Minecraft versions. With Minecraft 1.11 or newer you can also color potions and maps. Note that the colors might not look exactly how you'd expect.
Examples:
dye player's helmet blue color the player's tool red
Executes a command. This can be useful to use other plugins in triggers. If the command is a bungeecord side command, you can use the [bungeecord] option to execute command on the proxy.
Examples:
make player execute command "/home" execute console command "/say Hello everyone!" execute player bungeecord command "/alert &6Testing Announcement!"
Immediately moves the (while) loop on to the next iteration.
Examples:
# Broadcast online moderators loop all players: if loop-value does not have permission "moderator": continue # filter out non moderators broadcast "%loop-player% is a moderator!" # Only moderators get broadcast
# Game starting counter set {_counter} to 11 while {_counter} > 0: remove 1 from {_counter} wait a second if {_counter} != 1, 2, 3, 5 or 10: continue # only print when counter is 1, 2, 3, 5 or 10 broadcast "Game starting in %{_counter}% second(s)"
Delays the script's execution by a given timespan. Please note that delays are not persistent, e.g. trying to create a tempban script with ban player → wait 7 days → unban player will not work if you restart your server anytime within these 7 days. You also have to be careful even when using small delays!
Examples:
wait 2 minutes halt for 5 minecraft hours wait a tick
Equips or unequips an entity with some given armor. This will replace any armor that the entity is wearing.
Examples:
equip player with diamond helmet equip player with all diamond armor unequip diamond chestplate from player unequip all armor from player unequip player's armor
Exits a given amount of loops and conditionals, or the entire trigger.
Examples:
if player has any ore: stop message "%player% has no ores!" loop blocks above the player: loop-block is not air: exit 2 sections set loop-block to water
Creates an explosion of a given force. The Minecraft Wiki has an article on explosions which lists the explosion forces of TNT, creepers, etc. Hint: use a force of 0 to create a fake explosion that does no damage whatsoever, or use the explosion effect introduced in Skript 2.0. Starting with Bukkit 1.4.5 and Skript 2.0 you can use safe explosions which will damage entities but won't destroy any blocks.
Examples:
create an explosion of force 10 at the player create an explosion of force 0 at the victim
Kills an entity. Note: This effect does not set the entity's health to 0 (which causes issues), but damages the entity by 100 times its maximum health.
Examples:
kill the player kill all creepers in the player's world kill all endermen, witches and bats
load [the] server icon (from|of) [the] [image] [file] %text%
Since:
2.3
Requirements:
Paper 1.12.2 or newer
Loads server icons from the given files. You can get the loaded icon using the last loaded server icon expression. Please note that the image must be 64x64 and the file path starts from the server folder.
Examples:
on load: clear {server-icons::*} loop 5 times: load server icon from file "icons/%loop-number%.png" add the last loaded server icon to {server-icons::*}
on server list ping: set the icon to a random server icon out of {server-icons::*}
Writes text into a .log file. Skript will write these files to /plugins/Skript/logs. NB: Using 'server.log' as the log file will write to the default server log. Omitting the log file altogether will log the message as '[Skript] [<script>.sk] <message>' in the server log.
Examples:
on place of TNT: log "%player% placed TNT in %world% at %location of block%" to "tnt/placement.log"
Paper 1.17+, Paper 1.19.1+ (Players & Look Anchors)
Forces the mob(s) or player(s) to look at an entity, vector or location. Vanilla max head pitches range from 10 to 50.
Examples:
force the head of the player to look towards event-entity's feet
on entity explosion: set {_player} to the nearest player {_player} is set distance between {_player} and the event-location is less than 15 make {_player} look towards vector from the {_player} to location of the event-entity
force {_enderman} to face the block 3 meters above {_location} at head rotation speed 100.5 and max head pitch -40
Makes a living entity visible/invisible. This is not a potion and therefore does not have features such as a time limit or particles. When setting an entity to invisible while using an invisibility potion on it, the potion will be overridden and when it runs out the entity keeps its invisibility.
Sends a message to the given player. Only styles written in given string or in formatted expressions will be parsed. Adding an optional sender allows the messages to be sent as if a specific player sent them. This is useful with Minecraft 1.16.4's new chat ignore system, in which players can choose to ignore other players, but for this to work, the message needs to be sent from a player.
Examples:
message "A wild %player% appeared!" message "This message is a distraction. Mwahaha!" send "Your kill streak is %{kill streak::%uuid of player%}%." to player if the targeted entity exists: message "You're currently looking at a %type of the targeted entity%!" on chat: cancel event send "[%player%] >> %message%" to all players from player
Opens an inventory to a player. The player can then access and modify the inventory as if it was a chest that he just opened. Please note that currently 'show' and 'open' have the same effect, but 'show' will eventually show an unmodifiable view of the inventory in the future.
Examples:
show the victim's inventory to the player open the player's inventory for the player
Make an entity pathfind towards a location or another entity. Not all entities can pathfind. If the pathfinding target is another entity, the entities may or may not continuously follow the target.
Examples:
make all creepers pathfind towards player make all cows stop pathfinding make event-entity pathfind towards player at speed 1
Plays a visual effect at a given location or on a given entity. Please note that some effects can only be played on entities, e.g. wolf hearts or the hurt effect, and that these are always visible to all players.
Examples:
play wolf hearts on the clicked wolf show mob spawner flames at the targeted block to the player
Plays a sound at given location for everyone or just for given players, or plays a sound to specified players. Both Minecraft sound names and Spigot sound names are supported. Playing resource pack sounds are supported too. The sound category is 'master' by default.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
play sound "block.note_block.pling" # It is block.note.pling in 1.12.2 play sound "entity.experience_orb.pickup" with volume 0.5 to the player play sound "custom.music.1" in jukebox category at {speakerBlock}
Sets whether all player related information is hidden in the server list. The Vanilla Minecraft client will display ??? (dark gray) instead of player counts and will not show the hover hist when hiding player info. The version string can override the ???. Also the Online Players Count and Max Players expressions will return -1 when hiding player info.
Examples:
hide player info hide player related information in the server list reveal all player related info
Change visibility of a player for the given players. When reveal is used in combination of the hidden players expression and the viewers are not specified, this will default it to the given player in the hidden players expression.
Note: if a player was hidden and relogs, this player will be visible again.
Examples:
on join: if {vanished::%player's uuid%} is true: hide the player from all players
apply swiftness 2 to the player remove haste from the victim on join: apply potion of strength of tier {strength.%player%} to the player for 999 days apply potion effects of player's tool to player
2.0, 2.2-dev24 (replace in multiple strings and replace items in inventory), 2.5 (replace first, case sensitivity)
Replaces all occurrences of a given text with another text. Please note that you can only change variables and a few expressions, e.g. a message or a line of a sign.
Examples:
replace "<item>" in {textvar} with "%item%" replace every "&" with "§" in line 1 # The following acts as a simple chat censor, but it will e.g. censor mass, hassle, assassin, etc. as well: on chat: replace all "kys", "idiot" and "noob" with "****" in the message
replace all stone and dirt in player's inventory and player's top inventory with diamond
send [the] resource pack [from [[the] URL]] %text% to %players%
send [the] resource pack [from [[the] URL]] %text% with hash %text% to %players%
Since:
2.4
Request that the player's client download and switch resource packs. The client will download the resource pack in the background, and will automatically switch to it once the download is complete. The URL must be a direct download link.
The hash is used for caching, the player won't have to re-download the resource pack that way. The hash must be SHA-1, you can get SHA-1 hash of your resource pack using this online tool.
Stops specific or all sounds from playing to a group of players. Both Minecraft sound names and Spigot sound names are supported. Resource pack sounds are supported too. The sound category is 'master' by default. A sound can't be stopped from a different category.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
stop sound "block.chest.open" for the player stop playing sounds "ambient.underwater.loop" and "ambient.underwater.loop.additions" to the player stop all sound for all players stop sound in record category
Teleport an entity to a specific location. This effect is delayed by default on Paper, meaning certain syntax such as the return effect for functions cannot be used after this effect. The keyword 'force' indicates this effect will not be delayed, which may cause lag spikes or server crashes when using this effect to teleport entities to unloaded chunks.
Examples:
teleport the player to {homes.%player%} teleport the attacker to the victim
Sends a title/subtitle to the given player(s) with optional fadein/stay/fadeout times for Minecraft versions 1.11 and above.
If you're sending only the subtitle, it will be shown only if there's a title displayed at the moment, otherwise it will be sent with the next title. To show only the subtitle, use: send title " " with subtitle "yourtexthere" to player.
Note: if no input is given for the times, it will keep the ones from the last title sent, use the reset title effect to restore the default values.
Examples:
send title "Competition Started" with subtitle "Have fun, Stay safe!" to player for 5 seconds send title "Hi %player%" to player send title "Loot Drop" with subtitle "starts in 3 minutes" to all players send title "Hello %player%!" with subtitle "Welcome to our server" to player for 5 seconds with fadein 1 second and fade out 1 second send subtitle "Party!" to all players
Creates a tree. This may require that there is enough space above the given location and that the block below is dirt/grass, but it is possible that the tree will just grow anyways, possibly replacing every block in its path.
Spawn a creature. This can be used as an effect and as a section. If it is used as a section, the section is run before the entity is added to the world. You can modify the entity in this section, using for example 'event-entity' or 'cow'. Do note that other event values, such as 'player', won't work in this section.
Examples:
spawn 3 creepers at the targeted block spawn a ghast 5 meters above the player spawn a zombie at the player: set name of the zombie to ""
\ No newline at end of file
+ Skript Documentation - 2.8.0-dev-nightly-235b97a
Bans or unbans a player or an IP address. If a reason is given, it will be shown to the player when they try to join the server while banned. A length of ban may also be given to apply a temporary ban. If it is absent for any reason, a permanent ban will be used instead. We recommend that you test your scripts so that no accidental permanent bans are applied.
Note that banning people does not kick them from the server. Consider using the kick effect after applying a ban.
Examples:
unban player ban "127.0.0.1" IP-ban the player because "he is an idiot" ban player due to "inappropriate language" for 2 days
Breaks the block and spawns items as if a player had mined it
You can add a tool, which will spawn items based on how that tool would break the block (ie: When using a hand to break stone, it drops nothing, whereas with a pickaxe it drops cobblestone)
Examples:
on right click: break clicked block naturally loop blocks in radius 10 around player: break loop-block using player's tool loop blocks in radius 10 around player: break loop-block naturally using diamond pickaxe
Only usable in commands. Makes it so the current command usage isn't counted towards the cooldown.
Examples:
command /nick <text>: executable by: players cooldown: 10 seconds trigger: if length of arg-1 is more than 16: # Makes it so that invalid arguments don't make you wait for the cooldown again cancel the cooldown send "Your nickname may be at most 16 characters." stop set the player's display name to arg-1
Cancels drops of items or experiences in a death or block break event. Please note that this doesn't keep items or experiences of a dead player. If you want to do that, use the Keep Inventory / Experience effect.
Examples:
on death of a zombie: if name of the entity is "&cSpecial": cancel drops of items
on break of a coal ore: cancel the experience drops
A very general effect that can change many expressions. Many expressions can only be set and/or deleted, while some can have things added to or removed from them.
Examples:
# set: Set the player's display name to "<red>%name of player%" set the block above the victim to lava # add: add 2 to the player's health # preferably use '<a href='#EffHealth'>heal</a>' for this add argument to {blacklist::*} give a diamond pickaxe of efficiency 5 to the player increase the data value of the clicked block by 1 # remove: remove 2 pickaxes from the victim subtract 2.5 from {points::%uuid of player%} # remove all: remove every iron tool from the player remove all minecarts from {entitylist::*} # delete: delete the block below the player clear drops delete {variable} # reset: reset walk speed of player reset chunk at the targeted block
Colors items in a given color. You can also use RGB codes if you feel limited with the 16 default colors. RGB codes are three numbers from 0 to 255 in the order (red, green, blue), where (0,0,0) is black and (255,255,255) is white. Armor is colorable for all Minecraft versions. With Minecraft 1.11 or newer you can also color potions and maps. Note that the colors might not look exactly how you'd expect.
Examples:
dye player's helmet blue color the player's tool red
Executes a command. This can be useful to use other plugins in triggers. If the command is a bungeecord side command, you can use the [bungeecord] option to execute command on the proxy.
Examples:
make player execute command "/home" execute console command "/say Hello everyone!" execute player bungeecord command "/alert &6Testing Announcement!"
Immediately moves the (while) loop on to the next iteration.
Examples:
# Broadcast online moderators loop all players: if loop-value does not have permission "moderator": continue # filter out non moderators broadcast "%loop-player% is a moderator!" # Only moderators get broadcast
# Game starting counter set {_counter} to 11 while {_counter} > 0: remove 1 from {_counter} wait a second if {_counter} != 1, 2, 3, 5 or 10: continue # only print when counter is 1, 2, 3, 5 or 10 broadcast "Game starting in %{_counter}% second(s)"
Delays the script's execution by a given timespan. Please note that delays are not persistent, e.g. trying to create a tempban script with ban player → wait 7 days → unban player will not work if you restart your server anytime within these 7 days. You also have to be careful even when using small delays!
Examples:
wait 2 minutes halt for 5 minecraft hours wait a tick
Equips or unequips an entity with some given armor. This will replace any armor that the entity is wearing.
Examples:
equip player with diamond helmet equip player with all diamond armor unequip diamond chestplate from player unequip all armor from player unequip player's armor
Exits a given amount of loops and conditionals, or the entire trigger.
Examples:
if player has any ore: stop message "%player% has no ores!" loop blocks above the player: loop-block is not air: exit 2 sections set loop-block to water
Creates an explosion of a given force. The Minecraft Wiki has an article on explosions which lists the explosion forces of TNT, creepers, etc. Hint: use a force of 0 to create a fake explosion that does no damage whatsoever, or use the explosion effect introduced in Skript 2.0. Starting with Bukkit 1.4.5 and Skript 2.0 you can use safe explosions which will damage entities but won't destroy any blocks.
Examples:
create an explosion of force 10 at the player create an explosion of force 0 at the victim
Kills an entity. Note: This effect does not set the entity's health to 0 (which causes issues), but damages the entity by 100 times its maximum health.
Examples:
kill the player kill all creepers in the player's world kill all endermen, witches and bats
load [the] server icon (from|of) [the] [image] [file] %text%
Since:
2.3
Requirements:
Paper 1.12.2 or newer
Loads server icons from the given files. You can get the loaded icon using the last loaded server icon expression. Please note that the image must be 64x64 and the file path starts from the server folder.
Examples:
on load: clear {server-icons::*} loop 5 times: load server icon from file "icons/%loop-number%.png" add the last loaded server icon to {server-icons::*}
on server list ping: set the icon to a random server icon out of {server-icons::*}
Writes text into a .log file. Skript will write these files to /plugins/Skript/logs. NB: Using 'server.log' as the log file will write to the default server log. Omitting the log file altogether will log the message as '[Skript] [<script>.sk] <message>' in the server log.
Examples:
on place of TNT: log "%player% placed TNT in %world% at %location of block%" to "tnt/placement.log"
Paper 1.17+, Paper 1.19.1+ (Players & Look Anchors)
Forces the mob(s) or player(s) to look at an entity, vector or location. Vanilla max head pitches range from 10 to 50.
Examples:
force the head of the player to look towards event-entity's feet
on entity explosion: set {_player} to the nearest player {_player} is set distance between {_player} and the event-location is less than 15 make {_player} look towards vector from the {_player} to location of the event-entity
force {_enderman} to face the block 3 meters above {_location} at head rotation speed 100.5 and max head pitch -40
Makes a living entity visible/invisible. This is not a potion and therefore does not have features such as a time limit or particles. When setting an entity to invisible while using an invisibility potion on it, the potion will be overridden and when it runs out the entity keeps its invisibility.
Sends a message to the given player. Only styles written in given string or in formatted expressions will be parsed. Adding an optional sender allows the messages to be sent as if a specific player sent them. This is useful with Minecraft 1.16.4's new chat ignore system, in which players can choose to ignore other players, but for this to work, the message needs to be sent from a player.
Examples:
message "A wild %player% appeared!" message "This message is a distraction. Mwahaha!" send "Your kill streak is %{kill streak::%uuid of player%}%." to player if the targeted entity exists: message "You're currently looking at a %type of the targeted entity%!" on chat: cancel event send "[%player%] >> %message%" to all players from player
Opens an inventory to a player. The player can then access and modify the inventory as if it was a chest that he just opened. Please note that currently 'show' and 'open' have the same effect, but 'show' will eventually show an unmodifiable view of the inventory in the future.
Examples:
show the victim's inventory to the player open the player's inventory for the player
Make an entity pathfind towards a location or another entity. Not all entities can pathfind. If the pathfinding target is another entity, the entities may or may not continuously follow the target.
Examples:
make all creepers pathfind towards player make all cows stop pathfinding make event-entity pathfind towards player at speed 1
Plays a visual effect at a given location or on a given entity. Please note that some effects can only be played on entities, e.g. wolf hearts or the hurt effect, and that these are always visible to all players.
Examples:
play wolf hearts on the clicked wolf show mob spawner flames at the targeted block to the player
Plays a sound at given location for everyone or just for given players, or plays a sound to specified players. Both Minecraft sound names and Spigot sound names are supported. Playing resource pack sounds are supported too. The sound category is 'master' by default.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
play sound "block.note_block.pling" # It is block.note.pling in 1.12.2 play sound "entity.experience_orb.pickup" with volume 0.5 to the player play sound "custom.music.1" in jukebox category at {speakerBlock}
Sets whether all player related information is hidden in the server list. The Vanilla Minecraft client will display ??? (dark gray) instead of player counts and will not show the hover hist when hiding player info. The version string can override the ???. Also the Online Players Count and Max Players expressions will return -1 when hiding player info.
Examples:
hide player info hide player related information in the server list reveal all player related info
Change visibility of a player for the given players. When reveal is used in combination of the hidden players expression and the viewers are not specified, this will default it to the given player in the hidden players expression.
Note: if a player was hidden and relogs, this player will be visible again.
Examples:
on join: if {vanished::%player's uuid%} is true: hide the player from all players
2.0, 2.2-dev27 (ambient and particle-less potion effects), 2.5 (replacing existing effect), 2.5.2 (potion effects), INSERT VERSION (icon and infinite)
Apply or remove potion effects to/from entities.
Examples:
apply ambient swiftness 2 to the player remove haste from the victim
on join: apply infinite potion of strength of tier {strength::%uuid of player%} to the player apply potion of strength of tier {strength::%uuid of player%} to the player for 999 days # Before 1.19.4
apply potion effects of player's tool to player apply haste potion of tier 3 without any particles to the player whilst hiding the potion icon # Hide potions
2.0, 2.2-dev24 (replace in multiple strings and replace items in inventory), 2.5 (replace first, case sensitivity)
Replaces all occurrences of a given text with another text. Please note that you can only change variables and a few expressions, e.g. a message or a line of a sign.
Examples:
replace "<item>" in {textvar} with "%item%" replace every "&" with "§" in line 1 # The following acts as a simple chat censor, but it will e.g. censor mass, hassle, assassin, etc. as well: on chat: replace all "kys", "idiot" and "noob" with "****" in the message
replace all stone and dirt in player's inventory and player's top inventory with diamond
send [the] resource pack [from [[the] URL]] %text% to %players%
send [the] resource pack [from [[the] URL]] %text% with hash %text% to %players%
Since:
2.4
Request that the player's client download and switch resource packs. The client will download the resource pack in the background, and will automatically switch to it once the download is complete. The URL must be a direct download link.
The hash is used for caching, the player won't have to re-download the resource pack that way. The hash must be SHA-1, you can get SHA-1 hash of your resource pack using this online tool.
Stops specific or all sounds from playing to a group of players. Both Minecraft sound names and Spigot sound names are supported. Resource pack sounds are supported too. The sound category is 'master' by default. A sound can't be stopped from a different category.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
stop sound "block.chest.open" for the player stop playing sounds "ambient.underwater.loop" and "ambient.underwater.loop.additions" to the player stop all sounds for all players stop sound in the record category
Teleport an entity to a specific location. This effect is delayed by default on Paper, meaning certain syntax such as the return effect for functions cannot be used after this effect. The keyword 'force' indicates this effect will not be delayed, which may cause lag spikes or server crashes when using this effect to teleport entities to unloaded chunks.
Examples:
teleport the player to {homes.%player%} teleport the attacker to the victim
Sends a title/subtitle to the given player(s) with optional fadein/stay/fadeout times for Minecraft versions 1.11 and above.
If you're sending only the subtitle, it will be shown only if there's a title displayed at the moment, otherwise it will be sent with the next title. To show only the subtitle, use: send title " " with subtitle "yourtexthere" to player.
Note: if no input is given for the times, it will keep the ones from the last title sent, use the reset title effect to restore the default values.
Examples:
send title "Competition Started" with subtitle "Have fun, Stay safe!" to player for 5 seconds send title "Hi %player%" to player send title "Loot Drop" with subtitle "starts in 3 minutes" to all players send title "Hello %player%!" with subtitle "Welcome to our server" to player for 5 seconds with fadein 1 second and fade out 1 second send subtitle "Party!" to all players
Creates a tree. This may require that there is enough space above the given location and that the block below is dirt/grass, but it is possible that the tree will just grow anyways, possibly replacing every block in its path.
Spawn a creature. This can be used as an effect and as a section. If it is used as a section, the section is run before the entity is added to the world. You can modify the entity in this section, using for example 'event-entity' or 'cow'. Do note that other event values, such as 'player', won't work in this section.
Examples:
spawn 3 creepers at the targeted block spawn a ghast 5 meters above the player spawn a zombie at the player: set name of the zombie to ""
\ No newline at end of file
diff --git a/docs/nightly/fix/command-cooldown-storage/events.html b/docs/nightly/fix/command-cooldown-storage/events.html
index e47976b8ca..ca0a4d426f 100644
--- a/docs/nightly/fix/command-cooldown-storage/events.html
+++ b/docs/nightly/fix/command-cooldown-storage/events.html
@@ -1 +1 @@
- Skript Documentation - 2.8.0-dev-nightly-173935c
You can specify the event priority after each event syntax using the following syntax [with priority (lowest|low|normal|high|highest|monitor)] e.g. on spawn with priority lowest. Note that not all of the events support event priority feature and they will throw an error.
Called when an item is put in a slot for repair by an anvil. Please note that this event is called multiple times in a single item slot move.
Examples:
on anvil prepare: event-item is set # result item chance of 5%: set repair cost to repair cost * 50% send "You're LUCKY! You got 50% discount." to player
Called when a player rightclicks on a block while holding a block or a placeable item. You can either cancel the event to prevent the block from being built, or uncancel it to allow it. Please note that the data value of the block to be placed is not available in this event, only its ID.
Called whenever a player chats. Use chat format to change message format. Use chat recipients to edit chat recipients.
Examples:
on chat: if player has permission "owner": set chat format to "&amp;amp;amp;lt;red&amp;amp;amp;gt;[player]&amp;amp;amp;lt;light gray&amp;amp;amp;gt;: &amp;amp;amp;lt;light red&amp;amp;amp;gt;[message]" else if player has permission "admin": set chat format to "&amp;amp;amp;lt;light red&amp;amp;amp;gt;[player]&amp;amp;amp;lt;light gray&amp;amp;amp;gt;: &amp;amp;amp;lt;orange&amp;amp;amp;gt;[message]" else: #default message format set chat format to "&amp;amp;amp;lt;orange&amp;amp;amp;gt;[player]&amp;amp;amp;lt;light gray&amp;amp;amp;gt;: &amp;amp;amp;lt;white&amp;amp;amp;gt;[message]"
Called when a user clicks on a block, an entity or air with or without an item in their hand. Please note that rightclick events with an empty hand while not looking at a block are not sent to the server, so there's no way to detect them. Also note that a leftclick on an entity is an attack and thus not covered by the 'click' event, but the 'damage' event.
Examples:
on click: on rightclick holding a fishing rod: on leftclick on a stone or obsidian: on rightclick on a creeper: on click with a sword:
Called when a player enters a command (not necessarily a Skript command) but you can check if command is a skript command, see Is a Skript command condition.
Examples:
on command: on command "/stop": on command "pm Njol ":
Called when the player connects to the server. This event is called before the player actually joins the server, so if you want to prevent players from joining you should prefer this event over on join.
Examples:
on connect: player doesn't have permission "VIP" number of players is greater than 15 kick the player due to "The last 5 slots are reserved for VIP players."
Called when a player throws an egg and it lands. You can just use the shoot event in most cases. However, this event allows modification of properties like the hatched entity type and the number of entities to hatch.
Called when a player puts an item into enchantment table. This event may be called multiple times. To get the enchant item, see the enchant item expression
Examples:
on enchant prepare: set enchant offer 1 to sharpness 1 set the cost of enchant offer 1 to 10 levels
Called when an enderman places or picks up a block, a sheep eats grass, a silverfish boops into/out of a block or a falling block lands and turns into a block respectively.
Examples:
on sheep eat: kill event-entity broadcast "A sheep stole some grass!"
on falling block land: event-entity is a falling dirt cancel event
Called when an explosive is primed, i.e. an entity will explode shortly. Creepers can abort the explosion if the player gets too far away, while TNT will explode for sure after a short time.
on firework explode on firework exploding colored red, light green and black on firework explosion colored light green: broadcast "A firework colored %colors% was exploded at %location%!"
Called when a block is created, but not by a player, e.g. snow forms due to snowfall, water freezes in cold biomes. This isn't called when block spreads (mushroom growth, water physics etc.), as it has its own event (see spread event).
Called whenever a player swaps the items in their main- and offhand slots. Works also when one or both of the slots are empty. The event is called before the items are actually swapped, so when you use the player's tool or player's offtool expressions, they will return the values before the swap - this enables you to cancel the event before anything happens.
Examples:
on swap hand items: event-player's tool is a diamond sword cancel event
Called when an entity is healed, e.g. by eating (players), being fed (pets), or by the effect of a potion of healing (overworld mobs) or harm (nether mobs).
Called when a block starts burning, i.e. a fire block is placed next to it and this block is flammable. The burn event will be called when the block is about do be destroyed by the fire.
Examples:
on block ignite: if event-block is a ladder: cancel event
Called when an entity or block (e.g. hopper) tries to move items directly from one inventory to another. When this event is called, the initiator may have already removed the item from the source inventory and is ready to move it into the destination inventory. If this event is cancelled, the items will be returned to the source inventory.
Examples:
on inventory item move: broadcast "%holder of past event-inventory% is transporting %event-item% to %holder of event-inventory%!"
Called when dropped items merge into a single stack. event-entity will be the entity which is trying to merge, and future event-entity will be the entity which is being merged into.
Called whenever an item stack is spawned in a world, e.g. as drop of a block or mob, a player throwing items out of their inventory, or a dispenser dispensing an item (not shooting it).
Examples:
on item spawn of iron sword: broadcast "Someone dropped an iron sword!"
Called when the player joins the server. The player is already in a world when this event is called, so if you want to prevent players from joining you should prefer on connect over this event.
Examples:
on join: message "Welcome on our awesome server!" broadcast "%player% just joined the server!"
Called after a player changed their language in the game settings. You can use the language expression to get the current language of the player. This event requires Minecraft 1.12+.
Examples:
on language change: if player's language starts with "en": send "Hello!"
Called when a player or entity moves. NOTE: Move event will only be called when the entity/player moves position, not orientation (ie: looking around). NOTE: These events can be performance heavy as they are called quite often. If you use these events, and later remove them, a server restart is recommended to clear registered events from Skript.
Examples:
on player move: if player does not have permission "player.can.move": cancel event on skeleton move: if event-entity is not in world "world": kill event-entity
Called when a physics check is done on a block. By cancelling this event you can prevent some things from happening, e.g. sand falling, dirt turning into grass, torches dropping if their supporting block is destroyed, etc.Please note that using this event might cause quite some lag since it gets called extremely often.
Examples:
# prevents sand from falling on block physics: block is sand cancel event
Called when a player has slept long enough to count as passing the night/storm. Cancelling this event will prevent the player from being counted as deeply sleeping unless they exit and re-enter the bed.
Called when a portal is created, either by a player or mob lighting an obsidian frame on fire, or by a nether portal creating its teleportation target in the nether/overworld. In Minecraft 1.14+, you can use the player in this event. Please note that there may not always be a player (or other entity) in this event.
Called when a projectile hits an entity or a block. Use the damage event with a check for a projectile to be able to use the entity that got hit in the case when the projectile hit a living entity. A damage event will even be fired if the damage is 0, e.g. when throwing snowballs at non-nether mobs.
Examples:
on projectile hit: event-projectile is arrow delete event-projectile
Called when a player takes action on a resource pack request sent via the send resource pack effect. The resource pack condition can be used to check the resource pack state.
This event will be triggered once when the player accepts or declines the resource pack request, and once when the resource pack is successfully installed or failed to download.
Examples:
on resource pack request response: if the resource pack was declined or failed to download:
on resource pack deny: kick the player due to "You have to install the resource pack to play in this server!"
Called when the player activates the riptide enchantment, using their trident to propel them through the air. Note: the riptide action is performed client side, so manipulating the player in this event may have undesired effects.
Called directly after the trigger is loaded, or directly before the whole script is unloaded. The keyword 'async' indicates the trigger can be ran asynchronously,
Examples:
on load: set {running::%script%} to true on unload: set {running::%script%} to false
Called when a server list ping is coming in, generally when a Minecraft client pings the server to show its information in the server list. The IP expression can be used to get the IP adress of the pinger. This event can be cancelled on PaperSpigot 1.12.2+ only and this means the player will see the server as offline (but still can join).
on server list ping: set the motd to "Welcome %{player-by-IP::%ip%}%! Join now!" if {player-by-IP::%ip%} is set, else "Join now!" set the fake max players count to (online players count + 1) set the shown icon to a random server icon out of {server-icons::*}
Called whenever a player changes their held item by selecting a different slot (e.g. the keys 1-9 or the mouse wheel), not by dropping or replacing the item in the current slot.
Called when a world is initialised. As all default worlds are initialised before any scripts are loaded, this event is only called for newly created worlds. World management plugins might change the behaviour of this event though.
every 2 seconds in "world": every minecraft hour in "flatworld": every tick in "world": # can cause lag depending on the code inside the event every minecraft days in "plots":
\ No newline at end of file
+ Skript Documentation - 2.8.0-dev-nightly-235b97a
You can specify the event priority after each event syntax using the following syntax [with priority (lowest|low|normal|high|highest|monitor)] e.g. on spawn with priority lowest. Note that not all of the events support event priority feature and they will throw an error.
Called when an item is put in a slot for repair by an anvil. Please note that this event is called multiple times in a single item slot move.
Examples:
on anvil prepare: event-item is set # result item chance of 5%: set repair cost to repair cost * 50% send "You're LUCKY! You got 50% discount." to player
Called when a player rightclicks on a block while holding a block or a placeable item. You can either cancel the event to prevent the block from being built, or uncancel it to allow it. Please note that the data value of the block to be placed is not available in this event, only its ID.
Called whenever a player chats. Use chat format to change message format. Use chat recipients to edit chat recipients.
Examples:
on chat: if player has permission "owner": set chat format to "&amp;amp;lt;red&amp;amp;gt;[player]&amp;amp;lt;light gray&amp;amp;gt;: &amp;amp;lt;light red&amp;amp;gt;[message]" else if player has permission "admin": set chat format to "&amp;amp;lt;light red&amp;amp;gt;[player]&amp;amp;lt;light gray&amp;amp;gt;: &amp;amp;lt;orange&amp;amp;gt;[message]" else: #default message format set chat format to "&amp;amp;lt;orange&amp;amp;gt;[player]&amp;amp;lt;light gray&amp;amp;gt;: &amp;amp;lt;white&amp;amp;gt;[message]"
Called when a user clicks on a block, an entity or air with or without an item in their hand. Please note that rightclick events with an empty hand while not looking at a block are not sent to the server, so there's no way to detect them. Also note that a leftclick on an entity is an attack and thus not covered by the 'click' event, but the 'damage' event.
Examples:
on click: on rightclick holding a fishing rod: on leftclick on a stone or obsidian: on rightclick on a creeper: on click with a sword:
Called when a player enters a command (not necessarily a Skript command) but you can check if command is a skript command, see Is a Skript command condition.
Examples:
on command: on command "/stop": on command "pm Njol ":
Called when the player connects to the server. This event is called before the player actually joins the server, so if you want to prevent players from joining you should prefer this event over on join.
Examples:
on connect: player doesn't have permission "VIP" number of players is greater than 15 kick the player due to "The last 5 slots are reserved for VIP players."
Called when a player throws an egg and it lands. You can just use the shoot event in most cases. However, this event allows modification of properties like the hatched entity type and the number of entities to hatch.
Called when a player puts an item into enchantment table. This event may be called multiple times. To get the enchant item, see the enchant item expression
Examples:
on enchant prepare: set enchant offer 1 to sharpness 1 set the cost of enchant offer 1 to 10 levels
Called when an enderman places or picks up a block, a sheep eats grass, a silverfish boops into/out of a block or a falling block lands and turns into a block respectively.
Examples:
on sheep eat: kill event-entity broadcast "A sheep stole some grass!"
on falling block land: event-entity is a falling dirt cancel event
Called when an explosive is primed, i.e. an entity will explode shortly. Creepers can abort the explosion if the player gets too far away, while TNT will explode for sure after a short time.
on firework explode on firework exploding colored red, light green and black on firework explosion colored light green: broadcast "A firework colored %colors% was exploded at %location%!"
Called when a block is created, but not by a player, e.g. snow forms due to snowfall, water freezes in cold biomes. This isn't called when block spreads (mushroom growth, water physics etc.), as it has its own event (see spread event).
Called whenever a player swaps the items in their main- and offhand slots. Works also when one or both of the slots are empty. The event is called before the items are actually swapped, so when you use the player's tool or player's offtool expressions, they will return the values before the swap - this enables you to cancel the event before anything happens.
Examples:
on swap hand items: event-player's tool is a diamond sword cancel event
Called when an entity is healed, e.g. by eating (players), being fed (pets), or by the effect of a potion of healing (overworld mobs) or harm (nether mobs).
Called when a block starts burning, i.e. a fire block is placed next to it and this block is flammable. The burn event will be called when the block is about do be destroyed by the fire.
Examples:
on block ignite: if event-block is a ladder: cancel event
Called when an entity or block (e.g. hopper) tries to move items directly from one inventory to another. When this event is called, the initiator may have already removed the item from the source inventory and is ready to move it into the destination inventory. If this event is cancelled, the items will be returned to the source inventory.
Examples:
on inventory item move: broadcast "%holder of past event-inventory% is transporting %event-item% to %holder of event-inventory%!"
Called when dropped items merge into a single stack. event-entity will be the entity which is trying to merge, and future event-entity will be the entity which is being merged into.
Called whenever an item stack is spawned in a world, e.g. as drop of a block or mob, a player throwing items out of their inventory, or a dispenser dispensing an item (not shooting it).
Examples:
on item spawn of iron sword: broadcast "Someone dropped an iron sword!"
Called when the player joins the server. The player is already in a world when this event is called, so if you want to prevent players from joining you should prefer on connect over this event.
Examples:
on join: message "Welcome on our awesome server!" broadcast "%player% just joined the server!"
Called after a player changed their language in the game settings. You can use the language expression to get the current language of the player. This event requires Minecraft 1.12+.
Examples:
on language change: if player's language starts with "en": send "Hello!"
Called when a player or entity moves. NOTE: Move event will only be called when the entity/player moves position, not orientation (ie: looking around). NOTE: These events can be performance heavy as they are called quite often. If you use these events, and later remove them, a server restart is recommended to clear registered events from Skript.
Examples:
on player move: if player does not have permission "player.can.move": cancel event on skeleton move: if event-entity is not in world "world": kill event-entity
Called when a physics check is done on a block. By cancelling this event you can prevent some things from happening, e.g. sand falling, dirt turning into grass, torches dropping if their supporting block is destroyed, etc.Please note that using this event might cause quite some lag since it gets called extremely often.
Examples:
# prevents sand from falling on block physics: block is sand cancel event
Called when a player has slept long enough to count as passing the night/storm. Cancelling this event will prevent the player from being counted as deeply sleeping unless they exit and re-enter the bed.
Called when a portal is created, either by a player or mob lighting an obsidian frame on fire, or by a nether portal creating its teleportation target in the nether/overworld. In Minecraft 1.14+, you can use the player in this event. Please note that there may not always be a player (or other entity) in this event.
Called when a projectile hits an entity or a block. Use the damage event with a check for a projectile to be able to use the entity that got hit in the case when the projectile hit a living entity. A damage event will even be fired if the damage is 0, e.g. when throwing snowballs at non-nether mobs.
Examples:
on projectile hit: event-projectile is arrow delete event-projectile
Called when a player takes action on a resource pack request sent via the send resource pack effect. The resource pack condition can be used to check the resource pack state.
This event will be triggered once when the player accepts or declines the resource pack request, and once when the resource pack is successfully installed or failed to download.
Examples:
on resource pack request response: if the resource pack was declined or failed to download:
on resource pack deny: kick the player due to "You have to install the resource pack to play in this server!"
Called when the player activates the riptide enchantment, using their trident to propel them through the air. Note: the riptide action is performed client side, so manipulating the player in this event may have undesired effects.
Called directly after the trigger is loaded, or directly before the whole script is unloaded. The keyword 'async' indicates the trigger can be ran asynchronously,
Examples:
on load: set {running::%script%} to true on unload: set {running::%script%} to false
Called when a server list ping is coming in, generally when a Minecraft client pings the server to show its information in the server list. The IP expression can be used to get the IP adress of the pinger. This event can be cancelled on PaperSpigot 1.12.2+ only and this means the player will see the server as offline (but still can join).
on server list ping: set the motd to "Welcome %{player-by-IP::%ip%}%! Join now!" if {player-by-IP::%ip%} is set, else "Join now!" set the fake max players count to (online players count + 1) set the shown icon to a random server icon out of {server-icons::*}
Called whenever a player changes their held item by selecting a different slot (e.g. the keys 1-9 or the mouse wheel), not by dropping or replacing the item in the current slot.
Called when a world is initialised. As all default worlds are initialised before any scripts are loaded, this event is only called for newly created worlds. World management plugins might change the behaviour of this event though.
every 2 seconds in "world": every minecraft hour in "flatworld": every tick in "world": # can cause lag depending on the code inside the event every minecraft days in "plots":
\ No newline at end of file
diff --git a/docs/nightly/fix/command-cooldown-storage/expressions.html b/docs/nightly/fix/command-cooldown-storage/expressions.html
index c5c24238f8..5af75a7ed8 100644
--- a/docs/nightly/fix/command-cooldown-storage/expressions.html
+++ b/docs/nightly/fix/command-cooldown-storage/expressions.html
@@ -1 +1 @@
- Skript Documentation - 2.8.0-dev-nightly-173935c
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
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
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.
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!"
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
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
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!"
A part of a player's armour, 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
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
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
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
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
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
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
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
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
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
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"
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?
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
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
main name 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
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"
# 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%}
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%}
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
How much damage is done in a damage event, possibly ignoring armour, criticals and/or enchantments. Can be changed (remember that in Skript '1' is one full heart, not half a heart).
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
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!"
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
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.
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.
All entities in all worlds, in a specific world, in a chunk or in a radius around a certain location, 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
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!" set victim's attack speed attribute to 2
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
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%
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
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
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
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"]
Represents the input in a filter expression. 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.
Examples:
send "congrats on being staff!" to all players where [input has permission "staff"]
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
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
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
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.
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
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
Returns the hanging entity or remover in hanging break and place events.
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
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!"
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:
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).
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
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
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}
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
on inventory item move: if holder of event-initiator-inventory is a chest: broadcast "Item transport requested at %location at holder of event-initiator-inventory%..."
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
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
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
An item associated with an entity. For dropped item entities, it gets, obviously, the item that was dropped. For item frames, the item inside the frame is returned. For throwable projectiles (snowballs, enderpearls etc.),it gets the displayed item. Other entities do not have items associated with them.
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
All 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
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 with "" | ""%" # %all players% would use the default "x, y, and z" set {_s::*} to the string argument split at ","
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.
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
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."
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
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
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%."
# 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%"
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.
[the] [(real|default)|(fake|shown|displayed)] max[imum] (count|amount|number|size) of players
Since:
2.3, 2.7 (modify max real players)
Requirements:
Paper 1.16+ (modify max real players)
Return Type:
integer
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)
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
The (chat) message of a chat event, the join message of a join event, the quit message of a quit event, or the death message on a death 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: set quit message to "%player% left this awesome server!"
on death: set the death message to "%player% died!"
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."
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
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"
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"
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
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
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
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
[the] [((real|default)|(fake|shown|displayed))] [online] player (count|amount|number)
[the] [((real|default)|(fake|shown|displayed))] (count|amount|number|size) of online players
Since:
2.3
Return Type:
long
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 returns the real count of online players and can't be changed.
Fake online player count requires PaperSpigot 1.12.2+.
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 players count + 1)
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
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!"
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
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%"
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
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
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
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
A random number or integer 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
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>."
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
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!!"
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
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.
Examples:
if index of event-slot is 10: send "You bought a pie!"
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
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
For players this is the entity at the crosshair. For mobs and experience orbs this is the entity they are attacking/following (if any).
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
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.
Examples:
# A command to set the block a player looks at to a specific type: command /setblock <material>: trigger: set targeted block to argument
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
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
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%!"
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
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"
set {_v} to vector 1, 2, 3 // 5 set {_v} to {_v} ++ {_v} set {_v} to {_v} ++ 5 set {_v} to {_v} -- {_v} set {_v} to {_v} -- 5 set {_v} to {_v} ** {_v} set {_v} to {_v} ** 5 set {_v} to {_v} // {_v} set {_v} to {_v} // 5
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
Gets or changes the x, y or z component of a vector.
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}%"
The vehicle an entity is in, if any. This can actually be any entity, e.g. spider jockeys are skeletons that ride on a spider, so the spider is the 'vehicle' of the skeleton. See also: passenger
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%"
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
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
A server's whitelist.This expression can be used to add/remove players to/from the whitelist, to enable it and disable it (set whitelist to true / set whitelist to false), and to empty it (reset whitelist)
Examples:
set whitelist to false add all players to whitelist reset the whitelist
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.
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
\ No newline at end of file
+ Skript Documentation - 2.8.0-dev-nightly-235b97a
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
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
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.
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!"
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
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
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!"
A part of a player's armour, 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
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
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
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
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
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
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
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
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
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
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"
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?
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
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
main name 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
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"
# 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%}
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%}
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
How much damage is done in a damage event, possibly ignoring armour, criticals and/or enchantments. Can be changed (remember that in Skript '1' is one full heart, not half a heart).
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
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!"
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
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.
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.
All entities in all worlds, in a specific world, in a chunk or in a radius around a certain location, 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
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
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
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%
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
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
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
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"]
Represents the input in a filter expression. 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.
Examples:
send "congrats on being staff!" to all players where [input has permission "staff"]
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
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
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
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.
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
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
Returns the hanging entity or remover in hanging break and place events.
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
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!"
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:
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).
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
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
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}
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
on inventory item move: if holder of event-initiator-inventory is a chest: broadcast "Item transport requested at %location at holder of event-initiator-inventory%..."
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
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
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
An item associated with an entity. For dropped item entities, it gets, obviously, the item that was dropped. For item frames, the item inside the frame is returned. For throwable projectiles (snowballs, enderpearls etc.),it gets the displayed item. Other entities do not have items associated with them.
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
All 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
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 with "" | ""%" # %all players% would use the default "x, y, and z" set {_s::*} to the string argument split at ","
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.
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
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."
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
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
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%."
# 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%"
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.
[the] [(real|default)|(fake|shown|displayed)] max[imum] (count|amount|number|size) of players
Since:
2.3, 2.7 (modify max real players)
Requirements:
Paper 1.16+ (modify max real players)
Return Type:
integer
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)
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
The (chat) message of a chat event, the join message of a join event, the quit message of a quit event, or the death message on a death 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: set quit message to "%player% left this awesome server!"
on death: set the death message to "%player% died!"
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."
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
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"
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"
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
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
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
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
[the] [((real|default)|(fake|shown|displayed))] [online] player (count|amount|number)
[the] [((real|default)|(fake|shown|displayed))] (count|amount|number|size) of online players
Since:
2.3
Return Type:
long
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 returns the real count of online players and can't be changed.
Fake online player count requires PaperSpigot 1.12.2+.
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 players count + 1)
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
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!"
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
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
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%"
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
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
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
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
A random number or integer 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
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>."
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
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!!"
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
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
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
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
For players this is the entity at the crosshair. For mobs and experience orbs this is the entity they are attacking/following (if any).
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
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.
Examples:
# A command to set the block a player looks at to a specific type: command /setblock <material>: trigger: set targeted block to argument
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
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
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%!"
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
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"
set {_v} to vector 1, 2, 3 // 5 set {_v} to {_v} ++ {_v} set {_v} to {_v} ++ 5 set {_v} to {_v} -- {_v} set {_v} to {_v} -- 5 set {_v} to {_v} ** {_v} set {_v} to {_v} ** 5 set {_v} to {_v} // {_v} set {_v} to {_v} // 5
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
Gets or changes the x, y or z component of a vector.
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}%"
The vehicle an entity is in, if any. This can actually be any entity, e.g. spider jockeys are skeletons that ride on a spider, so the spider is the 'vehicle' of the skeleton. See also: passenger
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%"
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
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
A server's whitelist.This expression can be used to add/remove players to/from the whitelist, to enable it and disable it (set whitelist to true / set whitelist to false), and to empty it (reset whitelist)
Examples:
set whitelist to false add all players to whitelist reset the whitelist
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.
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
\ No newline at end of file
diff --git a/docs/nightly/fix/command-cooldown-storage/functions.html b/docs/nightly/fix/command-cooldown-storage/functions.html
index b763329f42..0393011ba5 100644
--- a/docs/nightly/fix/command-cooldown-storage/functions.html
+++ b/docs/nightly/fix/command-cooldown-storage/functions.html
@@ -1 +1 @@
- Skript Documentation - 2.8.0-dev-nightly-173935c
These functions are defined by Skript. You may also create your own functions! Tutorial for doing so is planned, but right now you need to seek it elsewhere.
Similar to atan, but requires two coordinates and returns values from -180 to 180. The returned angle is measured counterclockwise in a standard mathematical coordinate system (x to the right, y to the top).
date(year: number, month: number, day: number, hour: number = [[integer:0]], minute: number = [[integer:0]], second: number = [[integer:0]], millisecond: number = [[integer:0]], zone_offset: number = [[double:NaN]], dst_offset: number = [[double:NaN]])
Creates a date from a year, month, and day, and optionally also from hour, minute, second and millisecond. A time zone and DST offset can be specified as well (in minutes), if they are left out the server's time zone and DST offset are used (the created date will not retain this information).
Examples:
date(2014, 10, 1) # 0:00, 1st October 2014 date(1990, 3, 5, 14, 30) # 14:30, 5th May 1990 date(1999, 12, 31, 23, 59, 59, 999, -3*60, 0) # almost year 2000 in parts of Brazil (-3 hours offset, no DST)
Creates a location from a world and 3 coordinates, with an optional yaw and pitch. If for whatever reason the world is not found, it will fallback to the server's main world.
A logarithm, with base 10 if none is specified. This is the inverse operation to exponentiation (for positive bases only), i.e. log(base ^ exponent, base) = exponent for any positive number 'base' and any number 'exponent'. Another useful equation is base ^ log(a, base) = a for any numbers 'base' and 'a'. Please note that due to how numbers are represented in computers, these equations do not hold for all numbers, as the computed values may slightly differ from the correct value. Returns NaN (not a number) if any of the arguments are negative.
Returns the modulo of the given arguments, i.e. the remainder of the division d/m, where d and m are the arguments of this function. The returned value is always positive. Returns NaN (not a number) if the second argument is zero.
Returns an online player from their name or UUID, if player is offline function will return nothing. Setting 'getExactPlayer' parameter to true will return the player whose name is exactly equal to the provided name instead of returning a player that their name starts with the provided name.
Examples:
set {_p} to player("Notch") # will return an online player whose name is or starts with 'Notch' set {_p} to player("Notch", true) # will return the only online player whose name is 'Notch' set {_p} to player("069a79f4-44e9-4726-a5be-fca90e38aaf5") # <none> if player is offline
The sine function. It starts at 0° with a value of 0, goes to 1 at 90°, back to 0 at 180°, to -1 at 270° and then repeats every 360°. Uses degrees, not radians.
The square root, which is the inverse operation to squaring a number (for positive numbers only). This is the same as (argument) ^ (1/2) – other roots can be calculated via number ^ (1/root), e.g. set {_l} to {_volume}^(1/3). Returns NaN (not a number) if the argument is negative.
These functions are defined by Skript. You may also create your own functions! Tutorial for doing so is planned, but right now you need to seek it elsewhere.
Similar to atan, but requires two coordinates and returns values from -180 to 180. The returned angle is measured counterclockwise in a standard mathematical coordinate system (x to the right, y to the top).
date(year: number, month: number, day: number, hour: number = [[integer:0]], minute: number = [[integer:0]], second: number = [[integer:0]], millisecond: number = [[integer:0]], zone_offset: number = [[double:NaN]], dst_offset: number = [[double:NaN]])
Creates a date from a year, month, and day, and optionally also from hour, minute, second and millisecond. A time zone and DST offset can be specified as well (in minutes), if they are left out the server's time zone and DST offset are used (the created date will not retain this information).
Examples:
date(2014, 10, 1) # 0:00, 1st October 2014 date(1990, 3, 5, 14, 30) # 14:30, 5th May 1990 date(1999, 12, 31, 23, 59, 59, 999, -3*60, 0) # almost year 2000 in parts of Brazil (-3 hours offset, no DST)
Creates a location from a world and 3 coordinates, with an optional yaw and pitch. If for whatever reason the world is not found, it will fallback to the server's main world.
A logarithm, with base 10 if none is specified. This is the inverse operation to exponentiation (for positive bases only), i.e. log(base ^ exponent, base) = exponent for any positive number 'base' and any number 'exponent'. Another useful equation is base ^ log(a, base) = a for any numbers 'base' and 'a'. Please note that due to how numbers are represented in computers, these equations do not hold for all numbers, as the computed values may slightly differ from the correct value. Returns NaN (not a number) if any of the arguments are negative.
Returns the modulo of the given arguments, i.e. the remainder of the division d/m, where d and m are the arguments of this function. The returned value is always positive. Returns NaN (not a number) if the second argument is zero.
Returns an online player from their name or UUID, if player is offline function will return nothing. Setting 'getExactPlayer' parameter to true will return the player whose name is exactly equal to the provided name instead of returning a player that their name starts with the provided name.
Examples:
set {_p} to player("Notch") # will return an online player whose name is or starts with 'Notch' set {_p} to player("Notch", true) # will return the only online player whose name is 'Notch' set {_p} to player("069a79f4-44e9-4726-a5be-fca90e38aaf5") # &amp;lt;none&amp;gt; if player is offline
The sine function. It starts at 0° with a value of 0, goes to 1 at 90°, back to 0 at 180°, to -1 at 270° and then repeats every 360°. Uses degrees, not radians.
The square root, which is the inverse operation to squaring a number (for positive numbers only). This is the same as (argument) ^ (1/2) – other roots can be calculated via number ^ (1/root), e.g. set {_l} to {_volume}^(1/3). Returns NaN (not a number) if the argument is negative.
Skript is (surprise, surprise) a scripting plugin for the Bukkit platform. It is easy to use for simple tasks, but you can also create really complex things with it. The syntax of Skript is close to English, but it is still not magic. While you might succeed with experimentation for simple tasks, for anything more complex you will need some guidance.
This is Skript's documentation. You will find all supported features of the plugin here, along with some useful examples. We don't have tutorials yet, but you can find good ones using whatever search engine you prefer.
Skript is (surprise, surprise) a scripting plugin for the Bukkit platform. It is easy to use for simple tasks, but you can also create really complex things with it. The syntax of Skript is close to English, but it is still not magic. While you might succeed with experimentation for simple tasks, for anything more complex you will need some guidance.
This is Skript's documentation. You will find all supported features of the plugin here, along with some useful examples. We don't have tutorials yet, but you can find good ones using whatever search engine you prefer.
Quick Look
command /sethome:
permission: skript.home # Permission required for this command
description: Set your home # Description of this command
executable by: players # Console won't be able to run this command
@@ -19,4 +19,4 @@
# Teleport the player to their home
teleport player to {home::%uuid of player%}
send "&aYou have been teleported."
-
Found something incorrect in this documentation? Please report it to the issue tracker.
We are looking for docs authors! Currently, the only documentation is generated automatically. It would be nice to have some hand-written content such as tutorials on the docs as well. For example, currently we don't have a tutorial on how to use loops here; This makes it harder for newcomers to learn. Check this issue for more details and if you're interested in helping out.
Found something incorrect in this documentation? Please report it to the issue tracker.
We are looking for docs authors! Currently, the only documentation is generated automatically. It would be nice to have some hand-written content such as tutorials on the docs as well. For example, currently we don't have a tutorial on how to use loops here; This makes it harder for newcomers to learn. Check this issue for more details and if you're interested in helping out.
Main usage is ExprInventoryInfo
This class allows Skript to return a block while being able to recognize it as InventoryHolder,
You may only use this class if a expression's return type is an InventoryHolder.
@@ -307,198 +303,10 @@
All Classes and Interfaces<
Comparators are used to provide Skript with specific instructions for comparing two objects.
A block that gets all data from the world, but either delays
any changes by 1 tick of reflects them on a given BlockState
depending on which constructor is used.
An effect which is unconditionally executed when reached, and execution will usually continue with the next item of the trigger after this effect is executed (the stop effect
@@ -671,142 +443,6 @@
This class can be used for an easier writing of conditions that contain only one type in the pattern,
- and are in one of the following forms:
-
- something is something
- something can something
- something has something
-
- The plural and negated forms are also supported.
A class that has had fields added, changed, or removed from it should implement this interface to handle the now invalid/missing fields that may still be read from stream.
Replaces options in a string.
- Options are obtained from a Script's StructOptions.OptionsData.
+ Options are obtained from a Script's StructOptions.OptionsData.
Example: script.getData(OptionsData.class)
Disables the registration for the given hook classes. If Skript has been enabled, this method
will throw an API exception. It should be used in something like JavaPlugin.onLoad().
@Name("Alphanumeric")
-@Description("Checks if the given string is alphanumeric.")
-@Examples({"if the argument is not alphanumeric:","\tsend \"Invalid name!\""})
-@Since("2.4")
-public class CondAlphanumeric
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Do Respawn Anchors Work")
-@Description("Checks whether or not respawn anchors work in a world.")
-@Examples("respawn anchors work in world \"world_nether\"")
-@RequiredPlugins("Minecraft 1.16+")
-@Since("2.7")
-public class CondAnchorWorks
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Can Hold")
-@Description("Tests whether a player or a chest can hold the given item.")
-@Examples({"block can hold 200 cobblestone","player has enough space for 64 feathers"})
-@Since("1.0")
-public class CondCanHold
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Can Pick Up Items")
-@Description("Whether living entities are able to pick up items off the ground or not.")
-@Examples({"if player can pick items up:","\tsend \"You can pick up items!\" to player","","on drop:","\tif player can\'t pick\tup items:","\t\tsend \"Be careful, you won\'t be able to pick that up!\" to player"})
-@Since("INSERT VERSION")
-public class CondCanPickUpItems
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Can See")
-@Description("Checks whether the given players can see another players.")
-@Examples({"if the player can\'t see the player-argument:","\tmessage \"<light red>The player %player-argument% is not online!\""})
-@Since("2.3")
-public class CondCanSee
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Event Cancelled")
-@Description("Checks whether or not the event is cancelled.")
-@Examples({"on click:","\tif event is cancelled:","\t\tbroadcast \"no clicks allowed!\""})
-@Since("2.2-dev36")
-public class CondCancelled
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Chance")
-@Description({"A condition that randomly succeeds or fails.","Valid values are between 0% and 100%, or if the percent sign is omitted between 0 and 1."})
-@Examples({"chance of 50%:","\tdrop a diamond","chance of {chance}% # {chance} between 0 and 100","chance of {chance} # {chance} between 0 and 1"})
-@Since("1.0")
-public class CondChance
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Comparison")
-@Description({"A very general condition, it simply compares two values. Usually you can only compare for equality (e.g. block is/isn\'t of <type>), but some values can also be compared using greater than/less than. In that case you can also test for whether an object is between two others.","Note: This is the only element where not all patterns are shown. It has actually another two sets of similar patters, but with <code>(was|were)</code> or <code>will be</code> instead of <code>(is|are)</code> respectively, which check different <a href=\'expressions.html#ExprTimeState\'>time states</a> of the first expression."})
-@Examples({"the clicked block is a stone slab or a double stone slab","time in the player\'s world is greater than 8:00","the creature is not an enderman or an ender dragon"})
-@Since("1.0")
-public class CondCompare
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
vars - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Contains")
-@Description("Checks whether an inventory contains an item, a text contains another piece of text, or a list (e.g. {list variable::*} or \'drops\') contains another object.")
-@Examples({"block contains 20 cobblestone","player has 4 flint and 2 iron ingots","{list::*} contains 5"})
-@Since("1.0")
-public class CondContains
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Damage Cause")
-@Description("Tests what kind of damage caused a <a href=\'events.html#damage\'>damage event</a>. Refer to the <a href=\'classes.html#damagecause\'>Damage Cause</a> type for a list of all possible causes.")
-@Examples({"# make players use their potions of fire resistance whenever they take any kind of fire damage","on damage:","\tdamage was caused by lava, fire or burning","\tvictim is a player","\tvictim has a potion of fire resistance","\tcancel event","\tapply fire resistance to the victim for 30 seconds","\tremove 1 potion of fire resistance from the victim","# prevent mobs from dropping items under certain circumstances","on death:","\tentity is not a player","\tdamage wasn\'t caused by a block explosion, an attack, a projectile, a potion, fire, burning, thorns or poison","\tclear drops"})
-@Since("2.0")
-public class CondDamageCause
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Time")
-@Description("Tests whether a given <a href=\'classes.html#date\'>real time</a> was more or less than some <a href=\'classes.html#timespan\'>time span</a> ago.")
-@Examples({"command /command-with-cooldown:","\ttrigger:","\t\t{command::%player\'s uuid%::last-usage} was less than a minute ago:","\t\t\tmessage \"Please wait a minute between uses of this command.\"","\t\t\tstop","\t\tset {command::%player\'s uuid%::last-usage} to now","\t\t# ... actual command trigger here ..."})
-@Since("2.0")
-public class CondDate
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Entity is in Liquid")
-@Description("Checks whether an entity is in rain, lava, water or a bubble column.")
-@Examples({"if player is in rain:","if player is in water:","player is in lava:","player is in bubble column"})
-@RequiredPlugins("Minecraft 1.16+ (in water), Paper 1.16+ (in rain, lava and bubble column)")
-@Since("2.6.1")
-public class CondEntityIsInLiquid
-extends PropertyCondition<org.bukkit.entity.Entity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Entity is Wet")
-@Description("Checks whether an entity is wet or not (in water, rain or a bubble column).")
-@Examples("if player is wet:")
-@RequiredPlugins("Paper 1.16+")
-@Since("2.6.1")
-public class CondEntityIsWet
-extends PropertyCondition<org.bukkit.entity.Entity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Has Client Weather")
-@Description("Checks whether the given players have a custom client weather")
-@Examples({"if the player has custom weather:","\tmessage \"Your custom weather is %player\'s weather%\""})
-@Since("2.3")
-public class CondHasClientWeather
-extends PropertyCondition<org.bukkit.entity.Player>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Has Item Cooldown")
-@Description("Check whether a cooldown is active on the specified material for a specific player.")
-@Examples({"if player has player\'s tool on cooldown:","\tsend \"You can\'t use this item right now. Wait %item cooldown of player\'s tool for player%\""})
-@Since("INSERT VERSION")
-public class CondHasItemCooldown
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Has Line of Sight")
-@Description("Checks whether living entities have an unobstructed line of sight to other entities or locations.")
-@Examples({"player has direct line of sight to location 5 blocks to the right of player","victim has line of sight to attacker","player has no line of sight to location 100 blocks in front of player"})
-@Since("INSERT VERSION")
-public class CondHasLineOfSight
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Has Metadata")
-@Description("Checks whether a metadata holder has a metadata tag.")
-@Examples("if player has metadata value \"healer\":")
-@Since("2.2-dev36")
-public class CondHasMetadata
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Has Potion")
-@Description("Checks whether the given living entities have specific potion effects.")
-@Examples({"if player has potion speed:","\tsend \"You are sonic!\"","","if all players have potion effects speed and haste:","\tbroadcast \"You are ready to MINE!\""})
-@Since("2.6.1")
-public class CondHasPotion
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Has Resource Pack")
-@Description("Checks whether the given players have a server resource pack loaded. Please note that this can\'t detect player\'s own resource pack, only the resource pack that sent by the server.")
-@Examples("if the player has a resource pack loaded:")
-@Since("2.4")
-@RequiredPlugins("Paper 1.9 or newer")
-public class CondHasResourcePack
-extends PropertyCondition<org.bukkit.entity.Player>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Has Scoreboard Tag")
-@Description("Checks whether the given entities has the given <a href=\'expressions.html#ExprScoreboardTags\'>scoreboard tags</a>.")
-@Examples("if the targeted armor stand has the scoreboard tag \"test tag\":")
-@Since("2.3")
-public class CondHasScoreboardTag
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Ignition Process")
-@Description("Checks if a creeper is going to explode.")
-@Examples({"if the last spawned creeper is going to explode:","\tloop all players in radius 3 of the last spawned creeper","\t\tsend \"RUN!!!\" to the loop-player"})
-@Since("2.5")
-@RequiredPlugins("Paper 1.13 or newer")
-public class CondIgnitionProcess
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Is Incendiary")
-@Description("Checks if an entity will create fire when it explodes. This condition is also usable in an explosion prime event.")
-@Examples({"on explosion prime:","\tif the explosion is fiery:","\t\tbroadcast \"A fiery explosive has been ignited!\""})
-@Since("2.5")
-public class CondIncendiary
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Alive")
-@Description("Checks whether an entity is alive. Works for non-living entities too.")
-@Examples({"if {villager-buddy::%player\'s uuid%} is not dead:","","on shoot:","\twhile the projectile is alive:"})
-@Since("2.0, 2.4-alpha4 (non-living entity support)")
-public class CondIsAlive
-extends PropertyCondition<org.bukkit.entity.Entity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Is Banned")
-@Description("Checks whether a player or IP is banned.")
-@Examples({"player is banned","victim is not IP-banned","\"127.0.0.1\" is banned"})
-@Since("1.4")
-public class CondIsBanned
-extends PropertyCondition<Object>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Is Block Redstone Powered")
-@Description("Checks if a block is indirectly or directly powered by redstone")
-@Examples({"if clicked block is redstone powered:","\tsend \"This block is well-powered by redstone!\"","if clicked block is indirectly redstone powered:","\tsend \"This block is indirectly redstone powered.\""})
-@Since("2.5")
-public class CondIsBlockRedstonePowered
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Blocking")
-@Description("Checks whether a player is blocking with their shield.")
-@Examples({"on damage of player:","\tvictim is blocking","\tdamage attacker by 0.5 hearts"})
-@Since("<i>unknown</i> (before 2.1)")
-public class CondIsBlocking
-extends PropertyCondition<org.bukkit.entity.Player>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Burning")
-@Description("Checks whether an entity is on fire, e.g. a zombie due to being in sunlight, or any entity after falling into lava.")
-@Examples({"# increased attack against burning targets","victim is burning:","\tincrease damage by 2"})
-@Since("1.4.4")
-public class CondIsBurning
-extends PropertyCondition<org.bukkit.entity.Entity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Charged")
-@Description("Checks if a creeper is charged (powered).")
-@Examples({"if the last spawned creeper is charged:","\tbroadcast \"A charged creeper is at %location of last spawned creeper%\""})
-@Since("2.5")
-public class CondIsCharged
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Climbing")
-@Description("Whether a living entity is climbing, such as a spider up a wall or a player on a ladder.")
-@Examples({"spawn a spider at location of spawn","wait a second","if the last spawned spider is climbing:","\tmessage\"The spider is now climbing!\""})
-@RequiredPlugins("Minecraft 1.17+")
-@Since("INSERT VERSION")
-public class CondIsClimbing
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Empty")
-@Description("Checks whether an inventory, an inventory slot, or a text is empty.")
-@Examples("player\'s inventory is empty")
-@Since("<i>unknown</i> (before 2.1)")
-public class CondIsEmpty
-extends PropertyCondition<Object>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Enchanted")
-@Description("Checks whether an item is enchanted.")
-@Examples({"tool of the player is enchanted with efficiency 2","helm, chestplate, leggings or boots are enchanted"})
-@Since("1.4.6")
-public class CondIsEnchanted
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Flying")
-@Description("Checks whether a player is flying.")
-@Examples("player is not flying")
-@Since("1.4.4")
-public class CondIsFlying
-extends PropertyCondition<org.bukkit.entity.Player>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Frozen")
-@Description("Checks whether an entity is frozen.")
-@Examples({"if player is frozen:","\tkill player"})
-@Since("2.7")
-public class CondIsFrozen
-extends PropertyCondition<org.bukkit.entity.Entity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Fuel")
-@Description("Checks whether an item can be used as fuel in a furnace.")
-@Examples({"on right click on furnace:","\tif player\'s tool is not fuel:","\t\tsend \"Please hold a valid fuel item in your hand\"","\t\tcancel event"})
-@Since("2.5.1")
-@RequiredPlugins("Minecraft 1.11.2+")
-public class CondIsFuel
-extends PropertyCondition<ItemType>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Gliding")
-@Description("Checks whether a living entity is gliding.")
-@Examples("if player is gliding")
-@Since("2.7")
-public class CondIsGliding
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Interactable")
-@Description("Checks wether or not a block is interactable.")
-@Examples({"on block break:","\tif event-block is interactable:","\t\tcancel event","\t\tsend \"You cannot break interactable blocks!\""})
-@Since("2.5.2")
-@RequiredPlugins("Minecraft 1.13+")
-public class CondIsInteractable
-extends PropertyCondition<ItemType>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Invisible")
-@Description("Checks whether a living entity is invisible.")
-@Examples("target entity is invisible")
-@Since("2.7")
-public class CondIsInvisible
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Is Invulnerable")
-@Description("Checks whether an entity is invulnerable.")
-@Examples("target entity is invulnerable")
-@Since("2.5")
-public class CondIsInvulnerable
-extends PropertyCondition<org.bukkit.entity.Entity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Jumping")
-@Description("Checks whether a living entity is jumping. This condition does not work on players.")
-@Examples({"on spawn of zombie:","\twhile event-entity is not jumping:","\t\twait 5 ticks","\tpush event-entity upwards"})
-@Since("INSERT VERSION")
-@RequiredPlugins("Paper 1.15+")
-public class CondIsJumping
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Left Handed")
-@Description({"Checks if living entities or players are left or right-handed. Armor stands are neither right nor left-handed.","Paper 1.17.1+ is required for non-player entities."})
-@Examples({"on damage of player:","\tif victim is left handed:","\t\tcancel event"})
-@Since("INSERT VERSION")
-@RequiredPlugins("Paper 1.17.1+ (entities)")
-public class CondIsLeftHanded
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Is Loaded")
-@Description("Checks whether or not a chunk/world is loaded. \'chunk at 1, 1\' uses chunk coords, which are location coords divided by 16.")
-@Examples({"if chunk at {home::%player\'s uuid%} is loaded:","if chunk 1, 10 in world \"world\" is loaded:","if world(\"lobby\") is loaded:"})
-@Since("2.3, 2.5 (revamp with chunk at location/coords)")
-public class CondIsLoaded
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Occluding")
-@Description("Checks whether an item is a block and completely blocks vision.")
-@Examples("player\'s tool is occluding")
-@Since("2.5.1")
-public class CondIsOccluding
-extends PropertyCondition<ItemType>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is of Type")
-@Description("Checks whether an item of an entity is of the given type. This is mostly useful for variables, as you can use the general \'is\' condition otherwise (e.g. \'victim is a creeper\').")
-@Examples({"tool is of type {selected type}","victim is of type {villager type}"})
-@Since("1.4")
-public class CondIsOfType
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is on Ground")
-@Description("Checks whether an entity is on ground.")
-@Examples("player is not on ground")
-@Since("2.2-dev26")
-public class CondIsOnGround
-extends PropertyCondition<org.bukkit.entity.Entity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Online")
-@Description("Checks whether a player is online.")
-@Examples({"player is online","player-argument is offline"})
-@Since("1.4")
-public class CondIsOnline
-extends PropertyCondition<org.bukkit.OfflinePlayer>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Is Operator")
-@Description("Checks whether a player is a server operator.")
-@Examples("player is an operator")
-@Since("2.7")
-public class CondIsOp
-extends PropertyCondition<org.bukkit.OfflinePlayer>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Passable")
-@Description({"Checks whether a block is passable.","A block is passable if it has no colliding parts that would prevent players from moving through it.","Blocks like tall grass, flowers, signs, etc. are passable, but open doors, fence gates, trap doors, etc. are not because they still have parts that can be collided with."})
-@Examples("if player\'s targeted block is passable")
-@Since("2.5.1")
-@RequiredPlugins("Minecraft 1.13.2+")
-public class CondIsPassable
-extends PropertyCondition<org.bukkit.block.Block>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Plugin Enabled")
-@Description({"Check if a plugin is enabled/disabled on the server.","Plugin names can be found in the plugin\'s \'plugin.yml\' file or by using the \'/plugins\' command, they are NOT the name of the plugin\'s jar file.","When checking if a plugin is not enabled, this will return true if the plugin is either disabled or not on the server. ","When checking if a plugin is disabled, this will return true if the plugin is on the server and is disabled."})
-@Examples({"if plugin \"Vault\" is enabled:","if plugin \"WorldGuard\" is not enabled:","if plugins \"Essentials\" and \"Vault\" are enabled:","if plugin \"MyBrokenPlugin\" is disabled:"})
-@Since("2.6")
-public class CondIsPluginEnabled
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Poisoned")
-@Description("Checks whether an entity is poisoned.")
-@Examples({"player is poisoned:","\tcure the player from poison","\tmessage \"You have been cured!\""})
-@Since("1.4.4")
-public class CondIsPoisoned
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Preferred Tool")
-@Description("Checks whether an item is the preferred tool for a block. A preferred tool is one that will drop the block\'s item when used. For example, a wooden pickaxe is a preferred tool for grass and stone blocks, but not for iron ore.")
-@Examples({"on left click:","\tevent-block is set","\tif player\'s tool is the preferred tool for event-block:","\t\tbreak event-block naturally using player\'s tool","\telse:","\t\tcancel event"})
-@Since("2.7")
-@RequiredPlugins("1.16.5+, Paper 1.19.2+ (blockdata)")
-public class CondIsPreferredTool
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Riding")
-@Description("Tests whether an entity is riding another or is in a vehicle.")
-@Examples("player is riding a saddled pig")
-@Since("2.0")
-public class CondIsRiding
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Riptiding")
-@Description("Checks to see if an entity is currently using the Riptide enchantment.")
-@Examples("target entity is riptiding")
-@Since("2.5")
-public class CondIsRiptiding
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Exists/Is Set")
-@Description("Checks whether a given expression or variable is set.")
-@Examples({"{teams::%player\'s uuid%::preferred-team} is not set","on damage:","\tprojectile exists","\tbroadcast \"%attacker% used a %projectile% to attack %victim%!\""})
-@Since("1.2")
-public class CondIsSet
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Silent")
-@Description("Checks whether an entity is silent i.e. its sounds are disabled.")
-@Examples("target entity is silent")
-@Since("2.5")
-public class CondIsSilent
-extends PropertyCondition<org.bukkit.entity.Entity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is a Skript command")
-@Description("Checks whether a command/string is a custom Skript command.")
-@Examples({"# Example 1","on command:","\tcommand is a skript command","","# Example 2","\"sometext\" is a skript command"})
-@Since("2.6")
-public class CondIsSkriptCommand
-extends PropertyCondition<String>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Sleeping")
-@Description("Checks whether a player is sleeping.")
-@Examples({"# cut your enemies\' throats in their sleep >=)","on attack:","\tattacker is holding a sword","\tvictim is sleeping","\tincrease the damage by 1000"})
-@Since("1.4.4")
-public class CondIsSleeping
-extends PropertyCondition<org.bukkit.entity.Player>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Slime Chunk")
-@Description({"Tests whether a chunk is a so-called slime chunk.","Slimes can generally spawn in the swamp biome and in slime chunks.","For more info, see <a href=\'https://minecraft.gamepedia.com/Slime#.22Slime_chunks.22\'>the Minecraft wiki</a>."})
-@Examples({"command /slimey:","\ttrigger:","\t\tif chunk at player is a slime chunk:","\t\t\tsend \"Yeah, it is!\"","\t\telse:","\t\t\tsend \"Nope, it isn\'t\""})
-@Since("2.3")
-public class CondIsSlimeChunk
-extends PropertyCondition<org.bukkit.Chunk>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Sneaking")
-@Description("Checks whether a player is sneaking.")
-@Examples({"# prevent mobs from seeing sneaking players if they are at least 4 meters apart","on target:","\ttarget is sneaking","\tdistance of target and the entity is bigger than 4","\tcancel the event"})
-@Since("1.4.4")
-public class CondIsSneaking
-extends PropertyCondition<org.bukkit.entity.Player>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Sprinting")
-@Description("Checks whether a player is sprinting.")
-@Examples("player is not sprinting")
-@Since("1.4.4")
-public class CondIsSprinting
-extends PropertyCondition<org.bukkit.entity.Player>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Stackable")
-@Description("Checks whether an item is stackable.")
-@Examples({"diamond axe is stackable","birch wood is stackable","torch is stackable"})
-@Since("2.7")
-public class CondIsStackable
-extends PropertyCondition<org.bukkit.inventory.ItemStack>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Tameable")
-@Description("Check if an entity is tameable.")
-@Examples({"on damage:","\tif victim is tameable:","\t\tcancel event"})
-@Since("2.5")
-public class CondIsTameable
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Transparent")
-@Description("Checks whether an item is transparent. Note that this condition may not work for all blocks, due to the transparency list used by Spigot not being completely accurate.")
-@Examples("player\'s tool is transparent.")
-@Since("2.2-dev36")
-public class CondIsTransparent
-extends PropertyCondition<ItemType>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Valid")
-@Description("Checks whether an entity has died or been despawned for some other reason.")
-@Examples("if event-entity is valid")
-@Since("2.7")
-public class CondIsValid
-extends PropertyCondition<org.bukkit.entity.Entity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Normalized")
-@Description("Checks whether a vector is normalized i.e. length of 1")
-@Examples("vector of player\'s location is normalized")
-@Since("2.5.1")
-@RequiredPlugins("Minecraft 1.13.2+")
-public class CondIsVectorNormalized
-extends PropertyCondition<org.bukkit.util.Vector>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Is Wearing")
-@Description("Checks whether a player is wearing some armour.")
-@Examples({"player is wearing an iron chestplate and iron leggings","player is wearing all diamond armour"})
-@Since("1.0")
-public class CondIsWearing
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
vars - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Whitelisted")
-@Description("Whether or not the server or a player is whitelisted.")
-@Examples({"if server is whitelisted:","if player is whitelisted"})
-@Since("2.5.2")
-public class CondIsWhitelisted
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Within")
-@Description({"Whether a location is within something else. The \"something\" can be a block, an entity, a chunk, a world, or a cuboid formed by two other locations.","Note that using the <a href=\'conditions.html#CondCompare\'>is between</a> condition will refer to a straight line between locations, while this condition will refer to the cuboid between locations."})
-@Examples({"if player\'s location is within {_loc1} and {_loc2}:","\tsend \"You are in a PvP zone!\" to player","","if player is in world(\"world\"):","\tsend \"You are in the overworld!\" to player","","if attacker\'s location is inside of victim:","\tcancel event","\tsend \"Back up!\" to attacker and victim"})
-@Since("2.7")
-@RequiredPlugins("MC 1.17+ (within block)")
-public class CondIsWithin
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Holding")
-@Description("Checks whether a player is holding a specific item. Cannot be used with endermen, use \'entity is [not] an enderman holding <item type>\' instead.")
-@Examples({"player is holding a stick","victim isn\'t holding a sword of sharpness"})
-@Since("1.0")
-public class CondItemInHand
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Leashed")
-@Description("Checks to see if an entity is currently leashed.")
-@Examples("target entity is leashed")
-@Since("2.5")
-public class CondLeashed
-extends PropertyCondition<org.bukkit.entity.LivingEntity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("Matches")
-@Description("Checks whether the defined strings match the input regexes (Regular expressions).")
-@Examples({"on chat:","\tif message partially matches \"\\d\":","\t\tsend \"Message contains a digit!\"","\tif message doesn\'t match \"[A-Za-z]+\":","\t\tsend \"Message doesn\'t only contain letters!\""})
-@Since("2.5.2")
-public class CondMatches
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Has Permission")
-@Description("Test whether a player has a certain permission.")
-@Examples({"player has permission \"skript.tree\"","victim has the permission \"admin\":","\tsend \"You\'re attacking an admin!\" to attacker"})
-@Since("1.0")
-public class CondPermission
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Has Played Before")
-@Description("Checks whether a player has played on this server before. You can also use <a href=\'events.html#first_join\'>on first join</a> if you want to make triggers for new players.")
-@Examples({"player has played on this server before","player hasn\'t played before"})
-@Since("1.4, 2.7 (multiple players)")
-public class CondPlayedBefore
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Projectile Can Bounce")
-@Description("Whether or not a projectile can bounce.")
-@Examples({"on shoot:","\tsend \"Boing!\" to all players if projectile can bounce"})
-@Since("2.5.1")
-public class CondProjectileCanBounce
-extends PropertyCondition<org.bukkit.entity.Projectile>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.conditions.base.PropertyCondition
@Name("PvP")
-@Description("Checks the PvP state of a world.")
-@Examples({"PvP is enabled","PvP is disabled in \"world\""})
-@Since("1.3.4")
-public class CondPvP
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Resource Pack")
-@Description("Checks state of the resource pack in a <a href=\'events.html#resource_pack_request_action\'>resource pack request response</a> event.")
-@Examples({"on resource pack response:","\tif the resource pack wasn\'t accepted:","\t\tkick the player due to \"You have to install the resource pack to play in this server!\""})
-@Since("2.4")
-@Events("resource pack request response")
-public class CondResourcePack
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Bed/Anchor Spawn")
-@Description("Checks what the respawn location of a player in the respawn event is.")
-@Examples({"on respawn:","\tthe respawn location is a bed","\tbroadcast \"%player% is respawning in their bed! So cozy!\""})
-@RequiredPlugins("Minecraft 1.16+")
-@Since("2.7")
-@Events("respawn")
-public class CondRespawnLocation
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Script Loaded")
-@Description("Check if the current script, or another script, is currently loaded.")
-@Examples({"script is loaded","script \"example.sk\" is loaded"})
-@Since("2.2-dev31")
-public class CondScriptLoaded
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Starts/Ends With")
-@Description("Checks if a text starts or ends with another.")
-@Examples({"if the argument starts with \"test\" or \"debug\":","\tsend \"Stop!\""})
-@Since("2.2-dev36, 2.5.1 (multiple strings support)")
-public class CondStartsEndsWith
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Egg Will Hatch")
-@Description("Whether the egg will hatch in a Player Egg Throw event.")
-@Examples({"on player egg throw:","\tif an entity won\'t hatch:","\t\tsend \"Better luck next time!\" to the player"})
-@Events("Egg Throw")
-@Since("2.7")
-public class CondWillHatch
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Within Radius")
-@Description("Checks whether a location is within a certain radius of another location.")
-@Examples({"on damage:","\tif attacker\'s location is within 10 blocks around {_spawn}:","\t\tcancel event","\t\tsend \"You can\'t PVP in spawn.\""})
-@Since("2.7")
-public class CondWithinRadius
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
Returns the enum constant of this class with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this class. (Extraneous whitespace characters are
-not permitted.)
-
-
Parameters:
-
name - the name of the enum constant to be returned.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
This class can be used for an easier writing of conditions that contain only one type in the pattern,
- and are in one of the following forms:
-
- something is something
- something can something
- something has something
-
- The plural and negated forms are also supported.
@Name("Delay")
-@Description("Delays the script\'s execution by a given timespan. Please note that delays are not persistent, e.g. trying to create a tempban script with <code>ban player \u2192 wait 7 days \u2192 unban player</code> will not work if you restart your server anytime within these 7 days. You also have to be careful even when using small delays!")
-@Examples({"wait 2 minutes","halt for 5 minecraft hours","wait a tick"})
-@Since("1.4")
-public class Delay
-extends Effect
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Action Bar")
-@Description("Sends an action bar message to the given player(s).")
-@Examples("send action bar \"Hello player!\" to player")
-@Since("2.3")
-public class EffActionBar
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Ban")
-@Description({"Bans or unbans a player or an IP address.","If a reason is given, it will be shown to the player when they try to join the server while banned.","A length of ban may also be given to apply a temporary ban. If it is absent for any reason, a permanent ban will be used instead.","We recommend that you test your scripts so that no accidental permanent bans are applied.","","Note that banning people does not kick them from the server.","Consider using the <a href=\'effects.html#EffKick\'>kick effect</a> after applying a ban."})
-@Examples({"unban player","ban \"127.0.0.1\"","IP-ban the player because \"he is an idiot\"","ban player due to \"inappropriate language\" for 2 days"})
-@Since("1.4, 2.1.1 (ban reason), 2.5 (timespan)")
-public class EffBan
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Break Block")
-@Description({"Breaks the block and spawns items as if a player had mined it","\nYou can add a tool, which will spawn items based on how that tool would break the block ","(ie: When using a hand to break stone, it drops nothing, whereas with a pickaxe it drops cobblestone)"})
-@Examples({"on right click:","\tbreak clicked block naturally","loop blocks in radius 10 around player:","\tbreak loop-block using player\'s tool","loop blocks in radius 10 around player:","\tbreak loop-block naturally using diamond pickaxe"})
-@Since("2.4")
-public class EffBreakNaturally
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Broadcast")
-@Description("Broadcasts a message to the server.")
-@Examples({"broadcast \"Welcome %player% to the server!\"","broadcast \"Woah! It\'s a message!\""})
-@Since("1.0, 2.6 (broadcasting objects), 2.6.1 (using advanced formatting)")
-public class EffBroadcast
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Cancel Command Cooldown")
-@Description("Only usable in commands. Makes it so the current command usage isn\'t counted towards the cooldown.")
-@Examples({"command /nick <text>:","\texecutable by: players","\tcooldown: 10 seconds","\ttrigger:","\t\tif length of arg-1 is more than 16:","\t\t\t# Makes it so that invalid arguments don\'t make you wait for the cooldown again","\t\t\tcancel the cooldown","\t\t\tsend \"Your nickname may be at most 16 characters.\"","\t\t\tstop","\t\tset the player\'s display name to arg-1"})
-@Since("2.2-dev34")
-public class EffCancelCooldown
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Cancel Drops")
-@Description("Cancels drops of items or experiences in a death or block break event. Please note that this doesn\'t keep items or experiences of a dead player. If you want to do that, use the <a href=\'effects.html#EffKeepInventory\'>Keep Inventory / Experience</a> effect.")
-@Examples({"on death of a zombie:","\tif name of the entity is \"&cSpecial\":","\t\tcancel drops of items","","on break of a coal ore:","\tcancel the experience drops"})
-@Since("2.4")
-@RequiredPlugins("1.12.2 or newer (cancelling item drops of blocks)")
-@Events({"death","break / mine"})
-public class EffCancelDrops
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Cancel Event")
-@Description("Cancels the event (e.g. prevent blocks from being placed, or damage being taken).")
-@Examples({"on damage:","\tvictim is a player","\tvictim has the permission \"skript.god\"","\tcancel the event"})
-@Since("1.0")
-public class EffCancelEvent
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
vars - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Change: Set/Add/Remove/Delete/Reset")
-@Description("A very general effect that can change many <a href=\'./expressions\'>expressions</a>. Many expressions can only be set and/or deleted, while some can have things added to or removed from them.")
-@Examples({"# set:","Set the player\'s display name to \"<red>%name of player%\"","set the block above the victim to lava","# add:","add 2 to the player\'s health # preferably use \'<a href=\'#EffHealth\'>heal</a>\' for this","add argument to {blacklist::*}","give a diamond pickaxe of efficiency 5 to the player","increase the data value of the clicked block by 1","# remove:","remove 2 pickaxes from the victim","subtract 2.5 from {points::%uuid of player%}","# remove all:","remove every iron tool from the player","remove all minecarts from {entitylist::*}","# delete:","delete the block below the player","clear drops","delete {variable}","# reset:","reset walk speed of player","reset chunk at the targeted block"})
-@Since("1.0 (set, add, remove, delete), 2.0 (remove all)")
-public class EffChange
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Charge Creeper")
-@Description("Charges or uncharges a creeper. A creeper is charged when it has been struck by lightning.")
-@Examples({"on spawn of creeper:","\tcharge the event-entity"})
-@Since("2.5")
-public class EffChargeCreeper
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Color Items")
-@Description("Colors items in a given <a href=\'classes.html#color\'>color</a>. You can also use RGB codes if you feel limited with the 16 default colors. RGB codes are three numbers from 0 to 255 in the order <code>(red, green, blue)</code>, where <code>(0,0,0)</code> is black and <code>(255,255,255)</code> is white. Armor is colorable for all Minecraft versions. With Minecraft 1.11 or newer you can also color potions and maps. Note that the colors might not look exactly how you\'d expect.")
-@Examples({"dye player\'s helmet blue","color the player\'s tool red"})
-@Since("2.0, 2.2-dev26 (maps and potions)")
-public class EffColorItems
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Command")
-@Description({"Executes a command. This can be useful to use other plugins in triggers.","If the command is a bungeecord side command, you can use the [bungeecord] option to execute command on the proxy."})
-@Examples({"make player execute command \"/home\"","execute console command \"/say Hello everyone!\"","execute player bungeecord command \"/alert &6Testing Announcement!\""})
-@Since("1.0, INSERT VERSION (bungeecord command)")
-public class EffCommand
-extends Effect
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Connect")
-@Description("Connects a player to another bungeecord server")
-@Examples("connect all players to \"hub\"")
-@Since("2.3")
-public class EffConnect
-extends Effect
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Continue")
-@Description("Immediately moves the (while) loop on to the next iteration.")
-@Examples({"# Broadcast online moderators","loop all players:","\tif loop-value does not have permission \"moderator\":","\t\tcontinue # filter out non moderators","\tbroadcast \"%loop-player% is a moderator!\" # Only moderators get broadcast"," ","# Game starting counter","set {_counter} to 11","while {_counter} > 0:","\tremove 1 from {_counter}","\twait a second","\tif {_counter} != 1, 2, 3, 5 or 10:","\t\tcontinue # only print when counter is 1, 2, 3, 5 or 10","\tbroadcast \"Game starting in %{_counter}% second(s)\""})
-@Since("2.2-dev37, 2.7 (while loops)")
-public class EffContinue
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Do If")
-@Description("Execute an effect if a condition is true.")
-@Examples({"on join:","\tgive a diamond to the player if the player has permission \"rank.vip\""})
-@Since("2.3")
-public class EffDoIf
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Drop")
-@Description("Drops one or more items.")
-@Examples({"on death of creeper:","\tdrop 1 TNT"})
-@Since("1.0")
-public class EffDrop
-extends Effect
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Enchant/Disenchant")
-@Description("Enchant or disenchant an existing item.")
-@Examples({"enchant the player\'s tool with sharpness 5","disenchant the player\'s tool"})
-@Since("2.0")
-public class EffEnchant
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Equip")
-@Description("Equips or unequips an entity with some given armor. This will replace any armor that the entity is wearing.")
-@Examples({"equip player with diamond helmet","equip player with all diamond armor","unequip diamond chestplate from player","unequip all armor from player","unequip player\'s armor"})
-@Since("1.0, 2.7 (multiple entities, unequip)")
-public class EffEquip
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Exit")
-@Description("Exits a given amount of loops and conditionals, or the entire trigger.")
-@Examples({"if player has any ore:","\tstop","message \"%player% has no ores!\"","loop blocks above the player:","\tloop-block is not air:","\t\texit 2 sections","\tset loop-block to water"})
-@Since("<i>unknown</i> (before 2.1)")
-public class EffExit
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Explode Creeper")
-@Description("Starts the explosion process of a creeper or instantly explodes it.")
-@Examples({"start explosion of the last spawned creeper","stop ignition of the last spawned creeper"})
-@Since("2.5")
-@RequiredPlugins("Paper 1.13 or newer/Spigot 1.14 or newer. Ignition can be stopped on Paper 1.13 or newer.")
-public class EffExplodeCreeper
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Explosion")
-@Description({"Creates an explosion of a given force. The Minecraft Wiki has an <a href=\'https://www.minecraftwiki.net/wiki/Explosion\'>article on explosions</a> which lists the explosion forces of TNT, creepers, etc.","Hint: use a force of 0 to create a fake explosion that does no damage whatsoever, or use the explosion effect introduced in Skript 2.0.","Starting with Bukkit 1.4.5 and Skript 2.0 you can use safe explosions which will damage entities but won\'t destroy any blocks."})
-@Examples({"create an explosion of force 10 at the player","create an explosion of force 0 at the victim"})
-@Since("1.0")
-public class EffExplosion
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Feed")
-@Description("Feeds the specified players.")
-@Examples({"feed all players","feed the player by 5 beefs"})
-@Since("2.2-dev34")
-public class EffFeed
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Launch firework")
-@Description("Launch firework effects at the given location(s).")
-@Examples("launch ball large colored red, purple and white fading to light green and black at player\'s location with duration 1")
-@Since("2.4")
-public class EffFireworkLaunch
-extends Effect
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Force Attack")
-@Description("Makes a living entity attack an entity with a melee attack.")
-@Examples({"spawn a wolf at player\'s location","make last spawned wolf attack player"})
-@Since("2.5.1")
-@RequiredPlugins("Minecraft 1.15.2+")
-public class EffForceAttack
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Handedness")
-@Description("Make mobs left or right-handed. This does not affect players.")
-@Examples({"spawn skeleton at spawn of world \"world\":","\tmake entity left handed","","make all zombies in radius 10 of player right handed"})
-@Since("INSERT VERSION")
-@RequiredPlugins("Paper 1.17.1+")
-public class EffHandedness
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Damage/Heal/Repair")
-@Description("Damage/Heal/Repair an entity, or item.")
-@Examples({"damage player by 5 hearts","heal the player","repair tool of player"})
-@Since("1.0")
-public class EffHealth
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Hide Player from Server List")
-@Description("Hides a player from the <a href=\'expressions.html#ExprHoverList\'>hover list</a> and decreases the <a href=\'expressions.html#ExprOnlinePlayersCount\'>online players count</a> (only if the player count wasn\'t changed before).")
-@Examples({"on server list ping:","\thide {vanished::*} from the server list"})
-@Since("2.3")
-public class EffHidePlayerFromServerList
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Ignite/Extinguish")
-@Description("Lights entities on fire or extinguishes them.")
-@Examples({"ignite the player","extinguish the player"})
-@Since("1.4")
-public class EffIgnite
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Make Incendiary")
-@Description("Sets if an entity\'s explosion will leave behind fire. This effect is also usable in an explosion prime event.")
-@Examples({"on explosion prime:","\tmake the explosion fiery"})
-@Since("2.5")
-public class EffIncendiary
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Make Invisible")
-@Description({"Makes a living entity visible/invisible. This is not a potion and therefore does not have features such as a time limit or particles.","When setting an entity to invisible while using an invisibility potion on it, the potion will be overridden and when it runs out the entity keeps its invisibility."})
-@Examples("make target entity invisible")
-@Since("2.7")
-public class EffInvisible
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Keep Inventory / Experience")
-@Description("Keeps the inventory or/and experiences of the dead player in a death event.")
-@Examples({"on death of a player:","\tif the victim is an op:","\t\tkeep the inventory and experiences"})
-@Since("2.4")
-@Events("death")
-public class EffKeepInventory
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Kick")
-@Description("Kicks a player from the server.")
-@Examples({"on place of TNT, lava, or obsidian:","\tkick the player due to \"You may not place %block%!\"","\tcancel the event"})
-@Since("1.0")
-public class EffKick
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Kill")
-@Description({"Kills an entity.","Note: This effect does not set the entity\'s health to 0 (which causes issues), but damages the entity by 100 times its maximum health."})
-@Examples({"kill the player","kill all creepers in the player\'s world","kill all endermen, witches and bats"})
-@Since("1.0")
-public class EffKill
-extends Effect
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Knockback")
-@Description("Apply the same velocity as a knockback to living entities in a direction. Mechanics such as knockback resistance will be factored in.")
-@Examples({"knockback player north","knock victim (vector from attacker to victim) with strength 10"})
-@Since("2.7")
-@RequiredPlugins("Paper 1.19.2+")
-public class EffKnockback
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Leash entities")
-@Description("Leash living entities to other entities.")
-@Examples("leash the player to the target entity")
-@Since("2.3")
-public class EffLeash
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Lightning")
-@Description("Strike lightning at a given location. Can use \'lightning effect\' to create a lightning that does not harm entities or start fires.")
-@Examples({"strike lightning at the player","strike lightning effect at the victim"})
-@Since("1.4")
-public class EffLightning
-extends Effect
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Load Server Icon")
-@Description({"Loads server icons from the given files. You can get the loaded icon using the","<a href=\'expressions.html#ExprLastLoadedServerIcon\'>last loaded server icon</a> expression.","Please note that the image must be 64x64 and the file path starts from the server folder."})
-@Examples({"on load:","\tclear {server-icons::*}","\tloop 5 times:","\t\tload server icon from file \"icons/%loop-number%.png\"","\t\tadd the last loaded server icon to {server-icons::*}","","on server list ping:","\tset the icon to a random server icon out of {server-icons::*}"})
-@Since("2.3")
-@RequiredPlugins("Paper 1.12.2 or newer")
-public class EffLoadServerIcon
-extends AsyncEffect
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Log")
-@Description({"Writes text into a .log file. Skript will write these files to /plugins/Skript/logs.","NB: Using \'server.log\' as the log file will write to the default server log. Omitting the log file altogether will log the message as \'[Skript] [<script>.sk] <message>\' in the server log."})
-@Examples({"on place of TNT:","\tlog \"%player% placed TNT in %world% at %location of block%\" to \"tnt/placement.log\""})
-@Since("2.0")
-public class EffLog
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Look At")
-@Description("Forces the mob(s) or player(s) to look at an entity, vector or location. Vanilla max head pitches range from 10 to 50.")
-@Examples({"force the head of the player to look towards event-entity\'s feet","","on entity explosion:","\tset {_player} to the nearest player","\t{_player} is set","\tdistance between {_player} and the event-location is less than 15","\tmake {_player} look towards vector from the {_player} to location of the event-entity","","force {_enderman} to face the block 3 meters above {_location} at head rotation speed 100.5 and max head pitch -40"})
-@Since("2.7")
-@RequiredPlugins("Paper 1.17+, Paper 1.19.1+ (Players & Look Anchors)")
-public class EffLook
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Make Egg Hatch")
-@Description("Makes the egg hatch in a Player Egg Throw event.")
-@Examples({"on player egg throw:","\t# EGGS FOR DAYZ!","\tmake the egg hatch"})
-@Events("Egg Throw")
-@Since("2.7")
-public class EffMakeEggHatch
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Make Fly")
-@Description("Forces a player to start/stop flying.")
-@Examples({"make player fly","force all players to stop flying"})
-@Since("2.2-dev34")
-public class EffMakeFly
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Make Say")
-@Description("Forces a player to send a message to the chat. If the message starts with a slash it will force the player to use command.")
-@Examples({"make the player say \"Hello.\"","force all players to send the message \"I love this server\""})
-@Since("2.3")
-public class EffMakeSay
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Message")
-@Description({"Sends a message to the given player. Only styles written","in given string or in <a href=expressions.html#ExprColored>formatted expressions</a> will be parsed.","Adding an optional sender allows the messages to be sent as if a specific player sent them.","This is useful with Minecraft 1.16.4\'s new chat ignore system, in which players can choose to ignore other players,","but for this to work, the message needs to be sent from a player."})
-@Examples({"message \"A wild %player% appeared!\"","message \"This message is a distraction. Mwahaha!\"","send \"Your kill streak is %{kill streak::%uuid of player%}%.\" to player","if the targeted entity exists:","\tmessage \"You\'re currently looking at a %type of the targeted entity%!\"","on chat:","\tcancel event","\tsend \"[%player%] >> %message%\" to all players from player"})
-@RequiredPlugins("Minecraft 1.16.4+ for optional sender")
-@Since("1.0, 2.2-dev26 (advanced features), 2.5.2 (optional sender), 2.6 (sending objects)")
-public class EffMessage
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("op/deop")
-@Description("Grant/revoke a user operator state.")
-@Examples({"op the player","deop all players"})
-@Since("1.0")
-public class EffOp
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Open Book")
-@Description("Opens a written book to a player.")
-@Examples("open book player\'s tool to player")
-@RequiredPlugins("Minecraft 1.14.2+")
-@Since("2.5.1")
-public class EffOpenBook
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Open/Close Inventory")
-@Description({"Opens an inventory to a player. The player can then access and modify the inventory as if it was a chest that he just opened.","Please note that currently \'show\' and \'open\' have the same effect, but \'show\' will eventually show an unmodifiable view of the inventory in the future."})
-@Examples({"show the victim\'s inventory to the player","open the player\'s inventory for the player"})
-@Since("2.0, 2.1.1 (closing), 2.2-Fixes-V10 (anvil), 2.4 (hopper, dropper, dispenser")
-public class EffOpenInventory
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Pathfind")
-@Description("Make an entity pathfind towards a location or another entity. Not all entities can pathfind. If the pathfinding target is another entity, the entities may or may not continuously follow the target.")
-@Examples({"make all creepers pathfind towards player","make all cows stop pathfinding","make event-entity pathfind towards player at speed 1"})
-@Since("2.7")
-@RequiredPlugins("Paper")
-public class EffPathfind
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Play Sound")
-@Description({"Plays a sound at given location for everyone or just for given players, or plays a sound to specified players. Both Minecraft sound names and <a href=\"https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html\">Spigot sound names</a> are supported. Playing resource pack sounds are supported too. The sound category is \'master\' by default. ","","Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself."})
-@Examples({"play sound \"block.note_block.pling\" # It is block.note.pling in 1.12.2","play sound \"entity.experience_orb.pickup\" with volume 0.5 to the player","play sound \"custom.music.1\" in jukebox category at {speakerBlock}"})
-@Since("2.2-dev28, 2.4 (sound categories)")
-public class EffPlaySound
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Player Info Visibility")
-@Description({"Sets whether all player related information is hidden in the server list.","The Vanilla Minecraft client will display ??? (dark gray) instead of player counts and will not show the","<a href=\'expressions.html#ExprHoverList\'>hover hist</a> when hiding player info.","<a href=\'expressions.html#ExprVersionString\'>The version string</a> can override the ???.","Also the <a href=\'expressions.html#ExprOnlinePlayersCount\'>Online Players Count</a> and","<a href=\'expressions.html#ExprMaxPlayers\'>Max Players</a> expressions will return -1 when hiding player info."})
-@Examples({"hide player info","hide player related information in the server list","reveal all player related info"})
-@Since("2.3")
-@RequiredPlugins("Paper 1.12.2 or newer")
-@Events("server list ping")
-public class EffPlayerInfoVisibility
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Player Visibility")
-@Description({"Change visibility of a player for the given players.","When reveal is used in combination of the <a href=\'expressions.html#ExprHiddenPlayers\'>hidden players</a> expression and the viewers are not specified, this will default it to the given player in the hidden players expression.","","Note: if a player was hidden and relogs, this player will be visible again."})
-@Examples({"on join:","\tif {vanished::%player\'s uuid%} is true:","\t\thide the player from all players","","reveal hidden players of {_player}"})
-@Since("2.3")
-public class EffPlayerVisibility
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Poison/Cure")
-@Description("Poison or cure a creature.")
-@Examples({"poison the player","poison the victim for 20 seconds","cure the player from poison"})
-@Since("1.3.2")
-public class EffPoison
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Potion Effects")
-@Description("Apply or remove potion effects to/from entities.")
-@Examples({"apply swiftness 2 to the player","remove haste from the victim","on join:","\tapply potion of strength of tier {strength.%player%} to the player for 999 days","apply potion effects of player\'s tool to player"})
-@Since("2.0, 2.2-dev27 (ambient and particle-less potion effects), 2.5 (replacing existing effect), 2.5.2 (potion effects)")
-public class EffPotion
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Push")
-@Description("Push entities around.")
-@Examples({"push the player upwards","push the victim downwards at speed 0.5"})
-@Since("1.4.6")
-public class EffPush
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("PvP")
-@Description("Set the PvP state for a given world.")
-@Examples({"enable PvP #(current world only)","disable PvP in all worlds"})
-@Since("1.3.4")
-public class EffPvP
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Replace")
-@Description("Replaces all occurrences of a given text with another text. Please note that you can only change variables and a few expressions, e.g. a <a href=\'./expressions.html#ExprMessage\'>message</a> or a line of a sign.")
-@Examples({"replace \"<item>\" in {textvar} with \"%item%\"","replace every \"&\" with \"\u00a7\" in line 1","# The following acts as a simple chat censor, but it will e.g. censor mass, hassle, assassin, etc. as well:","on chat:","\treplace all \"kys\", \"idiot\" and \"noob\" with \"****\" in the message"," ","replace all stone and dirt in player\'s inventory and player\'s top inventory with diamond"})
-@Since("2.0, 2.2-dev24 (replace in multiple strings and replace items in inventory), 2.5 (replace first, case sensitivity)")
-public class EffReplace
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Title - Reset")
-@Description("Resets the title of the player to the default values.")
-@Examples({"reset the titles of all players","reset the title"})
-@Since("2.3")
-public class EffResetTitle
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Force Respawn")
-@Description("Forces player(s) to respawn if they are dead. If this is called without delay from death event, one tick is waited before respawn attempt.")
-@Examples({"on death of player:","\tforce event-player to respawn"})
-@Since("2.2-dev21")
-public class EffRespawn
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Send Block Change")
-@Description("Makes a player see a block as something it really isn\'t. BlockData support is only for MC 1.13+")
-@Examples({"make player see block at player as dirt","make player see target block as campfire[facing=south]"})
-@Since("2.2-dev37c, 2.5.1 (block data support)")
-public class EffSendBlockChange
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Send Resource Pack")
-@Description({"Request that the player\'s client download and switch resource packs. The client will download ","the resource pack in the background, and will automatically switch to it once the download is complete. ","The URL must be a direct download link.","","The hash is used for caching, the player won\'t have to re-download the resource pack that way. ","The hash must be SHA-1, you can get SHA-1 hash of your resource pack using ","<a href=\"https://emn178.github.io/online-tools/sha1_checksum.html\">this online tool</a>.","","The <a href=\'events.html#resource_pack_request_action\'>resource pack request action</a> can be used to check ","status of the sent resource pack request."})
-@Examples({"on join:","\tsend the resource pack from \"URL\" with hash \"hash\" to the player"})
-@Since("2.4")
-public class EffSendResourcePack
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Title - Send")
-@Description({"Sends a title/subtitle to the given player(s) with optional fadein/stay/fadeout times for Minecraft versions 1.11 and above. ","","If you\'re sending only the subtitle, it will be shown only if there\'s a title displayed at the moment, otherwise it will be sent with the next title. To show only the subtitle, use: <code>send title \" \" with subtitle \"yourtexthere\" to player</code>.","","Note: if no input is given for the times, it will keep the ones from the last title sent, use the <a href=\'effects.html#EffResetTitle\'>reset title</a> effect to restore the default values."})
-@Examples({"send title \"Competition Started\" with subtitle \"Have fun, Stay safe!\" to player for 5 seconds","send title \"Hi %player%\" to player","send title \"Loot Drop\" with subtitle \"starts in 3 minutes\" to all players","send title \"Hello %player%!\" with subtitle \"Welcome to our server\" to player for 5 seconds with fadein 1 second and fade out 1 second","send subtitle \"Party!\" to all players"})
-@Since("2.3")
-public class EffSendTitle
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Shear")
-@Description("Shears or \'un-shears\' a sheep. Please note that no wool is dropped, this only sets the \'sheared\' state of the sheep.")
-@Examples({"on rightclick on a sheep holding a sword:","\tshear the clicked sheep"})
-@Since("2.0")
-public class EffShear
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Shoot")
-@Description("Shoots a projectile (or any other entity) from a given entity.")
-@Examples({"shoot an arrow","make the player shoot a creeper at speed 10","shoot a pig from the creeper"})
-@Since("1.4")
-public class EffShoot
-extends Effect
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Silence Entity")
-@Description("Controls whether or not an entity is silent.")
-@Examples("make target entity silent")
-@Since("2.5")
-public class EffSilence
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Stop Server")
-@Description("Stops or restarts the server. If restart is used when the restart-script spigot.yml option isn\'t defined, the server will stop instead.")
-@Examples({"stop the server","restart server"})
-@Since("2.5")
-public class EffStopServer
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Stop Sound")
-@Description({"Stops specific or all sounds from playing to a group of players. Both Minecraft sound names and <a href=\"https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html\">Spigot sound names</a> are supported. Resource pack sounds are supported too. The sound category is \'master\' by default. A sound can\'t be stopped from a different category. ","","Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself."})
-@Examples({"stop sound \"block.chest.open\" for the player","stop playing sounds \"ambient.underwater.loop\" and \"ambient.underwater.loop.additions\" to the player","stop all sound for all players","stop sound in record category"})
-@Since("2.4, 2.7 (stop all sounds)")
-@RequiredPlugins("MC 1.17.1 (stop all sounds)")
-public class EffStopSound
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Locally Suppress Warning")
-@Description("Suppresses target warnings from the current script.")
-@Examples({"locally suppress missing conjunction warnings","suppress the variable save warnings"})
-@Since("2.3")
-public class EffSuppressWarnings
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Swing Hand")
-@Description("Makes an entity swing their hand. This does nothing if the entity does not have an animation for swinging their hand.")
-@Examples("make player swing their main hand")
-@Since("2.5.1")
-@RequiredPlugins("Minecraft 1.15.2+")
-public class EffSwingHand
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Teleport")
-@Description({"Teleport an entity to a specific location. ","This effect is delayed by default on Paper, meaning certain syntax such as the return effect for functions cannot be used after this effect.","The keyword \'force\' indicates this effect will not be delayed, ","which may cause lag spikes or server crashes when using this effect to teleport entities to unloaded chunks."})
-@Examples({"teleport the player to {homes.%player%}","teleport the attacker to the victim"})
-@Since("1.0")
-public class EffTeleport
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Toggle")
-@Description("Toggle the state of a block.")
-@Examples({"# use arrows to toggle switches, doors, etc.","on projectile hit:","\tprojectile is arrow","\ttoggle the block at the arrow"})
-@Since("1.4")
-public class EffToggle
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
vars - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Toggle Picking Up Items")
-@Description("Determines whether living entities are able to pick up items or not")
-@Examples({"forbid player from picking up items","send \"You can no longer pick up items!\" to player","","on drop:","\tif player can\'t pick\tup items:","\t\tallow player to pick up items"})
-@Since("INSERT VERSION")
-public class EffToggleCanPickUpItems
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Toggle Flight")
-@Description("Toggle the <a href=\'expressions.html#ExprFlightMode\'>flight mode</a> of a player.")
-@Examples("allow flight to event-player")
-@Since("2.3")
-public class EffToggleFlight
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Tree")
-@Description({"Creates a tree.","This may require that there is enough space above the given location and that the block below is dirt/grass, but it is possible that the tree will just grow anyways, possibly replacing every block in its path."})
-@Examples("grow a tall redwood tree above the clicked block")
-@Since("1.0")
-public class EffTree
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Rotate Around Vector")
-@Description("Rotates a vector around another vector")
-@Examples("rotate {_v} around vector 1, 0, 0 by 90")
-@Since("2.2-dev28")
-public class EffVectorRotateAroundAnother
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
kleenean - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Rotate around XYZ")
-@Description("Rotates a vector around x, y, or z axis by some degrees")
-@Examples({"rotate {_v} around x-axis by 90","rotate {_v} around y-axis by 90","rotate {_v} around z-axis by 90 degrees"})
-@Since("2.2-dev28")
-public class EffVectorRotateXYZ
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
expressions - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vehicle")
-@Description("Makes an entity ride another entity, e.g. a minecart, a saddled pig, an arrow, etc.")
-@Examples({"make the player ride a saddled pig","make the attacker ride the victim"})
-@Since("2.0")
-public class EffVehicle
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Play Effect")
-@Description({"Plays a <a href=\'classes.html#visualeffect\'>visual effect</a> at a given location or on a given entity.","Please note that some effects can only be played on entities, e.g. wolf hearts or the hurt effect, and that these are always visible to all players."})
-@Examples({"play wolf hearts on the clicked wolf","show mob spawner flames at the targeted block to the player"})
-@Since("2.1")
-public class EffVisualEffect
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
@Name("Affected Entities")
-@Description("The affected entities in the <a href=\'events.html#aoe_cloud_effect\'>area cloud effect</a> event.")
-@Examples({"on area cloud effect:","\tloop affected entities:","\t\tif loop-value is a player:","\t\t\tsend \"WARNING: you\'ve step on an area effect cloud!\" to loop-value"})
-@Since("2.4")
-public class ExprAffectedEntities
-extends SimpleExpression<org.bukkit.entity.LivingEntity>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
Returns whether this value represents the default value of its type for the event, i.e. it can be replaced with a call to event.getXyz() if one knows the event & value type.
-
- This method might be removed in the future as it's better to check whether value == event.getXyz() for every value an expression returns.
@Name("Age of Block/Entity")
-@Description({"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"})
-@Since("2.7")
-public class ExprAge
-extends SimplePropertyExpression<Object,Integer>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("All Banned Players/IPs")
-@Description("Obtains the list of all banned players or IP addresses.")
-@Examples({"command /banlist:","\ttrigger:","\t\tsend all the banned players"})
-@Since("2.7")
-public class ExprAllBannedEntries
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("All commands")
-@Description("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%\""})
-@Since("2.6")
-public class ExprAllCommands
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Alphabetical Sort")
-@Description("Sorts given strings in alphabetical order.")
-@Examples("set {_list::*} to alphabetically sorted {_strings::*}")
-@Since("2.2-dev18b")
-public class ExprAlphabetList
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Altitude")
-@Description("Effectively an alias of \'y-<a href=\'#ExprCoordinate\'>coordinate</a> of \u2026\', it represents the height of some object above bedrock.")
-@Examples({"on damage:","\taltitude of the attacker is higher than the altitude of the victim","\tset damage to damage * 1.2"})
-@Since("1.4.3")
-public class ExprAltitude
-extends SimplePropertyExpression<org.bukkit.Location,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Amount")
-@Description({"The amount of something.","Please note that <code>amount of %items%</code> 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 <a href=\'#ExprItemAmount\'>item amount</a> 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.","","<pre>","{list::*} Structure<br>"," \u251c\u2500\u2500\u2500\u2500 {list::1}: 1<br>"," \u251c\u2500\u2500\u2500\u2500 {list::2}: 2<br>"," \u2502 \u251c\u2500\u2500\u2500\u2500 {list::2::1}: 3<br>"," \u2502 \u2502 \u2514\u2500\u2500\u2500\u2500 {list::2::1::1}: 4<br>"," \u2502 \u2514\u2500\u2500\u2500\u2500 {list::2::2}: 5<br>"," \u2514\u2500\u2500\u2500\u2500 {list::3}: 6","</pre>","","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!\"")
-@Since("1.0")
-public class ExprAmount
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Amount of Items")
-@Description("Counts how many of a particular <a href=\'./classes.html#itemtype\'>item type</a> are in a given inventory.")
-@Examples("message \"You have %number of ores in the player\'s inventory% ores in your inventory.\"")
-@Since("2.0")
-public class ExprAmountOfItems
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Anvil Repair Cost")
-@Description({"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:","\tif {AnvilRepairSaleActive} = true:","\t\twait a tick # recommended, to avoid client bugs","\t\tset anvil repair cost to anvil repair cost * 50%","\t\tsend \"Anvil repair sale is ON!\" to player","","on inventory click:","\tplayer have permission \"anvil.repair.max.bypass\"","\tset max repair cost of event-inventory to 99999"})
-@Since("INSERT VERSION")
-public class ExprAnvilRepairCost
-extends SimplePropertyExpression<org.bukkit.inventory.Inventory,Integer>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Anvil Text Input")
-@Description("An expression to get the name to be applied to an item in an anvil inventory.")
-@Examples({"on inventory click:","\ttype of event-inventory is anvil inventory","\tif the anvil input text of the event-inventory is \"FREE OP\":","\t\tban player"})
-@Since("2.7")
-public class ExprAnvilText
-extends SimplePropertyExpression<org.bukkit.inventory.Inventory,String>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Applied Enchantments")
-@Description({"The applied enchantments in an enchant event."," Deleting or removing the applied enchantments will prevent the item\'s enchantment."})
-@Examples({"on enchant:","\tset the applied enchantments to sharpness 10 and fire aspect 5"})
-@Events("enchant")
-@Since("2.5")
-public class ExprAppliedEnchantments
-extends SimpleExpression<EnchantmentType>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Argument")
-@Description({"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"})
-@Since("1.0, 2.7 (support for command events)")
-public class ExprArgument
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether the given 'loop-...' expression should match this loop, e.g. loop-block matches any loops that loop through blocks and loop-argument matches an
- argument loop.
-
- You should usually just return false as e.g. loop-block will automatically match the expression if its returnType is Block or a subtype of it.
@Name("Armour Slot")
-@Description("A part of a player\'s armour, 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"})
-@Since("1.0")
-public class ExprArmorSlot
-extends SimplePropertyExpression<org.bukkit.entity.LivingEntity,Slot>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Arrow Knockback Strength")
-@Description("An arrow\'s knockback strength.")
-@Examples({"on shoot:","\tevent-projectile is an arrow","\tset arrow knockback strength of event-projectile to 10"})
-@Since("2.5.1")
-public class ExprArrowKnockbackStrength
-extends SimplePropertyExpression<org.bukkit.entity.Projectile,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Arrows Stuck")
-@Description("The number of arrows stuck in a living entity.")
-@Examples("set arrows stuck in player to 5")
-@Since("2.5")
-public class ExprArrowsStuck
-extends SimplePropertyExpression<org.bukkit.entity.LivingEntity,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Arrow Attached Block")
-@Description("Returns the attached block of an arrow.")
-@Examples("set hit block of last shot arrow to diamond block")
-@Since("INSERT VERSION")
-public class ExprAttachedBlock
-extends SimplePropertyExpression<org.bukkit.entity.Projectile,org.bukkit.block.Block>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Attack Cooldown")
-@Description({"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:","\tif attack cooldown of attacker < 1:","\t\tset damage to 0","\t\tsend \"Your hit was too weak! wait until your weapon is fully charged next time.\" to attacker"})
-@Since("2.6.1")
-@RequiredPlugins("Minecraft 1.15+")
-public class ExprAttackCooldown
-extends SimplePropertyExpression<org.bukkit.entity.HumanEntity,Float>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Attacked")
-@Description("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:","\tvictim is a creeper","\tdamage the attacked by 1 heart"})
-@Since("1.3, 2.6.1 (projectile hit event)")
-@Events({"damage","death","projectile hit"})
-public class ExprAttacked
-extends SimpleExpression<org.bukkit.entity.Entity>
vars - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Attacker")
-@Description({"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:","\tattacker is a player","\thealth of attacker is less than or equal to 2","\tdamage victim by 1 heart"})
-@Since("1.3")
-@Events({"damage","death","destroy"})
-public class ExprAttacker
-extends SimpleExpression<org.bukkit.entity.Entity>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Bed")
-@Description({"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. <code>safe bed location</code>.","","NOTE: Offline players can not have their bed location changed, only online players."})
-@Examples({"if bed of player exists:","\tteleport player the the player\'s bed","else:","\tteleport 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"})
-@Since("2.0, 2.7 (offlineplayers, safe bed)")
-public class ExprBed
-extends SimplePropertyExpression<org.bukkit.OfflinePlayer,org.bukkit.Location>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Biome")
-@Description({"The biome at a certain location. Please note that biomes are only defined for x/z-columns","(i.e. the <a href=\'#ExprAltitude\'>altitude</a> (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:","\tloop all players:","\t\tbiome at loop-player is desert","\t\tdamage the loop-player by 1"})
-@Since("1.4.4, 2.6.1 (3D biomes)")
-public class ExprBiome
-extends PropertyExpression<org.bukkit.Location,org.bukkit.block.Biome>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Block")
-@Description({"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:","\tloop-block is obsidian","\tset loop-block to water","block is a chest:","\tclear the inventory of the block"})
-@Since("1.0")
-public class ExprBlock
-extends WrapperExpression<org.bukkit.block.Block>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Block Data")
-@Description("Get the <a href=\'classes.html#blockdata\'>block data</a> 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]"})
-@RequiredPlugins("Minecraft 1.13+")
-@Since("2.5, 2.5.2 (set)")
-public class ExprBlockData
-extends SimplePropertyExpression<org.bukkit.block.Block,org.bukkit.block.data.BlockData>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Block Hardness")
-@Description("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:"})
-@RequiredPlugins("Minecraft 1.13+")
-@Since("2.6")
-public class ExprBlockHardness
-extends SimplePropertyExpression<ItemType,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Block Sphere")
-@Description("All blocks in a sphere around a center, mostly useful for looping.")
-@Examples({"loop blocks in radius 5 around the player:","\tset loop-block to air"})
-@Since("1.0")
-public class ExprBlockSphere
-extends SimpleExpression<org.bukkit.block.Block>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
Checks whether the given 'loop-...' expression should match this loop, e.g. loop-block matches any loops that loop through blocks and loop-argument matches an
- argument loop.
-
- You should usually just return false as e.g. loop-block will automatically match the expression if its returnType is Block or a subtype of it.
@Name("Blocks")
-@Description({"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"})
-@Since("1.0, 2.5.1 (within/cuboid/chunk)")
-public class ExprBlocks
-extends SimpleExpression<org.bukkit.block.Block>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Book Pages")
-@Description({"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:","\tmessage \"Book Pages: %pages of event-item%\"","\tmessage \"Book Page 1: %page 1 of event-item%\"","","set page 1 of player\'s held item to \"Book writing\""})
-@Since("2.2-dev31, 2.7 (changers)")
-public class ExprBookPages
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Block Break Speed")
-@Description("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:","\tevent-block is set","\tsend \"Break Speed: %break speed for player%\" to player"})
-@Since("2.7")
-@RequiredPlugins("1.17+")
-public class ExprBreakSpeed
-extends SimpleExpression<Float>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Burn/Cook Time")
-@Description({"The time a furnace takes to burn an item in a <a href=\'events.html#fuel_burn\'>fuel burn</a> event.","Can also be used to change the burn/cook time of a placed furnace."})
-@Examples({"on fuel burn:","\tif fuel slot is coal:","\t\tset burning time to 1 tick"})
-@Since("2.3")
-public class ExprBurnCookTime
-extends PropertyExpression<org.bukkit.block.Block,Timespan>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Chat Format")
-@Description("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]\"")
-@Since("2.2-dev31")
-public class ExprChatFormat
-extends SimpleExpression<String>
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Chat Recipients")
-@Description("Recipients of chat events where this is called.")
-@Examples("chat recipients")
-@Since("2.2-Fixes-v7, 2.2-dev35 (clearing recipients)")
-public class ExprChatRecipients
-extends SimpleExpression<org.bukkit.entity.Player>
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Custom Chest Inventory")
-@Description("Returns a chest inventory with the given amount of rows and the name. Use the <a href=effects.html#EffOpenInventory>open inventory</a> effect to open it.")
-@Examples({"open chest inventory with 1 row named \"test\" to player","set {_inventory} to chest inventory with 1 row"})
-@Since("2.2-dev34")
-public class ExprChestInventory
-extends SimpleExpression<org.bukkit.inventory.Inventory>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Chunk")
-@Description("Returns the <a href=\'./classes.html#chunk\'>chunk</a> 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"})
-@Since("2.0, INSERT VERSION (loaded chunks)")
-public class ExprChunk
-extends SimpleExpression<org.bukkit.Chunk>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Clicked Block/Entity/Inventory/Slot")
-@Description("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:","\tshow the inventory of the clicked block to the player"})
-@Since("1.0, 2.2-dev35 (more clickable things)")
-@Events({"click","inventory click"})
-public class ExprClicked
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("View Distance of Client")
-@Description("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"})
-@RequiredPlugins("1.13.2+")
-@Since("2.5")
-public class ExprClientViewDistance
-extends SimplePropertyExpression<org.bukkit.entity.Player,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Cooldown Time/Remaining Time/Elapsed Time/Last Usage/Bypass Permission")
-@Description({"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:","\tcooldown: 10 seconds","\tcooldown message: You last teleported home %elapsed time% ago, you may teleport home again in %remaining time%.","\ttrigger:","\t\tteleport player to {home::%player%}"})
-@Since("2.2-dev33")
-public class ExprCmdCooldownInfo
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Color of")
-@Description("The <a href=\'./classes.html#color\'>color</a> of an item, can also be used to color chat messages with \"<%color of ...%>this text is colored!\".")
-@Examples({"on click on wool:","\tmessage \"This wool block is <%color of block%>%color of block%<reset>!\"","\tset the color of the block to black"})
-@Since("1.2")
-public class ExprColorOf
-extends PropertyExpression<Object,Color>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Colored / Uncolored")
-@Description({"Parses <color>s and, optionally, chat styles in a message or removes","any colors <i>and</i> chat styles from the message. Parsing all","chat styles requires this expression to be used in same line with","the <a href=effects.html#EffSend>send effect</a>."})
-@Examples({"on chat:","\tset message to colored message # Safe; only colors get parsed","command /fade <player>:","\ttrigger:","\t\tset display name of the player-argument to uncolored display name of the player-argument","command /format <text>:","\ttrigger:","\t\tmessage formatted text-argument # Safe, because we\'re sending to whoever used this command"})
-@Since("2.0")
-public class ExprColoured
-extends PropertyExpression<String,String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Command")
-@Description("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:","\tif {game::%player%::playing} is true:","\t\tif the command is not \"exit\":","\t\t\tmessage \"You\'re not allowed to use commands during the game\"","\t\t\tcancel the event"})
-@Since("2.0, 2.7 (support for script commands)")
-@Events("command")
-public class ExprCommand
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Command Info")
-@Description("Get information about a command.")
-@Examples({"main name 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"})
-@Since("2.6")
-public class ExprCommandInfo
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Command Sender")
-@Description({"The player or the console who sent a command. Mostly useful in <a href=\'commands\'>commands</a> and <a href=\'events.html#command\'>command events</a>.","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:","\tlog \"%executor% used command /%command% %arguments%\" to \"commands.log\""})
-@Since("2.0")
-@Events("command")
-public class ExprCommandSender
-extends EventValueExpression<org.bukkit.command.CommandSender>
@Name("Compass Target")
-@Description("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:","\tloop all players:","\t\tset the loop-player\'s compass target to location of {compass::target::%%loop-player%}"})
-@Since("2.0")
-public class ExprCompassTarget
-extends SimplePropertyExpression<org.bukkit.entity.Player,org.bukkit.Location>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Coordinate")
-@Description("Represents a given coordinate of a location. ")
-@Examples({"player\'s y-coordinate is smaller than 40:","\tmessage \"Watch out for lava!\""})
-@Since("1.4.3")
-public class ExprCoordinate
-extends SimplePropertyExpression<org.bukkit.Location,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Creeper Max Fuse Ticks")
-@Description("The max fuse ticks that a creeper has.")
-@Examples("set target entity\'s max fuse ticks to 20 #1 second")
-@Since("2.5")
-public class ExprCreeperMaxFuseTicks
-extends SimplePropertyExpression<org.bukkit.entity.LivingEntity,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Cursor Slot")
-@Description("The item which the player has on their cursor. This slot is always empty if player has no inventories open.")
-@Examples({"cursor slot of player is dirt","set cursor slot of player to 64 diamonds"})
-@Since("2.2-dev17")
-public class ExprCursorSlot
-extends SimplePropertyExpression<org.bukkit.entity.Player,Slot>
-
Cursor item slot is not actually an inventory slot, but an item which the player
- has in their cursor when any inventory is open for them.
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Custom Model Data")
-@Description("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"})
-@RequiredPlugins("1.14+")
-@Since("2.5")
-public class ExprCustomModelData
-extends SimplePropertyExpression<ItemType,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Damage")
-@Description("How much damage is done in a damage event, possibly ignoring armour, criticals and/or enchantments. Can be changed (remember that in Skript \'1\' is one full heart, not half a heart).")
-@Examples("increase the damage by 2")
-@Since("1.3.5")
-@Events("damage")
-public class ExprDamage
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Damage Cause")
-@Description("The <a href=\'./classes.html#damagecause\'>damage cause</a> of a damage event. Please click on the link for more information.")
-@Examples("damage cause is lava, fire or burning")
-@Since("2.0")
-public class ExprDamageCause
-extends EventValueExpression<org.bukkit.event.entity.EntityDamageEvent.DamageCause>
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
-
-
Specified by:
-
setTime in interface Expression<org.bukkit.event.entity.EntityDamageEvent.DamageCause>
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Damaged Item")
-@Description("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"})
-@Since("2.4")
-public class ExprDamagedItem
-extends PropertyExpression<ItemType,ItemType>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Date Ago/Later")
-@Description("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}"})
-@Since("2.2-dev33")
-public class ExprDateAgoLater
-extends SimpleExpression<Date>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Default Value")
-@Description("A shorthand expression for giving things a default value. If the first thing isn\'t set, the second thing will be returned.")
-@Examples("broadcast {score::%player\'s uuid%} otherwise \"%player% has no score!\"")
-@Since("2.2-dev36")
-public class ExprDefaultValue<T>
-extends SimpleExpression<T>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Usually, you want to override SimpleExpression.getConvertedExpr(Class[]).
- However, it may be useful to override this method if you have an expression with a return
- type that is unknown until runtime (like variables). Usually, you'll be fine with just
- the default implementation. This method is final on versions below 2.2-dev36.
@Name("Difference")
-@Description("The difference between two values, e.g. <a href=\'./classes.html#number\'>numbers</a>, <a href=\'./classes/#date\'>dates</a> or <a href=\'./classes/#time\'>times</a>.")
-@Examples({"if difference between {command::%player%::lastuse} and now is smaller than a minute:","\tmessage \"You have to wait a minute before using this command again!\""})
-@Since("1.4")
-public class ExprDifference
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Difficulty")
-@Description("The difficulty of a world.")
-@Examples("set the difficulty of \"world\" to hard")
-@Since("2.3")
-public class ExprDifficulty
-extends SimplePropertyExpression<org.bukkit.World,org.bukkit.Difficulty>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Direction")
-@Description("A helper expression for the <a href=\'classes.html#direction\'>direction type</a>.")
-@Examples({"thrust the player upwards","set the block behind the player to water","loop blocks above the player:","\tset {_rand} to a random integer between 1 and 10","\tset 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"})
-@Since("1.0 (basic), 2.0 (extended)")
-public class ExprDirection
-extends SimpleExpression<Direction>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Distance")
-@Description("The distance between two points.")
-@Examples({"if the distance between the player and {home::%uuid of player%} is smaller than 20:","\tmessage \"You\'re very close to your home!\""})
-@Since("1.0")
-public class ExprDistance
-extends SimpleExpression<Number>
vars - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Drops")
-@Description("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"})
-@Since("1.0")
-@Events("death")
-public class ExprDrops
-extends SimpleExpression<ItemType>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Drops Of Block")
-@Description("A list of the items that will drop when a block is broken.")
-@RequiredPlugins("Minecraft 1.15+ (\'as %entity%\')")
-@Examples({"on break of block:","\tgive drops of block using player\'s tool to player"})
-@Since("2.5.1")
-public class ExprDropsOfBlock
-extends SimpleExpression<ItemType>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Damage Value/Durability")
-@Description("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"})
-@Since("1.2, 2.7 (durability reversed)")
-public class ExprDurability
-extends SimplePropertyExpression<Object,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Element of")
-@Description({"The first, last or a random element of a set, e.g. a list variable.","See also: <a href=\'#ExprRandom\'>random</a>"})
-@Examples("give a random element out of {free items::*} to the player")
-@Since("2.0, 2.7 (relative to last element)")
-public class ExprElement
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Usually, you want to override SimpleExpression.getConvertedExpr(Class[]).
- However, it may be useful to override this method if you have an expression with a return
- type that is unknown until runtime (like variables). Usually, you'll be fine with just
- the default implementation. This method is final on versions below 2.2-dev36.
@Name("Enchant Item")
-@Description({"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:","\tset the enchanted item to a diamond chestplate","on enchant prepare:","\tset the enchant item to a wooden sword"})
-@Events({"enchant prepare","enchant"})
-@Since("2.5")
-public class ExprEnchantItem
-extends SimpleExpression<ItemType>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Enchanting Experience Cost")
-@Description({"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:","\tsend \"Cost: %the displayed enchanting cost%\" to player"})
-@Events("enchant")
-@Since("2.5")
-public class ExprEnchantingExpCost
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Enchantment Bonus")
-@Description("The enchantment bonus in an enchant prepare event. This represents the number of bookshelves affecting/surrounding the enchantment table.")
-@Examples({"on enchant:","\tsend \"There are %enchantment bonus% bookshelves surrounding this enchantment table!\" to player"})
-@Events("enchant prepare")
-@Since("2.5")
-public class ExprEnchantmentBonus
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Enchantment Level")
-@Description("The level of a particular <a href=\'classes.html#enchantment\'>enchantment</a> on an item.")
-@Examples({"player\'s tool is a sword of sharpness:","\tmessage \"You have a sword of sharpness %level of sharpness of the player\'s tool% equipped\""})
-@Since("2.0")
-public class ExprEnchantmentLevel
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
-
-
Specified by:
-
change in interface Expression<org.bukkit.enchantments.EnchantmentOffer>
@Name("Enchantment Offer Cost")
-@Description({"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")
-@Since("2.5")
-@RequiredPlugins("1.11 or newer")
-public class ExprEnchantmentOfferCost
-extends SimplePropertyExpression<org.bukkit.enchantments.EnchantmentOffer,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Item Enchantments")
-@Description("All the enchantments an <a href=\'classes.html#itemtype\'>item type</a> has.")
-@Examples("clear enchantments of event-item")
-@Since("2.2-dev36")
-public class ExprEnchantments
-extends SimpleExpression<EnchantmentType>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Ender Chest")
-@Description("The ender chest of a player.")
-@Examples("open the player\'s ender chest to the player")
-@Since("2.0")
-public class ExprEnderChest
-extends SimplePropertyExpression<org.bukkit.entity.Player,org.bukkit.inventory.Inventory>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Entities")
-@Description("All entities in all worlds, in a specific world, in a chunk or in a radius around a certain location, e.g. <code>all players</code>, <code>all creepers in the player\'s world</code>, or <code>players in radius 100 of the player</code>.")
-@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"})
-@Since("1.2.1, 2.5 (chunks)")
-public class ExprEntities
-extends SimpleExpression<org.bukkit.entity.Entity>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether the given 'loop-...' expression should match this loop, e.g. loop-block matches any loops that loop through blocks and loop-argument matches an
- argument loop.
-
- You should usually just return false as e.g. loop-block will automatically match the expression if its returnType is Block or a subtype of it.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
@Name("Creature/Entity/Player/Projectile/Villager/Powered Creeper/etc.")
-@Description({"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"})
-@Since("1.0")
-public class ExprEntity
-extends SimpleExpression<org.bukkit.entity.Entity>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Usually, you want to override SimpleExpression.getConvertedExpr(Class[]).
- However, it may be useful to override this method if you have an expression with a return
- type that is unknown until runtime (like variables). Usually, you'll be fine with just
- the default implementation. This method is final on versions below 2.2-dev36.
@Name("Entity Attribute")
-@Description({"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:","\tsend \"You are wounded!\"","\tset victim\'s attack speed attribute to 2"})
-@Since("2.5, 2.6.1 (final attribute value)")
-public class ExprEntityAttribute
-extends PropertyExpression<org.bukkit.entity.Entity,Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Entity Owner")
-@Description("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"})
-@Since("2.5")
-public class ExprEntityTamer
-extends SimplePropertyExpression<org.bukkit.entity.LivingEntity,org.bukkit.OfflinePlayer>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
vars - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Initiator Inventory")
-@Description("Returns the initiator inventory in an on <a href=\"./events.html?search=#inventory_item_move\">inventory item move</a> event.")
-@Examples({"on inventory item move:","\tif holder of event-initiator-inventory is a chest:","broadcast \"Item transport requested at %location at holder of event-initiator-inventory%...\""})
-@Events("Inventory Item Move")
-@Since("INSERT VERSION")
-public class ExprEvtInitiator
-extends EventValueExpression<org.bukkit.inventory.Inventory>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Exhaustion")
-@Description("The exhaustion of a player. This is mainly used to determine the rate of hunger depletion.")
-@Examples("set exhaustion of all players to 1")
-@Since("2.2-dev35")
-public class ExprExhaustion
-extends SimplePropertyExpression<org.bukkit.entity.Player,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Experience")
-@Description("How much experience was spawned in an experience spawn or block break event. Can be changed.")
-@Examples({"on experience spawn:","\tadd 5 to the spawned experience","on break of coal ore:","\tclear dropped experience","on break of diamond ore:","\tif tool of player = diamond pickaxe:","\t\tadd 100 to dropped experience"})
-@Since("2.1, 2.5.3 (block break event), 2.7 (experience change event)")
-@Events({"experience spawn","break / mine","experience change"})
-public class ExprExperience
-extends SimpleExpression<Experience>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Exploded Blocks")
-@Description("Get all the blocks that were destroyed in an explode event")
-@Examples({"on explode:","\tloop exploded blocks:","\t\tadd loop-block to {exploded::blocks::*}"})
-@Events("explode")
-@Since("2.5")
-public class ExprExplodedBlocks
-extends SimpleExpression<org.bukkit.block.Block>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Explosion Block Yield")
-@Description({"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%"})
-@Events("explosion")
-@Since("2.5")
-public class ExprExplosionBlockYield
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Explosion Yield")
-@Description({"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 <a href=\'https://minecraft.gamepedia.com/Explosion\'>this wiki page</a> for more information"})
-@Examples({"on explosion prime:","\tset the yield of the explosion to 10"})
-@Events("explosion prime")
-@Since("2.5")
-public class ExprExplosionYield
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Explosive Yield")
-@Description({"The yield of an explosive (creeper, primed tnt, fireball, etc.). This is how big of an explosion is caused by the entity.","Read <a href=\'https://minecraft.gamepedia.com/Explosion\'>this wiki page</a> for more information"})
-@Examples({"on spawn of a creeper:","\tset the explosive yield of the event-entity to 10"})
-@RequiredPlugins("Minecraft 1.12 or newer for creepers")
-@Since("2.5")
-public class ExprExplosiveYield
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Head location")
-@Description({"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:"})
-@Since("2.0")
-public class ExprEyeLocation
-extends SimplePropertyExpression<org.bukkit.entity.LivingEntity,org.bukkit.Location>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Facing")
-@Description("The facing of an entity or block, i.e. exactly north, south, east, west, up or down (unlike <a href=\'#ExprDirection\'>direction</a> 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:","\tset loop-block to cobblestone"})
-@Since("1.4")
-public class ExprFacing
-extends SimplePropertyExpression<Object,Direction>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Fall Distance")
-@Description("The distance an entity has fallen for.")
-@Examples({"set all entities\' fall distance to 10","on damage:","\tsend \"%victim\'s fall distance%\" to victim"})
-@Since("2.5")
-public class ExprFallDistance
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
@Name("Filter Input")
-@Description("Represents the input in a filter expression. 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.")
-@Examples("send \"congrats on being staff!\" to all players where [input has permission \"staff\"]")
-@Since("2.2-dev36")
-public static class ExprFilter.ExprInput<T>
-extends SimpleExpression<T>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Usually, you want to override SimpleExpression.getConvertedExpr(Class[]).
- However, it may be useful to override this method if you have an expression with a return
- type that is unknown until runtime (like variables). Usually, you'll be fine with just
- the default implementation. This method is final on versions below 2.2-dev36.
@Name("Filter")
-@Description("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\"]")
-@Since("2.2-dev36")
-public class ExprFilter
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
Checks whether the given 'loop-...' expression should match this loop, e.g. loop-block matches any loops that loop through blocks and loop-argument matches an
- argument loop.
-
- You should usually just return false as e.g. loop-block will automatically match the expression if its returnType is Block or a subtype of it.
@Name("Final Damage")
-@Description("How much damage is done in a damage event, considering all types of damage reduction. Can NOT be changed.")
-@Examples("send \"%final damage%\" to victim")
-@Since("2.2-dev19")
-@Events("damage")
-public class ExprFinalDamage
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
@Name("Entity Fire Burn Duration")
-@Description("How much time an entity will be burning for.")
-@Examples("send \"You will stop burning in %fire time of player%\"")
-@Since("2.7")
-public class ExprFireTicks
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Timespan>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Firework Effect")
-@Description("Represents a \'firework effect\' which can be used in the <a href=\'effects.html#EffFireworkLaunch\'>launch firework</a> 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"})
-@Since("2.4")
-public class ExprFireworkEffect
-extends SimpleExpression<org.bukkit.FireworkEffect>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Flight Mode")
-@Description("Whether the player(s) are allowed to fly. Use <a href=effects.html#EffMakeFly>Make Fly</a> effect to force player(s) to fly.")
-@Examples({"set flight mode of player to true","send \"%flying state of all players%\""})
-@Since("2.2-dev34")
-public class ExprFlightMode
-extends SimplePropertyExpression<org.bukkit.entity.Player,Boolean>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Food Level")
-@Description("The food level of a player from 0 to 10. Has several aliases: food/hunger level/meter/bar. ")
-@Examples("set the player\'s food level to 10")
-@Since("1.0")
-public class ExprFoodLevel
-extends PropertyExpression<org.bukkit.entity.Player,Number>
vars - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Formatted Date")
-@Description("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 <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">Wikipedia article</a>.")
-@Examples({"command /date:","\ttrigger:","\t\tsend \"Full date: %now formatted human-readable%\" to sender","\t\tsend \"Short date: %now formatted as \"yyyy-MM-dd\"%\" to sender"})
-@Since("2.2-dev31, 2.7 (support variables in format)")
-public class ExprFormatDate
-extends PropertyExpression<Date,String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Freeze Time")
-@Description("How much time an entity has been in powdered snow for.")
-@Examples({"player\'s freeze time is less than 3 seconds:","\tsend \"you\'re about to freeze!\" to the player"})
-@Since("2.7")
-public class ExprFreezeTicks
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Timespan>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Furnace Slot")
-@Description({"A slot of a furnace, i.e. either the ore, fuel or result slot.","Remember to use \'<a href=\'#ExprBlock\'>block</a>\' and not \'furnace\', as \'furnace\' is not an existing expression."})
-@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"})
-@Since("1.0")
-@Events({"smelt","fuel burn"})
-public class ExprFurnaceSlot
-extends PropertyExpression<org.bukkit.block.Block,Slot>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Game Mode")
-@Description("The gamemode of a player. (<a href=\"classes.html#gamemode\">Gamemodes</a>)")
-@Examples({"player\'s gamemode is survival","set the player\'s gamemode to creative"})
-@Since("1.0")
-public class ExprGameMode
-extends PropertyExpression<org.bukkit.entity.Player,org.bukkit.GameMode>
vars - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Gliding State")
-@Description("Sets of gets gliding state of player. It allows you to set gliding state of entity even if they do not have an <a href=\"https://minecraft.gamepedia.com/Elytra\">Elytra</a> equipped.")
-@Examples("set gliding of player to off")
-@Since("2.2-dev21")
-public class ExprGlidingState
-extends SimplePropertyExpression<org.bukkit.entity.LivingEntity,Boolean>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Glowing")
-@Description("Indicates if targeted entity is glowing (new 1.9 effect) or not. Glowing entities can be seen through walls.")
-@Examples("set glowing of player to true")
-@Since("2.2-dev18")
-public class ExprGlowing
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Boolean>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Gravity")
-@Description("If entity is affected by gravity or not, i.e. if it has Minecraft 1.10+ NoGravity flag.")
-@Examples("set gravity of player off")
-@Since("2.2-dev21")
-public class ExprGravity
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Boolean>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Hanging Entity/Remover")
-@Description("Returns the hanging entity or remover in hanging <a href=\'./events.html#break_mine\'>break</a> and <a href=\'./events.html#place\'>place</a> events.")
-@Examples({"on break of item frame:","\tif item of hanging entity is diamond pickaxe:","\t\tcancel event","\t\tif hanging remover is a player:","\t\t\tsend \"You can\'t break that item frame!\" to hanging remover"})
-@Since("2.6.2")
-public class ExprHanging
-extends SimpleExpression<org.bukkit.entity.Entity>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Hash")
-@Description({"Hashes the given text using the MD5 or SHA-256 algorithms. Each algorithm is suitable for different use cases.<p>","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 <i>that</i> secure out of the box, so please consider using salt when dealing with passwords! ","When hashing data, you <strong>must</strong> specify algorithms that will be used for security reasons! ","<p>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>:","\ttrigger:","\t\tset {password::%uuid of player%} to text-argument hashed with SHA-256","command /login <text>:","\ttrigger:","\t\tif text-argument hashed with SHA-256 is {password::%uuid of player%}:","\t\t\tmessage \"Login successful.\"","\t\telse:","\t\t\tmessage \"Wrong password!\""})
-@Since("2.0, 2.2-dev32 (SHA-256 algorithm)")
-public class ExprHash
-extends PropertyExpression<String,String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Hatching Number")
-@Description({"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:","\tset the hatching number to 10"})
-@Events("Egg Throw")
-@Since("2.7")
-public class ExprHatchingNumber
-extends SimpleExpression<Byte>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Hatching Entity Type")
-@Description("The type of the entity that will be hatched in a Player Egg Throw event.")
-@Examples({"on player egg throw:","\tset the hatching entity type to a primed tnt"})
-@Events("Egg Throw")
-@Since("2.7")
-public class ExprHatchingType
-extends SimpleExpression<EntityData<?>>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Heal Amount")
-@Description("The amount of health healed in a healing event.")
-@Examples({"increase heal amount by 2","remove 0.5 from heal amount"})
-@Since("2.5.1")
-@Events("heal")
-public class ExprHealAmount
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Heal Reason")
-@Description("The <a href=\'./classes.html#healreason\'>heal reason</a> of a heal event. Please click on the link for more information.")
-@Examples({"on heal:","\tif heal reason = satiated:","\t\tsend \"You ate enough food and gained health back!\" to player"})
-@Since("2.5")
-public class ExprHealReason
-extends SimpleExpression<org.bukkit.event.entity.EntityRegainHealthEvent.RegainReason>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Health")
-@Description("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.\"")
-@Since("1.0")
-@Events("damage")
-public class ExprHealth
-extends PropertyExpression<org.bukkit.entity.LivingEntity,Number>
vars - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Hidden Players")
-@Description("The players hidden from a player that were hidden using the <a href=\'effects.html#EffPlayerVisibility\'>player visibility</a> effect.")
-@Examples("message \"<light red>You are currently hiding: <light gray>%hidden players of the player%\"")
-@Since("2.3")
-public class ExprHiddenPlayers
-extends SimpleExpression<org.bukkit.entity.Player>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Highest Solid Block")
-@Description("Returns the highest solid block at the x and z coordinates of the world of a given location.")
-@Examples("highest block at location of arg-player")
-@Since("2.2-dev34")
-public class ExprHighestSolidBlock
-extends SimplePropertyExpression<org.bukkit.Location,org.bukkit.block.Block>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Hostname")
-@Description("The hostname used by the connecting player to connect to the server in a <a href=\'events.html#connect\'>connect</a> event.")
-@Examples({"on connect:","\thostname is \"testers.example.com\"","\tsend \"Welcome back tester!\""})
-@Since("2.6.1")
-public class ExprHostname
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Hotbar Slot")
-@Description({"The currently selected hotbar <a href=\'./classes.html#slot\'>slot</a>.","To retrieve its number use <a href=\'#ExprSlotIndex\'>Slot Index</a> 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:","\tif the selected hotbar slot was a diamond:","\t\tset the currently selected hotbar slot to slot 5 of player"})
-@Since("2.2-dev36")
-public class ExprHotbarSlot
-extends PropertyExpression<org.bukkit.entity.Player,Slot>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Hover List")
-@Description({"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 <a href=\'events.html#server_list_ping\'>server list ping</a> 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 <a href=\'#ExprOnlinePlayersCount\'>fake online count</a>) 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:","\tclear the hover list","\tadd \"&aWelcome to the &6Minecraft &aserver!\" to the hover list","\tadd \"\" to the hover list # A blank line","\tadd \"&cThere are &6%online players count% &conline players!\" to the hover list"})
-@Since("2.3")
-@RequiredPlugins("Paper 1.12.2 or newer")
-@Events("server list ping")
-public class ExprHoverList
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("IP")
-@Description("The IP address of a player, or the connected player in a <a href=\'events.html#connect\'>connect</a> event, or the pinger in a <a href=\'events.html#server_list_ping\'>server list ping</a> event.")
-@Examples({"ban the IP address of the player","broadcast \"Banned the IP %IP of player%\"","","on connect:","\tlog \"[%now%] %player% (%ip%) is connected to the server.\"","","on server list ping:","\tsend \"%IP-address%\" to the console"})
-@Since("1.4, 2.2-dev26 (when used in connect event), 2.3 (when used in server list ping event)")
-public class ExprIP
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Index Of")
-@Description("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 <a href=\'#ExprIndexOf\'>length</a> of the text.")
-@Examples({"set {_first} to the first index of \"@\" in the text argument","if {_s} contains \"abc\":","\tset {_s} to the first (index of \"abc\" in {_s} + 3) characters of {_s} # removes everything after the first \"abc\" from {_s}"})
-@Since("2.1")
-public class ExprIndexOf
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Indices of List")
-@Description({"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"})
-@Since("2.4 (indices), 2.6.1 (sorting)")
-public class ExprIndices
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Inventory")
-@Description("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"})
-@Since("1.0")
-public class ExprInventory
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Inventory Action")
-@Description("The <a href=\'./classes.html#inventoryaction\'>inventory action</a> of an inventory event. Please click on the link for more information.")
-@Examples("inventory action is pickup all")
-@Since("2.2-dev16")
-public class ExprInventoryAction
-extends EventValueExpression<org.bukkit.event.inventory.InventoryAction>
@Name("Inventory Close Reason")
-@Description("The <a href=\'/classes.html#inventoryclosereason\'>inventory close reason</a> of an <a href=\'/events.html#inventory_close\'>inventory close event</a>.")
-@Examples({"on inventory close:","\tinventory close reason is teleport","\tsend \"Your inventory closed due to teleporting!\" to player"})
-@Events("Inventory Close")
-@RequiredPlugins("Paper")
-@Since("INSERT VERSION")
-public class ExprInventoryCloseReason
-extends EventValueExpression<org.bukkit.event.inventory.InventoryCloseEvent.Reason>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Inventory Holder/Viewers/Rows/Slots")
-@Description({"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"})
-@Since("2.2-dev34, 2.5 (slots)")
-public class ExprInventoryInfo
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Inventory Slot")
-@Description("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:","\tset slot 0 of player to 2 stones","\tremove 1 stone from slot 0 of player","\tadd 2 stones to slot 0 of player","\tclear slot 1 of player"})
-@Since("2.2-dev24")
-public class ExprInventorySlot
-extends SimpleExpression<Slot>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Item")
-@Description("The item involved in an event, e.g. in a drop, dispense, pickup or craft event.")
-@Examples({"on dispense:","\titem is a clock","\tset the time to 6:00"})
-@Since("<i>unknown</i> (before 2.1)")
-public class ExprItem
-extends EventValueExpression<org.bukkit.inventory.ItemStack>
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Item Amount")
-@Description("The amount of an <a href=\'classes.html#itemstack\'>item stack</a>.")
-@Examples("send \"You have got %item amount of player\'s tool% %player\'s tool% in your hand!\" to player")
-@Since("2.2-dev24")
-public class ExprItemAmount
-extends SimplePropertyExpression<Object,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Item Cooldown")
-@Description("Change the cooldown of a specific material to a certain amount of <a href=\'./classes.html#timespan\'>Timespan</a>.")
-@Examples({"on right click using stick:","\tset item cooldown of player\'s tool for player to 1 minute","\tset item cooldown of stone and grass for all players to 20 seconds","\treset item cooldown of cobblestone and dirt for all players"})
-@Since("INSERT VERSION")
-public class ExprItemCooldown
-extends SimpleExpression<Timespan>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Item of an Entity")
-@Description("An item associated with an entity. For dropped item entities, it gets, obviously, the item that was dropped. For item frames, the item inside the frame is returned. For throwable projectiles (snowballs, enderpearls etc.),it gets the displayed item. Other entities do not have items associated with them.")
-@Examples("")
-@Since("2.2-dev35, 2.2-dev36 (improved), 2.5.2 (throwable projectiles)")
-@RequiredPlugins("Minecraft 1.15.2+ (throwable projectiles)")
-public class ExprItemFrameSlot
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Slot>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Item with CustomModelData")
-@Description("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"})
-@RequiredPlugins("1.14+")
-@Since("2.5")
-public class ExprItemWithCustomModelData
-extends PropertyExpression<ItemType,ItemType>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
i - The index of the pattern which matched
-
kleenean - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Item with Lore")
-@Description({"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"})
-@Since("2.3")
-public class ExprItemWithLore
-extends PropertyExpression<ItemType,ItemType>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
kleenean - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Items")
-@Description("Items or blocks of a specific type, useful for looping.")
-@Examples({"loop items of type ore and log:","\tblock contains loop-item","\tmessage \"Theres at least one %loop-item% in this block\"","drop all blocks at the player # drops one of every block at the player"})
-@Since("1.0 pre-5")
-public class ExprItems
-extends SimpleExpression<ItemType>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
Checks whether the given 'loop-...' expression should match this loop, e.g. loop-block matches any loops that loop through blocks and loop-argument matches an
- argument loop.
-
- You should usually just return false as e.g. loop-block will automatically match the expression if its returnType is Block or a subtype of it.
@Name("Items In")
-@Description({"All 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:","\tloop-item is enchanted","\tremove loop-item from the player","set {inventory::%uuid of player%::*} to items in the player\'s inventory"})
-@Since("2.0")
-public class ExprItemsIn
-extends SimpleExpression<Slot>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
Checks whether the given 'loop-...' expression should match this loop, e.g. loop-block matches any loops that loop through blocks and loop-argument matches an
- argument loop.
-
- You should usually just return false as e.g. loop-block will automatically match the expression if its returnType is Block or a subtype of it.
@Name("Join & Split")
-@Description("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 with \"\" | \"\"%\" # %all players% would use the default \"x, y, and z\"","set {_s::*} to the string argument split at \",\""})
-@Since("2.1, 2.5.2 (regex support), 2.7 (case sensitivity)")
-public class ExprJoinSplit
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Language")
-@Description({"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")
-@Since("2.3")
-public class ExprLanguage
-extends SimplePropertyExpression<org.bukkit.entity.Player,String>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Last Attacker")
-@Description("The last block or entity that attacked an entity.")
-@Examples("send \"%last attacker of event-entity%\"")
-@Since("2.5.1")
-public class ExprLastAttacker
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Object>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Last Color")
-@Description("The colors used at the end of a string. The colors of the returned string will be formatted with their symbols.")
-@Examples("set {_color} to the last colors of \"<red>hey<blue>yo\"")
-@Since("2.6")
-public class ExprLastColor
-extends SimplePropertyExpression<String,String>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Last Damage")
-@Description("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")
-@Since("2.5.1")
-public class ExprLastDamage
-extends SimplePropertyExpression<org.bukkit.entity.LivingEntity,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Last Damage Cause")
-@Description("Cause of last damage done to an entity")
-@Examples("set last damage cause of event-entity to fire tick")
-@Since("2.2-Fixes-V10")
-public class ExprLastDamageCause
-extends PropertyExpression<org.bukkit.entity.LivingEntity,org.bukkit.event.entity.EntityDamageEvent.DamageCause>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
-
-
Specified by:
-
change in interface Expression<org.bukkit.event.entity.EntityDamageEvent.DamageCause>
@Name("Last Loaded Server Icon")
-@Description("Returns the last loaded server icon with the <a href=\'effects.html#EffLoadServerIcon\'>load server icon</a> effect.")
-@Examples("set {server-icon} to the last loaded server icon")
-@Since("2.3")
-@RequiredPlugins("Paper 1.12.2 or newer")
-public class ExprLastLoadedServerIcon
-extends SimpleExpression<org.bukkit.util.CachedServerIcon>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Last/First Login Time")
-@Description("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:","\ttrigger:","\t\tsend \"You have been online for %difference between player\'s last login and now%.\"","\t\tsend \"You first joined the server %difference between player\'s first login and now% ago.\""})
-@Since("2.5")
-public class ExprLastLoginTime
-extends SimplePropertyExpression<org.bukkit.OfflinePlayer,Date>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Last Resource Pack Response")
-@Description("Returns the last resource pack response received from a player.")
-@Examples("if player\'s last resource pack response is deny or download fail:")
-@Since("2.4")
-@RequiredPlugins("Paper 1.9 or newer")
-public class ExprLastResourcePackResponse
-extends SimplePropertyExpression<org.bukkit.entity.Player,org.bukkit.event.player.PlayerResourcePackStatusEvent.Status>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Last Spawned Entity")
-@Description("Holds the entity that was spawned most recently with the spawn effect (section), dropped with the <a href=\'../effects/#EffDrop\'>drop effect</a>, shot with the <a href=\'../effects/#EffShoot\'>shoot effect</a> or created with the <a href=\'../effects/#EffLightning\'>lightning effect</a>. 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"})
-@Since("1.3 (spawned entity), 2.0 (shot entity), 2.2-dev26 (dropped item), 2.7 (struck lightning, firework)")
-public class ExprLastSpawnedEntity
-extends SimpleExpression<org.bukkit.entity.Entity>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Leash Holder")
-@Description("The leash holder of a living entity.")
-@Examples("set {_example} to the leash holder of the target mob")
-@Since("2.3")
-public class ExprLeashHolder
-extends SimplePropertyExpression<org.bukkit.entity.LivingEntity,org.bukkit.entity.Entity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Level")
-@Description("The level of a player.")
-@Examples({"reduce the victim\'s level by 1","set the player\'s level to 0"})
-@Since("<i>unknown</i> (before 2.1)")
-@Events("level change")
-public class ExprLevel
-extends SimplePropertyExpression<org.bukkit.entity.Player,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Level Progress")
-@Description({"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. <code>increase the player\'s level progress by 0.5</code> 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:","\tplayer\'s level progress is larger than 0.2","\tshoot a fireball from the player","\treduce the player\'s level progress by 0.2","every 2 seconds:","\tloop all players:","\t\tlevel progress of loop-player is smaller than 0.9:","\t\t\tincrease level progress of the loop-player by 0.1","\t\telse:","\t\t\tset level progress of the loop-player to 0.99","on xp spawn:","\tcancel event"})
-@Since("2.0")
-@Events("level change")
-public class ExprLevelProgress
-extends SimplePropertyExpression<org.bukkit.entity.Player,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Light Level")
-@Description({"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:","\tloop all players:","\t\t{vampire::%uuid of loop-player%} is true","\t\tsunlight level at the loop-player is greater than 10","\t\tignite the loop-player for 5 seconds"})
-@Since("1.3.4")
-public class ExprLightLevel
-extends PropertyExpression<org.bukkit.Location,Byte>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Location")
-@Description("The location where an event happened (e.g. at an entity or block), or a location <a href=\'#ExprDirection\'>relative</a> 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"})
-@Since("2.0")
-public class ExprLocation
-extends WrapperExpression<org.bukkit.Location>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Location At")
-@Description("Allows to create a <a href=\'./classes.html#location\'>location</a> from three coordinates and a world.")
-@Examples({"set {_loc} to the location at arg-1, arg-2, arg-3 of the world arg-4","distance between the player and the location (0, 0, 0) is less than 200"})
-@Since("2.0")
-public class ExprLocationAt
-extends SimpleExpression<org.bukkit.Location>
-
FIXME doesn't parse - update documentation when fixed
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Create Location from Vector")
-@Description("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"})
-@Since("2.2-dev28")
-public class ExprLocationFromVector
-extends SimpleExpression<org.bukkit.Location>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Location")
-@Description({"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 <a href=\'#ExprEyeLocation\'>head location</a> 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%.\""})
-@Since("")
-public class ExprLocationOf
-extends WrapperExpression<org.bukkit.Location>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Loop Iteration")
-@Description("Returns the loop\'s current iteration count (for both normal and while loops).")
-@Examples({"while player is online:","\tgive player 1 stone","\twait 5 ticks","\tif loop-counter > 30:","\t\tstop loop","","loop {top-balances::*}:","\tif loop-iteration <= 10:","\t\tbroadcast \"##%loop-iteration% %loop-index% has $%loop-value%\""})
-@Since("INSERT VERSION")
-public class ExprLoopIteration
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Loop value")
-@Description("Returns the currently looped value.")
-@Examples({"# Countdown","loop 10 times:","\tmessage \"%11 - loop-number%\"","\twait 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:","\tloop blocks from the loop-block to the block 10 north of the loop-block:","\t\tset loop-block-2 to any wool","","loop {top-balances::*}:","\tloop-iteration <= 10","\tsend \"##%loop-iteration% %loop-index% has $%loop-value%\""})
-@Since("1.0, INSERT VERSION (loop-counter)")
-public class ExprLoopValue
-extends SimpleExpression<Object>
vars - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Loot")
-@Description("The loot that will be generated in a \'loot generate\' event.")
-@Examples({"on loot generate:","\tchance of %10","\tadd 64 diamonds","\tsend \"You hit the jackpot!!\""})
-@Since("2.7")
-@RequiredPlugins("MC 1.16+")
-public class ExprLoot
-extends SimpleExpression<org.bukkit.inventory.ItemStack>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("MOTD")
-@Description({"The message of the day in the server list. This can be changed in a <a href=\'events.html#server_list_ping\'>server list ping</a> event only.","\'default MOTD\' returns the default MOTD always and can\'t be changed."})
-@Examples({"on server list ping:","\tset the motd to \"Join now!\""})
-@Since("2.3")
-public class ExprMOTD
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Max Durability")
-@Description("The maximum durability of an item.")
-@Examples({"maximum durability of diamond sword","if max durability of player\'s tool is not 0: # Item is damageable"})
-@Since("2.5")
-public class ExprMaxDurability
-extends SimplePropertyExpression<Object,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Maximum Freeze Time")
-@Description("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:","\tsend \"you\'re about to freeze!\" to the player"})
-@Since("2.7")
-public class ExprMaxFreezeTicks
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Timespan>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Max Health")
-@Description("The maximum health of an entity, e.g. 10 for a player.")
-@Examples({"on join:","\tset the maximum health of the player to 100","spawn a giant","set the last spawned entity\'s max health to 1000"})
-@Since("2.0")
-@Events({"damage","death"})
-public class ExprMaxHealth
-extends SimplePropertyExpression<org.bukkit.entity.LivingEntity,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Max Minecart Speed")
-@Description("The maximum speed of a minecart.")
-@Examples({"on right click on minecart:","\tset max minecart speed of event-entity to 1"})
-@Since("2.5.1")
-public class ExprMaxMinecartSpeed
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Max Players")
-@Description({"The count of max players. This can be changed in a <a href=\'events.html#server_list_ping\'>server list ping</a> 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:","\tset the max players count to (online players count + 1)"})
-@RequiredPlugins("Paper 1.16+ (modify max real players)")
-@Since("2.3, 2.7 (modify max real players)")
-public class ExprMaxPlayers
-extends SimpleExpression<Integer>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Maximum Stack Size")
-@Description("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")
-@Since("2.1")
-public class ExprMaxStack
-extends SimplePropertyExpression<ItemType,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Me")
-@Description("A \'me\' expression that can be used in players\' effect commands only.")
-@Examples({"!heal me","!kick myself","!give a diamond axe to me"})
-@Since("2.1.1")
-public class ExprMe
-extends SimpleExpression<org.bukkit.entity.Player>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Mending Repair Amount")
-@Description({"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:","\tset the mending repair amount to 100"})
-@Since("2.5.1")
-public class ExprMendingRepairAmount
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Message")
-@Description("The (chat) message of a chat event, the join message of a join event, the quit message of a quit event, or the death message on a death event. This expression is mostly useful for being changed.")
-@Examples({"on chat:","\tplayer has permission \"admin\"","\tset message to \"&c%message%\"","","on first join:","\tset join message to \"Welcome %player% to our awesome server!\"","","on join:","\tplayer has played before","\tset join message to \"Welcome back, %player%!\"","","on quit:","\tset quit message to \"%player% left this awesome server!\"","","on death:","\tset the death message to \"%player% died!\""})
-@Since("1.4.6 (chat message), 1.4.9 (join & quit messages), 2.0 (death message)")
-@Events({"chat","join","quit","death"})
-public class ExprMessage
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Metadata")
-@Description("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"})
-@Since("2.2-dev36")
-public class ExprMetadata<T>
-extends SimpleExpression<T>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Usually, you want to override SimpleExpression.getConvertedExpr(Class[]).
- However, it may be useful to override this method if you have an expression with a return
- type that is unknown until runtime (like variables). Usually, you'll be fine with just
- the default implementation. This method is final on versions below 2.2-dev36.
@Name("Middle of Location")
-@Description("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:","\texecutable by: players","\ttrigger:","\t\tteleport player to the center of player\'s location","\t\tsend \"You\'re no longer stuck.\""})
-@Since("2.6.1")
-public class ExprMiddleOfLocation
-extends SimplePropertyExpression<org.bukkit.Location,org.bukkit.Location>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Minecart Derailed / Flying Velocity")
-@Description("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:","\tset derailed velocity of event-entity to vector 2, 10, 2"})
-@Since("2.5.1")
-public class ExprMinecartDerailedFlyingVelocity
-extends SimplePropertyExpression<org.bukkit.entity.Entity,org.bukkit.util.Vector>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Moon Phase")
-@Description("The current moon phase of a world.")
-@Examples({"if moon phase of player\'s world is full moon:","\tsend \"Watch for the wolves!\""})
-@Since("2.7")
-@RequiredPlugins("Paper 1.16+")
-public class ExprMoonPhase
-extends SimplePropertyExpression<org.bukkit.World,io.papermc.paper.world.MoonPhase>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Name / Display Name / Tab List Name")
-@Description({"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.","","<ul>","\t<li><strong>Players</strong>","\t\t<ul>","\t\t\t<li><strong>Name:</strong> The Minecraft account name of the player. Can\'t be changed, but \'display name\' can be changed.</li>","\t\t\t<li><strong>Display Name:</strong> 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).</li>","\t\t</ul>","\t</li>","\t<li><strong>Entities</strong>","\t\t<ul>","\t\t\t<li><strong>Name:</strong> 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\'.</li>","\t\t\t<li><strong>Display Name:</strong> The custom name of the entity. Can be changed, which will also enable <em>custom name visibility</em> of the entity so name tag of the entity will be visible always.</li>","\t\t</ul>","\t</li>","\t<li><strong>Items</strong>","\t\t<ul>","\t\t\t<li><strong>Name and Display Name:</strong> The <em>custom</em> name of the item (not the Minecraft locale name). Can be changed.</li>","\t\t</ul>","\t</li>","\t<li><strong>Inventories</strong>","\t\t<ul>","\t\t\t<li><strong>Name and Display Name:</strong> 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.</li>","\t\t</ul>","\t</li>","\t<li><strong>Gamerules (1.13+)</strong>","\t\t<ul>","\t\t\t<li><strong>Name:</strong> The name of the gamerule. Cannot be changed.</li>","\t\t</ul>","\t</li>","\t<li><strong>Worlds</strong>","\t\t<ul>","\t\t\t<li><strong>Name:</strong> The name of the world. Cannot be changed.</li>","\t\t</ul>","\t</li>","</ul>"})
-@Examples({"on join:","\tplayer has permission \"name.red\"","\tset the player\'s display name to \"<red>[admin] <gold>%name of player%\"","\tset the player\'s tab list name to \"<green>%player\'s name%\"","set the name of the player\'s tool to \"Legendary Sword of Awesomeness\""})
-@Since("before 2.1, 2.2-dev20 (inventory name), 2.4 (non-living entity support, changeable inventory name), 2.7 (worlds)")
-public class ExprName
-extends SimplePropertyExpression<Object,String>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Named Item/Inventory")
-@Description("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 <code>set <a href=\'#ExprName\'>name of <item/inventory></a> to <text></code>.")
-@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"})
-@Since("2.0, 2.2-dev34 (inventories)")
-public class ExprNamed
-extends PropertyExpression<Object,Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Nearest Entity")
-@Description("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:","\tkill nearest pig"})
-@Since("2.7")
-public class ExprNearestEntity
-extends SimpleExpression<org.bukkit.entity.Entity>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("No Damage Ticks")
-@Description("The number of ticks that an entity is invulnerable to damage for.")
-@Examples({"on damage:","\tset victim\'s invulnerability ticks to 20 #Victim will not take damage for the next second"})
-@Since("2.5")
-public class ExprNoDamageTicks
-extends SimplePropertyExpression<org.bukkit.entity.LivingEntity,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Now")
-@Description("The current <a href=\'classes.html#date\'>system time</a> of the server. Use <a href=\'#ExprTime\'>time</a> to get the <a href=\'classes.html#time\'>Minecraft time</a> of a world.")
-@Examples("broadcast \"Current server time: %now%\"")
-@Since("1.4")
-public class ExprNow
-extends SimpleExpression<Date>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Number of Characters")
-@Description("The number of uppercase, lowercase, or digit characters in a string.")
-@Examples({"#Simple Chat Filter","on chat:","\tif number of uppercase chars in message / length of message > 0.5","\t\tcancel event","\t\tsend \"<red>Your message has to many caps!\" to player"})
-@Since("2.5")
-public class ExprNumberOfCharacters
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Numbers")
-@Description({"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"})
-@Since("1.4.6 (integers & numbers), 2.5.1 (decimals)")
-public class ExprNumbers
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
Checks whether the given 'loop-...' expression should match this loop, e.g. loop-block matches any loops that loop through blocks and loop-argument matches an
- argument loop.
-
- You should usually just return false as e.g. loop-block will automatically match the expression if its returnType is Block or a subtype of it.
@Name("Offline players")
-@Description("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%\"")
-@Since("2.2-dev35")
-public class ExprOfflinePlayers
-extends SimpleExpression<org.bukkit.OfflinePlayer>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Online Player Count")
-@Description({"The amount of online players. This can be changed in a","<a href=\'events.html#server_list_ping\'>server list ping</a> event only to show fake online player amount.","\'real online player count\' always returns the real count of online players and can\'t be changed.","","Fake online player count requires PaperSpigot 1.12.2+."})
-@Examples({"on server list ping:","\t# This will make the max players count 5 if there are 4 players online.","\tset the fake max players count to (online players count + 1)"})
-@Since("2.3")
-public class ExprOnlinePlayersCount
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Opened Inventory")
-@Description({"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")
-@Since("2.2-dev24, 2.2-dev35 (Just \'current inventory\' works in player events)")
-public class ExprOpenedInventory
-extends PropertyExpression<org.bukkit.entity.Player,org.bukkit.inventory.Inventory>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("All Operators")
-@Description("The list of operators on the server.")
-@Examples("set {_ops::*} to all operators")
-@Since("2.7")
-public class ExprOps
-extends SimpleExpression<org.bukkit.OfflinePlayer>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Parse")
-@Description({"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 <a href=\'#ExprParseError\'>parse error</a> will be set if some information is available.","Some notes about parsing with a pattern:","- The pattern must be a <a href=\'./patterns/\'>Skript pattern</a>, 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 <i>have to</i> save the expression\'s value in a list variable, e.g. <code>set {parsed::*} to message parsed as \"...\"</code>.","- 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:","\tset {var::*} to message parsed as \"buying %items% for %money%\"","\tif parse error is set:","\t\tmessage \"%parse error%\"","\telse if {var::*} is set:","\t\tcancel event","\t\tremove {var::2} from the player\'s balance","\t\tgive {var::1::*} to the player"})
-@Since("2.0")
-public class ExprParse
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Parse Error")
-@Description("The error which caused the last <a href=\'#ExprParse\'>parse operation</a> 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:","\tparse error is set:","\t\tmessage \"<red>Line 1 is invalid: %last parse error%\"","\telse:","\t\tmessage \"<red>Please put an integer on line 1!\""})
-@Since("2.0")
-public class ExprParseError
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Passenger")
-@Description({"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: <a href=\'#ExprVehicle\'>vehicle</a>"})
-@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"})
-@Since("2.0, 2.2-dev26 (Multiple passengers for 1.11.2+)")
-public class ExprPassenger
-extends SimpleExpression<org.bukkit.entity.Entity>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("All Permissions")
-@Description("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")
-@Since("2.2-dev33")
-public class ExprPermissions
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Pickup Delay")
-@Description("The amount of time before a dropped item can be picked up by an entity.")
-@Examples({"drop diamond sword at {_location} without velocity","set pickup delay of last dropped item to 5 seconds"})
-@Since("2.7")
-public class ExprPickupDelay
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Timespan>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Ping")
-@Description("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%>:","\ttrigger:","\t\tsend \"%arg-1%\'s ping is %arg-1\'s ping%\""})
-@Since("2.2-dev36")
-public class ExprPing
-extends SimplePropertyExpression<org.bukkit.entity.Player,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Plain Item")
-@Description("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","\tsend \"You are holding a plain diamond!\""})
-@Since("2.6")
-public class ExprPlain
-extends SimpleExpression<ItemType>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Player Protocol Version")
-@Description("Player\'s protocol version. For more information and list of protocol versions <a href=\'https://wiki.vg/Protocol_version_numbers\'>visit wiki.vg</a>.")
-@Examples({"command /protocolversion <player>:","\ttrigger:","\t\tsend \"Protocol version of %arg-1%: %protocol version of arg-1%\""})
-@Since("2.6.2")
-@RequiredPlugins("Paper 1.12.2 or newer")
-public class ExprPlayerProtocolVersion
-extends SimplePropertyExpression<org.bukkit.entity.Player,Integer>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("View Distance")
-@Description({"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"})
-@RequiredPlugins("Paper")
-@Since("2.4")
-public class ExprPlayerViewDistance
-extends SimplePropertyExpression<org.bukkit.entity.Player,Integer>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Player Weather")
-@Description("The weather for a player.")
-@Examples({"set weather of arg-player to rainy","reset player\'s weather","if arg-player\'s weather is rainy"})
-@Since("2.2-dev34")
-public class ExprPlayerWeather
-extends SimplePropertyExpression<org.bukkit.entity.Player,WeatherType>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Player List Header and Footer")
-@Description("The message above and below the player list in the tab menu.")
-@Examples({"set all players\' tab list header to \"Welcome to the Server!\"","send \"%the player\'s tab list header%\" to player","reset all players\' tab list header"})
-@Since("2.4")
-@RequiredPlugins("Minecraft 1.13 or newer")
-public class ExprPlayerlistHeaderFooter
-extends SimplePropertyExpression<org.bukkit.entity.Player,String>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Loaded Plugins")
-@Description("An expression to obtain a list of the names of the server\'s loaded plugins.")
-@Examples({"if the loaded plugins contains \"Vault\":","\tbroadcast \"This server uses Vault plugin!\"","","send \"Plugins (%size of loaded plugins%): %plugins%\" to player"})
-@Since("2.7")
-public class ExprPlugins
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Portal")
-@Description("The blocks associated with a portal in the portal creation event.")
-@Examples({"on portal creation:","\tloop portal blocks:","\t\tbroadcast \"%loop-block% is part of a portal!\""})
-@Since("2.4")
-@Events("portal_create")
-public class ExprPortal
-extends SimpleExpression<org.bukkit.block.Block>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
Returns whether this value represents the default value of its type for the event, i.e. it can be replaced with a call to event.getXyz() if one knows the event & value type.
-
- This method might be removed in the future as it's better to check whether value == event.getXyz() for every value an expression returns.
@Name("Portal Cooldown")
-@Description({"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:","\twait 1 tick","\tset portal cooldown of event-entity to 5 seconds"})
-@Since("INSERT VERSION")
-public class ExprPortalCooldown
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Timespan>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Potion Effect")
-@Description({"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"})
-@Since("2.5.2")
-public class ExprPotionEffect
-extends SimpleExpression<org.bukkit.potion.PotionEffect>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Potion Effect Tier")
-@Description("An expression to obtain the amplifier of a potion effect applied to an entity.")
-@Examples("if the amplifier of haste of player >= 3:")
-@Since("2.7")
-public class ExprPotionEffectTier
-extends SimpleExpression<Integer>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Potion Effects")
-@Description({"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"})
-@Since("2.5.2")
-public class ExprPotionEffects
-extends SimpleExpression<org.bukkit.potion.PotionEffect>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Projectile Critical State")
-@Description("A projectile\'s critical state. The only currently accepted projectiles are arrows and tridents.")
-@Examples({"on shoot:","\tevent-projectile is an arrow","\tset projectile critical mode of event-projectile to true"})
-@Since("2.5.1")
-public class ExprProjectileCriticalState
-extends SimplePropertyExpression<org.bukkit.entity.Projectile,Boolean>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Protocol Version")
-@Description({"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 <a href=\'https://wiki.vg/Protocol_version_numbers\'>visit wiki.vg</a>.","If this protocol version doesn\'t match with the protocol version of the client, the client will see the <a href=\'#ExprVersionString\'>version string</a>.","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 <a href=\'#ExprVersionString\'>version string</a> 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 <a href=\'events.html#server_list_ping\'>server list ping</a> event only","(increase and decrease effects cannot be used because that wouldn\'t make sense)."})
-@Examples({"on server list ping:","\tset the version string to \"<light green>Version: <orange>%minecraft version%\"","\tset the protocol version to 0 # 13w41a (1.7) - so the player will see the custom version string almost always"})
-@Since("2.3")
-@RequiredPlugins("Paper 1.12.2 or newer")
-@Events("server list ping")
-public class ExprProtocolVersion
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Moved blocks")
-@Description("Blocks which are moved in a piston event. Cannot be used outside of piston events.")
-@Examples("the moved blocks")
-@Since("2.2-dev27")
-public class ExprPushedBlocks
-extends SimpleExpression<org.bukkit.block.Block>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Quit Reason")
-@Description("The <a href=\'classes.html#quitreason\'>quit reason</a> as to why a player disconnected in a <a href=\'events.html#quit\'>quit</a> event.")
-@Examples({"on quit:","\tquit reason was kicked","\tplayer is banned","\tclear {server::player::%uuid of player%::*}"})
-@RequiredPlugins("Paper 1.16.5+")
-@Since("INSERT VERSION")
-public class ExprQuitReason
-extends EventValueExpression<org.bukkit.event.player.PlayerQuitEvent.QuitReason>
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
-
-
Specified by:
-
setTime in interface Expression<org.bukkit.event.player.PlayerQuitEvent.QuitReason>
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Random")
-@Description("Gets a random item out of a set, e.g. a random player out of all players online.")
-@Examples({"give a diamond to a random player out of all players","give a random item out of all items to the player"})
-@Since("1.4.9")
-public class ExprRandom
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Random Number")
-@Description({"A random number or integer 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. <code>random number between 2 and 1</code> will work as well as <code>random number between 1 and 2</code>."})
-@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"})
-@Since("1.4")
-public class ExprRandomNumber
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Raw Name")
-@Description("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")
-@Since("unknown (2.2)")
-public class ExprRawName
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Raw String")
-@Description("Returns the string without formatting (colors etc.) and without stripping them from it, e.g. <code>raw \"&aHello There!\"</code> would output <code>&aHello There!</code>")
-@Examples("send raw \"&aThis text is unformatted!\" to all players")
-@Since("2.7")
-public class ExprRawString
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Redstone Block Power")
-@Description("Power of a redstone block")
-@Examples({"if redstone power of targeted block is 15:","\tsend \"This block is very powerful!\""})
-@Since("2.5")
-public class ExprRedstoneBlockPower
-extends SimplePropertyExpression<org.bukkit.block.Block,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Remaining Air")
-@Description("How much time a player has left underwater before starting to drown.")
-@Examples({"player\'s remaining air is less than 3 seconds:","\tsend \"hurry, get to the surface!\" to the player"})
-@Since("<i>unknown</i> (before 2.1)")
-public class ExprRemainingAir
-extends SimplePropertyExpression<org.bukkit.entity.LivingEntity,Timespan>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Respawn location")
-@Description("The location that a player should respawn at. This is used within the respawn event.")
-@Examples({"on respawn:","\tset respawn location to {example::spawn}"})
-@Since("2.2-dev35")
-public class ExprRespawnLocation
-extends SimpleExpression<org.bukkit.Location>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Usually, you want to override SimpleExpression.getConvertedExpr(Class[]).
- However, it may be useful to override this method if you have an expression with a return
- type that is unknown until runtime (like variables). Usually, you'll be fine with just
- the default implementation. This method is final on versions below 2.2-dev36.
@Name("Rounding")
-@Description("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"})
-@Since("2.0")
-public class ExprRound
-extends PropertyExpression<Number,Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Saturation")
-@Description("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")
-@Since("2.2-Fixes-v10, 2.2-dev35 (fully modifiable), 2.6.2 (syntax pattern changed)")
-public class ExprSaturation
-extends SimplePropertyExpression<org.bukkit.entity.Player,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Scoreboard Tags")
-@Description({"Scoreboard tags are simple list of texts stored directly in the data of an <a href=\'classes.html#entity\'>entity</a>.","So this is a Minecraft related thing, not Bukkit, so the tags will not get removed when the server stops. You can visit <a href=\'https://minecraft.gamepedia.com/Scoreboard#Tags\'>visit Minecraft Wiki</a> for more info.","This is changeable and valid for any type of entity. Also you can use use the <a href=\'conditions.html#CondHasScoreboardTag\'>Has Scoreboard Tag</a> 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:","\tif the spawn reason is mob spawner:","\t\tadd \"spawned by a spawner\" to the scoreboard tags of event-entity","","on death of a monster:","\tif the attacker is a player:","\t\tif the victim doesn\'t have the scoreboard tag \"spawned by a spawner\":","\t\t\tadd 1$ to attacker\'s balance"})
-@Since("2.3")
-public class ExprScoreboardTags
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Script Name")
-@Description("Holds the current script\'s name (the file name without \'.sk\').")
-@Examples({"on script load:","\tset {running::%script%} to true","on script unload:","\tset {running::%script%} to false"})
-@Since("2.0")
-@Events("Script Load/Unload")
-public class ExprScript
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("All Scripts")
-@Description("Returns all of the scripts, or just the enabled or disabled ones.")
-@Examples({"command /scripts:","\ttrigger:","\t\tsend \"All Scripts: %scripts%\" to player","\t\tsend \"Loaded Scripts: %enabled scripts%\" to player","\t\tsend \"Unloaded Scripts: %disabled scripts%\" to player"})
-@Since("2.5")
-public class ExprScripts
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Sea Level")
-@Description("Gets the sea level of a world.")
-@Examples("send \"The sea level in your world is %sea level in player\'s world%\"")
-@Since("2.5.1")
-public class ExprSeaLevel
-extends SimplePropertyExpression<org.bukkit.World,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Sea Pickles")
-@Description("An expression to obtain or modify data relating to the pickles of a sea pickle block.")
-@Examples({"on block break:","\ttype of block is sea pickle","\tsend \"Wow! This stack of sea pickles contained %event-block\'s sea pickle count% pickles!\"","\tsend \"It could\'ve contained a maximum of %event-block\'s maximum sea pickle count% pickles!\"","\tsend \"It had to have contained at least %event-block\'s minimum sea pickle count% pickles!\"","\tcancel event","\tset event-block\'s sea pickle count to event-block\'s maximum sea pickle count","\tsend \"This bad boy is going to hold so many pickles now!!\""})
-@Since("2.7")
-public class ExprSeaPickles
-extends SimplePropertyExpression<org.bukkit.block.Block,Integer>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("World Seed")
-@Description("The seed of given world. Note that it will be returned as Minecraft internally treats seeds, not as you specified it in world configuration.")
-@Examples("broadcast \"Seed: %seed of player\'s world%\"")
-@Since("2.2-dev35")
-public class ExprSeed
-extends PropertyExpression<org.bukkit.World,Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Server Icon")
-@Description({"Icon of the server in the server list. Can be set to an icon that loaded using the","<a href=\'effects.html#EffLoadServerIcon\'>load server icon</a> effect,","or can be reset to the default icon in a <a href=\'events.html#server_list_ping\'>server list ping</a>.","\'default server icon\' returns the default server icon (server-icon.png) always and cannot be changed."})
-@Examples({"on script load:","\tset {server-icons::default} to the default server icon"})
-@Since("2.3")
-@RequiredPlugins("Paper 1.12.2 or newer")
-public class ExprServerIcon
-extends SimpleExpression<org.bukkit.util.CachedServerIcon>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
-
-
Specified by:
-
change in interface Expression<org.bukkit.util.CachedServerIcon>
@Name("Sets")
-@Description("Returns a list of all the values of a type; useful for looping.")
-@Examples({"loop all attribute types:","\tset loop-value attribute of player to 10","\tmessage \"Set attribute %loop-value% to 10!\""})
-@Since("<i>unknown</i> (before 1.4.2), 2.7 (colors)")
-public class ExprSets
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
@Name("Shooter")
-@Description("The shooter of a projectile.")
-@Examples("shooter is a skeleton")
-@Since("1.3.7")
-public class ExprShooter
-extends PropertyExpression<org.bukkit.entity.Projectile,org.bukkit.entity.LivingEntity>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Shuffled List")
-@Description("Shuffles given list randomly. This is done by replacing indices by random numbers in resulting list.")
-@Examples("set {_list::*} to shuffled {_list::*}")
-@Since("2.2-dev32")
-public class ExprShuffledList
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Usually, you want to override SimpleExpression.getConvertedExpr(Class[]).
- However, it may be useful to override this method if you have an expression with a return
- type that is unknown until runtime (like variables). Usually, you'll be fine with just
- the default implementation. This method is final on versions below 2.2-dev36.
@Name("Sign Text")
-@Description("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:","\tline 2 of the clicked block is \"[Heal]\":","\t\theal the player","\tset line 3 to \"%player%\""})
-@Since("1.3")
-public class ExprSignText
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Player Skull")
-@Description("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"})
-@Since("2.0")
-public class ExprSkull
-extends SimplePropertyExpression<Object,ItemType>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Slot Index")
-@Description("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.")
-@Examples({"if index of event-slot is 10:","\tsend \"You bought a pie!\""})
-@Since("2.2-dev35")
-public class ExprSlotIndex
-extends SimplePropertyExpression<Slot,Long>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Sorted List")
-@Description({"Sorts given list in natural order. All objects in list must be comparable;","if they\'re not, this expression will return nothing."})
-@Examples("set {_sorted::*} to sorted {_players::*}")
-@Since("2.2-dev19")
-public class ExprSortedList
-extends SimpleExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Usually, you want to override SimpleExpression.getConvertedExpr(Class[]).
- However, it may be useful to override this method if you have an expression with a return
- type that is unknown until runtime (like variables). Usually, you'll be fine with just
- the default implementation. This method is final on versions below 2.2-dev36.
@Name("Source Block")
-@Description("The source block in a spread event.")
-@Events("Spread")
-@Examples({"on spread:","\tif the source block is a grass block:","\t\tset the source block to a dirt block"})
-@Since("2.7")
-public class ExprSourceBlock
-extends SimpleExpression<org.bukkit.block.Block>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Spawn")
-@Description("The spawn point of a world.")
-@Examples({"teleport all players to spawn","set the spawn point of \"world\" to the player\'s location"})
-@Since("1.4.2")
-public class ExprSpawn
-extends PropertyExpression<org.bukkit.World,org.bukkit.Location>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Spawn Reason")
-@Description("The <a href=\'classes.html#spawnreason\'>spawn reason</a> in a <a href=\'events.html#spawn\'>spawn</a> event.")
-@Examples({"on spawn:","\tspawn reason is reinforcements or breeding"})
-@Since("2.3")
-public class ExprSpawnReason
-extends EventValueExpression<org.bukkit.event.entity.CreatureSpawnEvent.SpawnReason>
@Name("Spawner Type")
-@Description("Retrieves, sets, or resets the spawner\'s entity type")
-@Examples({"on right click:","\tif event-block is spawner:","\t\tsend \"Spawner\'s type is %target block\'s entity type%\""})
-@Since("2.4")
-public class ExprSpawnerType
-extends SimplePropertyExpression<org.bukkit.block.Block,EntityData>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Special Number")
-@Description("Special number values, namely NaN, Infinity and -Infinity")
-@Examples("if {_number} is NaN value:")
-@Since("2.2-dev32d")
-public class ExprSpecialNumber
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Spectator Target")
-@Description("Grabs the spectator target entity of the players.")
-@Examples({"on player start spectating of player:","\tmessage \"&c%spectator target% currently has %{game::kills::%spectator target%}% kills!\" to the player","","on player stop spectating:","\tpast spectator target was a zombie","\tset spectator target to the nearest skeleton"})
-@RequiredPlugins("Paper")
-@Since("2.4-alpha4, 2.7 (Paper Spectator Event)")
-public class ExprSpectatorTarget
-extends SimpleExpression<org.bukkit.entity.Entity>
expressions - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Speed")
-@Description({"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"})
-@Since("<i>unknown</i> (before 2.1)")
-public class ExprSpeed
-extends SimplePropertyExpression<org.bukkit.entity.Player,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Case Text")
-@Description("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?"})
-@Since("2.2-dev16 (lowercase and uppercase), 2.5 (advanced cases)")
-public class ExprStringCase
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Substring")
-@Description("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 <a href=\'#ExprLength\'>length</a> of the text (other values will be fit into this range).")
-@Keywords({"substring","subtext"})
-@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"})
-@Since("2.1, 2.5.2 (character at, multiple strings support)")
-public class ExprSubstring
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("TPS (ticks per second)")
-@Description("Returns the 3 most recent TPS readings, like the /tps command. This expression is only supported on some server software (PaperSpigot).")
-@Examples("broadcast \"%tps%\"")
-@Since("2.2-dev36")
-public class ExprTPS
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Tamer")
-@Description("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:","\tif the tamer is a player:","\t\tsend \"someone tamed something!\" to console"})
-@Since("2.2-dev25")
-public class ExprTamer
-extends SimpleExpression<org.bukkit.entity.Player>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Target")
-@Description({"For players this is the entity at the crosshair.","For mobs and experience orbs this is the entity they are attacking/following (if any)."})
-@Examples({"on entity target:","\tif entity\'s target is a player:","\t\tsend \"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"})
-@Since("1.4.2, 2.7 (Reset)")
-public class ExprTarget
-extends PropertyExpression<org.bukkit.entity.LivingEntity,org.bukkit.entity.Entity>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Targeted Block")
-@Description("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.")
-@Examples({"# A command to set the block a player looks at to a specific type:","command /setblock <material>:","\ttrigger:","\t\tset targeted block to argument"})
-@Since("1.0")
-public class ExprTargetedBlock
-extends PropertyExpression<org.bukkit.entity.Player,org.bukkit.block.Block>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Teleport Cause")
-@Description("The <a href=\'classes.html#teleportcause\'>teleport cause</a> within a player <a href=\'events.html#teleport\'>teleport</a> event.")
-@Examples({"on teleport:","\tteleport cause is nether portal, end portal or end gateway"})
-@Since("2.2-dev35")
-public class ExprTeleportCause
-extends EventValueExpression<org.bukkit.event.player.PlayerTeleportEvent.TeleportCause>
@Name("Ternary")
-@Description("A shorthand expression for returning something based on a condition.")
-@Examples("set {points} to 500 if {admin::%player\'s uuid%} is set else 100")
-@Since("2.2-dev36")
-public class ExprTernary<T>
-extends SimpleExpression<T>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Usually, you want to override SimpleExpression.getConvertedExpr(Class[]).
- However, it may be useful to override this method if you have an expression with a return
- type that is unknown until runtime (like variables). Usually, you'll be fine with just
- the default implementation. This method is final on versions below 2.2-dev36.
@Name("Time")
-@Description("The <a href=\'classes.html#time\'>time</a> of a world.")
-@Examples({"time in world is between 18:00 and 6:00:","\tbroadcast \"It\'s night-time, watch out for monsters!\""})
-@Since("1.0")
-public class ExprTime
-extends PropertyExpression<org.bukkit.World,Time>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Time Played")
-@Description({"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 <code><none></code>."})
-@Examples({"set {_t} to time played of player","if player\'s time played is greater than 10 minutes:","\tgive player a diamond sword","","set player\'s time played to 0 seconds"})
-@RequiredPlugins("MC 1.15+ (offline players)")
-@Since("2.5, 2.7 (offline players)")
-public class ExprTimePlayed
-extends SimplePropertyExpression<org.bukkit.OfflinePlayer,Timespan>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Time Since")
-@Description("The time that has passed since a date. If the given date is in the future, a value will not be returned.")
-@Examples("send \"%time since 5 minecraft days ago% has passed since 5 minecraft days ago!\" to player")
-@Since("2.5")
-public class ExprTimeSince
-extends SimplePropertyExpression<Date,Timespan>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Former/Future State")
-@Description({"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 <a href=\'./events.html#level_change\'>level change event</a>.","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:","\tformer world was \"world_nether\" # or \'world was\'","\tworld will be \"world\" # or \'world after the event is\'","on tool change:","\tpast tool is an axe","\tthe tool after the event will be air","on weather change:","\tset {weather::%world%::old} to past weather","\tset {weather::%world%::current} to the new weather"})
-@Since("1.1")
-public class ExprTimeState
-extends WrapperExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("X Times")
-@Description("Integers between 1 and X, used in loops to loop X times.")
-@Examples({"loop 20 times:","\tbroadcast \"%21 - loop-number% seconds left..\"","\twait 1 second"})
-@Since("1.4.6")
-public class ExprTimes
-extends SimpleExpression<Long>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
@Name("Tool")
-@Description("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"})
-@Since("1.0")
-public class ExprTool
-extends PropertyExpression<org.bukkit.entity.LivingEntity,Slot>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Total Experience")
-@Description({"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:","\tset player\'s total experience to 0","\tgive player 1 diamond"})
-@Since("2.7")
-public class ExprTotalExperience
-extends SimplePropertyExpression<org.bukkit.entity.Entity,Integer>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Type of")
-@Description({"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:","\tmessage \"This is a %type of clicked entity%!\""})
-@Since("1.4, 2.5.2 (potion effect), 2.7 (block datas)")
-public class ExprTypeOf
-extends SimplePropertyExpression<Object,Object>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("UUID")
-@Description({"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.","<em>Please note that this expression does not work for offline players if you are under 1.8!</em>"})
-@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:","\tif {uuid::%name of player%} exists:","\t\t{uuid::%name of player%} is not uuid of player","\t\tkick player due to \"Someone with your name has played on this server before\"","\telse:","\t\tset {uuid::%name of player%} to uuid of player"})
-@Since("2.1.2, 2.2 (offline players\' UUIDs), 2.2-dev24 (other entities\' UUIDs)")
-public class ExprUUID
-extends SimplePropertyExpression<Object,String>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Unix Date")
-@Description("Converts given Unix timestamp to a date. The Unix timespan represents the number of seconds elapsed since 1 January 1970.")
-@Examples("unix date of 946684800 #1 January 2000 12:00 AM (UTC Time)")
-@Since("2.5")
-public class ExprUnixDate
-extends SimplePropertyExpression<Number,Date>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Unix Timestamp")
-@Description("Converts given date to Unix timestamp. This is roughly how many seconds have elapsed since 1 January 1970.")
-@Examples("unix timestamp of now")
-@Since("2.2-dev31")
-public class ExprUnixTicks
-extends SimplePropertyExpression<Date,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Value Within")
-@Description("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\""})
-@Since("2.7")
-public class ExprValueWithin
-extends WrapperExpression<Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Vectors - Angle Between")
-@Description("Gets the angle between two vectors.")
-@Examples("send \"%the angle between vector 1, 0, 0 and vector 0, 1, 1%\"")
-@Since("2.2-dev28")
-public class ExprVectorAngleBetween
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Vector Between Locations")
-@Description("Creates a vector between two locations.")
-@Examples("set {_v} to vector between {_loc1} and {_loc2}")
-@Since("2.2-dev28")
-public class ExprVectorBetweenLocations
-extends SimpleExpression<org.bukkit.util.Vector>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Dot Product")
-@Description("Gets the dot product between two vectors.")
-@Examples("set {_v} to {_v2} dot {_v3}")
-@Since("2.2-dev28")
-public class ExprVectorDotProduct
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Create from Direction")
-@Description({"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"})
-@Since("INSERT VERSION")
-public class ExprVectorFromDirection
-extends SimpleExpression<org.bukkit.util.Vector>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Create from XYZ")
-@Description("Creates a vector from x, y and z values.")
-@Examples("set {_v} to vector 0, 1, 0")
-@Since("2.2-dev28")
-public class ExprVectorFromXYZ
-extends SimpleExpression<org.bukkit.util.Vector>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Vector from Pitch and Yaw")
-@Description("Creates a vector from a yaw and pitch value.")
-@Examples("set {_v} to vector from yaw 45 and pitch 45")
-@Since("2.2-dev28")
-public class ExprVectorFromYawAndPitch
-extends SimpleExpression<org.bukkit.util.Vector>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Length")
-@Description("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}%\""})
-@Since("2.2-dev28")
-public class ExprVectorLength
-extends SimplePropertyExpression<org.bukkit.util.Vector,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Vectors - Normalized")
-@Description("Returns the same vector but with length 1.")
-@Examples("set {_v} to normalized {_v}")
-@Since("2.2-dev28")
-public class ExprVectorNormalize
-extends SimpleExpression<org.bukkit.util.Vector>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Vector from Location")
-@Description("Creates a vector from a location.")
-@Examples("set {_v} to vector of {_loc}")
-@Since("2.2-dev28")
-public class ExprVectorOfLocation
-extends SimpleExpression<org.bukkit.util.Vector>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Vector Projection")
-@Description("An expression to get the vector projection of two vectors.")
-@Examples("set {_projection} to vector projection of vector(1, 2, 3) onto vector(4, 4, 4)")
-@Since("INSERT VERSION")
-public class ExprVectorProjection
-extends SimpleExpression<org.bukkit.util.Vector>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Random Vector")
-@Description("Creates a random unit vector.")
-@Examples("set {_v} to a random vector")
-@Since("2.2-dev28, 2.7 (signed components)")
-public class ExprVectorRandom
-extends SimpleExpression<org.bukkit.util.Vector>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Vectors - Squared Length")
-@Description("Gets the squared length of a vector.")
-@Examples("send \"%squared length of vector 1, 2, 3%\"")
-@Since("2.2-dev28")
-public class ExprVectorSquaredLength
-extends SimplePropertyExpression<org.bukkit.util.Vector,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("Vectors - XYZ Component")
-@Description("Gets or changes the x, y or z component of a vector.")
-@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}%\""})
-@Since("2.2-dev28")
-public class ExprVectorXYZ
-extends SimplePropertyExpression<org.bukkit.util.Vector,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Vehicle")
-@Description({"The vehicle an entity is in, if any. This can actually be any entity, e.g. spider jockeys are skeletons that ride on a spider, so the spider is the \'vehicle\' of the skeleton.","See also: <a href=\'#ExprPassenger\'>passenger</a>"})
-@Examples("vehicle of the player is a minecart")
-@Since("2.0")
-public class ExprVehicle
-extends SimplePropertyExpression<org.bukkit.entity.Entity,org.bukkit.entity.Entity>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Vectors - Velocity")
-@Description("Gets or changes velocity of an entity.")
-@Examples("set player\'s velocity to {_v}")
-@Since("2.2-dev31")
-public class ExprVelocity
-extends SimplePropertyExpression<org.bukkit.entity.Entity,org.bukkit.util.Vector>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Version")
-@Description("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%\""})
-@Since("2.0")
-public class ExprVersion
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Version String")
-@Description({"The text to show if the protocol version of the server doesn\'t match with protocol version of the client. You can check the <a href=\'#ExprProtocolVersion\'>protocol version</a> expression for more information about this.","This can only be set in a <a href=\'events.html#server_list_ping\'>server list ping</a> event."})
-@Examples({"on server list ping:","\tset the protocol version to 0 # 13w41a (1.7), so it will show the version string always","\tset the version string to \"<light green>Version: <orange>%minecraft version%\""})
-@Since("2.3")
-@RequiredPlugins("Paper 1.12.2+")
-@Events("Server List Ping")
-public class ExprVersionString
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Weather")
-@Description("The weather in the given or the current world.")
-@Examples({"set weather to clear","weather in \"world\" is rainy"})
-@Since("1.0")
-@Events("weather change")
-public class ExprWeather
-extends PropertyExpression<org.bukkit.World,WeatherType>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("Whitelist")
-@Description("A server\'s whitelist.This expression can be used to add/remove players to/from the whitelist, to enable it and disable it (set whitelist to true / set whitelist to false), and to empty it (reset whitelist)")
-@Examples({"set whitelist to false","add all players to whitelist","reset the whitelist"})
-@Since("2.5.2")
-public class ExprWhitelist
-extends SimpleExpression<org.bukkit.OfflinePlayer>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("World")
-@Description("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"})
-@Since("1.0")
-public class ExprWorld
-extends PropertyExpression<Object,org.bukkit.World>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
@Name("World Environment")
-@Description("The environment of a world")
-@Examples({"if environment of player\'s world is nether:","\tapply fire resistance to player for 10 minutes"})
-@Since("2.7")
-public class ExprWorldEnvironment
-extends SimplePropertyExpression<org.bukkit.World,org.bukkit.World.Environment>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
@Name("World from Name")
-@Description("Returns the world from a string.")
-@Examples({"world named {game::world-name}","the world \"world\""})
-@Since("2.6.1")
-public class ExprWorldFromName
-extends SimpleExpression<org.bukkit.World>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Worlds")
-@Description("All worlds of the server, useful for looping.")
-@Examples({"loop all worlds:","\tbroadcast \"You\'re in %loop-world%\" to loop-world"})
-@Since("1.0")
-public class ExprWorlds
-extends SimpleExpression<org.bukkit.World>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
@Name("X of Item")
-@Description("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")
-@Since("1.2")
-public class ExprXOf
-extends PropertyExpression<Object,Object>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Yaw / Pitch")
-@Description("The yaw or pitch of a location or vector.")
-@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"})
-@Since("2.0, 2.2-dev28 (vector yaw/pitch)")
-public class ExprYawPitch
-extends SimplePropertyExpression<Object,Number>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Console")
-@Description("Represents the server\'s console which can receive messages and execute commands")
-@Examples({"execute console command \"/stop\"","send \"message to console\" to the console"})
-@Since("1.3.1")
-public class LitConsole
-extends SimpleLiteral<org.bukkit.command.ConsoleCommandSender>
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.util.SimpleLiteral
init in class SimpleLiteral<org.bukkit.command.ConsoleCommandSender>
-
Parameters:
-
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Arithmetic")
-@Description("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:","\tmessage \"Two useless numbers: %loop-num * 2 - 5%, %2^loop-num - 1%\"","message \"You have %health of player * 2% half hearts of HP!\""})
-@Since("1.4.2")
-public class ExprArithmetic
-extends SimpleExpression<Number>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
A reference to a simpler version of this expression. Can change this expression directly and return itself if applicable, i.e. no references to the expression before
- this method call should be kept!
Returns the enum constant of this class with the specified name.
-The string must match exactly an identifier used to declare an
-enum constant in this class. (Extraneous whitespace characters are
-not permitted.)
-
-
Parameters:
-
name - the name of the enum constant to be returned.
A useful class for creating default expressions. It simply returns the event value of the given type.
-
- This class can be used as default expression with new EventValueExpression<T>(T.class) or extended to make it manually placeable in expressions with:
-
-
- class MyExpression extends EventValueExpression<SomeClass> {
- public MyExpression() {
- super(SomeClass.class);
- }
- // ...
- }
-
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parser - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
Returns whether this value represents the default value of its type for the event, i.e. it can be replaced with a call to event.getXyz() if one knows the event & value type.
-
- This method might be removed in the future as it's better to check whether value == event.getXyz() for every value an expression returns.
Registers an expression as ExpressionType.PROPERTY with the two default property patterns "property [of %types%]" and "%types%'[s] property"
- This method also makes the expression type optional to force a default expression on the property expression.
Registers an expression as ExpressionType.PROPERTY with the two default property patterns "property [of %types%]" and "%types%'[s] property"
- This method also makes the expression type optional to force a default expression on the property expression.
-
-
Parameters:
-
c - the PropertyExpression class being registered.
-
type - the main expression type the property is based off of.
-
property - the name of the property.
-
fromType - should be plural to support multiple objects but doesn't have to be.
An array of all possible values of this expression for the given event which must neither be null nor contain nulls, and which must not be an internal array.
A reference to a simpler version of this expression. Can change this expression directly and return itself if applicable, i.e. no references to the expression before
- this method call should be kept!
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.
-
- This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if
- it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
-
- If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be
- printed (NB: Skript.error(String) always creates semantic errors).
-
- This implementation sets the time but returns false.
time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.
-
Returns:
-
Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
- ParserInstance.isCurrentEvent(Class)).
Returns whether this value represents the default value of its type for the event, i.e. it can be replaced with a call to event.getXyz() if one knows the event & value type.
-
- This method might be removed in the future as it's better to check whether value == event.getXyz() for every value an expression returns.
A reference to a simpler version of this expression. Can change this expression directly and return itself if applicable, i.e. no references to the expression before
- this method call should be kept!
This method is called before this expression is set to another one.
- The return value is what will be used for change. You can use modified
- version of initial delta array or create a new one altogether
-
- Default implementation will convert slots to items when they're set
- to variables, as specified in Skript documentation.
@Name("Prefix/Suffix")
-@Description("The prefix or suffix as defined in the server\'s chat plugin.")
-@Examples({"on chat:","\tcancel event","\tbroadcast \"%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>] \""})
-@Since("2.0")
-@RequiredPlugins({"Vault","a chat plugin that supports Vault"})
-public class ExprPrefixSuffix
-extends SimplePropertyExpression<org.bukkit.entity.Player,String>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("Money")
-@Description("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"})
-@Since("2.0, 2.5 (offline players)")
-@RequiredPlugins({"Vault","an economy plugin that supports Vault"})
-public class ExprBalance
-extends SimplePropertyExpression<org.bukkit.OfflinePlayer,Money>
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
@Name("All Groups")
-@Description("All the groups a player can have. This expression requires Vault and a compatible permissions plugin to be installed.")
-@Examples({"command /group <text>:","\ttrigger:","\t\tif argument is \"list\":","\t\t\tsend \"%all groups%\""})
-@Since("2.2-dev35")
-@RequiredPlugins({"Vault","a permission plugin that supports Vault"})
-public class ExprAllGroups
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Group")
-@Description({"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:","\tbroadcast \"%group of player%\" # this is the player\'s primary group","\tbroadcast \"%groups of player%\" # this is all of the player\'s groups"})
-@Since("2.2-dev35")
-@RequiredPlugins({"Vault","a permission plugin that supports Vault"})
-public class ExprGroup
-extends SimpleExpression<String>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though
- make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with
- super.change(...).
-
Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by
- Expression.acceptChange(ChangeMode)
Deserialises this object. No fields have been set when this method is called, use fields.setFields(this, yggdrasil) to set all
- compatible non-transient and non-static fields (and call incompatible/missing field handlers if applicable – this implies that errors will be thrown if the fields
- object is invalid).
-
- You can use fields.setFields(this); to emulate the default behaviour.
-
-
Parameters:
-
fields - A Fields object containing all fields read from stream
Deserialises this object. No fields have been set when this method is called, use fields.setFields(this, yggdrasil) to set all
- compatible non-transient and non-static fields (and call incompatible/missing field handlers if applicable – this implies that errors will be thrown if the fields
- object is invalid).
-
- You can use fields.setFields(this); to emulate the default behaviour.
-
-
Parameters:
-
fields - A Fields object containing all fields read from stream
Deserialises this object. No fields have been set when this method is called, use fields.setFields(this, yggdrasil) to set all
- compatible non-transient and non-static fields (and call incompatible/missing field handlers if applicable – this implies that errors will be thrown if the fields
- object is invalid).
-
- You can use fields.setFields(this); to emulate the default behaviour.
-
-
Parameters:
-
fields - A Fields object containing all fields read from stream
Deserialises this object. No fields have been set when this method is called, use fields.setFields(this, yggdrasil) to set all
- compatible non-transient and non-static fields (and call incompatible/missing field handlers if applicable – this implies that errors will be thrown if the fields
- object is invalid).
-
- You can use fields.setFields(this); to emulate the default behaviour.
-
-
Parameters:
-
fields - A Fields object containing all fields read from stream
@Name("Can Build")
-@Description({"Tests whether a player is allowed to build at a certain location.","This condition requires a supported <a href=\'./classes.html#region\'>regions</a> plugin to be installed."})
-@Examples({"command /setblock <material>:","\tdescription: set the block at your crosshair to a different type","\ttrigger:","\t\tplayer cannot build at the targeted block:","\t\t\tmessage \"You do not have permission to change blocks there!\"","\t\t\tstop","\t\tset the targeted block to argument"})
-@Since("2.0")
-@RequiredPlugins("Supported regions plugin")
-public class CondCanBuild
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Is Member/Owner of Region")
-@Description({"Checks whether a player is a member or owner of a particular region.","This condition requires a supported regions plugin to be installed."})
-@Examples({"on region enter:","\tplayer is the owner of the region","\tmessage \"Welcome back to %region%!\"","\tsend \"%player% just entered %region%!\" to all members of the region"})
-@Since("2.1")
-@RequiredPlugins("Supported regions plugin")
-public class CondIsMember
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
@Name("Region Contains")
-@Description({"Checks whether a location is contained in a particular <a href=\'./classes.html#region\'>region</a>.","This condition requires a supported regions plugin to be installed."})
-@Examples({"player is in the region {regions::3}","","on region enter:","\tregion contains {flags.%world%.red}","\tmessage \"The red flag is near!\""})
-@Since("2.1")
-@RequiredPlugins("Supported regions plugin")
-public class CondRegionContains
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
@Name("Blocks in Region")
-@Description({"All blocks in a <a href=\'./classes.html#region\'>region</a>.","This expression requires a supported regions plugin to be installed."})
-@Examples({"loop all blocks in the region {arena.%{faction.%player%}%}:","\tclear the loop-block"})
-@Since("2.1")
-@RequiredPlugins("Supported regions plugin")
-public class ExprBlocksInRegion
-extends SimpleExpression<org.bukkit.block.Block>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
@Name("Region Members & Owners")
-@Description({"A list of members or owners of a <a href=\'./classes.html#region\'>region</a>.","This expression requires a supported regions plugin to be installed."})
-@Examples({"on entering of a region:","\tmessage \"You\'re entering %region% whose owners are %owners of region%\""})
-@Since("2.1")
-@RequiredPlugins("Supported regions plugin")
-public class ExprMembersOfRegion
-extends SimpleExpression<org.bukkit.OfflinePlayer>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Region")
-@Description({"The <a href=\'./classes.html#region\'>region</a> involved in an event.","This expression requires a supported regions plugin to be installed."})
-@Examples({"on region enter:","\tregion is {forbidden region}","\tcancel the event"})
-@Since("2.1")
-@RequiredPlugins("Supported regions plugin")
-public class ExprRegion
-extends EventValueExpression<Region>
@Name("Regions At")
-@Description({"All <a href=\'./classes.html#region\'>regions</a> at a particular <a href=\'./classes/#location\'>location</a>.","This expression requires a supported regions plugin to be installed."})
-@Examples({"On click on a sign:","\tline 1 of the clicked block is \"[region info]\"","\tset {_regions::*} to regions at the clicked block","\tif {_regions::*} is empty:","\t\tmessage \"No regions exist at this sign.\"","\telse:","\t\tmessage \"Regions containing this sign: <gold>%{_regions::*}%<r>.\""})
-@Since("2.1")
-@RequiredPlugins("Supported regions plugin")
-public class ExprRegionsAt
-extends SimpleExpression<Region>
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
public abstract class SkriptEventextends Structure
A SkriptEvent is like a condition. It is called when any of the registered events occurs.
An instance of this class should then check whether the event applies
- (e.g. the rightclick event is included in the PlayerInteractEvent which also includes lefclicks, thus the SkriptEvent EvtClick checks whether it was a rightclick or
+ (e.g. the rightclick event is included in the PlayerInteractEvent which also includes lefclicks, thus the SkriptEvent EvtClick checks whether it was a rightclick or
not).
It is also needed if the event has parameters.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Usually, you want to override SimpleExpression.getConvertedExpr(Class[]).
- However, it may be useful to override this method if you have an expression with a return
- type that is unknown until runtime (like variables). Usually, you'll be fine with just
- the default implementation. This method is final on versions below 2.2-dev36.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Spawn")
-@Description({"Spawn a creature. This can be used as an effect and as a section.","If it is used as a section, the section is run before the entity is added to the world.","You can modify the entity in this section, using for example \'event-entity\' or \'cow\'. ","Do note that other event values, such as \'player\', won\'t work in this section."})
-@Examples({"spawn 3 creepers at the targeted block","spawn a ghast 5 meters above the player","spawn a zombie at the player:","\tset name of the zombie to \"\""})
-@Since("1.0, 2.6.1 (with section)")
-public class EffSecSpawn
-extends EffectSection
@Name("Conditionals")
-@Description({"Conditional sections","if: executed when its condition is true","else if: executed if all previous chained conditionals weren\'t executed, and its condition is true","else: executed if all previous chained conditionals weren\'t executed","","parse if: a special case of \'if\' condition that its code will not be parsed if the condition is not true","else parse if: another special case of \'else if\' condition that its code will not be parsed if all previous chained conditionals weren\'t executed, and its condition is true"})
-@Examples({"if player\'s health is greater than or equal to 4:","\tsend \"Your health is okay so far but be careful!\"","","else if player\'s health is greater than 2:","\tsend \"You need to heal ASAP, your health is very low!\"","","else: # Less than 2 hearts","\tsend \"You are about to DIE if you don\'t heal NOW. You have only %player\'s health% heart(s)!\"","","parse if plugin \"SomePluginName\" is enabled: # parse if %condition%","\t# This code will only be executed if the condition used is met otherwise Skript will not parse this section therefore will not give any errors/info about this section",""})
-@Since("1.0")
-public class SecConditional
-extends Section
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.lang.Section
@Name("Loop")
-@Description({"Loop sections repeat their code with multiple values.","","A loop will loop through all elements of the given expression, e.g. all players, worlds, items, etc. The conditions & effects inside the loop will be executed for every of those elements, which can be accessed with \u2018loop-<what>\u2019, e.g. <code>send \"hello\" to loop-player</code>. When a condition inside a loop is not fulfilled the loop will start over with the next element of the loop. You can however use <code>stop loop</code> to exit the loop completely and resume code execution after the end of the loop.","","<b>Loopable Values</b>","All <a href=\"/expressions.html\">expressions</a> that represent more than one value, e.g. \u2018all players\u2019, \u2018worlds\u2019, etc., as well as list variables, can be looped. You can also use a list of expressions, e.g. <code>loop the victim and the attacker</code>, to execute the same code for only a few values.","","<b>List Variables</b>","When looping list variables, you can also use <code>loop-index</code> in addition to <code>loop-value</code> inside the loop. <code>loop-value</code> is the value of the currently looped variable, and <code>loop-index</code> is the last part of the variable\'s name (the part where the list variable has its asterisk *)."})
-@Examples({"loop all players:","\tsend \"Hello %loop-player%!\" to loop-player","","loop items in player\'s inventory:","\tif loop-item is dirt:","\t\tset loop-item to air","","loop 10 times:","\tsend title \"%11 - loop-value%\" and subtitle \"seconds left until the game begins\" to player for 1 second # 10, 9, 8 etc.","\twait 1 second","","loop {Coins::*}:","\tset {Coins::%loop-index%} to loop-value + 5 # Same as \"add 5 to {Coins::%loop-index%}\" where loop-index is the uuid of the player and loop-value is the actually coins value such as 200"})
-@Since("1.0")
-public class SecLoop
-extends LoopSection
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.lang.Section
@Name("While Loop")
-@Description("While Loop sections are loops that will just keep repeating as long as a condition is met.")
-@Examples({"while size of all players < 5:","\tsend \"More players are needed to begin the adventure\" to all players","\twait 5 seconds","","set {_counter} to 1","do while {_counter} > 1: # false but will increase {_counter} by 1 then get out","\tadd 1 to {_counter}","","# Be careful when using while loops with conditions that are almost ","# always true for a long time without using \'wait %timespan%\' inside it, ","# otherwise it will probably hang and crash your server.","while player is online:","\tgive player 1 dirt","\twait 1 second # without using a delay effect the server will crash"})
-@Since("2.0, 2.6 (do while)")
-public class SecWhile
-extends LoopSection
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class ch.njol.skript.lang.Section
The second phase of Structure loading.
- During this phase, Structures are loaded script by script.
- The order they are loaded in for each script is based on the Structure's priority.
@Name("Command")
-@Description("Used for registering custom commands.")
-@Examples({"command /broadcast <string>:","\tusage: A command for broadcasting a message to all players.","\tpermission: skript.command.broadcast","\tpermission message: You don\'t have permission to broadcast messages","\taliases: /bc","\texecutable by: players and console","\tcooldown: 15 seconds","\tcooldown message: You last broadcast a message %elapsed time% ago. You can broadcast another message in %remaining time%.","\tcooldown bypass: skript.command.broadcast.admin","\tcooldown storage: {cooldown::%player%}","\ttrigger:","\t\tbroadcast the argument"})
-@Since("1.0")
-public class StructCommand
-extends Structure
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class org.skriptlang.skript.lang.structure.Structure
The second phase of Structure loading.
- During this phase, Structures are loaded script by script.
- The order they are loaded in for each script is based on the Structure's priority.
The third and final phase of Structure loading.
- The loading order and method is the same as Structure.load().
- This method is primarily designed for Structures that wish to execute actions after
- most other Structures have finished loading.
Called when this structure is unloaded.
- This method is primarily designed for Structures that wish to execute actions after
- most other Structures have finished unloading.
@Name("Function")
-@Description({"Functions are structures that can be executed with arguments/parameters to run code.","They can also return a value to the trigger that is executing the function.","Note that local functions come before global functions execution"})
-@Examples({"function sayMessage(message: text):","\tbroadcast {_message} # our message argument is available in \'{_message}\'","","local function giveApple(amount: number) :: item:","\treturn {_amount} of apple","","function getPoints(p: player) returns number:","\treturn {points::%{_p}%}"})
-@Since("2.2, 2.7 (local functions)")
-public class StructFunction
-extends Structure
-
-
-
-
-
-
-
Nested Class Summary
-
-
Nested classes/interfaces inherited from class org.skriptlang.skript.lang.structure.Structure
The second phase of Structure loading.
- During this phase, Structures are loaded script by script.
- The order they are loaded in for each script is based on the Structure's priority.
The third and final phase of Structure loading.
- The loading order and method is the same as Structure.load().
- This method is primarily designed for Structures that wish to execute actions after
- most other Structures have finished loading.
@Name("Options")
-@Description({"Options are used for replacing parts of a script with something else.","For example, an option may represent a message that appears in multiple locations.","Take a look at the example below that showcases this."})
-@Examples({"options:","\tno_permission: You\'re missing the required permission to execute this command!","","command /ping:","\tpermission: command.ping","\tpermission message: {@no_permission}","\ttrigger:","\t\tmessage \"Pong!\"","","command /pong:","\tpermission: command.pong","\tpermission message: {@no_permission}","\ttrigger:","\t\tmessage \"Ping!\""})
-@Since("1.0")
-public class StructOptions
-extends Structure
The second phase of Structure loading.
- During this phase, Structures are loaded script by script.
- The order they are loaded in for each script is based on the Structure's priority.
@Name("Variables")
-@Description({"Used for defining variables present within a script.","This section is not required, but it ensures that a variable has a value if it doesn\'t exist when the script is loaded."})
-@Examples({"variables:","\t{joins} = 0","\t{balance::%player%} = 0","","on join:","\tadd 1 to {joins}","\tmessage \"Your balance is %{balance::%player%}%\"",""})
-@Since("1.0")
-public class StructVariables
-extends Structure
The second phase of Structure loading.
- During this phase, Structures are loaded script by script.
- The order they are loaded in for each script is based on the Structure's priority.
Called when this structure is unloaded.
- This method is primarily designed for Structures that wish to execute actions after
- most other Structures have finished unloading.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Running Minecraft")
-@Description("Checks if current Minecraft version is given version or newer.")
-@Examples("running minecraft \"1.14\"")
-@Since("2.5")
-public class CondMinecraftVersion
-extends Condition
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns
- false. All subsequent conditions of the same trigger will then be omitted.
-
- You might want to use SimpleExpression.check(Event, Checker)
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Debug")
-@Description({"Debug an expression by printing data of it to console.","Can also debug what class an input is parsed as for Conditions and Effects.","Useful for dealing with conflict debugging."})
-@Since("2.7")
-@NoDoc
-public class EffDebug
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
@Name("Objectives")
-@Description("An effect to setup required objectives for JUnit tests to complete.")
-@NoDoc
-public class EffObjectives
-extends Effect
-
-
-
-
-
-
-
Field Summary
-
-
Fields inherited from class ch.njol.skript.lang.TriggerItem
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Checks whether the given Event applies, e.g. the leftclick event is only part of the PlayerInteractEvent, and this checks whether the player leftclicked or not. This method
- will only be called for events this SkriptEvent is registered for.
exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list
- holding the default value of the desired type which usually depends on the event.
-
matchedPattern - The index of the pattern which matched
-
isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
-
parseResult - Additional information about the match.
-
Returns:
-
Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
Root path for scripts containing tests. If DEV_MODE is enabled,
- a command will be available to run them individually or collectively.
- Otherwise, all tests are run, results are written in JSON format to
- RESULTS_FILE as in TestResults.
-
-
-
-
-
DEV_MODE
-
public static finalbooleanDEV_MODE
-
Enable test development mode. Skript will allow individual test scripts
- to be loaded and ran, and prints results to chat or console.
Contains test results: successes, failures and doc failure. Will be serialized with Gson
- for transfering it between processes of gradle/environment and the actual spigot server.
Main usage is ExprInventoryInfo
This class allows Skript to return a block while being able to recognize it as InventoryHolder,
You may only use this class if a expression's return type is an InventoryHolder.
public staticdoublegetBlockHeight(int type,
byte data)
Gets the collision height of solid or partially-solid blocks at the center of the block.
- This is mostly for use in the teleport effect.
+ This is mostly for use in the teleport effect.
This version operates on numeric ids, thus only working on
Minecraft 1.12 or older.
Main usage is ExprInventoryInfo
This class allows Skript to return a block while being able to recognize it as InventoryHolder,
You may only use this class if a expression's return type is an InventoryHolder.
Main usage is ExprInventoryInfo
This class allows Skript to return a block while being able to recognize it as InventoryHolder,
You may only use this class if a expression's return type is an InventoryHolder.
Clones the given object by calling ClassInfo.clone(Object),
+ getting the ClassInfo from the closest registered superclass
+ (or the given object's class).
Uses strings for serialisation because the whole ConfigurationSerializable interface is badly documented, and especially DelegateDeserialization doesn't work well with
+ Yggdrasil.
Clones the given object by calling ClassInfo.clone(Object),
- getting the ClassInfo from the closest registered superclass
- (or the given object's class).
Uses strings for serialisation because the whole ConfigurationSerializable interface is badly documented, and especially DelegateDeserialization doesn't work well with
- Yggdrasil.
A block that gets all data from the world, but either delays
- any changes by 1 tick of reflects them on a given BlockState
- depending on which constructor is used.
An effect which is unconditionally executed when reached, and execution will usually continue with the next item of the trigger after this effect is executed (the stop effect
- for example stops the trigger, i.e.
-
-
Effect() - Constructor for class ch.njol.skript.lang.Effect
This class can be used for an easier writing of ClassInfos that are enums,
- it registers a language node with usage, a serializer, default expression and a parser.
Extracts the actual CraftBukkit block from the given argument,
- by extracting the block from DelayedChangeBlock if the given argument is a DelayedChangeBlock.
Returns a string representation of the given object to be used for debugging.
- The Parser of 'Block' for example returns the block's type in toString, while this method also returns the coordinates of the block.
- The default implementation of this method returns toString(o, 0).
Checks if this chat code takes a string parameter.
+
A block that gets all data from the world, but either delays
+ any changes by 1 tick of reflects them on a given BlockState
+ depending on which constructor is used.
An effect which is unconditionally executed when reached, and execution will usually continue with the next item of the trigger after this effect is executed (the stop effect
+ for example stops the trigger, i.e.
+
+
Effect() - Constructor for class ch.njol.skript.lang.Effect
This class can be used for an easier writing of ClassInfos that are enums,
+ it registers a language node with usage, a serializer, default expression and a parser.
Extracts the actual CraftBukkit block from the given argument,
+ by extracting the block from DelayedChangeBlock if the given argument is a DelayedChangeBlock.
Returns a string representation of the given object to be used for debugging.
+ The Parser of 'Block' for example returns the block's type in toString, while this method also returns the coordinates of the block.
+ The default implementation of this method returns toString(o, 0).
Intersects all ItemDatas with all ItemDatas of the given ItemType, returning an ItemType with at most n*m ItemDatas, where n = #ItemDatas of this ItemType, and m =
- #ItemDatas of the argument.
Doesn't lock the database for reading (it's not used anywhere else, and locking while loading will interfere with loaded variables being deleted by
- Variables.variableLoaded(String, Object, VariablesStorage)).
Intersects all ItemDatas with all ItemDatas of the given ItemType, returning an ItemType with at most n*m ItemDatas, where n = #ItemDatas of this ItemType, and m =
+ #ItemDatas of the argument.
The pattern structure is a linked list of PatternElements,
- where PatternElement.next points to the next element to be matched,
- which can be on an outer level, and where PatternElement.originalNext points
- to the next element on the same level.
+
Sets all Option fields of the given object to the values from this config
Creates a permutation of all integers in the interval [start, end]
+
Doesn't lock the database for reading (it's not used anywhere else, and locking while loading will interfere with loaded variables being deleted by
+ Variables.variableLoaded(String, Object, VariablesStorage)).
-
PI - Static variable in class ch.njol.util.VectorMath
This class can be used for an easier writing of conditions that contain only one type in the pattern,
- and are in one of the following forms:
-
- something is something
- something can something
- something has something
-
- The plural and negated forms are also supported.
Registers an expression as ExpressionType.PROPERTY with the two default property patterns "property [of %types%]" and "%types%'[s] property"
- This method also makes the expression type optional to force a default expression on the property expression.
Internal method for updating a ParserInstance's ParserInstance.isActive() status!
- You probably don't need to use this method!
+
The pattern structure is a linked list of PatternElements,
+ where PatternElement.next points to the next element to be matched,
+ which can be on an outer level, and where PatternElement.originalNext points
+ to the next element on the same level.
Skript - A Bukkit plugin to modify how Minecraft behaves without having to write a single line of code (You'll likely be writing some code though if you're reading this
- =P)
+
This API is experimental and subject to change.
+ Adds the provided event to this Script.
Skript - A Bukkit plugin to modify how Minecraft behaves without having to write a single line of code (You'll likely be writing some code though if you're reading this
+ =P)