WoW:API GetFactionInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Added isWatched return value)
Line 3: Line 3:
Get's details for a specific faction/faction header.
Get's details for a specific faction/faction header.


  name, description, standingId, bottomValue, topValue, earnedValue, atWarWith, canToggleAtWar, isHeader, isCollapsed = GetFactionInfo(factionIndex)
  name, description, standingId, bottomValue, topValue, earnedValue, atWarWith,
  canToggleAtWar, isHeader, isCollapsed, isWatched = GetFactionInfo(factionIndex)
== Parameters ==
== Parameters ==
=== Arguments ===
=== Arguments ===
Line 22: Line 23:
:;isHeader : Flag - 1 if this row is a header row, 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.
:;isCollapsed : Flag - 1 if this row is a collapsed header row, nil otherwise.
:;isWatched : Flag - 1 if this faction is being watched (faction progress bar in default UI), nil otherwise.
== Notes ==
== Notes ==
Thanks to [[User:Flickering|Flickering]] for cleaning up the formatting.
Thanks to [[User:Flickering|Flickering]] for cleaning up the formatting.

Revision as of 18:23, 2 April 2006

GetFactionInfo - Documentation by Ulic

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

name, description, standingId, bottomValue, topValue, earnedValue, atWarWith,
  canToggleAtWar, isHeader, isCollapsed, isWatched = 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.
isWatched
Flag - 1 if this faction is being watched (faction progress bar in default UI), nil otherwise.

Notes

Thanks to Flickering for cleaning up the formatting.


Template:WoW API