Script API - v1.21.0
    Preparing search index...

    Class WorldBeforeEvents

    A set of events that fire before an actual action occurs. In most cases, you can potentially cancel or modify the impending event. Note that in before events any APIs that modify gameplay state will not function and will throw an error. (e.g., dimension.spawnEntity)

    Index

    Properties

    effectAdd entityRemove explosion itemUse itemUseOn playerBreakBlock playerGameModeChange playerLeave weatherChange

    Properties

    effectAdd: EffectAddBeforeEventSignal

    This event is triggered after an event has been added to an entity.

    entityRemove: EntityRemoveBeforeEventSignal

    Fires before an entity is removed from the world (for example, unloaded or removed after being killed.)

    explosion: ExplosionBeforeEventSignal

    This event is fired after an explosion occurs.

    itemUse: ItemUseBeforeEventSignal

    This event fires when an item is successfully used by a player.

    itemUseOn: ItemUseOnBeforeEventSignal

    This event fires when an item is used on a block by a player.

    import { world, Player, BlockPermutation } from "@minecraft/server";

    // Subscribe to the itemUseOn event before it happens
    world.beforeEvents.itemUseOn.subscribe((event) => {
        const { source, block, itemStack } = event;
        if (!(source instanceof Player)) return;

        source.sendMessage("You used " + itemStack.typeId + " on " + block.typeId);

        // If the item is a diamond, set the block to be a diamond block
        if (itemStack.typeId === "minecraft:diamond") {
            block.setPermutation(
                BlockPermutation.resolve("minecraft:diamond_block")
            );
        }
    });
    playerBreakBlock: PlayerBreakBlockBeforeEventSignal

    This event fires before a block is broken by a player.

    playerGameModeChange: PlayerGameModeChangeBeforeEventSignal
    playerLeave: PlayerLeaveBeforeEventSignal

    Fires when a player leaves the game.

    import { world } from "@minecraft/server";
    world.beforeEvents.playerLeave.subscribe(({ player }) => {
        world.sendMessage(
            `[${new Date().toISOString()}]` + player.name + "left the server"
        );
    });
    weatherChange: WeatherChangeBeforeEventSignal

    Settings

    Member Visibility

    On This Page

    Properties