WoW API: GetFactionInfo

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < GetFactionInfo

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, isWatched

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.

Example

for factionIndex = 1, GetNumFactions() do
  name, description, standingId, bottomValue, topValue, earnedValue, atWarWith,
    canToggleAtWar, isHeader, isCollapsed, isWatched = GetFactionInfo(factionIndex)
  if isHeader == nil then
     DEFAULT_CHAT_FRAME:AddMessage("Faction: " .. name .. " - " .. earnedValue)
  end
end

Result

Prints each faction's name and earned value.

Faction: Cenarion Circle - 2785
Faction: Argent Dawn - 405
Faction: Thunder Bluff - 15042