WoW:API UnitFactionGroup: Difference between revisions

WoW:API UnitFactionGroup (source)

15 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: @@
-Get the [[API_TYPE_UnitId|UnitID]] faction
+{{wowapi}}
+Get the name of the faction (Horde/Alliance) a unit belongs to.
-  UnitFactionGroup("unitid");
+  englishFaction, localizedFaction = UnitFactionGroup(unit)
-== Parameters ==
-=== Arguments ===
-:[[API_TYPE_UnitId|UnitID]]
-:; [[API_TYPE_UnitId|UnitID]] : String - Unit ID you want to get the faction for
-----
+== Arguments ==
-=== Returns ===
+; unit : String - [[API_TYPE_UnitId|UnitID]] you want to get the faction for
-:englishFaction, localizedFaction
-:;englishFaction : String - Faction name of the [[API_TYPE_UnitId|UnitID]] in English.
+== Returns ==
-:;localizedFaction : String - Localized version of the faction name.
+;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 ==
-=== Details ===
+The functon returns correct results after the  PLAYER_ENTERING_WORLD event.
-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]].
-----
+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>.
-__NOTOC__
-{{wowapi}}