WoW:API UnitName - Revision history

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

2023-08-15T04:47:48Z

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

← Older revision

Revision as of 04:47, 15 August 2023

1.129.109.2: /* Returns */

2020-02-09T07:20:40Z

Returns

← Older revision		Revision as of 07:20, 9 February 2020
Line 17:		Line 17:
	=== Returns ===		=== Returns ===
	<!-- List each return value, together with its type -->		<!-- List each return value, together with its type -->
	:;name : String - The name of the specified unit, "nil" if not applicable (e.g., if the specified unit is "target" but the player has no target selected).		:;name
	:;realm : String - The realm the specified unit is from. ~~If from~~ your own realm~~, then realm == nil (but the 2nd return value is still there)~~. ~~This~~ is as of 1.12		:: String - The name of the specified unit, "nil" if not applicable (e.g., if the specified unit is "target" but the player has no target selected).
			:;realm
			:: String - The realm the specified unit is from. For "player" returns nil, for any other character on your own realm returns an empty string. This is as of 1.12

	== Example ==		== Example ==

223.176.155.33 at 05:24, 7 March 2017

2017-03-07T05:24:25Z

← Older revision		Revision as of 05:24, 7 March 2017
Line 7:		Line 7:
	<!-- 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 -->
	name, realm = UnitName("unit")		name, realm = UnitName("unit")


	== Parameters ==		== Parameters ==

WoWWiki>Egingell at 09:21, 4 March 2010

2010-03-04T09:21:11Z

← Older revision		Revision as of 09:21, 4 March 2010
Line 48:		Line 48:
	* Note that this function always returns two values even though the latter may be nil. The difference is usually moot, but there are some cases where it matters, e.g. <span style="white-space: nowrap;"><tt>tinsert(myTable, UnitName("player"))</tt></span>, which would previously work, but will now cause errors. The fix is to put the expression in parenthesis: <span style="white-space: nowrap;" ><tt>tinsert(myTable, (UnitName("player")) )</tt></span>.		* Note that this function always returns two values even though the latter may be nil. The difference is usually moot, but there are some cases where it matters, e.g. <span style="white-space: nowrap;"><tt>tinsert(myTable, UnitName("player"))</tt></span>, which would previously work, but will now cause errors. The fix is to put the expression in parenthesis: <span style="white-space: nowrap;" ><tt>tinsert(myTable, (UnitName("player")) )</tt></span>.

	* The default Blizzard UI defines GetUnitName(unit, showServerName) which only returns the unit name, but for characters from another server appends the server name (showServerName==true) or "(*)" (if showServerName==false).		* The default Blizzard UI defines [[API_GetUnitName\|GetUnitName]](unit, showServerName) which only returns the unit name, but for characters from another server appends the server name (showServerName==true) or "(*)" (if showServerName==false).

	[[Category:World of Warcraft API]]		[[Category:World of Warcraft API]]

WoWWiki>Thoughtlover at 19:59, 19 December 2007

2007-12-19T19:59:23Z

← Older revision		Revision as of 19:59, 19 December 2007
Line 18:		Line 18:
	=== Returns ===		=== Returns ===
	<!-- List each return value, together with its type -->		<!-- List each return value, together with its type -->
	:;name : String - The name of the specified unit, or nil if not applicable (e.g., if the specified unit is "target" but the player has no target selected).		:;name : String - The name of the specified unit, "nil" if not applicable (e.g., if the specified unit is "target" but the player has no target selected).
	:;realm : String - The realm the specified unit is from. If from your own realm, then realm == nil (but the 2nd return value is still there). This is as of 1.12		:;realm : String - The realm the specified unit is from. If from your own realm, then realm == nil (but the 2nd return value is still there). This is as of 1.12

WoWWiki>Qzot: /* Details */

2007-01-05T00:37:31Z

Details

← Older revision		Revision as of 00:37, 5 January 2007
Line 47:		Line 47:

	* Note that this function always returns two values even though the latter may be nil. The difference is usually moot, but there are some cases where it matters, e.g. <span style="white-space: nowrap;"><tt>tinsert(myTable, UnitName("player"))</tt></span>, which would previously work, but will now cause errors. The fix is to put the expression in parenthesis: <span style="white-space: nowrap;" ><tt>tinsert(myTable, (UnitName("player")) )</tt></span>.		* Note that this function always returns two values even though the latter may be nil. The difference is usually moot, but there are some cases where it matters, e.g. <span style="white-space: nowrap;"><tt>tinsert(myTable, UnitName("player"))</tt></span>, which would previously work, but will now cause errors. The fix is to put the expression in parenthesis: <span style="white-space: nowrap;" ><tt>tinsert(myTable, (UnitName("player")) )</tt></span>.

			* The default Blizzard UI defines GetUnitName(unit, showServerName) which only returns the unit name, but for characters from another server appends the server name (showServerName==true) or "(*)" (if showServerName==false).

	[[Category:World of Warcraft API]]		[[Category:World of Warcraft API]]

WoWWiki>Foopy: /* Returns */ Clarified return values.

2006-10-22T10:44:25Z

Returns: Clarified return values.

← Older revision		Revision as of 10:44, 22 October 2006
Line 18:		Line 18:
	=== Returns ===		=== Returns ===
	<!-- List each return value, together with its type -->		<!-- List each return value, together with its type -->
	:;name : String - The name of the specified unit.		:;name : String - The name of the specified unit, or nil if not applicable (e.g., if the specified unit is "target" but the player has no target selected).
	:;realm : String - The realm the specified unit is from. If from your own realm, then realm == nil (but the 2nd return value is still there). This is as of 1.12		:;realm : String - The realm the specified unit is from. If from your own realm, then realm == nil (but the 2nd return value is still there). This is as of 1.12

WoWWiki>Shadowed at 13:11, 28 August 2006

2006-08-28T13:11:15Z

← Older revision		Revision as of 13:11, 28 August 2006
Line 44:		Line 44:

	* The '''realm''' return will be nil even if the player is from a different realm, if it is out of visible range.		* The '''realm''' return will be nil even if the player is from a different realm, if it is out of visible range.
			* Realm name will not include server type

	* Note that this function always returns two values even though the latter may be nil. The difference is usually moot, but there are some cases where it matters, e.g. <span style="white-space: nowrap;"><tt>tinsert(myTable, UnitName("player"))</tt></span>, which would previously work, but will now cause errors. The fix is to put the expression in parenthesis: <span style="white-space: nowrap;" ><tt>tinsert(myTable, (UnitName("player")) )</tt></span>.		* Note that this function always returns two values even though the latter may be nil. The difference is usually moot, but there are some cases where it matters, e.g. <span style="white-space: nowrap;"><tt>tinsert(myTable, UnitName("player"))</tt></span>, which would previously work, but will now cause errors. The fix is to put the expression in parenthesis: <span style="white-space: nowrap;" ><tt>tinsert(myTable, (UnitName("player")) )</tt></span>.

	[[Category:World of Warcraft API]]		[[Category:World of Warcraft API]]

WoWWiki>Mikk: /* Details */ Notes on the second return value

2006-08-28T13:03:00Z

Details: Notes on the second return value

← Older revision		Revision as of 13:03, 28 August 2006
Line 40:		Line 40:
	REMOVE the section if you're just going to restate the intro line! -->		REMOVE the section if you're just going to restate the intro line! -->

	: UnitName("~~player~~") (or any other unit) will return "Unknown Entity" (Actually the value of the UNKNOWNOBJECT global) if called before the unit in question has been fully loaded into the world.		* UnitName("unit") (or any other unit) will return "Unknown Entity" (Actually the value of the UNKNOWNOBJECT global) if called before the unit in question has been fully loaded into the world.


			* The '''realm''' return will be nil even if the player is from a different realm, if it is out of visible range.


			* Note that this function always returns two values even though the latter may be nil. The difference is usually moot, but there are some cases where it matters, e.g. <span style="white-space: nowrap;"><tt>tinsert(myTable, UnitName("player"))</tt></span>, which would previously work, but will now cause errors. The fix is to put the expression in parenthesis: <span style="white-space: nowrap;" ><tt>tinsert(myTable, (UnitName("player")) )</tt></span>.

	[[Category:World of Warcraft API]]		[[Category:World of Warcraft API]]

WoWWiki>Farmbuyer at 03:31, 25 August 2006

2006-08-25T03:31:54Z

← Older revision		Revision as of 03:31, 25 August 2006
Line 3:		Line 3:

	<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->		<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
	Returns the name of the specified unit.		Returns the name and realm of the specified unit.

	<!-- 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 -->
	name = UnitName("unit")		name, realm = UnitName("unit")