WoW:API SendAddonMessage: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Updated with new information -> allowed characters)
No edit summary
Tags: Mobile edit Mobile web edit
 
(11 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{wowapi}} __NOTOC__
Hi,
Sends a message to hidden AddOn channels. Introduced in [[Patch 1.12]].
SendAddonMessage("prefix", "text", "type", "target")


== Parameters ==
I just visited addonstudio.org and wondered if you'd ever thought about having an engaging video to explain what you do?
=== Arguments ===
:;prefix : String - Message prefix, can be used as your addon identifier.
:;text : String - Text to send.
:;type : String - AddOn channel to send to. Valid types are "PARTY", "RAID", "GUILD", "BATTLEGROUND". As of 2.1, "WHISPER" was also added.
:;target : String - Used only for "WHISPER" communication - the player to whisper to.


== Example ==
Our prices start from just $195.
SendAddonMessage( "CTRA", "User Data: XYZ", "RAID" );


== Notes ==
Let me know if you're interested in seeing samples of our previous work.
* Calling this function results in the event [[Events/C#CHAT_MSG_ADDON|CHAT_MSG_ADDON]] being invoked on all clients in the PARTY, RAID, BATTLEGROUND or GUILD channels.
 
* Messages sent to "RAID" while in a party will get delivered to "PARTY"; messages sent to "RAID" or "PARTY" while not in a group will not be delivered. To send to your battleground group, "BATTLEGROUND" must be used.
Regards,
* The message will not be affected by the player's level of [[Drunk|drunkenness]].
Joanna
* The tab character ("\t") is used as a delimiter between the prefix and the message text -- because of this, \t can not be used as part of prefix. The combined length of message and prefix can be at most 254 characters (255th is the tab character used to delimit the two), 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)
* 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.

Latest revision as of 05:05, 4 November 2024

Hi,

I just visited addonstudio.org and wondered if you'd ever thought about having an engaging video to explain what you do?

Our prices start from just $195.

Let me know if you're interested in seeing samples of our previous work.

Regards, Joanna