Class Events_WorldBeforeEvents

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

Implements

ReplaceTypeOfKey<WorldBeforeEvents, keyof WorldBeforeEvents, any>

Index

Constructors

constructor

Accessors

chatSend effectAdd entityRemove explosion itemUse playerBreakBlock playerGameModeChange playerInteractWithBlock playerInteractWithEntity playerLeave playerPlaceBlock weatherChange

Constructors

constructor

new Events_WorldBeforeEvents(): Events_WorldBeforeEvents
Returns Events_WorldBeforeEvents
- Defined in init/classes/events.ts:498

Accessors

chatSend

get chatSend(): {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.chatSend",
        ChatSendBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.chatSend">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"world.beforeEvents.chatSend">,
    ): void;
}
Beta
Returns {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.chatSend",
        ChatSendBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.chatSend">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"world.beforeEvents.chatSend">,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.chatSend",
    ChatSendBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "world.beforeEvents.chatSend",
    ChatSendBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:584
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.chatSend">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"world.beforeEvents.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.
    
    Defined in init/classes/events.ts:549
- unsubscribe:function
  - unsubscribe(
    subscription: Globals.SubscribedEvent<"world.beforeEvents.chatSend">,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.chatSend">
    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.chatSend event.
    
    Defined in init/classes/events.ts:573
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.
Example: customCommand.ts
```
import { world, DimensionLocation } from "@minecraft/server";

function customCommand(targetLocation: DimensionLocation) {
  const chatCallback = Events.world.beforeEvents.chatSend.subscribe(`(eventData) => {
    if (eventData.message.includes("cancel")) {
      // Cancel event if the message contains "cancel"
      eventData.cancel = true;
    } else {
      const args = eventData.message.split(" ");

      if (args.length > 0) {
        switch (args[0].toLowerCase()) {
          case "echo":
            // Send a modified version of chat message
            world.sendMessage(`Echo '${eventData.message.substring(4).trim()}'`);
            break;
          case "help":
            world.sendMessage(`Available commands: echo <message>`);
            break;
        }
      }
    }
  }`);
}
```
Implementation of ReplaceTypeOfKey.chatSend
- Defined in init/classes/events.ts:535

effectAdd

get effectAdd(): {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.effectAdd",
        EffectAddBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.effectAdd">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"world.beforeEvents.effectAdd">,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.effectAdd",
        EffectAddBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.effectAdd">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"world.beforeEvents.effectAdd">,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.effectAdd",
    EffectAddBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "world.beforeEvents.effectAdd",
    EffectAddBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:638
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.effectAdd">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"world.beforeEvents.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.
    
    Defined in init/classes/events.ts:603
- unsubscribe:function
  - unsubscribe(
    subscription: Globals.SubscribedEvent<"world.beforeEvents.effectAdd">,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.effectAdd">
    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.effectAdd event.
    
    Defined in init/classes/events.ts:627
Remarks
This event is triggered after an event has been added to an entity.

This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.effectAdd
- Defined in init/classes/events.ts:589

entityRemove

get entityRemove(): {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.entityRemove",
        EntityRemoveBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.entityRemove">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.entityRemove",
        >,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.entityRemove",
        EntityRemoveBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.entityRemove">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.entityRemove",
        >,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.entityRemove",
    EntityRemoveBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "world.beforeEvents.entityRemove",
    EntityRemoveBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:692
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.entityRemove">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"world.beforeEvents.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.
    
    Defined in init/classes/events.ts:657
- unsubscribe:function
  - unsubscribe(
    subscription: Globals.SubscribedEvent<"world.beforeEvents.entityRemove">,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.entityRemove">
    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.entityRemove event.
    
    Defined in init/classes/events.ts:681
Remarks
Fires before an entity is removed from the world (for example, unloaded or removed after being killed.)

This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.entityRemove
- Defined in init/classes/events.ts:643

explosion

get explosion(): {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.explosion",
        ExplosionBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.explosion">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"world.beforeEvents.explosion">,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.explosion",
        ExplosionBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.explosion">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"world.beforeEvents.explosion">,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.explosion",
    ExplosionBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "world.beforeEvents.explosion",
    ExplosionBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:746
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.explosion">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"world.beforeEvents.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.
    
    Defined in init/classes/events.ts:711
- unsubscribe:function
  - unsubscribe(
    subscription: Globals.SubscribedEvent<"world.beforeEvents.explosion">,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.explosion">
    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.explosion event.
    
    Defined in init/classes/events.ts:735
Remarks
This event is fired after an explosion occurs.

This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.explosion
- Defined in init/classes/events.ts:697

itemUse

get itemUse(): {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.itemUse",
        ItemUseBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.itemUse">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"world.beforeEvents.itemUse">,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.itemUse",
        ItemUseBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.itemUse">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"world.beforeEvents.itemUse">,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.itemUse",
    ItemUseBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<"world.beforeEvents.itemUse", ItemUseBeforeEventSignal>[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:800
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.itemUse">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"world.beforeEvents.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.
    
    Defined in init/classes/events.ts:765
- unsubscribe:function
  - unsubscribe(
    subscription: Globals.SubscribedEvent<"world.beforeEvents.itemUse">,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.itemUse">
    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.itemUse event.
    
    Defined in init/classes/events.ts:789
Remarks
This event fires when an item is successfully used by a player.

This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.itemUse
- Defined in init/classes/events.ts:751

playerBreakBlock

get playerBreakBlock(): {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerBreakBlock",
        PlayerBreakBlockBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerBreakBlock">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerBreakBlock",
        >,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerBreakBlock",
        PlayerBreakBlockBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerBreakBlock">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerBreakBlock",
        >,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.playerBreakBlock",
    PlayerBreakBlockBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "world.beforeEvents.playerBreakBlock",
    PlayerBreakBlockBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:854
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerBreakBlock">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"world.beforeEvents.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.
    
    Defined in init/classes/events.ts:819
- unsubscribe:function
  - unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerBreakBlock",
        >,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.playerBreakBlock">
    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.playerBreakBlock event.
    
    Defined in init/classes/events.ts:843
Remarks
This event fires before a block is broken by a player.

This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.playerBreakBlock
- Defined in init/classes/events.ts:805

playerGameModeChange

get playerGameModeChange(): {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerGameModeChange",
        PlayerGameModeChangeBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerGameModeChange">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerGameModeChange",
        >,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerGameModeChange",
        PlayerGameModeChangeBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerGameModeChange">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerGameModeChange",
        >,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.playerGameModeChange",
    PlayerGameModeChangeBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "world.beforeEvents.playerGameModeChange",
    PlayerGameModeChangeBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:908
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerGameModeChange">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"world.beforeEvents.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.
    
    Defined in init/classes/events.ts:873
- unsubscribe:function
  - unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerGameModeChange",
        >,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.playerGameModeChange">
    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.playerGameModeChange event.
    
    Defined in init/classes/events.ts:897
Remarks
This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.playerGameModeChange
- Defined in init/classes/events.ts:859

playerInteractWithBlock

get playerInteractWithBlock(): {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerInteractWithBlock",
        PlayerInteractWithBlockBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerInteractWithBlock">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerInteractWithBlock",
        >,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerInteractWithBlock",
        PlayerInteractWithBlockBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerInteractWithBlock">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerInteractWithBlock",
        >,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.playerInteractWithBlock",
    PlayerInteractWithBlockBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "world.beforeEvents.playerInteractWithBlock",
    PlayerInteractWithBlockBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:962
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerInteractWithBlock">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"world.beforeEvents.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.
    
    Defined in init/classes/events.ts:927
- unsubscribe:function
  - unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerInteractWithBlock",
        >,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.playerInteractWithBlock">
    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.playerInteractWithBlock event.
    
    Defined in init/classes/events.ts:951
Remarks
Fires before a player interacts with a block.

This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.playerInteractWithBlock
- Defined in init/classes/events.ts:913

playerInteractWithEntity

get playerInteractWithEntity(): {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerInteractWithEntity",
        PlayerInteractWithEntityBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerInteractWithEntity">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerInteractWithEntity",
        >,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerInteractWithEntity",
        PlayerInteractWithEntityBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerInteractWithEntity">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerInteractWithEntity",
        >,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.playerInteractWithEntity",
    PlayerInteractWithEntityBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "world.beforeEvents.playerInteractWithEntity",
    PlayerInteractWithEntityBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:1016
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerInteractWithEntity">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"world.beforeEvents.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.
    
    Defined in init/classes/events.ts:981
- unsubscribe:function
  - unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerInteractWithEntity",
        >,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.playerInteractWithEntity">
    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.playerInteractWithEntity event.
    
    Defined in init/classes/events.ts:1005
Remarks
Fires before a player interacts with an entity.

This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.playerInteractWithEntity
- Defined in init/classes/events.ts:967

playerLeave

get playerLeave(): {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerLeave",
        PlayerLeaveBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerLeave">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"world.beforeEvents.playerLeave">,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerLeave",
        PlayerLeaveBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerLeave">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"world.beforeEvents.playerLeave">,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.playerLeave",
    PlayerLeaveBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "world.beforeEvents.playerLeave",
    PlayerLeaveBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:1070
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerLeave">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"world.beforeEvents.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.
    
    Defined in init/classes/events.ts:1035
- unsubscribe:function
  - unsubscribe(
    subscription: Globals.SubscribedEvent<"world.beforeEvents.playerLeave">,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.playerLeave">
    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.playerLeave event.
    
    Defined in init/classes/events.ts:1059
Remarks
Fires when a player leaves the game.

This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.playerLeave
- Defined in init/classes/events.ts:1021

playerPlaceBlock

get playerPlaceBlock(): {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerPlaceBlock",
        PlayerPlaceBlockBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerPlaceBlock">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerPlaceBlock",
        >,
    ): void;
}
Beta
Returns {
    getAll(): Globals.SubscribedEvent<
        "world.beforeEvents.playerPlaceBlock",
        PlayerPlaceBlockBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerPlaceBlock">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerPlaceBlock",
        >,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.playerPlaceBlock",
    PlayerPlaceBlockBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "world.beforeEvents.playerPlaceBlock",
    PlayerPlaceBlockBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:1124
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"world.beforeEvents.playerPlaceBlock">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"world.beforeEvents.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.
    
    Defined in init/classes/events.ts:1089
- unsubscribe:function
  - unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.playerPlaceBlock",
        >,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.playerPlaceBlock">
    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.playerPlaceBlock event.
    
    Defined in init/classes/events.ts:1113
Remarks
This event fires before a block is placed by a player.

This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.playerPlaceBlock
- Defined in init/classes/events.ts:1075

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
  - getAll(): Globals.SubscribedEvent<
    "world.beforeEvents.weatherChange",
    WeatherChangeBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "world.beforeEvents.weatherChange",
    WeatherChangeBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:1178
- 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.
    
    Defined in init/classes/events.ts:1143
- unsubscribe:function
  - unsubscribe(
        subscription: Globals.SubscribedEvent<
            "world.beforeEvents.weatherChange",
        >,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"world.beforeEvents.weatherChange">
    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.
    
    Defined in init/classes/events.ts:1167
Remarks
This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.weatherChange
- Defined in init/classes/events.ts:1129

Class Events_WorldBeforeEvents

Implements

Implements

Index

Constructors

Accessors

Constructors

constructor

Returns Events_WorldBeforeEvents

Accessors

chatSend

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

getAll:function

Returns Globals.SubscribedEvent< "world.beforeEvents.chatSend", ChatSendBeforeEventSignal,>[]

subscribe:function

Parameters

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

Remarks

Throws

Throws

Throws

unsubscribe:function

Parameters

Returns void

Remarks

Throws

Throws

Remarks

Example: customCommand.ts

effectAdd

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

getAll:function

Returns Globals.SubscribedEvent< "world.beforeEvents.effectAdd", EffectAddBeforeEventSignal,>[]

subscribe:function

Parameters

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

Remarks

Throws

Throws

Throws

unsubscribe:function

Parameters

Returns void

Remarks

Throws

Throws

Remarks

entityRemove

getAll:function

Returns Globals.SubscribedEvent< "world.beforeEvents.entityRemove", EntityRemoveBeforeEventSignal,>[]

subscribe:function

Parameters

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

Remarks

Throws

Throws

Throws

unsubscribe:function

Parameters

Returns void

Remarks

Throws

Throws

Remarks

explosion

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

getAll:function

Returns Globals.SubscribedEvent< "world.beforeEvents.explosion", ExplosionBeforeEventSignal,>[]

subscribe:function

Parameters

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

Remarks

Throws

Throws

Throws

unsubscribe:function

Parameters

Returns void

Remarks

Throws

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

Returns Globals.SubscribedEvent<
"world.beforeEvents.chatSend",
ChatSendBeforeEventSignal,
>[]

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

Returns Globals.SubscribedEvent<
"world.beforeEvents.effectAdd",
EffectAddBeforeEventSignal,
>[]

Returns Globals.SubscribedEvent<
"world.beforeEvents.entityRemove",
EntityRemoveBeforeEventSignal,
>[]

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

Returns Globals.SubscribedEvent<
"world.beforeEvents.explosion",
ExplosionBeforeEventSignal,
>[]

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

Returns Globals.SubscribedEvent<
"world.beforeEvents.playerBreakBlock",
PlayerBreakBlockBeforeEventSignal,
>[]

Returns Globals.SubscribedEvent<
"world.beforeEvents.playerGameModeChange",
PlayerGameModeChangeBeforeEventSignal,
>[]

Returns Globals.SubscribedEvent<
"world.beforeEvents.playerInteractWithBlock",
PlayerInteractWithBlockBeforeEventSignal,
>[]