Clarify return values
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>. | |||