| Patterns: |
|
| Since: | 2.11 |
Set whether an allay can or cannot duplicate itself.
This is not the same as breeding allays.
This is not the same as breeding allays.
Examples:
allow all allays to duplicate
prevent all allays from duplicating
prevent all allays from duplicating
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Unleash |
Allows or prevents the leash from being dropped in an unleash event.
Examples:
on unleash:
if player is not set:
prevent the leash from dropping
else if player is op:
allow the leash to drop
if player is not set:
prevent the leash from dropping
else if player is op:
allow the leash to drop
| Patterns: |
|
| Since: | 2.10 |
Sets whether or not living entities will be able to age.
Examples:
on spawn of animal:
allow aging of entity
allow aging of entity
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Fishing |
Sets whether the lure enchantment should be applied, which reduces the wait time.
Examples:
on fishing line cast:
apply lure enchantment bonus
apply lure enchantment bonus
| Patterns: |
|
| Since: | 1.4, 2.1.1 (ban reason), 2.5 (timespan), 2.9.0 (kick) |
Bans or unbans a player or an IP address.
If a reason is given, it will be shown to the player when they try to join the server while banned.
A length of ban may also be given to apply a temporary ban. If it is absent for any reason, a permanent ban will be used instead.
We recommend that you test your scripts so that no accidental permanent bans are applied.
Note that banning people does not kick them from the server.
You can optionally use 'and kick' or consider using the kick effect after applying a ban.
If a reason is given, it will be shown to the player when they try to join the server while banned.
A length of ban may also be given to apply a temporary ban. If it is absent for any reason, a permanent ban will be used instead.
We recommend that you test your scripts so that no accidental permanent bans are applied.
Note that banning people does not kick them from the server.
You can optionally use 'and kick' or consider using the kick effect after applying a ban.
Examples:
unban player
ban "127.0.0.1"
IP-ban the player because "he is an idiot"
ban player due to "inappropriate language" for 2 days
ban and kick player due to "inappropriate language" for 2 days
ban "127.0.0.1"
IP-ban the player because "he is an idiot"
ban player due to "inappropriate language" for 2 days
ban and kick player due to "inappropriate language" for 2 days
| Patterns: | |
| Since: | 2.4 |
Breaks the block and spawns items as if a player had mined it
You can add a tool, which will spawn items based on how that tool would break the block
(ie: When using a hand to break stone, it drops nothing, whereas with a pickaxe it drops cobblestone)
You can add a tool, which will spawn items based on how that tool would break the block
(ie: When using a hand to break stone, it drops nothing, whereas with a pickaxe it drops cobblestone)
Examples:
on right click:
break clicked block naturally
loop blocks in radius 10 around player:
break loop-block using player's tool
loop blocks in radius 10 around player:
break loop-block naturally using diamond pickaxe
break clicked block naturally
loop blocks in radius 10 around player:
break loop-block using player's tool
loop blocks in radius 10 around player:
break loop-block naturally using diamond pickaxe
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper 1.16+ |
Interrupts the action entities may be trying to complete.
For example, interrupting eating, or drawing back a bow.
For example, interrupting eating, or drawing back a bow.
Examples:
on damage of player:
if the victim's active tool is a bow:
interrupt the usage of the player's active item
if the victim's active tool is a bow:
interrupt the usage of the player's active item
| Patterns: |
|
| Since: | 2.2-dev34 |
Only usable in commands. Makes it so the current command usage isn't counted towards the cooldown.
Examples:
command /nick <text>:
executable by: players
cooldown: 10 seconds
trigger:
if length of arg-1 is more than 16:
# Makes it so that invalid arguments don't make you wait for the cooldown again
cancel the cooldown
send "Your nickname may be at most 16 characters."
stop
set the player's display name to arg-1
executable by: players
cooldown: 10 seconds
trigger:
if length of arg-1 is more than 16:
# Makes it so that invalid arguments don't make you wait for the cooldown again
cancel the cooldown
send "Your nickname may be at most 16 characters."
stop
set the player's display name to arg-1
| Patterns: |
|
| Since: | 2.4, 2.12 (harvest event) |
| Usable in events: | death, break / mine, block drop, harvest |
| Requirements: | 1.12.2 or newer (cancelling item drops of blocks) |
Cancels drops of items in a death, block break, block drop, and block harvest events.
The dropped experience can be cancelled in a death and block break events.
Please note that using this in a death event doesn't keep items or experience of a dead player. If you want to do that, use the Keep Inventory / Experience effect.
The dropped experience can be cancelled in a death and block break events.
Please note that using this in a death event doesn't keep items or experience 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
on player block harvest:
cancel the item drops
if name of the entity is "&cSpecial":
cancel drops of items
on break of a coal ore:
cancel the experience drops
on player block harvest:
cancel the item drops
| Patterns: |
|
| Since: | 1.0 |
Cancels the event (e.g. prevent blocks from being placed, or damage being taken).
Examples:
on damage:
victim is a player
victim has the permission "skript.god"
cancel the event
victim is a player
victim has the permission "skript.god"
cancel the event
| Patterns: | |
| Since: | 1.0 (set, add, remove, delete), 2.0 (remove all) |
A general effect that can be used for changing many expressions.
Some expressions can only be set and/or deleted, while others can also have things added to or removed from them.
Some expressions can only be set and/or deleted, while others can also have things added to or removed from them.
Examples:
# Set
Set the player's display name to "<red>%name of player%"
set the block above the victim to lava
# Add
add 2 to the player's health # preferably use '<a href='#EffHealth'>heal</a>' for this
add argument to {blacklist::*}
give a diamond pickaxe of efficiency 5 to the player
increase the data value of the clicked block by 1
# Remove
remove 2 pickaxes from the victim
subtract 2.5 from {points::%uuid of player%}
# Remove All
remove every iron tool from the player
remove all minecarts from {entitylist::*}
# Delete
delete the block below the player
clear drops
delete {variable}
# Reset
reset walk speed of player
reset chunk at the targeted block
Set the player's display name to "<red>%name of player%"
set the block above the victim to lava
# Add
add 2 to the player's health # preferably use '<a href='#EffHealth'>heal</a>' for this
add argument to {blacklist::*}
give a diamond pickaxe of efficiency 5 to the player
increase the data value of the clicked block by 1
# Remove
remove 2 pickaxes from the victim
subtract 2.5 from {points::%uuid of player%}
# Remove All
remove every iron tool from the player
remove all minecarts from {entitylist::*}
# Delete
delete the block below the player
clear drops
delete {variable}
# Reset
reset walk speed of player
reset chunk at the targeted block
| Patterns: |
|
| Since: | 2.11 |
| Requirements: | Paper |
Clear the stored entities of an entity block storage (i.e. beehive).
Examples:
clear the stored entities of {_beehive}
| Patterns: |
|
| Since: | 2.0, 2.2-dev26 (maps and potions) |
Colors items in a given color. You can also use RGB codes if you feel limited with the 16 default colors. RGB codes are three numbers from 0 to 255 in the order
(red, green, blue), where (0,0,0) is black and (255,255,255) is white. Armor is colorable for all Minecraft versions. With Minecraft 1.11 or newer you can also color potions and maps. Note that the colors might not look exactly how you'd expect. Examples:
dye player's helmet blue
color the player's tool red
color the player's tool red
| Patterns: |
|
| Since: | 1.0, 2.8.0 (bungeecord command) |
Executes a command. This can be useful to use other plugins in triggers.
If the command is a bungeecord side command, you can use the [bungeecord] option to execute command on the proxy.
If the command is a bungeecord side command, you can use the [bungeecord] option to execute command on the proxy.
Examples:
make player execute command "/home"
execute console command "/say Hello everyone!"
execute player bungeecord command "/alert &6Testing Announcement!"
execute console command "/say Hello everyone!"
execute player bungeecord command "/alert &6Testing Announcement!"
| Patterns: |
|
| Since: | 2.10 |
Sets whether the provided command blocks are conditional or not.
Examples:
make command block {_block} conditional
make command block {_block} unconditional if {_block} is conditional
make command block {_block} unconditional if {_block} is conditional
| Patterns: | |
| Since: | 2.3, 2.10 (transfer) |
Connect a player to a server running on your proxy, or any server supporting transfers. Read below for more information.
If the server is running Minecraft 1.20.5 or above, you may specify an IP and Port to transfer a player over to that server.
When transferring players using an IP, the transfer will not complete if the `accepts-transfers` option isn't enabled in `server.properties` for the server specified.
If the port is not provided, it will default to `25565`.
If the server is running Minecraft 1.20.5 or above, you may specify an IP and Port to transfer a player over to that server.
When transferring players using an IP, the transfer will not complete if the `accepts-transfers` option isn't enabled in `server.properties` for the server specified.
If the port is not provided, it will default to `25565`.
Examples:
connect all players to proxy server "hub"
transfer player to server "my.server.com"
transfer player to server "localhost" on port 25566
transfer player to server "my.server.com"
transfer player to server "localhost" on port 25566
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Paper |
Prevent the firework used in an 'elytra boost' event to be consumed.
Examples:
on elytra boost:
if the used firework will be consumed:
prevent the used firework from being consume
if the used firework will be consumed:
prevent the used firework from being consume
| Patterns: |
|
| Since: | 2.2-dev37, 2.7 (while loops), 2.8.0 (outer loops) |
Moves the loop to the next iteration. You may also continue an outer loop from an inner one. The loops are labelled from 1 until the current loop, starting with the outermost one.
Examples:
# Broadcast online moderators
loop all players:
if loop-value does not have permission "moderator":
continue # filter out non moderators
broadcast "%loop-player% is a moderator!" # Only moderators get broadcast
# Game starting counter
set {_counter} to 11
while {_counter} > 0:
remove 1 from {_counter}
wait a second
if {_counter} != 1, 2, 3, 5 or 10:
continue # only print when counter is 1, 2, 3, 5 or 10
broadcast "Game starting in %{_counter}% second(s)"
loop all players:
if loop-value does not have permission "moderator":
continue # filter out non moderators
broadcast "%loop-player% is a moderator!" # Only moderators get broadcast
# Game starting counter
set {_counter} to 11
while {_counter} > 0:
remove 1 from {_counter}
wait a second
if {_counter} != 1, 2, 3, 5 or 10:
continue # only print when counter is 1, 2, 3, 5 or 10
broadcast "Game starting in %{_counter}% second(s)"
| Patterns: | |
| Since: | 2.8.0 |
Copies objects into a variable. When copying a list over to another list, the source list and its sublists are also copied over.
Note: Copying a value into a variable/list will overwrite the existing data.
Note: Copying a value into a variable/list will overwrite the existing data.
Examples:
set {_foo::bar} to 1
set {_foo::sublist::foobar} to "hey"
copy {_foo::*} to {_copy::*}
broadcast indices of {_copy::*} # bar, sublist
broadcast {_copy::bar} # 1
broadcast {_copy::sublist::foobar} # "hey!"
set {_foo::sublist::foobar} to "hey"
copy {_foo::*} to {_copy::*}
broadcast indices of {_copy::*} # bar, sublist
broadcast {_copy::bar} # 1
broadcast {_copy::sublist::foobar} # "hey!"
| Patterns: |
|
| Since: | 1.0, 2.10 (damage cause) |
| Requirements: | Spigot 1.20.4+ (for damage cause) |
Damage, heal, or repair an entity or item.
Servers running Spigot 1.20.4+ can optionally choose to specify a fake damage cause.
Servers running Spigot 1.20.4+ can optionally choose to specify a fake damage cause.
Examples:
damage player by 5 hearts
damage player by 3 hearts with fake cause fall
heal the player
repair tool of player
damage player by 3 hearts with fake cause fall
heal the player
repair tool of player
| Patterns: |
|
| Since: | 2.11 |
| Requirements: | Paper 1.20.1+ (piglins) |
Make an allay or piglin start or stop dancing.
Providing a location only applies to allays. They will check to see if the the block at the location is a jukebox and playing music. If it isn't, they will stop dancing. If no location is provided, the allay will dance indefinitely.
Providing a timespan only applies for piglins. It determines the length of time they will dance for. If no timespan is provided, they will dance indefinitely.
Providing a location only applies to allays. They will check to see if the the block at the location is a jukebox and playing music. If it isn't, they will stop dancing. If no location is provided, the allay will dance indefinitely.
Providing a timespan only applies for piglins. It determines the length of time they will dance for. If no timespan is provided, they will dance indefinitely.
Examples:
if last spawned allay is not dancing:
make last spawned allay start dancing
if block at location(0, 0, 0) is a jukebox:
make all allays dance at location(0, 0, 0)
make last spawned piglin start dancing
make all piglins dance for 5 hours
make last spawned allay start dancing
if block at location(0, 0, 0) is a jukebox:
make all allays dance at location(0, 0, 0)
make last spawned piglin start dancing
make all piglins dance for 5 hours
| Patterns: |
|
| Since: | 1.4 |
Delays the script's execution by a given timespan. Please note that delays are not persistent, e.g. trying to create a tempban script with
ban player → wait 7 days → unban player will not work if you restart your server anytime within these 7 days. You also have to be careful even when using small delays! Examples:
wait 2 minutes
halt for 5 minecraft hours
wait a tick
halt for 5 minecraft hours
wait a tick
| Patterns: |
|
| Since: | 2.10 |
Immediately detonates an entity. Accepted entities are fireworks, TNT minecarts, primed TNT, wind charges and creepers.
Examples:
detonate last launched firework
| Patterns: |
|
| Since: | 2.3 |
Execute an effect if a condition is true.
Examples:
on join:
give a diamond to the player if the player has permission "rank.vip"
give a diamond to the player if the player has permission "rank.vip"
| Patterns: |
|
| Since: | 1.0 |
Drops one or more items.
Examples:
on death of creeper:
drop 1 TNT
drop 1 TNT
| Patterns: | |
| Since: | 2.4, 2.10 (unloading) |
Enables, disables, unloads, or reloads a script.
Disabling a script unloads it and prepends - to its name so it will not be loaded the next time the server restarts. If the script reflection experiment is enabled: unloading a script terminates it and removes it from memory, but does not alter the file.
Examples:
reload script "test"
enable script file "testing"
unload script file "script.sk"
set {_script} to the script "MyScript.sk"
reload {_script}
enable script file "testing"
unload script file "script.sk"
set {_script} to the script "MyScript.sk"
reload {_script}
| Patterns: |
|
| Since: | 2.0 |
Enchant or disenchant an existing item.
Examples:
enchant the player's tool with sharpness 5
disenchant the player's tool
disenchant the player's tool
| Patterns: |
|
| Since: | 2.11 |
| Requirements: | Minecraft 1.20.1+ |
Make an enderman teleport randomly or towards an entity.
Teleporting towards an entity teleports in the direction to the entity and not to them.
Teleporting towards an entity teleports in the direction to the entity and not to them.
Examples:
make last spawned enderman teleport randomly
loop 10 times:
make all endermen teleport towards player
loop 10 times:
make all endermen teleport towards player
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | MC 1.17+ |
Enforces or un-enforce a server's whitelist.
All non-whitelisted players will be kicked upon enforcing the whitelist.
All non-whitelisted players will be kicked upon enforcing the whitelist.
Examples:
enforce the whitelist
unenforce the whitelist
unenforce the whitelist
| Patterns: |
|
| Since: | 2.11 |
Make a living entity despawn when the chunk they're located at is unloaded.
Setting a custom name on a living entity automatically makes it not despawnable.
More information on what and when entities despawn can be found at reference.
Setting a custom name on a living entity automatically makes it not despawnable.
More information on what and when entities despawn can be found at reference.
Examples:
make all entities not despawnable on chunk unload
spawn zombie at location(0, 0, 0):
force event-entity to not despawn when far away
spawn zombie at location(0, 0, 0):
force event-entity to not despawn when far away
| Patterns: | |
| Since: | 2.3, 2.10 (entities) |
| Requirements: | Minecraft 1.19+ (entities) |
Change visibility of the given entities for the given players.
If no players are given, will hide the entities from all online players.
When reveal is used in combination of the hidden players expression and the viewers are not specified, this will default it to the given player in the hidden players expression.
Note: all previously hidden entities (including players) will be visible when a player leaves and rejoins.
If no players are given, will hide the entities from all online players.
When reveal is used in combination of the hidden players expression and the viewers are not specified, this will default it to the given player in the hidden players expression.
Note: all previously hidden entities (including players) will be visible when a player leaves and rejoins.
Examples:
on spawn:
if event-entity is a chicken:
hide event-entity
reveal hidden players of players
if event-entity is a chicken:
hide event-entity
reveal hidden players of players
| Patterns: |
|
| Since: | 1.0, 2.7 (multiple entities, unequip), 2.10 (wolves) 2.12.1 (happy ghasts) |
Equips or unequips an entity with the given itemtypes (usually armor).
This effect will replace any armor that the entity is already wearing.
This effect will replace any armor that the entity is already wearing.
Examples:
equip player with diamond helmet
equip player with diamond leggings, diamond chestplate, and diamond boots
unequip diamond chestplate from player
unequip player's armor
equip player with diamond leggings, diamond chestplate, and diamond boots
unequip diamond chestplate from player
unequip player's armor
| Patterns: |
|
| Since: | unknown (before 2.1) |
Exits a given amount of loops and conditionals, or the entire trigger.
Examples:
if player has any ore:
stop
message "%player% has no ores!"
loop blocks above the player:
loop-block is not air:
exit 2 sections
set loop-block to water
stop
message "%player% has no ores!"
loop blocks above the player:
loop-block is not air:
exit 2 sections
set loop-block to water
| Patterns: |
|
| Since: | 2.11 |
Expand or shrink the size of a world border.
Using `by` adds/subtracts from the current size of the world border.
Using `to` sets to the specified size.
Using `by` adds/subtracts from the current size of the world border.
Using `to` sets to the specified size.
Examples:
expand world border of player by 100 over 5 seconds
shrink world border of world "world" to 100 over 10 seconds
shrink world border of world "world" to 100 over 10 seconds
| Patterns: |
|
| Since: | 2.5 |
| Requirements: | Paper 1.13 or newer/Spigot 1.14 or newer. Ignition can be stopped on Paper 1.13 or newer. |
Starts the explosion process of a creeper or instantly explodes it.
Examples:
start explosion of the last spawned creeper
stop ignition of the last spawned creeper
stop ignition of the last spawned creeper
| Patterns: |
|
| Since: | 1.0 |
Creates an explosion of a given force. The Minecraft Wiki has an article on explosions which lists the explosion forces of TNT, creepers, etc.
Hint: use a force of 0 to create a fake explosion that does no damage whatsoever, or use the explosion effect introduced in Skript 2.0.
Starting with Bukkit 1.4.5 and Skript 2.0 you can use safe explosions which will damage entities but won't destroy any blocks.
Hint: use a force of 0 to create a fake explosion that does no damage whatsoever, or use the explosion effect introduced in Skript 2.0.
Starting with Bukkit 1.4.5 and Skript 2.0 you can use safe explosions which will damage entities but won't destroy any blocks.
Examples:
create an explosion of force 10 at the player
create an explosion of force 0 at the victim
create an explosion of force 0 at the victim
| Patterns: |
|
| Since: | 2.5.1 |
| Requirements: | Minecraft 1.15.2+ |
Makes a living entity attack an entity with a melee attack.
Examples:
spawn a wolf at player's location
make last spawned wolf attack player
make last spawned wolf attack player
| Patterns: |
|
| Since: | 2.11 |
| Requirements: | Paper (horse type) |
Make a panda or horse type (horse, camel, donkey, llama, mule) start/stop eating.
Examples:
if last spawned panda is eating:
make last spawned panda stop eating
make last spawned panda stop eating
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Spigot 1.20.5+ |
Forces the items to glint or not, or removes its existing enchantment glint enforcement.
Examples:
force {_items::*} to glint
force the player's tool to stop glinting
force the player's tool to stop glinting
| Patterns: |
|
| Since: | 2.11 |
Make a panda get on/off its back.
Examples:
if last spawned panda is on its back:
make last spawned panda get off its back
make last spawned panda get off its back
| Patterns: |
|
| Since: | 2.2-dev21 |
Forces player(s) to respawn if they are dead. If this is called without delay from death event, one tick is waited before respawn attempt.
Examples:
on death of player:
force event-player to respawn
force event-player to respawn
| Patterns: |
|
| Since: | 2.10 |
Generates the loot in the specified inventories from a loot table using a loot context. Not specifying a loot context will use a loot context with a location at the world's origin.
Note that if the inventory is full, it will cause warnings in the console due to over-filling the inventory.
Note that if the inventory is full, it will cause warnings in the console due to over-filling the inventory.
Examples:
generate loot of loot table "minecraft:chests/simple_dungeon" using loot context at player in {_inventory}
generate loot using "minecraft:chests/shipwreck_supply" in {_inventory}
generate loot using "minecraft:chests/shipwreck_supply" in {_inventory}
| Patterns: |
|
| Since: | 2.11 |
Make a goat have or not have a left, right, or both horns.
Examples:
remove the left horn of last spawned goat
regrow {_goat}'s horns
remove both horns of all goats
regrow {_goat}'s horns
remove both horns of all goats
| Patterns: |
|
| Since: | 2.8.0 |
| Requirements: | Paper 1.17.1+ |
Make mobs left or right-handed. This does not affect players.
Examples:
spawn skeleton at spawn of world "world":
make entity left handed
make all zombies in radius 10 of player right handed
make entity left handed
make all zombies in radius 10 of player right handed
| Patterns: | |
| Since: | 2.3 |
Hides a player from the hover list and decreases the online players count (only if the player count wasn't changed before).
Examples:
on server list ping:
hide {vanished::*} from the server list
hide {vanished::*} from the server list
| Patterns: |
|
| Since: | 2.11 |
| Requirements: | Minecraft 1.21+ |
Add an entity into the entity storage of a block (e.g. beehive).
The entity must be of the right type for the block (e.g. bee for beehive).
Due to unstable behavior on older versions, adding entities to an entity storage requires Minecraft version 1.21+.
The entity must be of the right type for the block (e.g. bee for beehive).
Due to unstable behavior on older versions, adding entities to an entity storage requires Minecraft version 1.21+.
Examples:
add last spawned bee into the entity storage of {_beehive}
| Patterns: |
|
| Since: | 2.11 |
Prevent a dropped item from naturally despawning through Minecraft's timer.
Examples:
prevent all dropped items from naturally despawning
allow all dropped items to naturally despawn
allow all dropped items to naturally despawn
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Spigot 1.20.5+ |
Show or hide the tooltip of an item.
If changing the 'entire' tooltip of an item, nothing will show up when a player hovers over it.
If changing the 'additional' tooltip, only specific parts (which change per item) will be hidden.
If changing the 'entire' tooltip of an item, nothing will show up when a player hovers over it.
If changing the 'additional' tooltip, only specific parts (which change per item) will be hidden.
Examples:
hide the entire tooltip of player's tool
hide {_item}'s additional tool tip
hide {_item}'s additional tool tip
| Patterns: |
|
| Since: | 2.4 |
| Usable in events: | death |
Keeps the inventory or/and experiences of the dead player in a death event.
Examples:
on death of a player:
if the victim is an op:
keep the inventory and experiences
if the victim is an op:
keep the inventory and experiences
| Patterns: |
|
| Since: | 1.0, 2.10 (ignoring totem of undying) |
Kills an entity.
Examples:
kill the player
kill all creepers in the player's world
kill all endermen, witches and bats
kill all creepers in the player's world
kill all endermen, witches and bats
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper 1.19.2+ |
Apply the same velocity as a knockback to living entities in a direction. Mechanics such as knockback resistance will be factored in.
Examples:
knockback player north
knock victim (vector from attacker to victim) with strength 10
knock victim (vector from attacker to victim) with strength 10
| Patterns: |
|
| Since: | 2.4 |
Launch firework effects at the given location(s).
Examples:
launch ball large colored red, purple and white fading to light green and black at player's location with duration 1
| Patterns: |
|
| Since: | 2.3 |
Leash living entities to other entities. When trying to leash an Ender Dragon, Wither, Player, or a Bat, this effect will not work.
See Spigot's Javadocs for more info.
See Spigot's Javadocs for more info.
Examples:
on right click:
leash event-entity to player
send "&aYou leashed &2%event-entity%!" to player
leash event-entity to player
send "&aYou leashed &2%event-entity%!" to player
| Patterns: |
|
| Since: | 1.4 |
Strike lightning at a given location. Can use 'lightning effect' to create a lightning that does not harm entities or start fires.
Examples:
strike lightning at the player
strike lightning effect at the victim
strike lightning effect at the victim
| Patterns: |
|
| Since: | 2.3 |
| Requirements: | Paper 1.12.2 or newer |
Loads server icons from the given files. You can get the loaded icon using the
last loaded server icon expression.
Please note that the image must be 64x64 and the file path starts from the server folder.
last loaded server icon expression.
Please note that the image must be 64x64 and the file path starts from the server folder.
Examples:
on load:
clear {server-icons::*}
loop 5 times:
load server icon from file "icons/%loop-number%.png"
add the last loaded server icon to {server-icons::*}
on server list ping:
set the icon to a random server icon out of {server-icons::*}
clear {server-icons::*}
loop 5 times:
load server icon from file "icons/%loop-number%.png"
add the last loaded server icon to {server-icons::*}
on server list ping:
set the icon to a random server icon out of {server-icons::*}
| Patterns: |
|
| Since: | 2.8.0 |
Load your worlds or unload your worlds
The load effect will create a new world if world doesn't already exist.
When attempting to load a normal vanilla world you must define it's environment i.e "world_nether" must be loaded with nether environment
The load effect will create a new world if world doesn't already exist.
When attempting to load a normal vanilla world you must define it's environment i.e "world_nether" must be loaded with nether environment
Examples:
load world "world_nether" with environment nether
load the world "myCustomWorld"
unload "world_nether"
unload "world_the_end" without saving
unload all worlds
load the world "myCustomWorld"
unload "world_nether"
unload "world_the_end" without saving
unload all worlds
| Patterns: |
|
| Since: | 2.3 |
Suppresses target warnings from the current script.
Examples:
locally suppress missing conjunction warnings
suppress the variable save warnings
suppress the variable save warnings
| Patterns: | |
| Since: | 2.0, 2.9.0 (severities) |
Writes text into a .log file. Skript will write these files to /plugins/Skript/logs.
NB: Using 'server.log' as the log file will write to the default server log. Omitting the log file altogether will log the message as '[Skript] [<script>.sk] <message>' in the server log.
NB: Using 'server.log' as the log file will write to the default server log. Omitting the log file altogether will log the message as '[Skript] [<script>.sk] <message>' in the server log.
Examples:
on join:
log "%player% has just joined the server!"
on world change:
log "Someone just went to %event-world%!" to file "worldlog/worlds.log"
on command:
log "%player% just executed %full command%!" to file "server/commands.log" with a severity of warning
log "%player% has just joined the server!"
on world change:
log "Someone just went to %event-world%!" to file "worldlog/worlds.log"
on command:
log "%player% just executed %full command%!" to file "server/commands.log" with a severity of warning
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper 1.17+, Paper 1.19.1+ (Players & Look Anchors) |
Forces the mob(s) or player(s) to look at an entity, vector or location. Vanilla max head pitches range from 10 to 50.
Examples:
force the player to look towards event-entity's feet
on entity explosion:
set {_player} to the nearest player
{_player} is set
distance between {_player} and the event-location is less than 15
make {_player} look towards vector from the {_player} to location of the event-entity
force {_enderman} to face the block 3 meters above {_location} at head rotation speed 100.5 and max head pitch -40
on entity explosion:
set {_player} to the nearest player
{_player} is set
distance between {_player} and the event-location is less than 15
make {_player} look towards vector from the {_player} to location of the event-entity
force {_enderman} to face the block 3 meters above {_location} at head rotation speed 100.5 and max head pitch -40
| Patterns: |
|
| Since: | 2.10 |
Force a animal to become an adult or baby.
Examples:
on spawn of mob:
entity is not an adult
make entity an adult
entity is not an adult
make entity an adult
| Patterns: |
|
| Since: | 2.11 |
Make an allay duplicate itself.
This effect will always make an allay duplicate regardless of whether the duplicate attribute is disabled.
This effect will always make an allay duplicate regardless of whether the duplicate attribute is disabled.
Examples:
make all allays duplicate
| Patterns: |
|
| Since: | 2.10 |
Sets whether or not entities will be able to breed. Only works on animals.
Examples:
on spawn of animal:
make entity unbreedable
make entity unbreedable
| Patterns: |
|
| Since: | 2.11 |
Make a warden sense a disturbance at a location, causing the warden to investigate that area.
The warden will not investigate if the warden is aggressive towards an entity.
This effect does not add anger to the warden.
The warden will not investigate if the warden is aggressive towards an entity.
This effect does not add anger to the warden.
Examples:
make last spawned warden sense a disturbance at location(0, 0, 0)
| Patterns: |
|
| Since: | 2.7 |
| Usable in events: | Egg Throw |
Makes the egg hatch in a Player Egg Throw event.
Examples:
on player egg throw:
# EGGS FOR DAYZ!
make the egg hatch
# EGGS FOR DAYZ!
make the egg hatch
| Patterns: |
|
| Since: | 2.11 |
| Requirements: | Paper (endermen) |
Make a goat or enderman start or stop screaming.
Examples:
make last spawned goat start screaming
force last spawned goat to stop screaming
make {_enderman} scream
force {_enderman} to stop screaming
force last spawned goat to stop screaming
make {_enderman} scream
force {_enderman} to stop screaming
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Spigot 1.20.5+ |
Makes items fire resistant.
Examples:
make player's tool fire resistant:
make {_items::*} not resistant to fire
make {_items::*} not resistant to fire
| Patterns: |
|
| Since: | 2.11 |
| Requirements: | Paper |
Make a goat ram an entity.
Ramming does have a cooldown and currently no way to change it.
Ramming does have a cooldown and currently no way to change it.
Examples:
make all goats ram player
| Patterns: | |
| Since: | 2.5 |
Sets if an entity's explosion will leave behind fire. This effect is also usable in an explosion prime event.
Examples:
on explosion prime:
make the explosion fiery
make the explosion fiery
| Patterns: |
|
| Since: | 2.7 |
Makes a living entity visible/invisible. This is not a potion and therefore does not have features such as a time limit or particles.
When setting an entity to invisible while using an invisibility potion on it, the potion will be overridden and when it runs out the entity keeps its invisibility.
When setting an entity to invisible while using an invisibility potion on it, the potion will be overridden and when it runs out the entity keeps its invisibility.
Examples:
make target entity invisible
| Patterns: |
|
| Since: | 2.11 |
Make a panda start/stop rolling.
Examples:
if last spawned panda is not rolling:
make last spawned panda start rolling
make last spawned panda start rolling
| Patterns: |
|
| Since: | 2.11 |
Make a panda start/stop sneezing.
Examples:
if last spawned panda is not sneezing:
make last spawned panda start sneezing
make last spawned panda start sneezing
| Patterns: | |
| Since: | 2.3 |
Forces a player to send a message to the chat. If the message starts with a slash it will force the player to use command.
Examples:
make the player say "Hello."
force all players to send the message "I love this server"
force all players to send the message "I love this server"
| Patterns: |
|
| Since: | 2.8.0 |
Makes a sign (either a block or item) have glowing text or normal text
Examples:
make target block of player have glowing text
| Patterns: |
|
| Since: | 1.0, 2.2-dev26 (advanced features), 2.5.2 (optional sender), 2.6 (sending objects) |
| Requirements: | Minecraft 1.16.4+ for optional sender |
Sends a message to the given player. Only styles written
in given string or in formatted expressions will be parsed.
Adding an optional sender allows the messages to be sent as if a specific player sent them.
This is useful with Minecraft 1.16.4's new chat ignore system, in which players can choose to ignore other players,
but for this to work, the message needs to be sent from a player.
in given string or in formatted expressions will be parsed.
Adding an optional sender allows the messages to be sent as if a specific player sent them.
This is useful with Minecraft 1.16.4's new chat ignore system, in which players can choose to ignore other players,
but for this to work, the message needs to be sent from a player.
Examples:
message "A wild %player% appeared!"
message "This message is a distraction. Mwahaha!"
send "Your kill streak is %{kill streak::%uuid of player%}%." to player
if the targeted entity exists:
message "You're currently looking at a %type of the targeted entity%!"
on chat:
cancel event
send "[%player%] >> %message%" to all players from player
message "This message is a distraction. Mwahaha!"
send "Your kill streak is %{kill streak::%uuid of player%}%." to player
if the targeted entity exists:
message "You're currently looking at a %type of the targeted entity%!"
on chat:
cancel event
send "[%player%] >> %message%" to all players from player
| Patterns: |
|
| Since: | 2.0, 2.1.1 (closing), 2.2-Fixes-V10 (anvil), 2.4 (hopper, dropper, dispenser |
Opens an inventory to a player. The player can then access and modify the inventory as if it was a chest that he just opened.
Please note that currently 'show' and 'open' have the same effect, but 'show' will eventually show an unmodifiable view of the inventory in the future.
Please note that currently 'show' and 'open' have the same effect, but 'show' will eventually show an unmodifiable view of the inventory in the future.
Examples:
show the victim's inventory to the player
open the player's inventory for the player
open the player's inventory for the player
| Patterns: |
|
| Since: | 2.7 |
| Requirements: | Paper |
Make an entity pathfind towards a location or another entity. Not all entities can pathfind. If the pathfinding target is another entity, the entities may or may not continuously follow the target.
Examples:
make all creepers pathfind towards player
make all cows stop pathfinding
make event-entity pathfind towards player at speed 1
make all cows stop pathfinding
make event-entity pathfind towards player at speed 1
| Patterns: | |
| Since: | 2.11 |
Make entities, players, or leaves be persistent.
Persistence of entities is whether they are retained through server restarts.
Persistence of leaves is whether they should decay when not connected to a log block within 6 meters.
Persistence of players is if the player's playerdata should be saved when they leave the server. Players' persistence is reset back to 'true' when they join the server.
Passengers inherit the persistence of their vehicle, meaning a persistent zombie put on a non-persistent chicken will become non-persistent. This does not apply to players.
By default, all entities are persistent.
Persistence of entities is whether they are retained through server restarts.
Persistence of leaves is whether they should decay when not connected to a log block within 6 meters.
Persistence of players is if the player's playerdata should be saved when they leave the server. Players' persistence is reset back to 'true' when they join the server.
Passengers inherit the persistence of their vehicle, meaning a persistent zombie put on a non-persistent chicken will become non-persistent. This does not apply to players.
By default, all entities are persistent.
Examples:
prevent all entities from persisting
force {_leaves} to persist
command /kickcheater <cheater: player>:
permission: op
trigger:
prevent {_cheater} from persisting
kick {_cheater}
force {_leaves} to persist
command /kickcheater <cheater: player>:
permission: op
trigger:
prevent {_cheater} from persisting
kick {_cheater}
| Patterns: |
|
| Since: | 2.11 |
Make an axolotl start or stop playing dead.
Examples:
make last spawned axolotl play dead
| Patterns: |
|
| Since: | 2.1 |
Plays a visual effect at a given location or on a given entity.
Please note that some effects can only be played on entities, e.g. wolf hearts or the hurt effect, and that these are always visible to all players.
Please note that some effects can only be played on entities, e.g. wolf hearts or the hurt effect, and that these are always visible to all players.
Examples:
play wolf hearts on the clicked wolf
show mob spawner flames at the targeted block to the player
show mob spawner flames at the targeted block to the player
| Patterns: |
|
| Since: | 2.2-dev28, 2.4 (sound categories), 2.9 (sound seed & entity emitter) |
| Requirements: | Minecraft 1.18.1+ (entity emitters), Paper 1.19.4+ or Adventure API 4.12.0+ (sound seed) |
Plays a sound at given location for everyone or just for given players, or plays a sound to specified players. Both Minecraft sound names and Spigot sound names are supported. Playing resource pack sounds are supported too. The sound category is 'master' by default.
When running 1.19+, playing a sound from an entity directly will result in the sound coming from said entity, even while moving.
If the sound is custom, a location emitter will follow the entity. Do note that pitch and volume
are reflected based on the entity, and Minecraft may not use the values from this syntax.
If using Paper 1.19.4+ or Adventure API 4.12.0+ you can utilize sound seeds. Minecraft sometimes have a set of sounds under one sound ID
that will randomly play, to counter this, you can directly state which seed to use.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
When running 1.19+, playing a sound from an entity directly will result in the sound coming from said entity, even while moving.
If the sound is custom, a location emitter will follow the entity. Do note that pitch and volume
are reflected based on the entity, and Minecraft may not use the values from this syntax.
If using Paper 1.19.4+ or Adventure API 4.12.0+ you can utilize sound seeds. Minecraft sometimes have a set of sounds under one sound ID
that will randomly play, to counter this, you can directly state which seed to use.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
play sound "block.note_block.pling"
play sound "entity.experience_orb.pickup" with volume 0.5 to the player
play sound "custom.music.1" in jukebox category at {speakerBlock}
play sound "BLOCK_AMETHYST_BLOCK_RESONATE" with seed 1 on target entity for the player #1.20.1+
play sound "entity.experience_orb.pickup" with volume 0.5 to the player
play sound "custom.music.1" in jukebox category at {speakerBlock}
play sound "BLOCK_AMETHYST_BLOCK_RESONATE" with seed 1 on target entity for the player #1.20.1+
| Patterns: |
|
| Since: | 2.3 |
| Usable in events: | server list ping |
| Requirements: | Paper 1.12.2 or newer |
Sets whether all player related information is hidden in the server list.
The Vanilla Minecraft client will display ??? (dark gray) instead of player counts and will not show the
hover hist when hiding player info.
The version string can override the ???.
Also the Online Players Count and
Max Players expressions will return -1 when hiding player info.
The Vanilla Minecraft client will display ??? (dark gray) instead of player counts and will not show the
hover hist when hiding player info.
The version string can override the ???.
Also the Online Players Count and
Max Players expressions will return -1 when hiding player info.
Examples:
hide player info
hide player related information in the server list
reveal all player related info
hide player related information in the server list
reveal all player related info
| Patterns: |
|
| Since: | 1.3.2 |
Poison or cure a creature.
Examples:
poison the player
poison the victim for 20 seconds
cure the player from poison
poison the victim for 20 seconds
cure the player from poison
| Patterns: |
|
| Since: | 2.0, 2.2-dev27 (ambient and particle-less potion effects), 2.5 (replacing existing effect), 2.5.2 (potion effects), 2.7 (icon and infinite) |
Apply or remove potion effects to/from entities.
Examples:
apply ambient swiftness 2 to the player
remove haste from the victim
on join:
apply infinite potion of strength of tier {strength::%uuid of player%} to the player
apply potion of strength of tier {strength::%uuid of player%} to the player for 999 days # Before 1.19.4
apply potion effects of player's tool to player
apply haste potion of tier 3 without any particles whilst hiding the potion icon to the player # Hide potions
remove haste from the victim
on join:
apply infinite potion of strength of tier {strength::%uuid of player%} to the player
apply potion of strength of tier {strength::%uuid of player%} to the player for 999 days # Before 1.19.4
apply potion effects of player's tool to player
apply haste potion of tier 3 without any particles whilst hiding the potion icon to the player # Hide potions
| Patterns: |
|
| Since: | 2.10 |
| Usable in events: | Fishing |
Pull the hooked entity to the player.
Examples:
on fishing state of caught entity:
pull in hooked entity
pull in hooked entity
| Patterns: | |
| Since: | 1.4.6 2.12 (push towards) |
Push entities in a given direction or towards a specific location.
Examples:
push the player upwards
push the victim downwards at speed 0.5
push player towards player's target at speed 2
pull player along vector(1,1,1) at speed 1.5
push the victim downwards at speed 0.5
push player towards player's target at speed 2
pull player along vector(1,1,1) at speed 1.5
| Patterns: |
|
| Since: | 2.10 |
Registers a new tag containing either items or entity datas. Note that items will NOT keep any information other than their type, so adding `diamond sword named "test"` to a tag is the same as adding `diamond sword`
Item tags should be used for contexts where the item is not placed down, while block tags should be used for contexts where the item is placed. For example, and item tag could be "skript:edible", while a block tag would be "skript:needs_water_above".
All custom tags will be given the namespace "skript", followed by the name you give it. The name must only include the characters A to Z, 0 to 9, and '/', '.', '_', and '-'. Otherwise, the tag will not register.
Please note that two tags can share a name if they are of different types. Registering a new tag of the same name and type will overwrite the existing tag. Tags will reset on server shutdown.
Item tags should be used for contexts where the item is not placed down, while block tags should be used for contexts where the item is placed. For example, and item tag could be "skript:edible", while a block tag would be "skript:needs_water_above".
All custom tags will be given the namespace "skript", followed by the name you give it. The name must only include the characters A to Z, 0 to 9, and '/', '.', '_', and '-'. Otherwise, the tag will not register.
Please note that two tags can share a name if they are of different types. Registering a new tag of the same name and type will overwrite the existing tag. Tags will reset on server shutdown.
Examples:
register a new custom entity tag named "fish" using cod, salmon, tropical fish, and pufferfish
register an item tag named "skript:wasp_weapons/swords" containing diamond sword and netherite sword
register block tag named "pokey" containing sweet berry bush and bamboo sapling
on player move:
block at player is tagged as tag "skript:pokey"
damage the player by 1 heart
register an item tag named "skript:wasp_weapons/swords" containing diamond sword and netherite sword
register block tag named "pokey" containing sweet berry bush and bamboo sapling
on player move:
block at player is tagged as tag "skript:pokey"
damage the player by 1 heart
| Patterns: | |
| Since: | 2.11 |
| Requirements: | Minecraft 1.21 |
Releases the stored entities in an entity block storage (i.e. beehive).
When using beehives, providing a timespan will prevent the released bees from re-entering the beehive for that amount of time.
Due to unstable behaviour on older versions, this effect requires Minecraft version 1.21+.
When using beehives, providing a timespan will prevent the released bees from re-entering the beehive for that amount of time.
Due to unstable behaviour on older versions, this effect requires Minecraft version 1.21+.
Examples:
release the stored entities of {_beehive}
release the entity storage of {_hive} for 5 seconds
release the entity storage of {_hive} for 5 seconds
| Patterns: |
|
| Since: | 2.0, 2.2-dev24 (multiple strings, items in inventory), 2.5 (replace first, case sensitivity), 2.10 (regex) |
Replaces all occurrences of a given text or regex with another text. Please note that you can only change variables and a few expressions, e.g. a message or a line of a sign.
Examples:
replace "<item>" in {_msg} with "[%name of player's tool%]"
replace every "&" with "§" in line 1 of targeted block
# Very simple chat censor
on chat:
replace all "idiot" and "noob" with "****" in the message
regex replace "\b(idiot|noob)\b" with "****" in the message # Regex version using word boundaries for better results
replace all stone and dirt in player's inventory and player's top inventory with diamond
replace every "&" with "§" in line 1 of targeted block
# Very simple chat censor
on chat:
replace all "idiot" and "noob" with "****" in the message
regex replace "\b(idiot|noob)\b" with "****" in the message # Regex version using word boundaries for better results
replace all stone and dirt in player's inventory and player's top inventory with diamond
| Patterns: |
|
| Since: | 2.2, 2.8.0 (returns aliases) |
Makes a trigger or a section (e.g. a function) return a value
Examples:
function double(i: number) :: number:
return 2 * {_i}
function divide(i: number) returns number:
return {_i} / 2
return 2 * {_i}
function divide(i: number) returns number:
return {_i} / 2
| Patterns: | |
| Since: | 2.9.0 |
| Requirements: | Spigot 1.19.4+ |
Causes a bell to ring.
Optionally, the entity that rang the bell and the direction the bell should ring can be specified.
A bell can only ring in two directions, and the direction is determined by which way the bell is facing.
By default, the bell will ring in the direction it is facing.
Optionally, the entity that rang the bell and the direction the bell should ring can be specified.
A bell can only ring in two directions, and the direction is determined by which way the bell is facing.
By default, the bell will ring in the direction it is facing.
Examples:
make player ring target-block
| Patterns: |
|
| Since: | 2.2-dev28, 2.10 (quaternions, displays) |
Rotates displays, quaternions, or vectors around an axis a set amount of degrees, or around all 3 axes at once.
Vectors can only be rotated around the global X/Y/Z axes, or an arbitrary vector axis.
Quaternions are more flexible, allowing rotation around the global or local X/Y/Z axes, arbitrary vectors, or all 3 local axes at once.
Global axes are the ones in the Minecraft world. Local axes are relative to how the quaternion is already oriented.
Rotating a display is a shortcut for rotating its left rotation. If the right rotation needs to be modified, it should be acquired, rotated, and re-set.
Note that rotating a quaternion/display around a vector results in a rotation around the local vector, so results may not be what you expect. For example, rotating quaternions/displays around vector(1, 0, 0) is the same as rotating around the local X axis.
The same applies to rotations by all three axes at once. In addition, rotating around all three axes of a quaternion/display at once will rotate in ZYX order, meaning the Z rotation will be applied first and the X rotation last.
Vectors can only be rotated around the global X/Y/Z axes, or an arbitrary vector axis.
Quaternions are more flexible, allowing rotation around the global or local X/Y/Z axes, arbitrary vectors, or all 3 local axes at once.
Global axes are the ones in the Minecraft world. Local axes are relative to how the quaternion is already oriented.
Rotating a display is a shortcut for rotating its left rotation. If the right rotation needs to be modified, it should be acquired, rotated, and re-set.
Note that rotating a quaternion/display around a vector results in a rotation around the local vector, so results may not be what you expect. For example, rotating quaternions/displays around vector(1, 0, 0) is the same as rotating around the local X axis.
The same applies to rotations by all three axes at once. In addition, rotating around all three axes of a quaternion/display at once will rotate in ZYX order, meaning the Z rotation will be applied first and the X rotation last.
Examples:
rotate {_quaternion} around x axis by 10 degrees
rotate last spawned block display around y axis by 10 degrees
rotate {_vector} around vector(1, 1, 1) by 45
rotate {_quaternion} by x 45, y 90, z 135
rotate last spawned block display around y axis by 10 degrees
rotate {_vector} around vector(1, 1, 1) by 45
rotate {_quaternion} by x 45, y 90, z 135
| Patterns: |
|
| Since: | 2.10 |
Executes a task (a function). Any returned result is discarded.
Examples:
set {_function} to the function named "myFunction"
run {_function}
run {_function} with arguments {_things::*}
run {_function}
run {_function} with arguments {_things::*}
| Patterns: |
|
| Since: | 2.8.0 |
Save all worlds or a given world manually.
Note: saving many worlds at once may possibly cause the server to freeze.
Note: saving many worlds at once may possibly cause the server to freeze.
Examples:
save "world_nether"
save all worlds
save all worlds
| Patterns: | |
| Since: | 2.2-dev37c, 2.5.1 (block data support), 2.12 (as original) |
Makes a player see a block as something else or as the original.
Examples:
make player see block at player as dirt
make player see player's target block as campfire[facing=south]
make all players see (blocks in radius 5 of location(0, 0, 0)) as bedrock
make all players see (blocks in radius 5 of location(0, 0, 0)) as original
make player see player's target block as campfire[facing=south]
make all players see (blocks in radius 5 of location(0, 0, 0)) as bedrock
make all players see (blocks in radius 5 of location(0, 0, 0)) as original
| Patterns: | |
| Since: | 2.4 |
Request that the player's client download and switch resource packs. The client will download
the resource pack in the background, and will automatically switch to it once the download is complete.
The URL must be a direct download link.
The hash is used for caching, the player won't have to re-download the resource pack that way.
The hash must be SHA-1, you can get SHA-1 hash of your resource pack using
this online tool.
The resource pack request action can be used to check
status of the sent resource pack request.
the resource pack in the background, and will automatically switch to it once the download is complete.
The URL must be a direct download link.
The hash is used for caching, the player won't have to re-download the resource pack that way.
The hash must be SHA-1, you can get SHA-1 hash of your resource pack using
this online tool.
The resource pack request action can be used to check
status of the sent resource pack request.
Examples:
on join:
send the resource pack from "URL" with hash "hash" to the player
send the resource pack from "URL" with hash "hash" to the player
| Patterns: |
|
| Since: | 2.0 (cows, sheep & snowmen), 2.8.0 (all shearable entities) |
| Requirements: | Paper 1.19.4+ (all shearable entities) |
Shears or un-shears a shearable entity with drops by shearing and a 'sheared' sound. Using with 'force' will force this effect despite the entity's 'shear state'.
Please note that..:
- If your server is not running with Paper 1.19.4 or higher, this effect will only change its 'shear state', and the 'force' effect is unavailable
- Force-shearing or un-shearing on a sheared mushroom cow is not possible
Please note that..:
- If your server is not running with Paper 1.19.4 or higher, this effect will only change its 'shear state', and the 'force' effect is unavailable
- Force-shearing or un-shearing on a sheared mushroom cow is not possible
Examples:
on rightclick on a sheep holding a sword:
shear the clicked sheep
chance of 10%
force shear the clicked sheep
shear the clicked sheep
chance of 10%
force shear the clicked sheep
| Patterns: |
|
| Since: | 2.9.0, 2.10 (sort order) |
Sorts a list variable using either the natural ordering of the contents or the results of the given expression. Be warned, this will overwrite the indices of the list variable.
When using the full sort %~objects% (by|based on) <expression> pattern, the input expression can be used to refer to the current item being sorted. (See input expression for more information.)
Examples:
set {_words::*} to "pineapple", "banana", "yoghurt", and "apple"
sort {_words::*} # alphabetical sort
sort {_words::*} by length of input # shortest to longest
sort {_words::*} in descending order by length of input # longest to shortest
sort {_words::*} based on {tastiness::%input%} # sort based on custom value
sort {_words::*} # alphabetical sort
sort {_words::*} by length of input # shortest to longest
sort {_words::*} in descending order by length of input # longest to shortest
sort {_words::*} based on {tastiness::%input%} # sort based on custom value
| Patterns: | |
| Since: | 2.11 |
Make a player start or stop sprinting.
If the player is not moving when this effect is used, they will be put in sprint mode for a tick and then stopped (this causes the FOV to change). Using it a second time, without the player manually sprinting in between, causes the player to stay in sprint mode, with some quirks.
- Particles may not be produced under the player's feet.
- The player will not exit the sprinting state if they stop moving.
- Restrictions like low hunger will not prevent the player from sprinting
- The player pressing shift will stop them sprinting, and pressing sprint will re-assert normal sprinting behavior
Using this effect two or more consecutive times on a stationary player produces undefined behavior and should not be relied on.
If the player is not moving when this effect is used, they will be put in sprint mode for a tick and then stopped (this causes the FOV to change). Using it a second time, without the player manually sprinting in between, causes the player to stay in sprint mode, with some quirks.
- Particles may not be produced under the player's feet.
- The player will not exit the sprinting state if they stop moving.
- Restrictions like low hunger will not prevent the player from sprinting
- The player pressing shift will stop them sprinting, and pressing sprint will re-assert normal sprinting behavior
Using this effect two or more consecutive times on a stationary player produces undefined behavior and should not be relied on.
Examples:
make player start sprinting
force player to start sprinting
force player to start sprinting
| Patterns: |
|
| Since: | 2.5 |
Stops or restarts the server. If restart is used when the restart-script spigot.yml option isn't defined, the server will stop instead.
Examples:
stop the server
restart server
restart server
| Patterns: |
|
| Since: | 2.4, 2.7 (stop all sounds) |
Stops specific or all sounds from playing to a group of players. Both Minecraft sound names and Spigot sound names are supported. Resource pack sounds are supported too. The sound category is 'master' by default. A sound can't be stopped from a different category.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Please note that sound names can get changed in any Minecraft or Spigot version, or even removed from Minecraft itself.
Examples:
stop sound "block.chest.open" for the player
stop playing sounds "ambient.underwater.loop" and "ambient.underwater.loop.additions" to the player
stop all sounds for all players
stop sound in the record category
stop playing sounds "ambient.underwater.loop" and "ambient.underwater.loop.additions" to the player
stop all sounds for all players
stop sound in the record category
| Patterns: |
|
| Since: | 2.12 |
Make a strider start/stop shivering.
Examples:
if last spawned strider is shivering:
make last spawned strider stop shivering
make last spawned strider stop shivering
| Patterns: |
|
| Since: | 2.12 |
An effect to suppress local variable type hint errors for the syntax lines that follow this effect.
NOTE: Suppressing type hints also prevents syntax from providing new type hints. For example, with type hints suppressed, 'set {_x} to true' would not provide 'boolean' as a type hint for '{_x}'
NOTE: Suppressing type hints also prevents syntax from providing new type hints. For example, with type hints suppressed, 'set {_x} to true' would not provide 'boolean' as a type hint for '{_x}'
Examples:
start suppressing local variable type hints
# potentially unsafe code goes here
stop suppressing local variable type hints
# potentially unsafe code goes here
stop suppressing local variable type hints
| Patterns: |
|
| Since: | 2.5.1 |
| Requirements: | Minecraft 1.15.2+ |
Makes an entity swing their hand. This does nothing if the entity does not have an animation for swinging their hand.
Examples:
make player swing their main hand
| Patterns: |
|
| Since: | 2.10 |
Tame a tameable entity (horse, parrot, cat, etc.).
Examples:
tame {_horse}
untame {_horse}
untame {_horse}
| Patterns: |
|
| Since: | 1.0, 2.10 (flags) |
| Requirements: | Paper 1.19+ (teleport flags) |
Teleport an entity to a specific location.
This effect is delayed by default on Paper, meaning certain syntax such as the return effect for functions cannot be used after this effect.
The keyword 'force' indicates this effect will not be delayed,
which may cause lag spikes or server crashes when using this effect to teleport entities to unloaded chunks.
Teleport flags are settings to retain during a teleport. Such as direction, passengers, x coordinate, etc.
This effect is delayed by default on Paper, meaning certain syntax such as the return effect for functions cannot be used after this effect.
The keyword 'force' indicates this effect will not be delayed,
which may cause lag spikes or server crashes when using this effect to teleport entities to unloaded chunks.
Teleport flags are settings to retain during a teleport. Such as direction, passengers, x coordinate, etc.
Examples:
teleport the player to {home::%uuid of player%}
teleport the attacker to the victim
on dismount:
cancel event
teleport the player to {server::spawn} retaining vehicle and passengers
teleport the attacker to the victim
on dismount:
cancel event
teleport the player to {server::spawn} retaining vehicle and passengers
| Patterns: | |
| Since: | 2.10 |
Applies or removes drop shadow from the displayed text on a text display.
Examples:
apply drop shadow to last spawned text display
if {_display} has drop shadow:
remove drop shadow from the text of {_display}
if {_display} has drop shadow:
remove drop shadow from the text of {_display}
| Patterns: | |
| Since: | 2.10 |
Forces a text display to either be or not be visible through blocks.
Examples:
force last spawned text display to be visible through walls
prevent all text displays from being visible through walls
prevent all text displays from being visible through walls
| Patterns: | |
| Since: | 2.3 |
Sends a title/subtitle to the given player(s) with optional fadein/stay/fadeout times for Minecraft versions 1.11 and above.
If you're sending only the subtitle, it will be shown only if there's a title displayed at the moment, otherwise it will be sent with the next title. To show only the subtitle, use:
Note: if no input is given for the times, it will keep the ones from the last title sent, use the reset title effect to restore the default values.
If you're sending only the subtitle, it will be shown only if there's a title displayed at the moment, otherwise it will be sent with the next title. To show only the subtitle, use:
send title " " with subtitle "yourtexthere" to player.Note: if no input is given for the times, it will keep the ones from the last title sent, use the reset title effect to restore the default values.
Examples:
send title "Competition Started" with subtitle "Have fun, Stay safe!" to player for 5 seconds
send title "Hi %player%" to player
send title "Loot Drop" with subtitle "starts in 3 minutes" to all players
send title "Hello %player%!" with subtitle "Welcome to our server" to player for 5 seconds with fadein 1 second and fade out 1 second
send subtitle "Party!" to all players
send title "Hi %player%" to player
send title "Loot Drop" with subtitle "starts in 3 minutes" to all players
send title "Hello %player%!" with subtitle "Welcome to our server" to player for 5 seconds with fadein 1 second and fade out 1 second
send subtitle "Party!" to all players
| Patterns: |
|
| Since: | 1.4, 2.12 (booleans) |
Toggle the state of a block or boolean.
Examples:
# use arrows to toggle switches, doors, etc.
on projectile hit:
projectile is arrow
toggle the block at the arrow
# With booleans
toggle gravity of player
on projectile hit:
projectile is arrow
toggle the block at the arrow
# With booleans
toggle gravity of player
| Patterns: |
|
| Since: | 2.8.0 |
Determines whether living entities are able to pick up items or not
Examples:
forbid player from picking up items
send "You can no longer pick up items!" to player
on drop:
if player can't pick up items:
allow player to pick up items
send "You can no longer pick up items!" to player
on drop:
if player can't pick up items:
allow player to pick up items
| Patterns: |
|
| Since: | 2.10 |
Transforms (or 'maps') a list's values using a given expression. This is akin to looping over the list and setting each value to a modified version of itself.
Evaluates the given expression for each element in the list, replacing the original element with the expression's result.
If the given expression returns a single value, the indices of the list will not change. If the expression returns multiple values, then then indices will be reset as a single index cannot contain multiple values.
Only variable lists can be transformed with this effect. For other lists, see the transform expression.
Evaluates the given expression for each element in the list, replacing the original element with the expression's result.
If the given expression returns a single value, the indices of the list will not change. If the expression returns multiple values, then then indices will be reset as a single index cannot contain multiple values.
Only variable lists can be transformed with this effect. For other lists, see the transform expression.
Examples:
set {_a::*} to 1, 2, and 3
transform {_a::*} using input * 2
# {_a::*} is now 2, 4, and 6
# get a list of the sizes of all clans without manually looping
set {_clan-sizes::*} to indices of {clans::*}
transform {_clan-sizes::*} using {clans::%input%::size}
# set all existing values of a list to 0:
transform {_list::*} to 0
transform {_a::*} using input * 2
# {_a::*} is now 2, 4, and 6
# get a list of the sizes of all clans without manually looping
set {_clan-sizes::*} to indices of {clans::*}
transform {_clan-sizes::*} using {clans::%input%::size}
# set all existing values of a list to 0:
transform {_list::*} to 0
| Patterns: |
|
| Since: | 1.0 |
Creates a tree.
This may require that there is enough space above the given location and that the block below is dirt/grass, but it is possible that the tree will just grow anyways, possibly replacing every block in its path.
This may require that there is enough space above the given location and that the block below is dirt/grass, but it is possible that the tree will just grow anyways, possibly replacing every block in its path.
Examples:
grow a tall redwood tree above the clicked block
| Patterns: |
|
| Since: | 2.10 |
Updates the blocks by setting them to a selected block
Using 'without physics' will not send updates to the surrounding blocks of the blocks being set.
Example: Updating a block next to a sand block in the air 'without physics' will not cause the sand block to fall.
Using 'without physics' will not send updates to the surrounding blocks of the blocks being set.
Example: Updating a block next to a sand block in the air 'without physics' will not cause the sand block to fall.
Examples:
update {_blocks::*} as gravel
update {_blocks::*} to be sand without physics updates
update {_blocks::*} as stone without neighbouring updates
update {_blocks::*} to be sand without physics updates
update {_blocks::*} as stone without neighbouring updates
| Patterns: |
|
| Since: | 2.0 |
Makes an entity ride another entity, e.g. a minecart, a saddled pig, an arrow, etc.
Examples:
make the player ride a saddled pig
make the attacker ride the victim
make the attacker ride the victim
| Patterns: |
|
| Since: | 2.11 |
Make bats and foxes sleep or wake up.
Make villagers sleep by providing a location of a bed.
Make players sleep by providing a location of a bed. Using 'with force' will bypass "nearby monsters" ,the max distance, allowing players to sleep even if the bed is far away, and lets players sleep in the nether and end. Does not work if the location of the bed is not in the world the player is currently in.
Using 'without spawn location update' will make players wake up without setting their spawn location to the bed.
Make villagers sleep by providing a location of a bed.
Make players sleep by providing a location of a bed. Using 'with force' will bypass "nearby monsters" ,the max distance, allowing players to sleep even if the bed is far away, and lets players sleep in the nether and end. Does not work if the location of the bed is not in the world the player is currently in.
Using 'without spawn location update' will make players wake up without setting their spawn location to the bed.
Examples:
make {_fox} go to sleep
make {_bat} stop sleeping
make {_villager} start sleeping at location(0, 0, 0)
make player go to sleep at location(0, 0, 0) with force
make player wake up without spawn location update
make {_bat} stop sleeping
make {_villager} start sleeping at location(0, 0, 0)
make player go to sleep at location(0, 0, 0) with force
make player wake up without spawn location update
| Patterns: |
|
| Since: | 2.11 |
Turn a villager into a zombie villager. Cure a zombie villager immediately or after specified amount of time.
This effect removes the old entity and creates a new entity.
Zombifying a villager stored in a variable will update the variable to the new zombie villager.
Curing a zombie villager does not update the variable.
This effect removes the old entity and creates a new entity.
Zombifying a villager stored in a variable will update the variable to the new zombie villager.
Curing a zombie villager does not update the variable.
Examples:
zombify last spawned villager
set {_villager} to last spawned villager
zombify {_villager}
if {_villager} is a zombie villager:
# This will pass because '{_villager}' gets changed to the new zombie villager
set {_villager} to last spawned villager
zombify last spawned villager
if {_villager} is a zombie villager:
# This will fail because the variable was not provided when zombifying
unzombify {_zombieVillager}
unzombify {_zombieVillager} after 2 seconds
set {_villager} to last spawned villager
zombify {_villager}
if {_villager} is a zombie villager:
# This will pass because '{_villager}' gets changed to the new zombie villager
set {_villager} to last spawned villager
zombify last spawned villager
if {_villager} is a zombie villager:
# This will fail because the variable was not provided when zombifying
unzombify {_zombieVillager}
unzombify {_zombieVillager} after 2 seconds
| Patterns: |
|
| Since: | 1.0 |
Grant/revoke a user operator state.
Examples:
op the player
deop all players
deop all players
| Patterns: |
|
| Since: | 2.10 |
Shoots a projectile (or any other entity) from a given entity or location.
Examples:
shoot arrow from all players at speed 2
shoot a pig from all players:
add event-entity to {_projectiles::*}
shoot a pig from all players:
add event-entity to {_projectiles::*}
| Patterns: |
|
| Since: | 1.0, 2.6.1 (with section), 2.8.6 (dropped items), 2.10 (entity snapshots) |
| Requirements: | Minecraft 1.20.2+ (entity snapshots) |
Spawns entities. This can be used as an effect and as a section.
If it is used as a section, the section is run before the entity is added to the world.
You can modify the entity in this section, using for example 'event-entity' or 'cow'.
Do note that other event values, such as 'player', won't work in this section.
If you're spawning a display and want it to be empty on initialization, like not having a block display be stone, set hidden config node 'spawn empty displays' to true.
Note that when spawning an entity via entity snapshots, the code within the section will not run instantaneously as compared to spawning normally (via 'a zombie').
If it is used as a section, the section is run before the entity is added to the world.
You can modify the entity in this section, using for example 'event-entity' or 'cow'.
Do note that other event values, such as 'player', won't work in this section.
If you're spawning a display and want it to be empty on initialization, like not having a block display be stone, set hidden config node 'spawn empty displays' to true.
Note that when spawning an entity via entity snapshots, the code within the section will not run instantaneously as compared to spawning normally (via 'a zombie').
Examples:
spawn 3 creepers at the targeted block
spawn a ghast 5 meters above the player
spawn a zombie at the player:
set name of the zombie to ""
spawn a block display of a ladder[waterlogged=true] at location above player:
set billboard of event-display to center # allows the display to rotate around the center axis
spawn a ghast 5 meters above the player
spawn a zombie at the player:
set name of the zombie to ""
spawn a block display of a ladder[waterlogged=true] at location above player:
set billboard of event-display to center # allows the display to rotate around the center axis