WoW:API GetWorldStateUIInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API GetWorldStateUIInfo to API GetWorldStateUIInfo without leaving a redirect)
 
(14 intermediate revisions by 13 users not shown)
Line 1: Line 1:
text, icon, isFlashing, dynamicIcon, tooltip, dynamicTooltip = GetWorldStateUIInfo(i);
Get score and flag status within a battlefield.


Get score and flag status within a battlefield
  uiType, state, hidden, text, icon, dynamicIcon, tooltip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3 = GetWorldStateUIInfo(index);


----
----
;''Arguments''
=== Arguments ===
: index


:(i)
:; index : Interger - 1 for Alliance data and 2 for Horde data.
:;i : Number - The team number to retrieve score information for (1..MAX_ALWAYS_UP_UI_FRAMES)
----
 
=== Returns ===
: 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 ({{Alliance Icon Small}} or {{Horde Icon Small}} 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.


----
----
;''Returns''


:text, icon, isFlashing, dynamicIcon, tooltip, dynamicTooltip
=== Details ===
:;text : String - The team's score ("0/3")
 
:;icon : String - The team's icon
: 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.
:;isFlashing : Boolean - Whether or not the dynamicIcon should be flashing (it flashes when the flag has been picked up)
:: uiType appears to be 0 for the first valid index and 1 for every other valid index (valid indexes being 1 to [[API_GetNumWorldStateUI|GetNumWorldStateUI]]())
:;dynamicIcon : String - The team's flag icon
: In [[The Burning Crusade]] this is used for more then just PvP, you can find it used for some instances like [[Opening the Dark Portal|Black Morass]].
:;toolip : String - Info about the icon/text ("Horde flag captures")
 
:;dynamicToolip : String - Info about the dynamicIcon ("Alliance flag has been picked up")
----
{{wowapi}}

Latest revision as of 04:46, 15 August 2023

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 (Template:Alliance Icon Small or Template:Horde Icon Small 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

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetWorldStateUIInfo&oldid=19382"