WoW:API UnitFactionGroup: Difference between revisions

WoW:API UnitFactionGroup (source)

79 bytes added , 15 August 2023

m

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

Anonymous user

@@ Line 1: / Line 1: @@
 {{wowapi}}
-Get the [[API_TYPE_UnitId|UnitID]] faction
+Get the name of the faction (Horde/Alliance) a unit belongs to.
-  englishFaction, localizedFaction = UnitFactionGroup([[API_TYPE_UnitId|UnitID]])
+  englishFaction, localizedFaction = UnitFactionGroup(unit)
 == Arguments ==
-; [[API_TYPE_UnitId|UnitID]] : String - Unit ID you want to get the faction for
+; unit : String - [[API_TYPE_UnitId|UnitID]] you want to get the faction for
 == Returns ==
-;englishFaction : String - Faction name of the [[API_TYPE_UnitId|UnitID]] in English.
+;englishFaction : String - Unit's faction name in English, i.e. "Alliance", "Horde" or nil.
-;localizedFaction : String - Localized version of the faction name.
+;localizedFaction : String - Unit's faction name in the client's locale or nil.
 == Details ==
-Used to retrieve the [[API_TYPE_UnitId|UnitID]] faction ([[Horde]] or [[Alliance]]), this can be called at PLAYER_ENTERING_WORLD with a player [[API_TYPE_UnitId|UnitID]].
+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>.