WoW:API DoEmote: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Added clarification on local variable, updated max number of emotes.)
m (→‎Arguments: More clarification on "target")
Line 1: Line 1:
{{wowapi}}__NOTOC__
{{wowapi}}__NOTOC__


  DoEmote("token" [,onPlayer]);
  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 8: Line 8:
=== Arguments===
=== Arguments===


:("token", onPlayer)
:("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]]


:;onPlayer : Boolean - If true, the emote will behave as if no target were selected (ie. performs it on the player).
:;target : String - [[UnitId]] of who the emote will be performed on. If nil, then it performs the emote on your current target, or yourself if you don't have a target. If the specified target does not exist or is out of range, then it performs the emote on yourself.


=== Returns ===
=== Returns ===
Line 23: Line 23:
  DoEmote("cry");    -- Say you have 'Bob' selected.  You see:  You cry on Bob's shoulder.
  DoEmote("cry");    -- Say you have 'Bob' selected.  You see:  You cry on Bob's shoulder.
                     -- If you have no target, you see:          You cry.
                     -- If you have no target, you see:          You cry.
  DoEmote("cry",1);  -- Regardless of whether or not you have Bob selected, you will see:
  DoEmote("cry","none");  -- Regardless of whether or not you have Bob selected, you will see:
                     --  You cry.
                     --  You cry.


Line 32: Line 32:
* Emotes in EmoteList will trigger animation 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.
* 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.

Revision as of 05:50, 21 November 2009

← WoW API < DoEmote 

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


Parameters

Arguments

("token" [, "target"])
token
String - the token that describes which emote is being used. See Emotes Tokens
target
String - UnitId of who the emote will be performed on. If nil, then it performs the emote on your current target, or yourself if you don't have a target. If the specified target does not exist or is out of range, then it performs the emote on yourself.

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","none");  -- 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 ChatFrame.lua's local variable MAXEMOTEINDEX (which is 452 in WotLK 3.3.0).
  • 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.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_DoEmote&oldid=9707"