WoW:API UnitName: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 19: | Line 19: | ||
<!-- 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. | ||
:;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 | |||
== Example == | == Example == | ||
| Line 42: | Line 42: | ||
: 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") (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. | ||
[[Category:World of Warcraft API]] | [[Category:World of Warcraft API]] | ||
Revision as of 15:19, 24 August 2006
Returns the name of the specified unit.
name = UnitName("unit")
Parameters
Arguments
- ("unit")
- unit
- String - The UnitId to query (e.g. "player", "party2", "pet", "target" etc.)
Returns
- name
- String - The name of the specified unit.
- 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
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.