WoW:API GetFactionInfo

From AddOn Studio
Revision as of 20:28, 11 September 2005 by WoWWiki>Flickering (Reformatted, moved StandingId to its own page.)
Jump to navigation Jump to search
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, barValue, 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)
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).
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.

Template:WoW API