Worlds and regions

Time and weather

set time in world "%player.world%" to 1000
set weather in world "%player.world%" to clear

Blocks

set block at 0, 64, 0 in "world" to gold block
set block at player's location to air
set block at {%player%.home} to "oak_planks"
if block at event's location is "bedrock":
    cancel event

A position is player, player's location, event's location, a variable holding a location, or <x>, <y>, <z> followed by in "<world>" (without it, the player's world is used).

Whether a world is there can be asked before it is used:

command /arena:
    trigger:
        if world "arena" exists:
            teleport player to spawn of world "arena"
        else:
            send "&cThe arena has not been made yet."

• at player and at player's location mean the block the player's feet are in.
• Changing a block happens at once and drops nothing. Changing many blocks in one go is slow; do a few at a time and wait between them.
• block at reads the world, which is only safe on the server thread: inside async: put it in a sync: block.

Regions are named boxes in a world. HyperScript only keeps track of where they are; what happens inside one is up to your scripts.

create region "spawn_protection" from -20, 0, -20 to 20, 255, 20 in "world"

Once a region exists, any trigger can ask which regions a location is in:

on block break:
    if region at event's location contains "spawn_protection":
        if player does not have permission "hyperscript.admin":
            cancel event
            send "&cYou cannot break blocks inside the spawn region!"
            play sound "block.anvil.land" with pitch 0.5 and volume 1.0 at player's location

Where somebody stands and what they look at:

on player jump:
    if block below player is "slime_block":
        push player upward with force 2
        play sound "entity.slime.jump" for players within 10 blocks of player's location
    if block above player is "glass":
        send action bar "&7Mind your head." to player

command /scan <player>:
    trigger:
        if player is looking at arg.1:
            send "&aYou have %arg.1% in your sights."
        if player is not looking at target block of player:
            send "&7You are looking at nothing in reach."
        if player is riding:
            set {_mount} to vehicle of player
            send "&7You are riding something."
        if player is in biome "desert":
            send "&eIt is hot here."
        if level of player is even:
            send "&7An even level."
        if level of player is odd:
            send "&7An odd level."
        if level of player is divisible by 5:
            give 1 diamond to player or drop
        chance of 10%:
            give player 1 emerald
            send "&aLucky!"

Containers, the creatures around, and regions:

command /bank:
    trigger:
        set {_chest} to target block of player
        set {_gold} to number of gold ingot in chest at {_chest}
        send "&7This chest holds &6%{_gold}% &7gold."
        if {_gold} is at least 5:
            remove 5 gold ingot from chest at {_chest}
            add 1 diamond to chest at {_chest}
        set chest slot 1 at {_chest} to paper named "&fReceipt"
        if chest slot 2 at {_chest} is not set:
            send "&7The second slot is empty."
        delete chest slot 3 at {_chest}

on inventory open:
    # A chest somebody locked with /lock opens for them alone.
    if nbt "owner" of block at event's location is set:
        if nbt "owner" of block at event's location is not player.name:
            cancel event
            send "&cThis chest is locked."

command /sweep:
    permission: "sweep.use"
    trigger:
        for each {_mob} in entities of zombie within 20 blocks of player:
            kill {_mob}
        set {_left} to size of entities within 20 blocks of player
        send "&7%{_left}% creatures are left around you."
        set {_friend} to nearest other player to player
        if {_friend} is set:
            send "&7Closest to you: &f%{_friend}%"
        set {_threat} to nearest zombie to player
        if {_threat} is set:
            make player look at location of {_threat}
        set {_any} to nearest entity to player's location

command /arena:
    trigger:
        set {_spot} to random location in region "arena"
        if {_spot} is set:
            teleport player to {_spot}
        set {_inside} to size of entities in region "arena"
        send "&7%{_inside}% creatures are in the arena."
        set {_far} to horizontal distance between player's location and {_spot}

command /restart-in <minutes>:
    permission: "restart.use"
    trigger:
        if time until schedule "restart" is set:
            set {_left} to time until schedule "restart"
            send "&cA restart is already coming in %{_left}%."
            stop
        schedule stop_server() in arg.1 * 60 seconds as "restart"

function stop_server():
    execute console command "stop"

A location here is player's location, event's location, a variable holding a location, or <x>, <y>, <z> followed by in "<world>" (without it, the player's world is used).

Whether a world is there can be asked before it is used:

command /arena:
    trigger:
        if world "arena" exists:
            teleport player to spawn of world "arena"
        else:
            send "&cThe arena has not been made yet."

• Holograms are saved: one made by a command is still there after a restart, and is listed in plugins/HyperScript/holograms.yml. A hologram a script keeps up to date is best made in on load:, which simply replaces the old one.
• Copies are for putting a place back the way it was: copy an arena once, and paste it after every round. A copy is the blocks themselves, with which way they face and whether they are open or lit; what is *inside* chests, and what is written on signs, is not kept. It is saved in plugins/HyperScript/copies/ and stays until it is deleted. Pasting sets every block at once, so a large copy makes the server pause for a moment; nothing falls or flows because of it.
• Fake blocks exist only on one player's screen. The server still has the real block, so the player cannot stand on a fake one over air, and the real block comes back by itself when they click it, when it changes, or when they leave the area and return. They are for showing things: a path to follow, an outline, a block that looks mined out. position is written as for set block: at player, at event's location, at 10, 64, -5 in "world".
• Worlds of your own. create world "skyblock" void makes a world and remembers it: it is listed in plugins/HyperScript/worlds.yml and loaded again every time the server starts (unless it was last let go with unload world), before any script runs, so locations saved in it stay good. A world is one of normal (the default), flat, void (nothing but one block to stand on), amplified or large biomes, in the overworld, the nether or the end. Everything that works on a world works on these: teleport player to spawn of world "skyblock", game rules, difficulty, time, weather, borders and regions. Creating one that exists does nothing, so an on load: block may do it every time.
• Region rules. set pvp of region "spawn" to false and set build of region "spawn" to false make HyperScript itself stop fighting and building there, so a script does not have to cancel events. Players with the permission hyperscript.region.bypass (operators by default) may still build. The rules are saved; set them once, for example in on load:.
• region at ... gives a list because regions may overlap; test it with contains.
• For block events, check event's location rather than player's location. The player can stand outside a region and still reach a block inside it.
• Region names ignore case. Regions are saved with the other variable data and survive restarts.
• This is HyperScript's own region list. It does not read WorldGuard regions.