An event that fires 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 fired before the format evalutation of a chat message is finalized, the finalized formatted message data is then passed to the chatSendMessageEvaluator_players function, and compiled formatted message string is then passed to the andexdb_ModifiedChatMessageSendBeforeEvent event.

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

Implements

Constructors

Properties

cancel: boolean

If set to true, the message will not be sent.

false
message: string

The message that was formatted.

originalMessage: string

The original chat message.

sender: Player

Player that sent the chat message.

targets?: Player[]

Optional list of players that will receive this message. If defined, this message is directly targeted to one or more players (i.e., is not broadcast.)

The evaluated message format token data.

Modifications to this will affect the final message.

With this you can modify many things about the message, including but not limited to:

  • Ranks
  • Names
  • Time Stamps
  • Message Formatting and Colors
  • Name Formatting and Colors
  • Separator Formatting and Colors
  • Whether the player's dimension is shown