WoW:API GetWorldStateUIInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
Line 7: Line 7:
: index
: index


:; index : Interger - Row to return data for
:; index : Interger - 1 for Alliance data and 2 for Horde data.
----


----
=== Returns ===
=== Returns ===
: state, text, icon, isFlashing, dynamicIcon, toolTip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3
: state, text, icon, isFlashing, dynamicIcon, toolTip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3


:;state : ? - unknown
:;state : In [[Warsong Gulch]], returns 1 if the team does not hold the enemy flag and 2 if the team does. Returns 0 outside of the battleground.
:;text : String - Score ([score]/2000 inside [[Arathi Basin]]; [score]/3 inside [[Warsong Gulch]])
:;text : String - Score ([score]/2000 inside [[Arathi Basin]]; [score]/3 inside [[Warsong Gulch]])
:;icon : String - Icon ({{Alliance Icon Small}} or {{Horde Icon Small}} icon path returned inside [[Warsong Gulch]])
:;icon : String - Icon ({{Alliance Icon Small}} or {{Horde Icon Small}} icon path returned inside [[Warsong Gulch]])

Revision as of 11:07, 20 September 2006

Get score and flag status within a battlefield.

 state, text, icon, isFlashing, dynamicIcon, tooltip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3 = GetWorldStateUIInfo(index);

Arguments

index
index
Interger - 1 for Alliance data and 2 for Horde data.

Returns

state, text, icon, isFlashing, dynamicIcon, toolTip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3
state
In Warsong Gulch, returns 1 if the team does not hold the enemy flag and 2 if the team does. Returns 0 outside of the battleground.
text
String - Score ([score]/2000 inside Arathi Basin; [score]/3 inside Warsong Gulch)
icon
String - Icon (Template:Alliance Icon Small or Template:Horde Icon Small icon path returned inside Warsong Gulch)
isFlashing
Boolean - Wether or not the dynamicIcon should be flashing (it flashes if somebody has the flag)
dynamicIcon
String - Second icon thats usually position to the right of the main icon (Alliance flag or Horde flag icon path returned insied Warsong Gulch)
tooltip
String - Tooltip displayed when hovering over the row (eg "Horde flag captures")
dynamicTooltip
String - Tooltip displayed when hovering over the dynamicIcon (eg "Alliance flag has been picked up")
extendedUI
? - unknown
extendedUIState1
? - unknown
extendedUIState2
? - unknown
extendedUIState3
? - unknown

WoW API < GetWorldStateUIInfo