m
Move page script moved page API SendAddonMessage to WoW:API SendAddonMessage without leaving a redirect
(→Notes) |
m (Move page script moved page API SendAddonMessage to WoW:API SendAddonMessage without leaving a redirect) |
||
| (6 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | {{wowapi}} __NOTOC__ | ||
Sends a message to hidden | 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", "type", "target"); | ||
== Parameters == | == Parameters == | ||
=== Arguments === | === Arguments === | ||
:;prefix : String - Message prefix, can be used as your addon identifier. | :;prefix | ||
:;text : String - Text to send. | :: String - Message prefix, can be used as your addon identifier. (16 Character Limit) | ||
:;type : String - AddOn channel to send to. Valid types are "PARTY", "RAID", "GUILD", "BATTLEGROUND". As of 2.1, "WHISPER" was also added. | :;text | ||
:;target : String - Used only for "WHISPER" communication - the player to whisper to. | :: 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 == | == Example == | ||
| Line 16: | Line 20: | ||
* Calling this function results in the event [[Events/C#CHAT_MSG_ADDON|CHAT_MSG_ADDON]] being invoked on: | * Calling this function results in the event [[Events/C#CHAT_MSG_ADDON|CHAT_MSG_ADDON]] being invoked on: | ||
** <target>'s client if <type> is "WHISPER" or | ** <target>'s client if <type> is "WHISPER" or | ||
** all clients in the <type> chat channel, otherwise | ** all clients in the <type> chat channel, otherwise | ||
* Messages sent to "RAID" while in a party will get delivered to "PARTY" | * Messages sent to "RAID" while in a party will get delivered to "PARTY" | ||
* To send to your battleground group, "BATTLEGROUND" must be used | * To send to your battleground group, "BATTLEGROUND" must be used | ||
| Line 27: | Line 31: | ||
* 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) | * 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) | ||
* The "WHISPER" mode was added with patch 2.1, as servers will begin to rate throttle regular whispers to alleviate [[spam]] problems. | * 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.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.) | ||