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

    Class ChatSendBeforeEventSignalBeta

    Advertisement

    Manages callbacks that are connected to an event that fires before chat messages are sent.

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

    function customCommand(targetLocation: DimensionLocation) {
      const chatCallback = 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;
            }
          }
        }
      });
    }

    import { world } from "@minecraft/server";

    // Subscribe to the blockExplode event
    world.beforeEvents.chatSend.subscribe((event) => {
       const { sender, message } = event;
       console.log(`${sender.name}: ${message}`);

       event.cancel = true; // Cancel message to be sent if needed.
    });
    Index

    Constructors

    constructor

    Methods

    subscribe unsubscribe

    Constructors

    Methods

    • Parameters

      • callback: (arg0: ChatSendBeforeEvent) => void

        This closure is called with restricted-execution privilege.

      Returns (arg0: ChatSendBeforeEvent) => void

      Closure that is called with restricted-execution privilege.

      Adds a callback that will be called before new chat messages are sent.

      This function can't be called in restricted-execution mode.

      This function can be called in early-execution mode.

    • Parameters

      • callback: (arg0: ChatSendBeforeEvent) => void

        This closure is called with restricted-execution privilege.

      Returns void

      Removes a callback from being called before new chat messages are sent.

      This function can't be called in restricted-execution mode.

      This function can be called in early-execution mode.

    Advertisement
    Advertisement

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods