WoW:API SendAddonMessage: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(Updated the info regarding the new BATTLEGROUND type tag)
Line 1: Line 1:
Sends a message to hidden AddOn channels. ('''new with patch 1.12''')
Sends a message to hidden AddOn channels. ('''new with patch 1.12''')


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


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


: The "RAID" and "PARTY" methods do not appear to work for auto-created battlegrounds groups.
: You will now be able to use "RAID" or "PARTY" for auto created battleground groups, you will have to use the "BATTLEGROUND" type instead.


----
----


{{Stub/API}}
{{Stub/API}}

Revision as of 18:14, 19 July 2006

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

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

Example

Template:Example/Begin SendAddonMessage("CTRA", "User Data: XYZ", "RAID"); Template:Example/End


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', Blizzard poster)
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.
You will now be able to use "RAID" or "PARTY" for auto created battleground groups, you will have to use the "BATTLEGROUND" type instead.