WoW:API SendAddonMessage: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Updated with a little bit of info)
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''')


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


== Example ==
:;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"


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


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


== Notes ==
== Notes ==


: Fires the Event [[Events_C_%28Cancel%2C_Character%2C_Chat%2C_Cinematic%2C_Clear%2C_Close%2C_Confirm%2C_Corpse%2C_Craft%2C_Current%2C_Cursor%2C_CVar%29#CHAT_MSG_ADDON|CHAT_MSG_ADDON]]
: Fires the Event [[Events_C#CHAT_MSG_ADDON|CHAT_MSG_ADDON]]


: The combined length of message plus prefix can be at most 254 characters.
: The combined length of message plus prefix can be at most 254 characters.
Line 21: Line 25:
: 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 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".


: 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.
 
__NOTOC__
{{wowapi}}

Revision as of 16:00, 22 August 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

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.
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.
(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.
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.


← WoW API < SendAddonMessage

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_SendAddonMessage&oldid=12851"