WoW:API UnitName: Difference between revisions
Jump to navigation
Jump to search
UnitName - Documentation by octon
mNo edit summary |
m (Fixed result.) |
||
| Line 1: | Line 1: | ||
<center>'''UnitName''' '' | <center>'''UnitName''' - ''Documentation by [[User:Octon|octon]]''</center> | ||
== Synopsis == | |||
Returns the name of the specified unit. | Returns the name of the specified unit. | ||
name = UnitName("unit") | |||
:(unit) | == Arguments == | ||
:("unit") | |||
:;unit : String - The [[API TYPE UnitId|UnitId]] to query (e.g. "player", "party2", "pet", "target" etc.) | :;unit : String - The [[API TYPE UnitId|UnitId]] to query (e.g. "player", "party2", "pet", "target" etc.) | ||
== Returns == | |||
:name | |||
:;name : String - The name of the specified unit. | :;name : String - The name of the specified unit. | ||
---- | == Example == | ||
<!-- begin code --> | |||
local playerName = UnitName("player"); | local playerName = UnitName("player"); | ||
ChatFrame1:AddMessage('Hi my name is: ' .. playerName); | ChatFrame1:AddMessage('Hi my name is: ' .. playerName); | ||
<!-- end code --> | |||
==== Result ==== | |||
:Prints the player's name to the chat frame. e.g. | |||
<!-- begin code --> | |||
Hi my name is: Octon | |||
<!-- end code --> | |||
== Details == | |||
: 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("player") will return "Unknown Entity" if called | |||
---- | ---- | ||
__NOTOC__ | |||
{{Template:WoW API}} | {{Template:WoW API}} | ||
[[Category:API Unit Functions|UnitName]] | |||
Revision as of 07:07, 29 March 2005
Synopsis
Returns the name of the specified unit.
name = UnitName("unit")
Arguments
- ("unit")
- unit
- String - The UnitId to query (e.g. "player", "party2", "pet", "target" etc.)
Returns
- name
- name
- String - The name of the specified unit.
Example
local playerName = UnitName("player");
ChatFrame1:AddMessage('Hi my name is: ' .. playerName);
Result
- Prints the player's name to the chat frame. e.g.
Hi my name is: Octon
Details
- 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.