WoW:API SendAddonMessage: Difference between revisions

← Older edit

WoW:API SendAddonMessage (source)

Revision as of 04:47, 15 August 2023

485 bytes added , 15 August 2023

m

Move page script moved page API SendAddonMessage to WoW:API SendAddonMessage without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi}} __NOTOC__
-Sends a message to hidden AddOn channels. ('''new with patch 1.12''')
+Sends a message to the hidden addon channel. Introduced in [[Patch 1.12]]. Replaced in 8.0 by C_ChatInfo.SendAddonMessage.
+ SendAddonMessage("prefix", "text", "type", "target");
- SendAddonMessage("prefix", "text", "PARTY|RAID|GUILD|BATTLEGROUND")
 == Parameters ==
 === Arguments ===
+:;prefix
-:;prefix : String - Message Prefix ( Used to figure out which addon sent the message )
+:: String - Message prefix, can be used as your addon identifier. (16 Character Limit)
-:;text : String - Text to send
+:;text
-:;type : String - AddOn channel to send to, valid types are "PARTY", "RAID", "GUILD", "BATTLEGROUND"
+:: String - Text to send.
+:;type
+:: String - AddOn channel to send to. Valid types are "PARTY", "RAID", "GUILD", "OFFICER", "BATTLEGROUND". As of 2.1, "WHISPER" was also added.
+:;target
+:: String - Used only for "WHISPER" communication - the player to whisper to.
 == Example ==
   SendAddonMessage( "CTRA", "User Data: XYZ", "RAID" );
 == Notes ==
-From [[Slouken]]:
+* Calling this function results in the event [[Events/C#CHAT_MSG_ADDON|CHAT_MSG_ADDON]] being invoked on:
-* The combined length of message plus prefix can be at most 254 characters.
+** <target>'s client if <type> is "WHISPER" or
-* The message will be unaffected by inebriation.
+** all clients in the <type> chat channel, otherwise
-* Messages sent to "RAID" when not in a raid will be delivered as if it had been sent as a "PARTY" message.
+* Messages sent to "RAID" while in a party will get delivered to "PARTY"
-* Using "RAID" or "PARTY" when not in a party or raid sends no message.
+* To send to your battleground group, "BATTLEGROUND" must be used
+* Messages sent to <type> when you are not in the specified community will not be delivered.
+* The message will not be affected by the player's level of [[Drunk|drunkenness]].
-* 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 tab character ("\t") is used as a delimiter between the prefix and the message text
-* 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.
+** because of this, \t can not be used as part of prefix
-* If you want to send messages inbetween your battleground group you will need to use "BATTLEGROUND" instead of "RAID" or "PARTY".
+** The combined length of message and prefix can be at most 254 characters (255th is the tab character used to delimit the two)
-* "Send'''Addon'''Message" isn't a typo, using "Send'''AddOn'''Message" will not work.
+** length above 254 will disconnect you.
+* except NULL (ASCII dec-ID 0) all characters (decimal ID 1-255) are allowed (in opposition to [[API SendChatMessage|SendChatMessage]] where many characters are disallowed)
-* it seems that ASCII 10 codes (thats the linefeed, or \n character) in the text get you disconnected (note from [[User:Psycoparrot|psycoparrot]])
+* The "WHISPER" mode was added with patch 2.1, as servers will begin to rate throttle regular whispers to alleviate [[spam]] problems.
+* As of 2.1.0 whispers sent cross-server in battlefields will be sent as regular whispers and aren't hidden by the addon channel. (As of 2.4.3 this does not seem to be true: sending a message via WHISPER to another servers player was '''not''' sent as regular whisper. I did not test if the message was received properly. I think it worked because no "this player is offline" error message appeared.)
-__NOTOC__
-{{AlsoSee|[[API SendChatMessage]]}}