WoW:API DoEmote - Revision history

Move page script: Move page script moved page API DoEmote to WoW:API DoEmote without leaving a redirect

2023-08-15T04:45:25Z

Move page script moved page API DoEmote to API DoEmote without leaving a redirect

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>X87bliss: /* Arguments */ More clarification on "target"

2009-11-21T05:50:53Z

Arguments: More clarification on "target"

← Older revision		Revision as of 05:50, 21 November 2009
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.

WoWWiki>Ghettogreen: Added clarification on local variable, updated max number of emotes.

2009-10-20T18:06:14Z

Added clarification on local variable, updated max number of emotes.

← Older revision		Revision as of 18:06, 20 October 2009
Line 28:		Line 28:
	=== Notes ===		=== 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 EMOTE''x''_TOKEN constants. ''x'' starts at 1 and goes up to MAXEMOTEINDEX (which is ~~451~~ in WotLK 3.0.3).		* 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 EMOTE''x''_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 TextEmoteSpeechList will trigger vocal effects. (defined in ChatFrame.lua)
	* 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.		* You cannot use the second option to specify a target, only to specify the absence of a target.

WoWWiki>Nefstar: /* Arguments */

2008-11-14T07:08:47Z

Arguments

← Older revision		Revision as of 07:08, 14 November 2008
Line 1:		Line 1:
	{{wowapi}}__NOTOC__		{{wowapi}}__NOTOC__

	DoEmote("token" [,~~"player"~~]);		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", ~~"player"~~)		:("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]]

	:;~~player~~ : ~~Any~~ - If ~~this argument is not '''nil'''~~, the emote will behave as if no target were selected (ie. performs it on the player).		:;onPlayer : Boolean - If true, the emote will behave as if no target were selected (ie. performs it on the player).

	=== Returns ===		=== Returns ===

WoWWiki>DrDoom: Rewritten

2008-11-10T10:51:37Z

Rewritten

← Older revision		Revision as of 10:51, 10 November 2008
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}__NOTOC__

	~~<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->~~		DoEmote("token" [,"player"]);

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

	<!-- 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 -->

	~~Executes an emote.~~		== Parameters ==
			=== Arguments===

	~~----~~		:("token", "player")
	~~;''Arguments''~~
	~~<!-- List each argument~~, ~~together with its type -->~~

	~~:("token", "player")~~
	:;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]]
	~~:;target : Any - if a string or number is set for this argument, the emote will behave as if no target were selected.~~

	-~~---~~		:;player : Any - If this argument is not '''nil''', the emote will behave as if no target were selected (ie. performs it on the player).
	;''~~Returns~~''
			=== Returns ===

			:;nil

			== Usage ==
			=== Example ===

	<!-- ~~List each return value~~, ~~together with its type~~ -->		DoEmote("cry"); -- Say you have 'Bob' selected. You see: You cry on Bob's shoulder.
	~~:Nothing~~.		-- 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 ===
	~~;''Details''~~

	~~<!-- Details not appropriate for the main description can go here -->~~		* 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 EMOTE''x''_TOKEN constants. ''x'' starts at 1 and goes up to MAXEMOTEINDEX (which is 451 in WotLK 3.0.3).
	: 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 EMOTE''x''_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.		* Emotes in TextEmoteSpeechList will trigger vocal effects. (defined in ChatFrame.lua)
	~~: As of August 21, 2008~~ (2.~~4.3~~), if the ~~function has only the first argument, it automatically produces a targeted emote if~~ a target ~~exists or a non-targeted emote if none exists. Supplying a string or number to the "target" argument appears~~ to ~~force~~ the ~~function to behave as if no target were selected, regardless~~ of ~~an actual~~ target.		* 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.

WoWWiki>Recompense: Formatting

2008-08-22T06:40:02Z

Formatting

← Older revision		Revision as of 06:40, 22 August 2008
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"[, "~~target~~"]);		DoEmote("token"[, "player"]);

	<!-- 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", "~~target~~")		:("token", "player")
	:;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]]
	:;target : ~~String~~ - ~~target~~ for the emote~~. For example: DoEmote("dance", "target")~~ will ~~cause you to dance with your~~ target~~. Takes a [[UnitId\|unit]] token~~.		:;target : Any - if a string or number is set for this argument, the emote will behave as if no target were selected.

	----		----
Line 28:		Line 28:
	<!-- Details not appropriate for the main description can go here -->		<!-- Details not appropriate for the main description can go here -->
	: 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 EMOTE''x''_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.		: 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 EMOTE''x''_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.
			: As of August 21, 2008 (2.4.3), if the function has only the first argument, it automatically produces a targeted emote if a target exists or a non-targeted emote if none exists. Supplying a string or number to the "target" argument appears to force the function to behave as if no target were selected, regardless of an actual target.

WoWWiki>Egingell at 22:28, 8 February 2008

2008-02-08T22:28:38Z

← Older revision		Revision as of 22:28, 8 February 2008
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.

	----		----

WoWWiki>Rectrix: Added an example for the target as the previous information was incorrect (not the player name, but the word 'target' or 'targettarget')

2008-02-08T14:48:29Z

Added an example for the target as the previous information was incorrect (not the player name, but the word 'target' or 'targettarget')

← Older revision		Revision as of 14:48, 8 February 2008
Line 15:		Line 15:
	:("token", "message")		:("token", "message")
	:;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 ~~/ additional command~~ for the emote? ~~It appears that if this is a player name, then the emote is~~ "~~done~~" to ~~the player for emotes that support that~~.		:;message : String - target for the emote. For example: DoEmote("dance", target) will cause you to dance with your target.

	----		----

WoWWiki>Pcj at 16:31, 4 December 2007

2007-12-04T16:31:48Z

← Older revision		Revision as of 16:31, 4 December 2007
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
	~~<center>'''DoEmote''' ''-Documentation by [[user:Xenoveritas\|Xenoveritas]]-''</center>~~

	<!-- 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 -->

WoWWiki>Egingell: tokens

2007-07-10T19:32:05Z

tokens

← Older revision		Revision as of 19:32, 10 July 2007
Line 28:		Line 28:

	<!-- Details not appropriate for the main description can go here -->		<!-- Details not appropriate for the main description can go here -->
	: 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 EMOTE''x''_TOKEN constants. ''x'' starts at 1 and currently goes up to ~~170~~ (as of 1.~~3.0~~). Certain emotes may also trigger character animations and sound effects.		: 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 EMOTE''x''_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.