WoW:API SendAddonMessage: Difference between revisions
Jump to navigation
Jump to search
m (→Notes) |
m (→Notes: fixed link(s)) |
||
| Line 1: | Line 1: | ||
{{wowapi}} | |||
Sends a message to hidden AddOn channels. ('''new with patch 1.12''') | Sends a message to hidden AddOn channels. ('''new with patch 1.12''') | ||
| Line 14: | Line 15: | ||
== Notes == | == Notes == | ||
From [[Slouken]]: | |||
* The combined length of message plus prefix can be at most 254 characters. | |||
* The message will be unaffected by inebriation. | |||
* Messages sent to "RAID" when not in a raid will be delivered as if it had been sent as a "PARTY" message. | |||
* Using "RAID" or "PARTY" when not in a party or raid sends no message. | |||
* Calling this function results in the event [[Events/C#CHAT_MSG_ADDON|CHAT_MSG_ADDON]] being invoked on ''other'' client machines in the PARTY, RAID, BATTLEGROUND or GUILD. | |||
* 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. | |||
* If you want to send messages inbetween your battleground group you will need to use "BATTLEGROUND" instead of "RAID" or "PARTY". | |||
* "Send'''Addon'''Message" isn't a typo, using "Send'''AddOn'''Message" will not work. | |||
* it seems that ASCII 10 codes (thats the linefeed, or \n character) in the text get you disconnected (note from [[User:Psycoparrot|psycoparrot]]) | |||
: | |||
__NOTOC__ | __NOTOC__ | ||
{{ | {{AlsoSee|[[API SendChatMessage]]}} | ||
Revision as of 14:45, 2 October 2006
Sends a message to hidden AddOn channels. (new with patch 1.12)
SendAddonMessage("prefix", "text", "PARTY|RAID|GUILD|BATTLEGROUND")
Parameters
Arguments
- prefix
- String - Message Prefix ( Used to figure out which addon sent the message )
- text
- String - Text to send
- type
- String - AddOn channel to send to, valid types are "PARTY", "RAID", "GUILD", "BATTLEGROUND"
Example
SendAddonMessage( "CTRA", "User Data: XYZ", "RAID" );
Notes
From Slouken:
- The combined length of message plus prefix can be at most 254 characters.
- The message will be unaffected by inebriation.
- Messages sent to "RAID" when not in a raid will be delivered as if it had been sent as a "PARTY" message.
- Using "RAID" or "PARTY" when not in a party or raid sends no message.
- Calling this function results in the event CHAT_MSG_ADDON being invoked on other client machines in the PARTY, RAID, BATTLEGROUND or GUILD.
- 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.
- If you want to send messages inbetween your battleground group you will need to use "BATTLEGROUND" instead of "RAID" or "PARTY".
- "SendAddonMessage" isn't a typo, using "SendAddOnMessage" will not work.
- it seems that ASCII 10 codes (thats the linefeed, or \n character) in the text get you disconnected (note from psycoparrot)