WoW:API GetWorldStateUIInfo: Difference between revisions

WoW:API GetWorldStateUIInfo (source)

Revision as of 02:11, 13 July 2006

209 bytes added , 13 July 2006

Typo fixed, cleaned up and clarified what it returns beyond Warsong Gulch.

Anonymous user

WoWWiki>Shadowed

@@ Line 1: / Line 1: @@
-  text, icon, isFlashing, dynamicIcon, tooltip, dynamicTooltip = GetWorldStateUIInfo(i);
+  text, icon, isFlashing, dynamicIcon, tooltip, dynamicTooltip = GetWorldStateUIInfo(index);
-Get score and flag status within a battlefield
 ----
 === Arguments ===
+: index
-:(i)
+:; index : Interger - Row to return data for
-:;i : Integer - The team number to retrieve score information for (1..MAX_ALWAYS_UP_UI_FRAMES)
 ----
 === Returns ===
+: text, icon, isFlashing, dynamicIcon, toolTip, dynamicTooltip
-:text, icon, isFlashing, dynamicIcon, tooltip, dynamicTooltip
+:;text : String - Score ([score]/2000 inside [[Arathi Basin]]; [score]/3 inside [[Warsong Gulch]])
-:;text : String - The team's score ("0/3")
+:;icon : String - Icon ({{Alliance Icon Small}} or {{Horde Icon Small}} icon path returned inside [[Warsong Gulch]])
-:;icon : String - The team's icon
+:;isFlashing : Boolean - Wether or not the dynamicIcon should be flashing (it flashes if somebody has the flag)
-:;isFlashing : Boolean - Whether or not the dynamicIcon should be flashing (it flashes when the flag has been picked up)
+:;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]])
-:;dynamicIcon : String - The team's flag icon
+:;tooltip : String - Tooltip displayed when hovering over the row (eg "Horde flag captures")
-:;toolip : String - Info about the icon/text ("Horde flag captures")
+:;dynamicTooltip : String - Tooltip displayed when hovering over the dynamicIcon (eg "Alliance flag has been picked up")
-:;dynamicToolip : String - Info about the dynamicIcon ("Alliance flag has been picked up")
 ----
-{{WoW API}}
+{{wowapi}}