WoW:API UnitClass - Revision history

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

2023-08-15T04:47:43Z

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

← Older revision

Revision as of 04:47, 15 August 2023

WoWWiki>Fandyllic at 23:58, 20 August 2017

2017-08-20T23:58:43Z

← Older revision		Revision as of 23:58, 20 August 2017
Line 24:		Line 24:
	:: the number index corresponding to the particular class that is returned. Number mapping is as follows:		:: the number index corresponding to the particular class that is returned. Number mapping is as follows:

	:None = 0		::None = 0
	::Warrior = 1		::Warrior = 1
	::Paladin = 2		::Paladin = 2

79.67.9.243: Added DH class index

2017-08-20T16:28:03Z

Added DH class index

← Older revision		Revision as of 16:28, 20 August 2017
Line 8:		Line 8:
	=== Arguments ===		=== Arguments ===

	:;unit: String - the [[unitId]] to query, e.g. "player"		:;unit
			:: String - the [[unitId]] to query, e.g. "player"

	=== Returns ===		=== Returns ===
Line 14:		Line 15:
	:localizedClass, englishClass, classIndex		: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:		:;classIndex
			:: the number index corresponding to the particular class that is returned. Number mapping is as follows:

	::None = 0		:None = 0
	::Warrior = 1		::Warrior = 1
	::Paladin = 2		::Paladin = 2
Line 31:		Line 35:
	::Warlock = 9		::Warlock = 9
	::Monk = 10		::Monk = 10
	::Druid = 11		::Druid = 11
			::Demon Hunter = 12

	== Example ==		== Example ==

WoWWiki>Rturner18: Updated for new MoP return values

2013-01-21T01:53:24Z

Updated for new MoP return values

← Older revision		Revision as of 01:53, 21 January 2013
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 ==

WoWWiki>DynamicBits: /* Result */ Typo

2010-08-27T01:38:30Z

Result: Typo

← Older revision		Revision as of 01:38, 27 August 2010
Line 24:		Line 24:
	=== Result ===		=== Result ===
	Prints the player's class to the chat frame, e.g.		Prints the player's class to the chat frame, e.g.
	Your player is a : Warrior; WARRIOR'.		Your player is a : Warrior; WARRIOR.

	== Details ==		== Details ==

WoWWiki>Moduspwnens: Clarified that englishclass omits spaces.

2009-07-31T11:13:22Z

Clarified that englishclass omits spaces.

← Older revision		Revision as of 11:13, 31 July 2009
Line 16:		Line 16:
	:;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, e.g. "MAGE", "WARRIOR", etc.		:;englishclass : The fully capitalized english class name with no spaces, e.g. "MAGE", "WARRIOR", "DEATHKNIGHT", etc.

	== Example ==		== Example ==

WoWWiki>Mikk: Formatting, another example

2006-08-11T11:23:41Z

Formatting, another example

← Older revision		Revision as of 11:23, 11 August 2006
Line 1:		Line 1:
	~~<center>'''UnitClass''' ''-Documentation by [[User:Octon\|octon]]- Correction by Vjeux''</center>~~		{{wowapi}} __NOTOC__

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

	~~----~~		localizedClass, englishClass = UnitClass("unit");
	;~~''Arguments''~~

	~~:[[API_TYPE_UnitId\|UnitID]]~~		== Parameters ==
			=== Arguments ===

	:;~~arg1~~ : ~~The unit~~ to query (e.g. "player")		:;unit: String - the [[unitId]] to query, e.g. "player"

	~~----~~		=== Returns ===
	~~;''~~Returns''

	:~~Localized Class~~		:localizedClass, englishClass
	~~:;localizedclass : The localized class of the specified unit as a string. e.g. Mage~~, ~~Warrior, Guerrier, etc.~~

	~~:English Class~~		:;localizedclass : The localized class of the specified unit as a string. e.g. "Mage", "Warrior", "Guerrier", etc.
	:;~~englishclass~~ : The ~~fully english capitalized~~ class of the specified unit as a string. e.g. ~~MAGE~~, ~~WARRIOR~~, etc.

			:;englishclass : The fully capitalized english class name, e.g. "MAGE", "WARRIOR", etc.

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

	~~;''~~Result''		=== Result ===
	Prints the player's class to the chat frame as		Prints the player's class to the chat frame, e.g.
			Your player is a : Warrior; WARRIOR'.
	'Your player is a : Warrior; WARRIOR'. ~~(Or whichever class the specified unit is)~~

	~~----~~		== Details ==
	~~;''Description''~~

	~~: Returns~~ the ~~class (Mage~~, ~~Warrior~~, ~~etc)~~ of the ~~specified unit~~.		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.:
	: ~~The second return is useful for localized addons.~~

			localizedClass, englishClass = UnitClass("target");
	~~----~~		MyAddOn_Classes[englishClass] = localizedClass;
	~~{{WoW API}}~~
			''.. do data tracking stuff with englishClass..''

WoWWiki>DerGhulbus: Specified parameter (UnitID-String)

2006-01-23T19:43:34Z

Specified parameter (UnitID-String)

← Older revision		Revision as of 19:43, 23 January 2006
Line 6:		Line 6:
	;''Arguments''		;''Arguments''

	:~~(String unit)~~		:[[API_TYPE_UnitId\|UnitID]]

	:;arg1 : The unit to query (e.g. "player")		:;arg1 : The unit to query (e.g. "player")

WoWWiki>Muert at 05:32, 4 January 2006

2006-01-04T05:32:12Z

← Older revision		Revision as of 05:32, 4 January 2006
Line 35:		Line 35:
	: Returns the class (Mage, Warrior, etc) of the specified unit.		: Returns the class (Mage, Warrior, etc) of the specified unit.
	: The second return is useful for localized addons.		: The second return is useful for localized addons.


	----		----
	{{~~Template:~~WoW API}}		{{WoW API}}
	~~[[Category:API Functions\|UnitClass]]~~
	~~[[Category:API Unit Functions\|UnitClass]]~~

WoWWiki>Inglais at 13:18, 27 August 2005

2005-08-27T13:18:18Z

← Older revision		Revision as of 13:18, 27 August 2005
Line 38:		Line 38:
	----		----
	{{Template:WoW API}}		{{Template:WoW API}}
			[[Category:API Functions\|UnitClass]]
			[[Category:API Unit Functions\|UnitClass]]