Class Events_WorldAfterEvents

Contains a set of events that are available across the scope of the World.

Implements

Implements

Constructors

constructor

Accessors

blockExplode buttonPush chatSend dataDrivenEntityTrigger effectAdd entityDie entityHealthChanged entityHitBlock entityHitEntity entityHurt entityLoad entityRemove entitySpawn explosion gameRuleChange itemCompleteUse itemReleaseUse itemStartUse itemStartUseOn itemStopUse itemStopUseOn itemUse leverAction messageReceive pistonActivate playerBreakBlock playerButtonInput playerDimensionChange playerEmote playerGameModeChange playerInputModeChange playerInputPermissionCategoryChange playerInteractWithBlock playerInteractWithEntity playerJoin playerLeave playerPlaceBlock playerSpawn pressurePlatePop pressurePlatePush projectileHitBlock projectileHitEntity targetBlockHit tripWireTrip weatherChange worldLoad

Constructors

constructor

Accessors

blockExplode

  • get blockExplode(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.blockExplode",
            BlockExplodeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.blockExplode">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.blockExplode">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.blockExplode",
            BlockExplodeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.blockExplode">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.blockExplode">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.blockExplode">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.blockExplode">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.blockExplode">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.blockExplode event.

    Remarks

    This event fires for each BlockLocation destroyed by an explosion. It is fired after the blocks have already been destroyed.

    This property can be read in early-execution mode.

buttonPush

  • get buttonPush(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.buttonPush",
            ButtonPushAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.buttonPush">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.buttonPush">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.buttonPush",
            ButtonPushAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.buttonPush">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.buttonPush">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.buttonPush">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.buttonPush">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.buttonPush">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.buttonPush event.

    Remarks

    This event fires when a button is pushed.

    This property can be read in early-execution mode.

chatSend

  • get chatSend(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.chatSend",
            ChatSendAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.chatSend">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.chatSend">,
        ): void;
    }
    Beta

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.chatSend",
            ChatSendAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.chatSend">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.chatSend">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.chatSend">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.chatSend">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.chatSend">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.chatSend event.

    Remarks

    This event is triggered after a chat message has been broadcast or sent to players.

    This property can be read in early-execution mode.

dataDrivenEntityTrigger

  • get dataDrivenEntityTrigger(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.dataDrivenEntityTrigger",
            DataDrivenEntityTriggerAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.dataDrivenEntityTrigger">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.dataDrivenEntityTrigger",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.dataDrivenEntityTrigger",
            DataDrivenEntityTriggerAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.dataDrivenEntityTrigger">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.dataDrivenEntityTrigger",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.dataDrivenEntityTrigger">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.dataDrivenEntityTrigger">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.dataDrivenEntityTrigger",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.dataDrivenEntityTrigger event.

    Remarks

    This event is fired when an entity event has been triggered that will update the component definition state of an entity.

    This property can be read in early-execution mode.

effectAdd

  • get effectAdd(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.effectAdd",
            EffectAddAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.effectAdd">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.effectAdd">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.effectAdd",
            EffectAddAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.effectAdd">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.effectAdd">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.effectAdd">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.effectAdd">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.effectAdd">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.effectAdd event.

    Remarks

    This event fires when an effect, like poisoning, is added to an entity.

    This property can be read in early-execution mode.

entityDie

  • get entityDie(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityDie",
            EntityDieAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityDie">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityDie">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityDie",
            EntityDieAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityDie">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityDie">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityDie">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.entityDie">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityDie">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.entityDie event.

    Remarks

    This event fires when an entity dies.

    This property can be read in early-execution mode.

entityHealthChanged

  • get entityHealthChanged(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityHealthChanged",
            EntityHealthChangedAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHealthChanged">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.entityHealthChanged",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityHealthChanged",
            EntityHealthChangedAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHealthChanged">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.entityHealthChanged",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHealthChanged">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.entityHealthChanged">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.entityHealthChanged",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.entityHealthChanged event.

    Remarks

    This event fires when entity health changes in any degree.

    This property can be read in early-execution mode.

entityHitBlock

  • get entityHitBlock(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityHitBlock",
            EntityHitBlockAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHitBlock">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.entityHitBlock",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityHitBlock",
            EntityHitBlockAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHitBlock">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.entityHitBlock",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHitBlock">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.entityHitBlock">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.entityHitBlock",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.entityHitBlock event.

    Remarks

    This event fires when an entity hits (that is, melee attacks) a block.

    This property can be read in early-execution mode.

entityHitEntity

  • get entityHitEntity(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityHitEntity",
            EntityHitEntityAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHitEntity">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.entityHitEntity",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityHitEntity",
            EntityHitEntityAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHitEntity">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.entityHitEntity",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHitEntity">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.entityHitEntity">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.entityHitEntity",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.entityHitEntity event.

    Remarks

    This event fires when an entity hits (that is, melee attacks) another entity.

    This property can be read in early-execution mode.

entityHurt

  • get entityHurt(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityHurt",
            EntityHurtAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHurt">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityHurt">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityHurt",
            EntityHurtAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHurt">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityHurt">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityHurt">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.entityHurt">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityHurt">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.entityHurt event.

    Remarks

    This event fires when an entity is hurt (takes damage).

    This property can be read in early-execution mode.

entityLoad

  • get entityLoad(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityLoad",
            EntityLoadAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityLoad">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityLoad">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityLoad",
            EntityLoadAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityLoad">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityLoad">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityLoad">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.entityLoad">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityLoad">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.entityLoad event.

    Remarks

    Fires when an entity is loaded.

    This property can be read in early-execution mode.

entityRemove

  • get entityRemove(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityRemove",
            EntityRemoveAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityRemove">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityRemove">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entityRemove",
            EntityRemoveAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityRemove">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityRemove">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entityRemove">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.entityRemove">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entityRemove">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.entityRemove event.

    Remarks

    Fires when an entity is removed (for example, potentially unloaded, or removed after being killed).

    This property can be read in early-execution mode.

entitySpawn

  • get entitySpawn(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entitySpawn",
            EntitySpawnAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entitySpawn">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entitySpawn">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.entitySpawn",
            EntitySpawnAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entitySpawn">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entitySpawn">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.entitySpawn">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.entitySpawn">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.entitySpawn">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.entitySpawn event.

    Remarks

    This event fires when an entity is spawned.

    This property can be read in early-execution mode.

explosion

  • get explosion(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.explosion",
            ExplosionAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.explosion">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.explosion">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.explosion",
            ExplosionAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.explosion">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.explosion">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.explosion">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.explosion">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.explosion">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.explosion event.

    Remarks

    This event is fired after an explosion occurs.

    This property can be read in early-execution mode.

gameRuleChange

  • get gameRuleChange(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.gameRuleChange",
            GameRuleChangeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.gameRuleChange">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.gameRuleChange",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.gameRuleChange",
            GameRuleChangeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.gameRuleChange">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.gameRuleChange",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.gameRuleChange">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.gameRuleChange">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.gameRuleChange",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.gameRuleChange event.

    Remarks

    This event fires when a world.gameRules property has changed.

    This property can be read in early-execution mode.

itemCompleteUse

  • get itemCompleteUse(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemCompleteUse",
            ItemCompleteUseAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemCompleteUse">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.itemCompleteUse",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemCompleteUse",
            ItemCompleteUseAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemCompleteUse">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.itemCompleteUse",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemCompleteUse">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.itemCompleteUse">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.itemCompleteUse",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.itemCompleteUse event.

    Remarks

    This event fires when a chargeable item completes charging.

    This property can be read in early-execution mode.

itemReleaseUse

  • get itemReleaseUse(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemReleaseUse",
            ItemReleaseUseAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemReleaseUse">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.itemReleaseUse",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemReleaseUse",
            ItemReleaseUseAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemReleaseUse">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.itemReleaseUse",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemReleaseUse">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.itemReleaseUse">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.itemReleaseUse",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.itemReleaseUse event.

    Remarks

    This event fires when a chargeable item is released from charging.

    This property can be read in early-execution mode.

itemStartUse

  • get itemStartUse(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemStartUse",
            ItemStartUseAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStartUse">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.itemStartUse">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemStartUse",
            ItemStartUseAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStartUse">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.itemStartUse">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStartUse">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.itemStartUse">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.itemStartUse">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.itemStartUse event.

    Remarks

    This event fires when a chargeable item starts charging.

    This property can be read in early-execution mode.

itemStartUseOn

  • get itemStartUseOn(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemStartUseOn",
            ItemStartUseOnAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStartUseOn">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.itemStartUseOn",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemStartUseOn",
            ItemStartUseOnAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStartUseOn">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.itemStartUseOn",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStartUseOn">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.itemStartUseOn">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.itemStartUseOn",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.itemStartUseOn event.

    Remarks

    This event fires when a player successfully uses an item or places a block by pressing the Use Item / Place Block button. If multiple blocks are placed, this event will only occur once at the beginning of the block placement. Note: This event cannot be used with Hoe or Axe items.

    This property can be read in early-execution mode.

itemStopUse

  • get itemStopUse(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemStopUse",
            ItemStopUseAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStopUse">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.itemStopUse">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemStopUse",
            ItemStopUseAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStopUse">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.itemStopUse">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStopUse">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.itemStopUse">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.itemStopUse">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.itemStopUse event.

    Remarks

    This event fires when a chargeable item stops charging.

    This property can be read in early-execution mode.

itemStopUseOn

  • get itemStopUseOn(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemStopUseOn",
            ItemStopUseOnAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStopUseOn">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.itemStopUseOn",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemStopUseOn",
            ItemStopUseOnAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStopUseOn">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.itemStopUseOn",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemStopUseOn">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.itemStopUseOn">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.itemStopUseOn">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.itemStopUseOn event.

    Remarks

    This event fires when a player releases the Use Item / Place Block button after successfully using an item. Note: This event cannot be used with Hoe or Axe items.

    This property can be read in early-execution mode.

itemUse

  • get itemUse(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemUse",
            ItemUseAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemUse">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.itemUse">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.itemUse",
            ItemUseAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemUse">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.itemUse">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.itemUse">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.itemUse">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.itemUse">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.itemUse event.

    Remarks

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

    This property can be read in early-execution mode.

leverAction

  • get leverAction(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.leverAction",
            LeverActionAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.leverAction">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.leverAction">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.leverAction",
            LeverActionAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.leverAction">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.leverAction">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.leverAction">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.leverAction">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.leverAction">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.leverAction event.

    Remarks

    A lever has been pulled.

    This property can be read in early-execution mode.

messageReceive

  • get messageReceive(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.messageReceive",
            ServerMessageAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.messageReceive">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.messageReceive",
            >,
        ): void;
    }
    Beta

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.messageReceive",
            ServerMessageAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.messageReceive">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.messageReceive",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.messageReceive">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.messageReceive">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.messageReceive",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.messageReceive event.

    Remarks

    This event is an internal implementation detail, and is otherwise not currently functional.

    This property can be read in early-execution mode.

pistonActivate

  • get pistonActivate(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.pistonActivate",
            PistonActivateAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.pistonActivate">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.pistonActivate",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.pistonActivate",
            PistonActivateAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.pistonActivate">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.pistonActivate",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.pistonActivate">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.pistonActivate">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.pistonActivate",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.pistonActivate event.

    Remarks

    This event fires when a piston expands or retracts.

    This property can be read in early-execution mode.

playerBreakBlock

  • get playerBreakBlock(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerBreakBlock",
            PlayerBreakBlockAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerBreakBlock">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerBreakBlock",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerBreakBlock",
            PlayerBreakBlockAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerBreakBlock">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerBreakBlock",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerBreakBlock">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerBreakBlock">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerBreakBlock",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerBreakBlock event.

    Remarks

    This event fires for a block that is broken by a player.

    This property can be read in early-execution mode.

playerButtonInput

  • get playerButtonInput(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerButtonInput",
            PlayerButtonInputAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerButtonInput">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerButtonInput",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerButtonInput",
            PlayerButtonInputAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerButtonInput">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerButtonInput",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerButtonInput">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerButtonInput">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerButtonInput",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerButtonInput event.

    Remarks

    This event fires when an InputButton state is changed.

    This property can be read in early-execution mode.

playerDimensionChange

  • get playerDimensionChange(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerDimensionChange",
            PlayerDimensionChangeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerDimensionChange">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerDimensionChange",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerDimensionChange",
            PlayerDimensionChangeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerDimensionChange">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerDimensionChange",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerDimensionChange">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerDimensionChange">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerDimensionChange",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerDimensionChange event.

    Remarks

    Fires when a player moved to a different dimension.

    This property can be read in early-execution mode.

playerEmote

  • get playerEmote(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerEmote",
            PlayerEmoteAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerEmote">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerEmote">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerEmote",
            PlayerEmoteAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerEmote">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerEmote">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerEmote">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerEmote">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerEmote">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerEmote event.

    Remarks

    This property can be read in early-execution mode.

playerGameModeChange

  • get playerGameModeChange(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerGameModeChange",
            PlayerGameModeChangeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerGameModeChange">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerGameModeChange",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerGameModeChange",
            PlayerGameModeChangeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerGameModeChange">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerGameModeChange",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerGameModeChange">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerGameModeChange">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerGameModeChange",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerGameModeChange event.

    Remarks

    This property can be read in early-execution mode.

playerInputModeChange

  • get playerInputModeChange(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerInputModeChange",
            PlayerInputModeChangeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerInputModeChange">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInputModeChange",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerInputModeChange",
            PlayerInputModeChangeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerInputModeChange">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInputModeChange",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerInputModeChange">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerInputModeChange">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInputModeChange",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerInputModeChange event.

    Remarks

    This event fires when a player's InputMode changes.

    This property can be read in early-execution mode.

playerInputPermissionCategoryChange

  • get playerInputPermissionCategoryChange(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerInputPermissionCategoryChange",
            PlayerInputPermissionCategoryChangeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<
            "world.afterEvents.playerInputPermissionCategoryChange",
        >;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInputPermissionCategoryChange",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerInputPermissionCategoryChange",
            PlayerInputPermissionCategoryChangeAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<
            "world.afterEvents.playerInputPermissionCategoryChange",
        >;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInputPermissionCategoryChange",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<
            "world.afterEvents.playerInputPermissionCategoryChange",
        >

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerInputPermissionCategoryChange">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInputPermissionCategoryChange",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerInputPermissionCategoryChange event.

    Remarks

    This event fires when a players input permissions change.

    This property can be read in early-execution mode.

playerInteractWithBlock

  • get playerInteractWithBlock(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerInteractWithBlock",
            PlayerInteractWithBlockAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerInteractWithBlock">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInteractWithBlock",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerInteractWithBlock",
            PlayerInteractWithBlockAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerInteractWithBlock">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInteractWithBlock",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerInteractWithBlock">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerInteractWithBlock">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInteractWithBlock",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerInteractWithBlock event.

    Remarks

    An event for when a player interacts with a block.

    This property can be read in early-execution mode.

playerInteractWithEntity

  • get playerInteractWithEntity(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerInteractWithEntity",
            PlayerInteractWithEntityAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerInteractWithEntity">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInteractWithEntity",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerInteractWithEntity",
            PlayerInteractWithEntityAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerInteractWithEntity">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInteractWithEntity",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerInteractWithEntity">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerInteractWithEntity">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerInteractWithEntity",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerInteractWithEntity event.

    Remarks

    This event fires when a player interacts with an entity.

    This property can be read in early-execution mode.

playerJoin

  • get playerJoin(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerJoin",
            PlayerJoinAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerJoin">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerJoin">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerJoin",
            PlayerJoinAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerJoin">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerJoin">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerJoin">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerJoin">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerJoin">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerJoin event.

    Remarks

    This event fires when a player joins a world. See also playerSpawn for another related event you can trap for when a player is spawned the first time within a world.

    This property can be read in early-execution mode.

playerLeave

  • get playerLeave(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerLeave",
            PlayerLeaveAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerLeave">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerLeave">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerLeave",
            PlayerLeaveAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerLeave">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerLeave">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerLeave">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerLeave">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerLeave">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerLeave event.

    Remarks

    This event fires when a player leaves a world.

    This property can be read in early-execution mode.

playerPlaceBlock

  • get playerPlaceBlock(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerPlaceBlock",
            PlayerPlaceBlockAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerPlaceBlock">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerPlaceBlock",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerPlaceBlock",
            PlayerPlaceBlockAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerPlaceBlock">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerPlaceBlock",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerPlaceBlock">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerPlaceBlock">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.playerPlaceBlock",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerPlaceBlock event.

    Remarks

    This event fires for a block that is placed by a player.

    This property can be read in early-execution mode.

playerSpawn

  • get playerSpawn(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerSpawn",
            PlayerSpawnAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerSpawn">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerSpawn">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.playerSpawn",
            PlayerSpawnAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerSpawn">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerSpawn">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.playerSpawn">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.playerSpawn">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.playerSpawn">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.playerSpawn event.

    Remarks

    This event fires when a player spawns or respawns. Note that an additional flag within this event will tell you whether the player is spawning right after join vs. a respawn.

    This property can be read in early-execution mode.

pressurePlatePop

  • get pressurePlatePop(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.pressurePlatePop",
            PressurePlatePopAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.pressurePlatePop">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.pressurePlatePop",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.pressurePlatePop",
            PressurePlatePopAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.pressurePlatePop">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.pressurePlatePop",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.pressurePlatePop">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.pressurePlatePop">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.pressurePlatePop",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.pressurePlatePop event.

    Remarks

    A pressure plate has popped back up (i.e., there are no entities on the pressure plate.)

    This property can be read in early-execution mode.

pressurePlatePush

  • get pressurePlatePush(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.pressurePlatePush",
            PressurePlatePushAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.pressurePlatePush">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.pressurePlatePush",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.pressurePlatePush",
            PressurePlatePushAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.pressurePlatePush">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.pressurePlatePush",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.pressurePlatePush">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.pressurePlatePush">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.pressurePlatePush",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.pressurePlatePush event.

    Remarks

    A pressure plate has pushed (at least one entity has moved onto a pressure plate.)

    This property can be read in early-execution mode.

projectileHitBlock

  • get projectileHitBlock(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.projectileHitBlock",
            ProjectileHitBlockAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.projectileHitBlock">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.projectileHitBlock",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.projectileHitBlock",
            ProjectileHitBlockAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.projectileHitBlock">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.projectileHitBlock",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.projectileHitBlock">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.projectileHitBlock">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.projectileHitBlock",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.projectileHitBlock event.

    Remarks

    This event fires when a projectile hits a block.

    This property can be read in early-execution mode.

projectileHitEntity

  • get projectileHitEntity(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.projectileHitEntity",
            ProjectileHitEntityAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.projectileHitEntity">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.projectileHitEntity",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.projectileHitEntity",
            ProjectileHitEntityAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.projectileHitEntity">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.projectileHitEntity",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.projectileHitEntity">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.projectileHitEntity">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.projectileHitEntity",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.projectileHitEntity event.

    Remarks

    This event fires when a projectile hits an entity.

    This property can be read in early-execution mode.

targetBlockHit

  • get targetBlockHit(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.targetBlockHit",
            TargetBlockHitAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.targetBlockHit">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.targetBlockHit",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.targetBlockHit",
            TargetBlockHitAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.targetBlockHit">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.targetBlockHit",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.targetBlockHit">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.targetBlockHit">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.afterEvents.targetBlockHit",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.targetBlockHit event.

    Remarks

    A target block was hit.

    This property can be read in early-execution mode.

tripWireTrip

  • get tripWireTrip(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.tripWireTrip",
            TripWireTripAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.tripWireTrip">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.tripWireTrip">,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.tripWireTrip",
            TripWireTripAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.tripWireTrip">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.tripWireTrip">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.tripWireTrip">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.tripWireTrip">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.tripWireTrip">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.tripWireTrip event.

    Remarks

    A trip wire was tripped.

    This property can be read in early-execution mode.

weatherChange

  • get weatherChange(): {
        getAll(): Globals.SubscribedEvent<
            "world.beforeEvents.weatherChange",
            WeatherChangeBeforeEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.beforeEvents.weatherChange">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.beforeEvents.weatherChange",
            >,
        ): void;
    }

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.beforeEvents.weatherChange",
            WeatherChangeBeforeEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.beforeEvents.weatherChange">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.beforeEvents.weatherChange",
            >,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.beforeEvents.weatherChange">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.beforeEvents.weatherChange">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "world.beforeEvents.weatherChange",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.beforeEvents.weatherChange event.

    Remarks

    This event will be triggered when the weather changes within Minecraft.

    This property can be read in early-execution mode.

worldLoad

  • get worldLoad(): {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.worldLoad",
            WorldLoadAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.worldLoad">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.worldLoad">,
        ): void;
    }
    Beta

    Returns {
        getAll(): Globals.SubscribedEvent<
            "world.afterEvents.worldLoad",
            WorldLoadAfterEventSignal,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.worldLoad">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.worldLoad">,
        ): void;
    }

    • getAll:function
    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"world.afterEvents.worldLoad">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"world.afterEvents.worldLoad">

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<"world.afterEvents.worldLoad">,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

        This function can't be called in read-only mode.

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the world.afterEvents.worldLoad event.

    Remarks

    This property can be read in early-execution mode.

Settings

Member Visibility

On This Page

Constructors
Accessors