Wikia

WoWWiki

API GetWorldStateUIInfo

Talk2
101,391pages on
this wiki

Get score and flag status within a battlefield.

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

Arguments Edit

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

Returns Edit

uiType, state, hidden, text, icon, dynamicIcon, tooltip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3
uiType 
Integer - Unknown, added in 2.1.0.
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.
hidden 
Boolean - Unknown
text 
String - Score ([score]/1600 inside Arathi Basin and Eye of the Storm; [score]/3 inside Warsong Gulch)
icon 
String - Icon (Official alliance mini-icon or Official horde mini-icon icon path returned inside Warsong Gulch)
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 
String - "CAPTUREPOINT" for objective capture bar, "" for regular objectives,
extendedUIState1 
Integer - for CaptureBar: bar index,
extendedUIState2 
Integer - for CaptureBar: current objective position : 100 means left, 0 means right,
extendedUIState3 
Integer - for CaptureBar: neutral zone width : 0 means no neutral zone, 90 means 5% Alliance, 90% neutral and 5% Horde.

Details Edit

2.1 added a new argument called uiType to GetWorldStateUIInfo, because this was added as the first argument you will have to update any code that uses this function.
uiType appears to be 0 for the first valid index and 1 for every other valid index (valid indexes being 1 to GetNumWorldStateUI())
In The Burning Crusade this is used for more then just PvP, you can find it used for some instances like Black Morass.

WoW API < GetWorldStateUIInfo

Around Wikia's network

Random Wiki