Events reference

• Also written: on hit:
• Can be cancelled: Yes
• player is: The victim if a player was hurt; otherwise the attacker if a player dealt the damage; otherwise nobody

on entity damage:
    if event.cause is "FALL":
        if player has permission "hyperscript.nofall":
            cancel event
            send action bar "&aFall damage negated!" to victim

on entity damage:
    # click a value above

• Can be cancelled: Yes. The player is snapped back to where they were, so a small hop may be visible
• player is: The jumping player

on player jump:
    if {%player%.frozen} is true:
        cancel event
        send action bar "&cYou cannot jump while frozen!" to player

on player jump:
    # click a value above

• Can be cancelled: Yes
• player is: The sender

on player chat:
    if message contains "badword":
        cancel event
        send "&cPlease keep chat friendly!" to player

on player chat:
    # click a value above

• Can be cancelled: Yes
• player is: The player breaking the block

on block break:
    if block is "diamond_ore":
        broadcast "&b%player.name% found diamonds! Drops: %event.drops%"

on block break:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on mob spawn:
    if entity is "phantom" and reason is "NATURAL":
        cancel event

on mob spawn:
    # click a value above

• Can be cancelled: Yes. The click then moves nothing
• player is: The player who clicked

on inventory click:
    if item is "barrier" and event.click_type is "SHIFT_LEFT":
        cancel event
        send "&cThat item cannot be moved." to player

on inventory click:
    # click a value above

• Can be cancelled: No
• player is: Nobody: the client has not logged in, so only its address is known

on server ping:
    set motd to "&6My Server &7- &a%server.online_players% online\n&eDouble coins weekend!"
    set max players to 100

on server ping:
    # click a value above

• Can be cancelled: Yes
• player is: The player who clicked

on left click:
    if item is "stick":
        send "&7Poke."

on left click:
    # click a value above

• Can be cancelled: Yes
• player is: The player sneaking

on player sneak:
    send action bar "&7Sneaking..." to player

on player sneak:
    # click a value above

• Can be cancelled: Yes
• player is: The player sprinting

on player sprint:
    add 1 to {%player%.sprints}

on player sprint:
    # click a value above

• Can be cancelled: Yes
• player is: The player swimming

on player swim:
    apply night vision to player for 30 seconds

on player swim:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on flight toggle:
    if player does not have permission "fly.use":
        cancel event

on flight toggle:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on hand swap:
    cancel event
    send "&7Hands are locked here."

on hand swap:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on slot change:
    if item is "compass":
        send action bar "&bRight-click to open the menu" to player

on slot change:
    # click a value above

• Can be cancelled: No
• player is: The player whose item broke

on item break:
    send "&cYour %event.item% broke!"

on item break:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on book edit:
    log "%player.name% edited a book"

on book edit:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on gamemode change:
    if event.gamemode is "creative" and player does not have permission "build.creative":
        cancel event

on gamemode change:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on hunger change:
    if region at player's location contains "spawn":
        cancel event

on hunger change:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on player heal:
    if {%player%.in_combat}:
        cancel event

on player heal:
    # click a value above

• Can be cancelled: No
• player is: The player

on experience gain:
    add amount to {%player%.total_xp}

on experience gain:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on effect gained:
    if event.effect is "poison" and player has permission "vip.immune":
        cancel event

on effect gained:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on effect ended:
    send action bar "&7%event.effect% wore off" to player

on effect ended:
    # click a value above

• Can be cancelled: Yes
• player is: The player being kicked

on player kick:
    log "%player.name% was kicked: %event.reason%"

on player kick:
    # click a value above

• Can be cancelled: No
• player is: The player

on advancement:
    if event.advancement is "story/mine_diamond":
        broadcast "&b%player.name% found diamonds!"

on advancement:
    # click a value above

• Can be cancelled: No
• player is: The player who made the kill

on player kill:
    add 1 to {%player%.kills}
    add 1 to {%victim%.deaths}
    send "&aYou defeated &f%event.victim%"

on player kill:
    # click a value above

• Can be cancelled: Yes
• player is: The player who shot

on projectile shoot:
    if entity is "ender_pearl" and {%player%.in_combat}:
        cancel event

on projectile shoot:
    # click a value above

• Can be cancelled: Yes
• player is: The player who shot it

on projectile hit:
    if entity is "snowball" and victim is set:
        send "&bSplat! You hit %event.victim%"

on projectile hit:
    # click a value above

• Can be cancelled: Yes
• player is: The player who was saved

on totem use:
    broadcast "&6%player.name% cheated death!"

on totem use:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on block burn:
    if region at event's location contains "spawn":
        cancel event

on block burn:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on explosion:
    if entity is "creeper":
        cancel event

on explosion:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on leaves decay:
    if region at event's location contains "park":
        cancel event

on leaves decay:
    # click a value above

• Can be cancelled: No
• player is: Nobody

on redstone:
    if event.block is "redstone_lamp":
        if event.power > 0:
            log "A lamp was lit at %event's location%"

on redstone:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on piston extend:
    if region at event's location contains "spawn":
        cancel event

on piston extend:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on piston retract:
    if region at event's location contains "spawn":
        cancel event

on piston retract:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on dispense:
    if event.item is "tnt":
        cancel event

on dispense:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on hopper move:
    if event.item is "diamond":
        cancel event

on hopper move:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on crop grow:
    if {season} is "winter":
        cancel event

on crop grow:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on bucket fill:
    if region at player's location contains "spawn":
        cancel event

on bucket fill:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on bucket empty:
    if item is "lava_bucket" and player does not have permission "build.lava":
        cancel event
        send "&cLava is not allowed."

on bucket empty:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on weather change:
    if event.weather is "rain":
        cancel event

on weather change:
    # click a value above

• Can be cancelled: Yes
• player is: The player who tamed it

on entity tame:
    send "&aYou tamed a %event.entity%!"

on entity tame:
    # click a value above

• Can be cancelled: Yes
• player is: The player who fed them, if a player did

on entity breed:
    if player is set:
        add 1 to {%player%.animals_bred}

on entity breed:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on shear:
    add 1 to {%player%.sheep_sheared}

on shear:
    # click a value above

• Can be cancelled: Yes
• player is: The player being targeted

on mob target:
    if player is vanished:
        cancel event

on mob target:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on player move:
    if block at (location below player's location) is "magma_block":
        send action bar "&cHot!" to player

on player move:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on portal use:
    if {%player%.level} < 10:
        cancel event
        send "&cReach level 10 before leaving the overworld."

on portal use:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on bed leave:
    send "&eGood morning, %player.name%!"

on bed leave:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on item damage:
    if player has permission "tools.unbreaking":
        cancel event

on item damage:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on harvest:
    add 1 to {%player%.harvests}

on harvest:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on glide toggle:
    if region at player's location contains "spawn":
        cancel event

on glide toggle:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on entity mount:
    send action bar "&7Sneak to get off" to player

on entity mount:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on entity dismount:
    add 1 to {%player%.rides}

on entity dismount:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on vehicle enter:
    send action bar "&7Hold on tight" to player

on vehicle enter:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on vehicle exit:
    log "%player.name% left a %event.entity%"

on vehicle exit:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on inventory open:
    if event.inventory is "ender_chest" and {%player%.in_combat}:
        cancel event

on inventory open:
    # click a value above

• Can be cancelled: No
• player is: The player

on inventory close:
    delete {%player%.shop_page}

on inventory close:
    # click a value above

• Can be cancelled: Yes
• player is: The player

on enchant item:
    add 1 to {%player%.enchants}

on enchant item:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on furnace smelt:
    add 1 to {smelted.%event.item%}

on furnace smelt:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on console command:
    if command is "stop":
        broadcast "&cThe server is shutting down."

on console command:
    # click a value above

• Can be cancelled: No
• player is: The player holding the shield

on shield block:
    play sound "item.shield.block" with pitch 0.8 and volume 1.0 at player's location
    add 1 to {%player%.blocks_made}

on shield block:
    # click a value above

• Can be cancelled: Yes
• player is: The player using the anvil

on anvil use:
    if item is "name_tag" and player does not have permission "anvil.nametags":
        cancel event
        send "&cYou cannot rename name tags here."

on anvil use:
    # click a value above

• Can be cancelled: Yes
• player is: The player trading

on villager trade:
    add 1 to {%player%.trades}
    if item is "emerald":
        send action bar "&aA fine deal" to player

on villager trade:
    # click a value above

• Can be cancelled: No
• player is: The new player

on first join:
    give 16 bread to player
    broadcast "&6Welcome &e%player.name% &6to the server!"

on first join:
    # click a value above

• Can be cancelled: No
• player is: The player who joined

on player join:
    send "&aWelcome, %player.name%!" to player

on player join:
    # click a value above

• Can be cancelled: No
• player is: The player who left

on player quit:
    log "%player.name% left"

on player quit:
    # click a value above

• Can be cancelled: Yes
• player is: The player who placed it

on block place:
    if block is "tnt" and player does not have permission "build.tnt":
        cancel event
        send "&cTNT is not allowed here."

on block place:
    # click a value above

• Can be cancelled: Yes
• player is: The player who wrote the sign

on sign change:
    if item 1 of event.lines is "[Shop]":
        send "&aShop sign created."

on sign change:
    # click a value above

• Can be cancelled: Yes
• player is: The player being teleported

on player teleport:
    if cause is "ENDER_PEARL" and region at event's location contains "spawn":
        cancel event
        send "&cNo pearling into spawn."

on player teleport:
    # click a value above

• Can be cancelled: Yes
• player is: The player who clicked

on entity click:
    if entity is "player":
        send "&7That is &f%event.clicked%&7."

on entity click:
    # click a value above

• Can be cancelled: Yes
• player is: The player crafting

on craft:
    if item is "diamond_sword" and level of player < 10:
        cancel event
        send "&cYou need level 10 to craft that."

on craft:
    # click a value above

• Can be cancelled: Yes
• player is: The player eating or drinking

on consume:
    if item is "golden_apple":
        apply speed 2 to player for 10 seconds

on consume:
    # click a value above

• Can be cancelled: Yes
• player is: The player fishing

on fish:
    add 1 to {%player%.fish_caught}
    send action bar "&bCatch #%{%player%.fish_caught}%: %event.item%" to player

on fish:
    # click a value above

• Can be cancelled: No
• player is: The player who levelled up

on level up:
    if event.level % 10 == 0:
        broadcast "&6%player.name% reached level %event.level%!"

on level up:
    # click a value above

• Can be cancelled: Yes
• player is: The player going to bed

on bed enter:
    set {%player%.bed} to event's location
    send "&7Sleep well."

on bed enter:
    # click a value above

• Can be cancelled: No
• player is: The player who is now in combat

on combat start:
    send action bar "&cIn combat" to player while player is in combat

on combat start:
    # click a value above

• Can be cancelled: No
• player is: The player who is out of combat again

on combat end:
    send "&aYou are out of combat."

on combat end:
    # click a value above

• Can be cancelled: No
• player is: The player who is away

on afk:
    broadcast "&7%player.name% is away."

on afk:
    # click a value above

• Can be cancelled: No
• player is: The player who is back

on afk return:
    broadcast "&7%player.name% is back."

on afk return:
    # click a value above

• Can be cancelled: No
• player is: The player who wrote it

on blocked word:
    add 1 to {%player%.warnings}
    if {%player%.warnings} >= 3:
        mute player for 10 minutes because "language"

on blocked word:
    # click a value above

• Can be cancelled: Yes
• player is: Nobody

on brew:
    spawn particle "witch" count 20 at event.location

on brew:
    # click a value above

• Can be cancelled: No
• player is: The player who made the kill

on kill streak:
    if event.streak is 5:
        broadcast "&6%player.name% is on a killing spree!"

on kill streak:
    # click a value above

• Can be cancelled: No
• player is: The player who entered

on region enter:
    if event.region is "spawn":
        send title "&aSpawn" with subtitle "&7You are safe here" to player

on region enter:
    # click a value above

• Can be cancelled: No
• player is: The player who left

on region leave:
    if event.region is "spawn":
        send action bar "&cYou left the safe zone" to player

on region leave:
    # click a value above

• Can be cancelled: With 'refuse login'
• player is: Nobody yet: 'player' is unset, but {%player%.<name>} is already the variables of whoever is logging in

on player login:
    if {%player%.muted_until} > server.time:
        set {_left} to duration({%player%.muted_until} - server.time)
        refuse login because "&cYou may join again in %{_left}%."

on player login:
    # click a value above

• Can be cancelled: Paper only
• player is: The player who died

on player death:
    set {%player%.death_place} to event's location
    if killer is set:
        set death message to "&c%player.name% &7was defeated by &c%event.killer%"

on player death:
    # click a value above

• Can be cancelled: No
• player is: The player who respawned

on player respawn:
    wait 1 tick
    give player 1 bread
    send "&7Here is something to eat."

on player respawn:
    # click a value above

• Can be cancelled: Yes
• player is: The player picking the item up

on item pickup:
    if item is "diamond":
        add amount to {%player%.diamonds_found}

on item pickup:
    # click a value above

• Can be cancelled: Yes
• player is: The player dropping the item

on item drop:
    if item is "compass":
        cancel event
        send "&cYou cannot drop your compass."

on item drop:
    # click a value above

• Can be cancelled: No
• player is: The player who changed world

on world change:
    send "&7You left &f%event.from% &7for &f%player.world%"

on world change:
    # click a value above

• Can be cancelled: Yes
• player is: The player who typed the command

on player command:
    if command is "plugins" and player does not have permission "server.admin":
        cancel event
        send "&cThat command is not available."

on player command:
    # click a value above

• Can be cancelled: Paper only
• player is: The killer, if a player made the kill; otherwise nobody

on entity death:
    if killer is set:
        send "&6You slew a %event.entity%" to player

on entity death:
    # click a value above

• Can be cancelled: Yes
• player is: The player who clicked

on right click:
    if item is "compass":
        send "&bYou are in %player.world%" to player

on right click:
    # click a value above

• Can be cancelled: No
• player is: The player

on resource pack accept:
    send action bar "&aDownloading server resource pack..." to player

on resource pack accept:
    # click a value above

• Can be cancelled: No
• player is: The player

on resource pack decline:
    send "&cSome custom items may look wrong without the pack." to player

on resource pack decline:
    # click a value above

• Can be cancelled: No
• player is: The player

on resource pack successfully loaded:
    send "&aResource pack loaded!" to player

on resource pack successfully loaded:
    # click a value above

• Can be cancelled: No
• player is: The player

on resource pack failed:
    send "&cThe resource pack failed to load." to player

on resource pack failed:
    # click a value above