WoW:API GetFactionInfo: Difference between revisions

Revision as of 05:04, 12 October 2005

GetFactionInfo - Documentation by Ulic

Get's details for a specific faction/faction header.

name, description, standingId, barValue, atWarWith, canToggleAtWar, isHeader, isCollapsed = GetFactionInfo(factionIndex)

Parameters

Arguments

(factionIndex)

factionIndex: Integer - The row of the faction display to request information from.

Returns

name, description, standingId, bottomValue, topValue, earnedValue, atWarWith, canToggleAtWar, isHeader, isCollapsed

name: String - The display name/label for this row.
description: String - Not currently used (always returns "")
standingId: Integer StandingId - Numeric representation of standing with faction (present for header rows, though its significance is unknown)
bottomValue: Integer - Numeric representation of the minimum reputation earned with this faction at the current standing, ex. Neutral is 0, Friendly is 3000 (Present for header rows, but significance of value is unknown).
topValue: Integer - Numeric representation of the maximum reputation that can be earned with this faction at the current standing, ex. Neutral is 3000, Friendly is 6000 (Present for header rows, but significance of value is unknown).
earnedValue: Integer - Numeric representation of the TOTAL reputation earned with this faction, ex. if Neutral is 1500 or Friendly is 4500, the bar would be half way full (Present for header rows, but significance of value is unknown).
atWarWith: Flag - 1 if player is at war with the faction, nil otherwise.
canToggleAtWar: Flag - 1 if player can toggle the 'At War' flag for this faction, nil otherwise.
isHeader: Flag - 1 if this row is a header row, nil otherwise.
isCollapsed: Flag - 1 if this row is a collapsed header row, nil otherwise.

Notes

Thanks to Flickering for cleaning up the formatting.

Template:WoW API

@@ Line 10: / Line 10: @@
 :;factionIndex : Integer - The row of the faction display to request information from.
 === Returns ===
-:name, description, standingId, barValue, atWarWith, canToggleAtWar, isHeader, isCollapsed
+:name, description, standingId, bottomValue, topValue, earnedValue, atWarWith, canToggleAtWar, isHeader, isCollapsed
 :;name : String - The display name/label for this row.
 :;description : String - Not currently used (always returns "")
 :;standingId : Integer [[API TYPE StandingId|StandingId]] - Numeric representation of standing with faction (present for header rows, though its significance is unknown)
-:;barValue : Number - Floating point value between 0 and 1 representing how much of the standing bar should be filled in (Present for header rows, but significance of value is unknown).
+:;bottomValue : Integer - Numeric representation of the minimum reputation earned with this faction at the current standing, ex. Neutral is 0, Friendly is 3000 (Present for header rows, but significance of value is unknown).
+:;topValue : Integer - Numeric representation of the maximum reputation that can be earned with this faction at the current standing, ex. Neutral is 3000, Friendly is 6000 (Present for header rows, but significance of value is unknown).
+:;earnedValue : Integer - Numeric representation of the TOTAL reputation earned with this faction, ex. if Neutral is 1500 or Friendly is 4500, the bar would be half way full (Present for header rows, but significance of value is unknown).
 :;atWarWith : Flag - 1 if player is at war with the faction, nil otherwise.
 :;canToggleAtWar : Flag - 1 if player can toggle the 'At War' flag for this faction, nil otherwise.
 :;isHeader : Flag - 1 if this row is a header row, nil otherwise.
 :;isCollapsed : Flag - 1 if this row is a collapsed header row, nil otherwise.
+== Notes ==
+Thanks to [[User:Flickering|Flickering]] for cleaning up the formatting.
 ----
 __NOTOC__
 {{Template:WoW API}}
 [[Category:API Faction Functions|GetFactionInfo]]

Navigation menu

Search