WoW API: DoEmote

WoW API < DoEmote

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


ParametersEdit

ArgumentsEdit

("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.

ReturnsEdit

nil

UsageEdit

ExampleEdit

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.

NotesEdit

  • 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.