WoW:API GetWorldStateUIInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Typo fixed, cleaned up and clarified what it returns beyond Warsong Gulch.)
No edit summary
Line 1: Line 1:
text, icon, isFlashing, dynamicIcon, tooltip, dynamicTooltip = GetWorldStateUIInfo(index);
Get score and flag status within a battlefield.
 
  state, text, icon, isFlashing, dynamicIcon, tooltip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3 = GetWorldStateUIInfo(index);


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


:;state : ? - unknown
:;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]])
Line 17: Line 20:
:;tooltip : String - Tooltip displayed when hovering over the row (eg "Horde flag captures")
:;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")
:;dynamicTooltip : String - Tooltip displayed when hovering over the dynamicIcon (eg "Alliance flag has been picked up")
:;extendedUI : ? - unknown
:;extendedUIState1 : ? - unknown
:;extendedUIState2 : ? - unknown
:;extendedUIState3 : ? - unknown


----
----
{{wowapi}}
{{wowapi}}

Revision as of 10:08, 9 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 - Row to return data for

Returns

state, text, icon, isFlashing, dynamicIcon, toolTip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3
state
? - unknown
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