ChatSendAfterEventSignal Class

Caution

This class is still in pre-release. Its signature may change or it may be removed in future releases.

Manages callbacks that are connected to chat messages being sent.

Methods

• subscribe
• unsubscribe

subscribe

subscribe(callback: (arg: ChatSendAfterEvent) => void): (arg: ChatSendAfterEvent) => void

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

Parameters

• callback: (arg: ChatSendAfterEvent) => void

Returns (arg: ChatSendAfterEvent) => void

Important

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

Examples

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

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

Parameters

• callback: (arg: ChatSendAfterEvent) => void

Important

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