WoW:API SendAddonMessage: Difference between revisions
Jump to navigation
Jump to search
Added officer as valid send target
(Added officer as valid send target) |
|||
| Line 5: | Line 5: | ||
== Parameters == | == Parameters == | ||
=== Arguments === | === Arguments === | ||
:;prefix : String - Message prefix, can be used as your addon identifier. (16 Character Limit) | :;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 | ||