Class Events_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)

Implements

Constructors

constructor

Accessors

modifiedChatMessageFormat modifiedChatMessageFormatFinalization modifiedChatMessageSend

Constructors

constructor

Accessors

modifiedChatMessageFormat

  • get modifiedChatMessageFormat(): {
        getAll(): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormat",
            never,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormat",
        >;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "andexdb.beforeEvents.modifiedChatMessageFormat",
            >,
        ): void;
    }

    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.

    Returns {
        getAll(): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormat",
            never,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormat",
        >;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "andexdb.beforeEvents.modifiedChatMessageFormat",
            >,
        ): void;
    }

    • getAll:function
      • getAll(): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormat",
            never,
        >[]

        Gets all event subscriptions to this event type.

        Returns Globals.SubscribedEvent<"andexdb.beforeEvents.modifiedChatMessageFormat", never>[]

        The event subscriptions.

    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"andexdb.beforeEvents.modifiedChatMessageFormat">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"andexdb.beforeEvents.modifiedChatMessageFormat">

        Remarks

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

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "andexdb.beforeEvents.modifiedChatMessageFormat",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

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

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the andexdb.beforeEvents.modifiedChatMessageFormat event.

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

modifiedChatMessageFormatFinalization

  • get modifiedChatMessageFormatFinalization(): {
        getAll(): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormatFinalization",
            never,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormatFinalization",
        >;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "andexdb.beforeEvents.modifiedChatMessageFormatFinalization",
            >,
        ): void;
    }

    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.

    Returns {
        getAll(): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormatFinalization",
            never,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormatFinalization",
        >;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "andexdb.beforeEvents.modifiedChatMessageFormatFinalization",
            >,
        ): void;
    }

    • getAll:function
      • getAll(): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormatFinalization",
            never,
        >[]

        Gets all event subscriptions to this event type.

        Returns Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormatFinalization",
            never,
        >[]

        The event subscriptions.

    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormatFinalization",
        >

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageFormatFinalization",
        >

        Remarks

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

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "andexdb.beforeEvents.modifiedChatMessageFormatFinalization",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

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

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the andexdb.beforeEvents.modifiedChatMessageFormatFinalization event.

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

modifiedChatMessageSend

  • get modifiedChatMessageSend(): {
        getAll(): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageSend",
            never,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"andexdb.beforeEvents.modifiedChatMessageSend">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "andexdb.beforeEvents.modifiedChatMessageSend",
            >,
        ): void;
    }

    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.

    Returns {
        getAll(): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageSend",
            never,
        >[];
        subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"andexdb.beforeEvents.modifiedChatMessageSend">;
        unsubscribe(
            subscription: Globals.SubscribedEvent<
                "andexdb.beforeEvents.modifiedChatMessageSend",
            >,
        ): void;
    }

    • getAll:function
      • getAll(): Globals.SubscribedEvent<
            "andexdb.beforeEvents.modifiedChatMessageSend",
            never,
        >[]

        Gets all event subscriptions to this event type.

        Returns Globals.SubscribedEvent<"andexdb.beforeEvents.modifiedChatMessageSend", never>[]

        The event subscriptions.

    • subscribe:function
      • subscribe(
            callback: string,
        ): Globals.SubscribedEvent<"andexdb.beforeEvents.modifiedChatMessageSend">

        Creates a new event subscription.

        Parameters

        • callback: string

        Returns Globals.SubscribedEvent<"andexdb.beforeEvents.modifiedChatMessageSend">

        Remarks

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

        This function can be called in early-execution mode.

        Throws

        If the event callback is an empty string.

        Throws

        If the event callback is not a string.

        Throws

        If the event callback is not a valid stringified JavaScript function.

    • unsubscribe:function
      • unsubscribe(
            subscription: Globals.SubscribedEvent<
                "andexdb.beforeEvents.modifiedChatMessageSend",
            >,
        ): void

        Deletes the provided event subscription.

        Parameters

        Returns void

        Remarks

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

        This function can be called in early-execution mode.

        Throws

        If the subscription is not an instance of SubscribedEvent.

        Throws

        If the subscription is not for the andexdb.beforeEvents.modifiedChatMessageSend event.

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

Settings

Member Visibility

On This Page

Constructors
Accessors