WoW:API UnitFactionGroup: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(Clarify return values)
Line 7: Line 7:


== Returns ==
== Returns ==
;englishFaction : String - Unit's faction name in English.
;englishFaction : String - Unit's faction name in English, i.e. "Alliance", "Horde" or nil.
;localizedFaction : String - Unit's faction name in the client's locale.
;localizedFaction : String - Unit's faction name in the client's locale or nil.


== Details ==
== Details ==
The functon returns correct results after the  PLAYER_ENTERING_WORLD event.
The functon returns correct results after the  PLAYER_ENTERING_WORLD event.
Note that for NPCs, the function will only return Alliance/Horde for factions closely allied with either side. Goblins, for instance, return <tt>nil,nil</tt>.

Revision as of 01:58, 6 September 2008

WoW API < UnitFactionGroup

Get the name of the faction (Horde/Alliance) a unit belongs to.

englishFaction, localizedFaction = UnitFactionGroup(unit)

Arguments

unit
String - UnitID you want to get the faction for

Returns

englishFaction
String - Unit's faction name in English, i.e. "Alliance", "Horde" or nil.
localizedFaction
String - Unit's faction name in the client's locale or nil.

Details

The functon returns correct results after the PLAYER_ENTERING_WORLD event.

Note that for NPCs, the function will only return Alliance/Horde for factions closely allied with either side. Goblins, for instance, return nil,nil.