| Patterns: |
|
| Since: | 1.0, 2.7 (multiple entities, unequip), 2.10 (wolves) 2.12.1 (happy ghasts) |
This effect shall replace any armour the entity doth presently wear.
Examples:
adorn player with diamond leggings, diamond chestplate, and diamond boots
disrobe diamond chestplate from player
disrobe player's armor
| Patterns: |
|
| Since: | 2.11 |
This is not the same as the breeding of allays.
Examples:
forbid all allays from duplicating
| Patterns: |
|
| Since: | 1.0 (set, add, remove, delete), 2.0 (remove all) |
Certain expressions may only be set and/or deleted, whilst others may also receive additions or suffer removals.
Examples:
set the block above the victim to lava
bestow 2 upon the player's health # preferably use '<a href='#EffHealth'>heal</a>' for this
bestow argument upon {blacklist::*}
grant a diamond pickaxe of efficiency 5 upon the player
increase the data value of the clicked block by 1
remove 2 pickaxes from the victim
subtract 2.5 from {points::%uuid of player%}
remove every iron tool from the player
remove all minecarts from {entitylist::*}
delete the block below the player
clear drops
delete {variable}
reset walk speed of player
reset chunk at the targeted block
| Patterns: |
|
| Since: | 2.4, 2.12 (harvest event) |
| Requirements: | 1.12.2 or newer (cancelling item drops of blocks) |
The dropped experience may be annulled in death and block break events.
Pray note that employing this within a death event doth not preserve items or experience of the fallen. Shouldst thou wish such, make use of the Keep Inventory / Experience effect.
Examples:
if name of the entity is "&cSpecial":
annul spoils of wares
on break of a coal ore:
annul the experience spoils
on player block harvest:
annul the ware spoils
| Patterns: |
|
| Since: | 2.9.0, 2.10 (sort order) |
When employing the full arrange %~objects% (by|based on) <expression> pattern, the input expression may be used to refer to the current item being arranged. (See input expression for further knowledge.)
Examples:
arrange {_words::*} # alphabetical arrangement
arrange {_words::*} by length of input # shortest to longest
arrange {_words::*} in descending order by length of input # longest to shortest
arrange {_words::*} based on {tastiness::%input%} # arrange based on custom value
| Patterns: |
|
| Since: | 1.4, 2.1.1 (ban reason), 2.5 (timespan), 2.9.0 (kick) |
If a reason be given, it shall be shown to the player when they attempt to join the server whilst banished.
A duration of banishment may also be given to impose a temporary exile. If it be absent for any reason, a permanent banishment shall be imposed instead.
We do counsel that thou test thy scripts so that no accidental permanent banishments be imposed.
Mark well that banishing people doth not cast them out from the server.
Thou mayest optionally employ 'and cast out' or consider using the cast out effect after imposing a banishment.
Examples:
banish "127.0.0.1"
IP-banish the player because "he is a knave"
banish player due to "inappropriate tongue" for 2 days
banish and cast out player due to "inappropriate tongue" for 2 days
| Patterns: |
|
| Since: | 2.10 |
Examples:
bestow lure enchantment boon
| Patterns: |
|
| Since: | 2.10 |
Examples:
bestow lure enchantment boon
| Patterns: |
|
| Since: | 2.8.0 |
Examples:
| Patterns: |
|
| Since: | 2.0 2.14 (syntax rework) |
Examples:
command /strengthboost:
trigger:
bestow strength 10 upon the player for 5 minutes
bestow the potion effects of the player's tool upon the player
| Patterns: |
|
| Since: | 2.2, 2.8.0 (returns aliases) |
Examples:
bestow 2 * {_i}
function divide(i: number) returns number:
bestow {_i} / 2
| Patterns: |
|
| Since: | 2.8.0 |
Examples:
send "Thou canst no longer gather items!" to player
on drop:
if player can't pick up items:
grant player leave to pick up items
| Patterns: | |
| Since: | 2.3 |
Examples:
| Patterns: |
|
| Since: | 1.0 |
Examples:
deop all players
| Patterns: |
|
| Since: | 2.0, 2.13 (at level) |
Examples:
enchant the player's tool at level 30
disenchant the player's tool
| Patterns: |
|
| Since: | 2.11 |
This effect shall always compel an allay to duplicate regardless of whether the duplicate attribute be disabled.
Examples:
| Patterns: |
|
| Since: | 2.11 |
Examples:
compel last spawned goat to cease wailing
make {_enderman} wail
compel {_enderman} to cease wailing
| Patterns: |
|
| Since: | 2.11 |
Examples:
make last spawned panda commence rolling
| Patterns: |
|
| Since: | 2.11 |
Examples:
make last spawned panda commence sneezing
| Patterns: | |
| Since: | 2.3 |
Examples:
compel all players to dispatch the message "I love this server"
| Patterns: |
|
| Since: | 2.7 |
Examples:
# EGGS FOR DAYZ!
make the egg hatch
| Patterns: |
|
| Since: | 2.11 |
Ramming doth bear a cooldown, and presently there existeth no means to alter it.
Examples:
| Patterns: |
|
| Since: | 2.10 |
Mark well that if the inventory be full, it shall cause warnings in the console due to overfilling.
Examples:
bring forth spoils using "minecraft:chests/shipwreck_supply" in {_inventory}
| Patterns: |
|
| Since: | 2.2-dev37, 2.7 (while loops), 2.8.0 (outer loops) |
Examples:
loop all players:
if loop-value does not have permission "moderator":
carry on # filter out non moderators
proclaim "%loop-player% is a moderator!" # Only moderators get proclaimed
# Game commencement counter
set {_counter} to 11
while {_counter} > 0:
remove 1 from {_counter}
wait a second
if {_counter} != 1, 2, 3, 5 or 10:
carry on # only print when counter is 1, 2, 3, 5 or 10
proclaim "Game commencing in %{_counter}% second(s)"
| Patterns: |
|
| Since: | 1.0 |
Examples:
cast down 1 TNT
| Patterns: |
|
| Since: | 2.11 |
Examples:
bid last spawned panda stop feasting
| Patterns: |
|
| Since: | 2.11 |
Examples:
make last spawned panda get off its back
| Patterns: |
|
| Since: | 2.2-dev21 |
Examples:
compel event-player to rise again
| Patterns: |
|
| Since: | 2.5.1, 2.13 (multiple, amount) |
| Requirements: | Minecraft 1.15.2+ |
Employing 'strike' shall cause the attacker to wield the item in their main hand and apply all enchantments and attributes thereupon.
Employing 'wound' with a number of hearts shall disregard the item in the main hand and deal precisely the harm specified.
Examples:
bid last spawned wolf strike all players
spawn a zombie at location(0, 0, 0)
bid player wound last spawned zombie by 2
| Patterns: | |
| Since: | 2.3 |
Examples:
conceal {vanished::*} from the server list
| Patterns: |
|
| Since: | 2.10 |
Examples:
render command block {_block} unconditional if {_block} is conditional
| Patterns: | |
| Since: | 2.2-dev37c, 2.5.1 (block data support), 2.12 (as original) |
Examples:
make player perceive player's target block as campfire[facing=south]
make all players perceive (blocks in radius 5 of location(0, 0, 0)) as bedrock
make all players perceive (blocks in radius 5 of location(0, 0, 0)) as original
| Patterns: |
|
| Since: | 1.0 |
This may require that sufficient space existeth above the given location and that the block beneath be dirt or grass, yet 'tis possible the tree shall simply grow regardless, perchance replacing every block in its path.
Examples:
| Patterns: |
|
| Since: | 1.0 |
Prithee note: employ a force of 0 to conjure a false explosion that causeth no harm whatsoever, or employ the explosion spectacle introduced in Skript 2.0.
Since Bukkit 1.4.5 and Skript 2.0, one may conjure safe explosions which shall wound entities yet destroy no blocks.
Examples:
conjure an explosion of force 0 at the victim
| Patterns: |
|
| Since: | 2.14 |
All effects do vary most significantly in availability from version to version, and some may simply not function upon thy version of Minecraft. Certain effects, such as the death animation entity effect, may cause client afflictions and should be employed with great caution!
Examples:
force render 10 red dust particles of size 3 unto player
conjure blue instant splash potion break effect bearing a view radius of 10
conjure ravager attack animation upon player's target
| Patterns: |
|
| Since: | 2.13 |
Examples:
forbid the brewing stand from consuming the fuel
| Patterns: |
|
| Since: | 2.10 |
Examples:
if the used firework will be consumed:
forbid the used firework from being consume
| Patterns: | |
| Since: | 2.3, 2.10 (transfer) |
If the realm runneth Minecraft 1.20.5 or above, thou mayest specify an IP and Port to transport a player unto that realm.
When transporting players by IP, the passage shall not complete lest the `accepts-transfers` option be enabled in `server.properties` for the realm specified.
If the port be not provided, it shall default to `25565`.
Examples:
transport player unto realm "my.server.com"
transport player unto realm "localhost" on port 25566
| Patterns: | |
| Since: | 2.11 |
If the player be not in motion when this effect is employed, they shall be set to dash for a single tick and then halted (this causeth the FOV to change).Employing it a second time, without the player dashing of their own accord betwixt, causeth the player to remain in dashing mode, with certain peculiarities.
- Particles may not be produced beneath the player's feet.
- The player shall not exit the dashing state shouldst they cease moving.
- Restrictions such as low hunger shall not prevent the player from dashing.
- The player pressing shift shall halt their dashing, and pressing sprint shall reassert normal dashing behaviour.
Employing this effect twice or more in succession upon a stationary player yieldeth undefined behaviour and should not be relied upon.
Examples:
compel player to commence dashing
| Patterns: |
|
| Since: | 2.10 |
| Requirements: | Spigot 1.20.5+ |
Examples:
compel the player's tool to stop glinting
| Patterns: |
|
| Since: | unknown (before 2.1) |
Examples:
loop-block is not air:
depart 2 sections
set loop-block to water
| Patterns: |
|
| Since: | 2.5 |
Examples:
halt ignition of the last spawned creeper
| Patterns: |
|
| Since: | 2.7 |
Examples:
on entity explosion:
set {_player} to the nearest player
{_player} is set
distance between {_player} and the event-location is less than 15
compel {_player} to gaze 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: | 1.0, 2.2-dev26 (advanced features), 2.5.2 (optional sender), 2.6 (sending objects) |
| Requirements: | Minecraft 1.16.4+ for optional sender |
within the given string or in formatted expressions shall be parsed.
Appending an optional sender doth allow the messages to be dispatched as though a specific player penned them.
This proveth useful with Minecraft 1.16.4's new chat ignore system, wherein players may choose to ignore other players,
yet for this to function, the message must needs be sent from a player.
Examples:
message "This message is a distraction. Mwahaha!"
dispatch "Thy kill streak standeth at %{kill streak::%uuid of player%}%" unto player
if the targeted entity exists:
message "Thou art presently gazing upon a %type of the targeted entity%!"
on chat:
cancel event
dispatch "[%player%] >> %message%" unto all players from player
| Patterns: | |
| Since: | 2.4 |
the resource pack in the background, and shall switch to it forthwith upon completion.
The URL must needs be a direct download link.
The hash serveth for caching, so the player need not re-procure the resource pack anew.
The hash must be SHA-1; thou canst obtain the SHA-1 hash of thy resource pack using
this online tool.
The resource pack request action may be employed to discern
the status of the dispatched resource pack request.
Examples:
dispatch the resource pack from "URL" with hash "hash" unto the player
| Patterns: | |
| Since: | 2.5, 2.10 (wither skulls) |
Examples:
charge the event-entity
| Patterns: |
|
| Since: | 2.11 |
| Requirements: | Minecraft 1.20.1+ |
Vanishing towards an entity doth transport in the direction of said entity, not unto them.
Examples:
loop 10 times:
bid all endermen vanish towards player
| Patterns: | |
| Since: | 2.11 |
The persistence of entities doth determine whether they be retained through server restarts.
The persistence of leaves doth determine whether they should decay when not bound to a log block within six meters.
The persistence of players doth determine whether their playerdata be preserved when they depart the server.A player's persistence is restored to 'true' upon their return to the server.
Passengers do inherit the persistence of their conveyance, meaning a persistent zombie set upon anon-persistent chicken shall become non-persistent. This doth not apply to players.
By default, all entities are persistent.
Examples:
compel {_leaves} to persist
command /kickcheater <cheater: player>:
permission: op
trigger:
forbid {_cheater} from persisting
kick {_cheater}
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | MC 1.17+ |
All souls not upon the whitelist shall be cast out upon its enforcement.
Examples:
unenforce the whitelist
| Patterns: | |
| Since: | 2.4, 2.10 (unloading) |
Quenching a script doth unload it and prepend - to its name so it shall not be loaded upon the next awakening of the server. If the script reflection experiment be enabled: unloading a script doth terminate it and cast it from memory, yet doth not alter the file.
Examples:
enliven script file "testing"
unload script file "script.sk"
set {_script} to the script "MyScript.sk"
reload {_script}
| Patterns: |
|
| Since: | 2.11 |
Bestowing a custom name upon a living entity doth automatically render it imperishable.
Further knowledge on what and when entities perish may be found at this tome of reference.
Examples:
spawn zombie at location(0, 0, 0):
compel event-entity to not perish when far away
| Patterns: | |
| Since: | 2.3, 2.10 (entities) |
| Requirements: | Minecraft 1.19+ (entities) |
If no players be specified, the entities shall be concealed from all players presently online.
When reveal is employed in conjunction with the hidden players expression and the viewers be not specified, it shall default to the given player in the hidden players expression.
Mark well: all previously concealed entities (including players) shall become visible when a player departs and returns.
Examples:
if event-entity is a chicken:
conceal event-entity
reveal hidden players of players
| Patterns: |
|
| Since: | 1.3.2 |
Examples:
envenom the victim for 20 seconds
purge the player of venom
| Patterns: |
|
| Since: | 2.13 |
| Requirements: | Minecraft 1.21.2+ |
Examples:
set {_component} to the equippable component of {_item}
forbid {_component} from being dispensed forth
| Patterns: |
|
| Since: | 2.13 |
| Requirements: | Minecraft 1.21.5+ |
Examples:
| Patterns: |
|
| Since: | 2.13 |
| Requirements: | Minecraft 1.21.2+ |
Examples:
set {_component} to the equippable component of {_item}
forbid {_component} from exchanging armament upon right click
| Patterns: |
|
| Since: | 2.13 |
| Requirements: | Minecraft 1.21.2+ |
Examples:
set {_component} to the equippable component of {_item}
if {_component} shall forfeit durability when wounded:
make {_component} forfeit durability upon wounding
| Patterns: |
|
| Since: | 2.13 |
| Requirements: | Minecraft 1.21.6+ |
Examples:
set {_component} to the equippable component of {_item}
if {_component} can be shorn from entities:
forbid {_component} from being shorn from entities
| Patterns: |
|
| Since: | 2.11 |
Employing `by` doth add or subtract from the present size of the world border.
Employing `to` doth set it to the specified measure.
Examples:
diminish world border of world "world" to 100 over 10 seconds
| Patterns: |
|
| Since: | 2.8.0 |
Examples:
render entity left handed
render all zombies in radius 10 of player right handed
| Patterns: |
|
| Since: | 2.11 |
Examples:
| Patterns: |
|
| Since: | 2.0 (cows, sheep & snowmen), 2.8.0 (all shearable entities) |
Prithee note that..:
- Force-fleecing or un-fleecing on a sheared mushroom cow is not possible
Examples:
fleece the clicked sheep
chance of 10%
force fleece the clicked sheep
| Patterns: |
|
| Since: | 2.5.1 |
| Requirements: | Minecraft 1.15.2+ |
Examples:
| Patterns: |
|
| Since: | 1.0 |
Examples:
victim is a player
victim has the permission "skript.god"
forbid the occasion
| Patterns: |
|
| Since: | 2.2-dev34 |
Examples:
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
forsake the cooldown
send "Your nickname may be at most 16 characters."
stop
set the player's display name to arg-1
| Patterns: |
|
| Since: | 2.11 |
Examples:
restore {_goat}'s horns
sever both horns of all goats
| Patterns: |
|
| Since: | 2.8.0 |
For instance, halting the consumption of victuals, or the drawing of a bow.
Examples:
if the victim's active tool is a bow:
halt the employment of the player's active item
| Patterns: |
|
| Since: | 2.5 |
Examples:
revive server
| Patterns: |
|
| Since: | 2.10 |
Item tags ought be employed for contexts wherein the item is not set upon the ground, whilst block tags are meet for contexts wherein the item is placed. For example, an item tag might be "skript:edible", whilst a block tag would be "skript:needs_water_above".
All bespoke tags shall be granted the namespace "skript", followed by the name thou dost provide. The name must only comprise the characters A to Z, 0 to 9, and '/', '.', '_', and '-'. Otherwise, the tag shall not be inscribed.
Pray note that two tags may share a name if they be of differing types. Inscribing a new tag of the same name and type shall overwrite the existing tag. Tags shall be cleared upon server shutdown.
Examples:
inscribe an item tag named "skript:wasp_weapons/swords" comprising diamond sword and netherite sword
inscribe block tag named "pokey" comprising sweet berry bush and bamboo sapling
on player move:
block at player is marked as tag "skript:pokey"
damage the player by 1 heart
| Patterns: | |
| Since: | 2.0, 2.9.0 (severities) |
NB: Employing 'server.log' as the log file shall write to the default server log. Omitting the log file altogether shall inscribe the message as '[Skript] [<script>.sk] <message>' in the server log.
Examples:
inscribe "%player% hath just arrived upon the server!"
on world change:
inscribe "Someone hath just departed unto %event-world%!" to file "worldlog/worlds.log"
on command:
inscribe "%player% hath just executed %full command%!" to file "server/commands.log" with a severity of warning
| Patterns: |
|
| Since: | 2.10 |
Examples:
invoke {_function}
invoke {_function} with arguments {_things::*}
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Spigot 1.20.5+ |
If altering the 'entire' tooltip of an item, naught shall appear when a player hovers upon it.
If altering the 'supplementary' tooltip, only particular portions (which vary per item) shall be concealed.
Examples:
conceal {_item}'s supplementary tool tip
| Patterns: |
|
| Since: | 2.11 |
Examples:
permit all dropped items to naturally despawn
| Patterns: |
|
| Since: | 2.7 |
Examples:
bid all cows halt journeying
bid event-entity journey towards player at speed 1
| Patterns: |
|
| Since: | 2.7 |
Examples:
smite back victim (vector from attacker to victim) with strength 10
| Patterns: | |
| Since: | 2.11 |
| Requirements: | Minecraft 1.21 |
When dealing with beehives, providing a timespan shall prevent the liberated bees from re-entering the beehive for that duration.
Due to unstable behaviour upon older versions, this effect doth require Minecraft version 1.21+.
Examples:
liberate the entity storage of {_hive} for 5 seconds
| Patterns: |
|
| Since: | 1.4 |
Examples:
strike lightning effect at the victim
| Patterns: |
|
| Since: | 2.3 |
Examples:
suppress the variable save warnings
| Patterns: |
|
| Since: | 2.11 |
| Requirements: | Minecraft 1.21+ |
The entity must be of the proper kind for the block (e.g. bee for beehive).
Owing to unstable behaviour upon older versions, lodging entities within an entity storage doth require Minecraft version 1.21+.
Examples:
| Patterns: |
|
| Since: | 2.4 |
Examples:
| Patterns: |
|
| Since: | 2.0 |
Examples:
make the attacker mount the victim
| Patterns: |
|
| Since: | 2.0, 2.1.1 (closing), 2.2-Fixes-V10 (anvil), 2.4 (hopper, dropper, dispenser) |
Pray note that presently 'show' and 'open' bear the same effect, yet 'show' shall in time reveal an unalterable view of the inventory.
Examples:
open the player's inventory for the player
| Patterns: |
|
| Since: | 2.11 |
The warden shall not investigate should it already be wrathful toward an entity.
This effect doth not add anger unto the warden.
Examples:
| Patterns: |
|
| Since: | 2.3 |
Examples:
grant a diamond unto the player should the player have permission "rank.vip"
| Patterns: |
|
| Since: | 2.10 |
Examples:
if player is not set:
forbid the tether from falling
else if player is op:
permit the tether to fall
| Patterns: |
|
| Since: | 2.10 |
Examples:
permit aging of entity
| Patterns: |
|
| Since: | 2.3 |
The Vanilla Minecraft client shall display ??? (dark gray) in lieu of player counts and shall not reveal the
hover list when concealing player tidings.
The version string may override the ???.
Also the Online Players Count and
Max Players expressions shall return -1 when concealing player tidings.
Examples:
conceal player related information in the server list
reveal all player related info
| Patterns: |
|
| Since: | 2.14 |
Examples:
| Patterns: |
|
| Since: | 2.14 |
That is to say, whether the potion effect doth produce more, translucent particles.
Examples:
| Patterns: |
|
| Since: | 2.14 |
Examples:
| Patterns: |
|
| Since: | 2.14 |
That is to say, whether the potion effect shall ever expire.
Examples:
| Patterns: |
|
| Since: | 2.4 |
Examples:
if the victim is an op:
preserve the inventory and experiences
| Patterns: |
|
| Since: | 2.8.0 |
Note: preserving many worlds at once may perchance cause the server to freeze.
Examples:
preserve all worlds
| Patterns: | |
| Since: | 1.4.6 2.12 (push towards) |
Examples:
thrust the victim downwards at speed 0.5
propel player towards player's target at speed 2
pull player along vector(1,1,1) at speed 1.5
| Patterns: |
|
| Since: | 2.11 |
Examples:
| Patterns: |
|
| Since: | 2.10 |
Examples:
entity is not an adult
render entity an adult
| Patterns: |
|
| Since: | 2.10 |
Examples:
render entity unbreedable
| Patterns: | |
| Since: | 2.5 |
Examples:
render the explosion fiery
| Patterns: | |
| Since: | 2.14 |
Examples:
| Patterns: |
|
| Since: | 2.9.0 |
| Requirements: | Spigot 1.20.5+ |
Examples:
render {_items::*} not resistant to fire
| Patterns: |
|
| Since: | 2.7 |
When setting an entity to invisible whilst an invisibility potion is upon it, the potion shall be overridden, and when it runneth out the entity keepeth its invisibility.
Examples:
| Patterns: |
|
| Since: | 2.2-dev28, 2.10 (quaternions, displays) |
Vectors may only be revolved about the global X/Y/Z axes, or an arbitrary vector axis.
Quaternions art more versatile, permitting revolution about the global or local X/Y/Z axes, arbitrary vectors, or all three local axes at once.
Global axes art those of the Minecraft world. Local axes art relative to the quaternion's present orientation.
Revolving a display is but a shorthand for revolving its left rotation. Should the right rotation require alteration, it must be acquired, revolved, and set anew.
Mark well that revolving a quaternion or display about a vector doth result in a revolution about the local vector, and thus the outcome may defy expectation.For instance, revolving quaternions or displays about vector(1, 0, 0) is the selfsame thing as revolving about the local X axis.
The same doth apply to revolutions by all three axes at once.Furthermore, revolving about all three axes of a quaternion or display at once shall proceed in ZYX order, meaning the Z revolution shall be applied first and the X revolution last.
Examples:
revolve last spawned block display about y axis by 10 degrees
revolve {_vector} about vector(1, 1, 1) by 45
revolve {_quaternion} by x 45, y 90, z 135
| Patterns: |
|
| Since: | 2.11 |
Bid villagers to slumber by providing a location of a bed.
Bid players to slumber by providing a location of a bed.Employing 'with force' shall bypass "nearby monsters", the maximum distance, permitting players to slumber even if the bed be far away, and letteth players slumber in the nether and end.Doth not function if the location of the bed be not in the world the player presently inhabits.
Employing 'without spawn location update' shall rouse players without setting their spawn location to the bed.
Examples:
make {_bat} cease slumber
make {_villager} commence slumber at location(0, 0, 0)
make player retire to slumber at location(0, 0, 0) with force
make player rouse without spawn location update
| Patterns: |
|
| Since: | 1.0, 2.8.0 (bungeecord command) |
If the command be a bungeecord-side decree, thou mayest employ the [bungeecord] option to enact the command upon the proxy.
Examples:
enact console decree "/say Hail, good people, one and all!"
enact player bungeecord decree "/alert &6Testing Announcement!"
| Patterns: |
|
| Since: | 2.10 |
Examples:
| Patterns: | |
| Since: | 2.4 |
Thou mayest add a tool, which shall scatter items based upon how that tool would break the block
(i.e.: When using a bare hand to break stone, it yieldeth nothing, whereas with a pickaxe it yieldeth cobblestone).
Examples:
shatter clicked block naturally
loop blocks in radius 10 around player:
shatter loop-block using player's tool
loop blocks in radius 10 around player:
shatter loop-block naturally using diamond pickaxe
| Patterns: |
|
| Since: | 2.4, 2.7 (stop all sounds) |
Pray note that sound names may be altered in any Minecraft or Spigot version, or indeed removed from Minecraft itself.
Examples:
cease playing sounds "ambient.underwater.loop" and "ambient.underwater.loop.additions" to the player
silence all sounds for all players
silence sound in the record category
| Patterns: |
|
| Since: | 1.0, 2.10 (ignoring totem of undying) |
Examples:
slay all creepers in the player's world
slay all endermen, witches and bats
| Patterns: |
|
| Since: | 2.2-dev28, 2.4 (sound categories), 2.9 (sound seed & entity emitter) |
When running 1.19+, playing a sound from an entity directly shall cause the sound to emanate from said entity, even whilst in motion.
If the sound be custom, a location emitter shall follow the entity. Do note that pitch and volume
are reflected based upon the entity, and Minecraft may not employ the values from this syntax.
Minecraft doth sometimes harbour a set of sounds under one sound ID that shall randomly play.To counter this, thou canst directly state which seed to employ.
Pray note that sound names may be altered in any Minecraft or Spigot version, or even banished from Minecraft itself.
Examples:
play sound "entity.experience_orb.pickup" with volume 0.5 unto 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
| Patterns: |
|
| Since: | 2.12 |
Examples:
make last spawned strider cease trembling
| Patterns: |
|
| Since: | 2.3 |
last loaded server icon expression.
Pray note that the image must be 64x64 and the file path doth begin from the server folder.
Examples:
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 |
The summoning effect shall create a new world should one not already exist.
When attempting to summon a vanilla world, thou must declare its environment, e.g. "world_nether" must be summoned with nether environment.
Examples:
summon the world "myCustomWorld"
banish "world_nether"
banish "world_the_end" without saving
banish all worlds
| Patterns: |
|
| Since: | 2.0, 2.2-dev24 (multiple strings, items in inventory), 2.5 (replace first, case sensitivity), 2.10 (regex) |
Examples:
replace every "&" with "§" in line 1 of targeted block
# A most simple chat censor
on chat:
replace all "idiot" and "noob" with "****" in the message
regex replace "(idiot|noob)" with "****" in the message # Regex version using word boundaries for finer results
replace all stone and dirt in player's inventory and player's top inventory with diamond
| Patterns: |
|
| Since: | 2.12 |
NOTE: Suppressing type hints doth also prevent 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:
# potentially unsafe code goes here
cease suppressing local variable type hints
| Patterns: |
|
| Since: | 2.10 |
Examples:
untame {_horse}
| Patterns: |
|
| Since: | 1.4 |
ban player → tarry 7 days → unban player shall not avail if thou dost restart thy server at any time within those 7 days. Thou must also take great care even when employing brief delays! Examples:
halt for 5 minecraft hours
tarry for a tick
| Patterns: |
|
| Since: | 2.3 |
See Spigot's Javadocs for further knowledge.
Examples:
tether event-entity to player
send "&aThou hast tether'd &2%event-entity%!" to player
| Patterns: | |
| Since: | 2.10 |
Examples:
if {_display} hath drop shadow:
remove drop shadow from the text of {_display}
| Patterns: | |
| Since: | 2.10 |
Examples:
forbid all text displays from being visible through walls
| Patterns: |
|
| Since: | 2.11 |
Providing a location applieth only unto allays. They shall inspect whether the block at said location be a jukebox playing music. If it be not, they shall cease their dance. If no location be provided, the allay shall dance without end.
Providing a timespan applieth only unto piglins. It determineth the duration of their revelry. If no timespan be provided, they shall dance in perpetuity.
Examples:
bid last spawned allay commence a dance
if block at location(0, 0, 0) is a jukebox:
bid all allays dance at location(0, 0, 0)
bid last spawned piglin commence a dance
bid all piglins dance for 5 hours
| Patterns: |
|
| Since: | 2.0, 2.2-dev26 (maps and potions) |
(red, green, blue), where (0,0,0) is black as night and (255,255,255) is white as snow. Armour may be tinted in all Minecraft versions. With Minecraft 1.11 or newer, thou canst also tint potions and maps. Note that the hues might not appear precisely as thou wouldst expect. Examples:
tint the player's tool red
| Patterns: | |
| Since: | 2.3 |
Shouldst thou send only the subtitle, it shall appear only if a title be presently displayed; otherwise it shall be shown with the next title. To display only the subtitle, employ:
proclaim title " " with subtitle "yourtexthere" unto player.Mark well: if no durations be given, it shall retain those from the last title proclaimed; use the reset title effect to restore the default values.
Examples:
proclaim title "Hi %player%" unto player
proclaim title "Loot Drop" with subtitle "starts in 3 minutes" unto all players
proclaim title "Hello %player%!" with subtitle "Welcome to our server" unto player for 5 seconds with fadein 1 second and fade out 1 second
proclaim subtitle "Party!" unto all players
| Patterns: |
|
| Since: | 1.4, 2.12 (booleans) |
Examples:
on projectile hit:
projectile is arrow
toggle the block at the arrow
# With booleans
toggle gravity of player
| Patterns: | |
| Since: | 2.9.0 |
Perchance, the entity that did toll the bell and the direction it should ring may be specified.
A bell may only toll in twain directions, determined by which way the bell doth face.
By default, the bell shall toll in the direction it faceth.
Examples:
| Patterns: | |
| Since: | 2.8.0 |
Note: Transcribing a value into a variable or list shall overwrite whatsoever data existeth therein.
Examples:
set {_foo::sublist::foobar} to "hey"
transcribe {_foo::*} to {_copy::*}
proclaim indices of {_copy::*} # bar, sublist
proclaim {_copy::bar} # 1
proclaim {_copy::sublist::foobar} # "hey!"
| Patterns: |
|
| Since: | 2.10 |
Employing 'without physics' shall not dispatch tidings to the surrounding blocks of those being set.
For example: Transmuting a block beside a sand block suspended in the air 'without physics' shall not cause the sand block to fall.
Examples:
transmute {_blocks::*} to be sand without physics updates
transmute {_blocks::*} as stone without neighbouring updates
| Patterns: |
|
| Since: | 2.10 |
Evaluateth the given expression for each element in the list, replacing the original element with the expression's yield.
Should the given expression return a single value, the indices of the list shall remain unchanged. Should the expression return manifold values, then the indices shall be reset, as a single index cannot harbour multiple values.
Only variable lists may be transmuted with this effect. For other lists, see the transform expression.
Examples:
transmute {_a::*} employing input * 2
# {_a::*} is now 2, 4, and 6
# procure a list of the sizes of all clans without manually traversing
set {_clan-sizes::*} to indices of {clans::*}
transmute {_clan-sizes::*} employing {clans::%input%::size}
# set all existing values of a list to naught:
transmute {_list::*} with 0
| Patterns: |
|
| Since: | 1.0, 2.10 (flags) |
This effect is delayed by default on Paper, meaning certain syntax such as the return effect for functions cannot be employed thereafter.
The keyword 'force' doth indicate this effect shall not be delayed,
which may cause lag spikes or server crashes when transporting entities unto unloaded chunks.
Transport flags are settings to retain during a transport, such as direction, passengers, x coordinate, and so forth.
Examples:
transport the attacker unto the victim
on dismount:
cancel event
transport the player unto {server::spawn} retaining vehicle and passengers
| Patterns: |
|
| Since: | 1.0, 2.10 (damage cause) |
| Requirements: | Spigot 1.20.4+ (for damage cause) |
Servers running Spigot 1.20.4+ may optionally declare a feign'd damage cause.
Examples:
wound player by 3 hearts with fake cause fall
heal the player
repair tool of player
| Patterns: |
|
| Since: | 2.11 |
This effect doth remove the former entity and conjure a new one in its stead.
Zombifying a villager stored within a variable shall update said variable to the newly cursed zombie villager.
Curing a zombie villager doth not update the variable.
Examples:
set {_villager} to last spawned villager
zombify {_villager}
if {_villager} is a zombie villager:
# This shall pass, for '{_villager}' is changed to the new zombie villager
set {_villager} to last spawned villager
zombify last spawned villager
if {_villager} is a zombie villager:
# This shall fail, for the variable was not provided when zombifying
cure {_zombieVillager}
cure {_zombieVillager} after 2 seconds
| Patterns: |
|
| Since: | 2.10 |
Examples:
loose 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) |
If employed as a section, the section shall run ere the entity is added unto the world.
Thou mayest modify the entity within this section, using for example 'event-entity' or 'cow'.
Mark well that other event values, such as 'player', shall not function within this section.
If thou art summoning a display and dost wish it to be empty upon initialization, such as not having a block display appear as stone, set the hidden config node 'spawn empty displays' to true.
Note that when summoning an entity by way of entity snapshots, the code within the section shall not run instantaneously as compared to summoning by the usual means (via 'a zombie').
Examples:
conjure a ghast 5 meters above the player
summon a zombie at the player:
set name of the zombie to ""
conjure a block display of a ladder[waterlogged=true] at location above player:
set billboard of event-display to center # permits the display to rotate about the centre axis