WoW:API DoEmote: Difference between revisions
Jump to navigation
Jump to search
(Rewritten) |
|||
| Line 1: | Line 1: | ||
{{wowapi}}__NOTOC__ | {{wowapi}}__NOTOC__ | ||
DoEmote("token" [, | DoEmote("token" [,onPlayer]); | ||
<!-- 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 8: | Line 8: | ||
=== Arguments=== | === Arguments=== | ||
:("token", | :("token", onPlayer) | ||
:;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]] | ||
:; | :;onPlayer : Boolean - If true, the emote will behave as if no target were selected (ie. performs it on the player). | ||
=== Returns === | === Returns === | ||
Revision as of 07:08, 14 November 2008
DoEmote("token" [,onPlayer]);
Parameters
Arguments
- ("token", onPlayer)
- token
- String - the token that describes which emote is being used. See Emotes Tokens
- onPlayer
- Boolean - If true, the emote will behave as if no target were selected (ie. performs it on the player).
Returns
- nil
Usage
Example
DoEmote("cry"); -- Say you have 'Bob' selected. You see: You cry on Bob's shoulder.
-- If you have no target, you see: You cry.
DoEmote("cry",1); -- Regardless of whether or not you have Bob selected, you will see:
-- You cry.
Notes
- Executes one of the emotes based on the given token, including vocal emotes and animations. The list of currently valid emotes is given in ChatFrame.lua, defined as one of the EMOTEx_TOKEN constants. x starts at 1 and goes up to MAXEMOTEINDEX (which is 451 in WotLK 3.0.3).
- Emotes in TextEmoteSpeechList will trigger vocal effects. (defined in ChatFrame.lua)
- Emotes in EmoteList will trigger animation effects. (defined in ChatFrame.lua)
- It is unclear whether two these lists contain all valid animation or speech effects, however.
- You cannot use the second option to specify a target, only to specify the absence of a target.