Wikia

WoWWiki

Changes: API UnitClass

Edit

Back to page

m (Result: Typo)
(Updated for new MoP return values)
Line 3: Line 3:
 
Returns the class (Mage, Warrior, etc) of the specified unit.
 
Returns the class (Mage, Warrior, etc) of the specified unit.
   
localizedClass, englishClass = UnitClass("unit");
+
localizedClass, englishClass, classIndex = UnitClass("unit");
   
 
== Parameters ==
 
== Parameters ==
Line 12: Line 12:
 
=== Returns ===
 
=== Returns ===
   
:localizedClass, englishClass
+
:localizedClass, englishClass, classIndex
   
 
:;localizedclass : The localized class of the specified unit as a string. e.g. "Mage", "Warrior", "Guerrier", etc.
 
:;localizedclass : The localized class of the specified unit as a string. e.g. "Mage", "Warrior", "Guerrier", etc.
   
 
:;englishclass : The fully capitalized english class name with no spaces, e.g. "MAGE", "WARRIOR", "DEATHKNIGHT", etc.
 
:;englishclass : The fully capitalized english class name with no spaces, e.g. "MAGE", "WARRIOR", "DEATHKNIGHT", etc.
  +
  +
:;classIndex : the number index corresponding to the particular class that is returned. Number mapping is as follows:
  +
  +
::None = 0
  +
::Warrior = 1
  +
::Paladin = 2
  +
::Hunter = 3
  +
::Rogue = 4
  +
::Priest = 5
  +
::DeathKnight = 6
  +
::Shaman = 7
  +
::Mage = 8
  +
::Warlock = 9
  +
::Monk = 10
  +
::Druid = 11
   
 
== Example ==
 
== Example ==

Revision as of 01:53, January 21, 2013

WoW API < UnitClass

Returns the class (Mage, Warrior, etc) of the specified unit.

localizedClass, englishClass, classIndex = UnitClass("unit");

Parameters

Arguments

unit
String - the unitId to query, e.g. "player"

Returns

localizedClass, englishClass, classIndex
localizedclass 
The localized class of the specified unit as a string. e.g. "Mage", "Warrior", "Guerrier", etc.
englishclass 
The fully capitalized english class name with no spaces, e.g. "MAGE", "WARRIOR", "DEATHKNIGHT", etc.
classIndex 
the number index corresponding to the particular class that is returned. Number mapping is as follows:
None = 0
Warrior = 1
Paladin = 2
Hunter = 3
Rogue = 4
Priest = 5
DeathKnight = 6
Shaman = 7
Mage = 8
Warlock = 9
Monk = 10
Druid = 11

Example

local playerClass, englishClass = UnitClass("player");
ChatFrame1:AddMessage('Your player is a : ' .. playerClass .. '; ' .. englishClass .. '.');

Result

Prints the player's class to the chat frame, e.g.

Your player is a : Warrior; WARRIOR.

Details

For any type of data tracking, use the second parameter, since it is guaranteed to stay the same in different-language clients. This is especially important in europe, where it is not uncommon for people with e.g. german or french client software to play on english servers. You can keep track of mappings for display by remembering the output pairs in a table, e.g.:

localizedClass, englishClass = UnitClass("target");
MyAddOn_Classes[englishClass] = localizedClass;

.. do data tracking stuff with englishClass..

Around Wikia's network

Random Wiki