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

    Manages callbacks that are connected to chat messages being sent.

    Index

    Methods

    • Beta

      Parameters

      Returns (arg: ChatSendAfterEvent) => void

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

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

      const chatCallback = World.beforeEvents.chatSend.subscribe((eventData) => {
      if (eventData.message.includes("cancel")) {
      // Cancel event if the message contains "cancel"
      eventData.canceled = true;
      } else {
      // Modify chat message being sent
      eventData.message = `Modified '${eventData.message}'`;
      }
      });
    • Beta

      Parameters

      Returns void

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

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

      This function can throw errors.