WoW API: SendAddonMessage

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < SendAddonMessage

Sends a message to hidden AddOn channels. (new with patch 1.12)

SendAddonMessage("prefix", "text", "PARTY|RAID|GUILD|BATTLEGROUND")

Example

SendAddonMessage("CTRA", "User Data: XYZ", "RAID");

Notes

Fires the Event CHAT_MSG_ADDON

The combined length of message plus prefix can be at most 254 characters.

The message will be unaffected by inebriation.

(From Slouken)

The prefix cannot include a tab character ("\t") as it's used as a delimiter between the prefix and the text when the message is sent from the client. When the message is recieved by other clients, it's broken back in to two peices in the client and the sent to lua. Using a tab character in the text may be acceptable, but is unadvised.

The actual function name may end up being SendAddOnMessage() to be consistent with existing function names.

If you want to send messages inbetween your battleground group you will need to use "BATTLEGROUND" instead of "RAID" or "PARTY".