Class ChatSendAfterEventSignalBeta

Manages callbacks that are connected to chat messages being sent.

Methods

subscribe unsubscribe

Methods

subscribe

  • subscribe(
        callback: (arg: ChatSendAfterEvent) => void,
    ): (arg: ChatSendAfterEvent) => void
    Beta

    Parameters

    Returns (arg: ChatSendAfterEvent) => void

    Remarks

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

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

    Example: custom_command.js

    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}'`;
      }
    });

unsubscribe

  • unsubscribe(callback: (arg: ChatSendAfterEvent) => void): void
    Beta

    Parameters

    Returns void

    Remarks

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

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

    Throws

    This function can throw errors.

Settings

Member Visibility

On This Page

Methods