WoW:API DoEmote: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Added an example for the target as the previous information was incorrect (not the player name, but the word 'target' or 'targettarget'))
mNo edit summary
Line 3: Line 3:
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->


DoEmote("token", "message");
DoEmote("token"[, "target"]);


<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
Line 13: Line 13:
<!-- List each argument, together with its type -->
<!-- List each argument, together with its type -->


:("token", "message")
:("token", "target")
:;token : String - the token that describes which emote is being used.  See [[API_TYPE_Emotes_Token|Emotes Tokens]]
:;token : String - the token that describes which emote is being used.  See [[API_TYPE_Emotes_Token|Emotes Tokens]]
:;message : String - target for the emote.  For example: DoEmote("dance", target) will cause you to dance with your target.
:;target : String - target for the emote.  For example: DoEmote("dance", "target") will cause you to dance with your target. Takes a [[UnitId|unit]] token.


----
----

Revision as of 22:28, 8 February 2008

WoW API < DoEmote


DoEmote("token"[, "target"]);


Executes an emote.


Arguments
("token", "target")
token
String - the token that describes which emote is being used. See Emotes Tokens
target
String - target for the emote. For example: DoEmote("dance", "target") will cause you to dance with your target. Takes a unit token.

Returns
Nothing.

Details
Executes one of the emotes based on the given token, including vocal emotes. The list of currently valid emotes is given in ChatFrame.lua, defined as one of the EMOTEx_TOKEN constants. x starts at 1 and currently goes up to 171 (as of 2.1.2). Certain emotes may also trigger character animations and sound effects.