Class andexdbBeforeEvents

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)

Properties

modifiedChatMessageFormat modifiedChatMessageFormatFinalization modifiedChatMessageSend instance

Properties

ReadonlymodifiedChatMessageFormat

modifiedChatMessageFormat: andexdb_ModifiedChatMessageFormatBeforeEventSignal = ...

This event is triggered before a modified chat message is formatted.

This is triggered by the chat ranks system of the add-on, if the chat ranks system is disabled this event will never fire.

This property can be read in early-execution mode.

Example: preventMessagesContainingHerobrine.ts

function preventMessagesContainingHerobrine() {
  const chatCallback = Events.andexdb.beforeEvents.modifiedChatMessageFormat.subscribe(`(eventData) => {
     if (eventData.message.includes("Herobrine")) {
        eventData.cancel = true;
     }
  }`);
}

Example: replaceEveryAInMessagesWithB.ts

function replaceEveryAInMessagesWithB() {
  const chatCallback = Events.andexdb.beforeEvents.modifiedChatMessageFormat.subscribe(`(eventData) => {
     eventData.message = eventData.message.replaceAll("a", "b");
  }`);
}

ReadonlymodifiedChatMessageFormatFinalization

modifiedChatMessageFormatFinalization: andexdb_ModifiedChatMessageFormatFinalizationBeforeEventSignal = ...

This event is triggered before a formatted chat message is finalized.

This event allows you do do things like change the evaluated ranks, name tag, and more.

This is triggered by the chat ranks system of the add-on, if the chat ranks system is disabled this event will never fire.

This property can be read in early-execution mode.

Example: changeDisplayNamesOfPlayersSendingMessagesContainingHerobrine.ts

function changeDisplayNamesOfPlayersSendingMessagesContainingHerobrine() {
  const chatCallback = Events.andexdb.beforeEvents.modifiedChatMessageFormatFinalization.subscribe(`(eventData) => {
    if (eventData.tokenData.message.includes("Herobrine")) {
      eventData.tokenData.name = "<Herobrine>";
      eventData.tokenData.nameb = "Herobrine";
    }
  }`);
}

Example: addAAAARankToAllMessages.ts

function addAAAARankToAllMessages() {
  const chatCallback = Events.andexdb.beforeEvents.modifiedChatMessageFormatFinalization.subscribe(`(eventData) => {
    eventData.tokenData.ranks.push("AAAA");
  }`);
}

Example: messUpPlayersMessagesIfTheySetMessUpMyMessages.ts

function messUpPlayersMessagesIfTheySetMessUpMyMessages() {
  Events.andexdb.beforeEvents.modifiedChatMessageFormat.subscribe(`(event) => {
    if (event.message.includes("mess up my message")) {
      event.message = event.message
        .replaceAll(/([a-z])([a-z])([a-z])([a-z])([a-z])/g, "$5$3$4$2$1")
        .replaceAll(/([a-z])([a-z])([a-z])/g, "$3$1$2")
        .replaceAll(/([a-z])([a-z])/g, "$2$1");
    }
  };`);

ReadonlymodifiedChatMessageSend

modifiedChatMessageSend: andexdb_ModifiedChatMessageSendBeforeEventSignal = ...

This event is triggered before a modified chat message is sent.

This is triggered by the chat ranks system of the add-on, if the chat ranks system is disabled this event will never fire.

This property can be read in early-execution mode.

Example: preventMessagesContainingHerobrine.ts

function preventMessagesContainingHerobrine() {
  const chatCallback = Events.andexdb.beforeEvents.modifiedChatMessageSend.subscribe(`(eventData) => {
     if (eventData.message.includes("Herobrine")) {
        eventData.cancel = true;
     }
  }`);
}

Example: replaceEveryAInMessagesIncludingNameTagsAndRanksWithB.ts

function replaceEveryAInMessagesIncludingNameTagsAndRanksWithB() {
  const chatCallback = Events.andexdb.beforeEvents.modifiedChatMessageSend.subscribe(`(eventData) => {
     eventData.message = eventData.message.replaceAll("a", "b");
  }`);
}

Static Readonlyinstance

instance: andexdbBeforeEvents = ...

The instance of the andexdbBeforeEvents class.

Settings

Member Visibility

On This Page

Properties