WoW:API GetWorldStateUIInfo - Revision history

Move page script: Move page script moved page API GetWorldStateUIInfo to WoW:API GetWorldStateUIInfo without leaving a redirect

2023-08-15T04:46:36Z

Move page script moved page API GetWorldStateUIInfo to API GetWorldStateUIInfo without leaving a redirect

← Older revision

Revision as of 04:46, 15 August 2023

WoWWiki>NanMetal at 23:29, 9 May 2012

2012-05-09T23:29:55Z

← Older revision		Revision as of 23:29, 9 May 2012
Line 1:		Line 1:
	Get score and flag status within a battlefield.		Get score and flag status within a battlefield.

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

	----		----
Line 11:		Line 11:

	=== Returns ===		=== Returns ===
	: uiType, state, text, icon, dynamicIcon, tooltip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3		: uiType, state, hidden, text, icon, dynamicIcon, tooltip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3

	:;uiType : Integer - Unknown, added in 2.1.0.		:;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.		:;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]])		:;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]])		:;icon : String - Icon ({{Alliance Icon Small}} or {{Horde Icon Small}} icon path returned inside [[Warsong Gulch]])

WoWWiki>Riokou: /* Returns */ fixed old AB/EotS max score

2010-07-23T01:15:28Z

Returns: fixed old AB/EotS max score

← Older revision		Revision as of 01:15, 23 July 2010
Line 15:		Line 15:
	:;uiType : Integer - Unknown, added in 2.1.0.		:;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.		:;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]] and [[Eye of the Storm]]; [score]/3 inside [[Warsong Gulch]])		:;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]])		:;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]])		:;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]])

WoWWiki>Sesshu: removed isFlashing

2010-03-27T16:04:24Z

removed isFlashing

← Older revision		Revision as of 16:04, 27 March 2010
Line 1:		Line 1:
	Get score and flag status within a battlefield.		Get score and flag status within a battlefield.

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

	----		----
Line 11:		Line 11:

	=== Returns ===		=== Returns ===
	: uiType, state, text, icon~~, isFlashing~~, dynamicIcon, ~~toolTip~~, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3		: uiType, state, text, icon, dynamicIcon, tooltip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3

	:;uiType : Integer - Unknown, added in 2.1.0.		:;uiType : Integer - Unknown, added in 2.1.0.
Line 17:		Line 17:
	:;text : String - Score ([score]/2000 inside [[Arathi Basin]] and [[Eye of the Storm]]; [score]/3 inside [[Warsong Gulch]])		:;text : String - Score ([score]/2000 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]])		:;icon : String - Icon ({{Alliance Icon Small}} or {{Horde Icon Small}} icon path returned inside [[Warsong Gulch]])
	~~:;isFlashing : Boolean - Whether 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]])		:;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")		:;tooltip : String - Tooltip displayed when hovering over the row (eg "Horde flag captures")

WoWWiki>Egingell at 21:06, 4 September 2007

2007-09-04T21:06:47Z

← Older revision		Revision as of 21:06, 4 September 2007
Line 1:		Line 1:
	Get score and flag status within a battlefield.		Get score and flag status within a battlefield.

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

	----		----
Line 31:		Line 31:

	: 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.		: 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 [[API_GetNumWorldStateUI\|GetNumWorldStateUI]]())
	: 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]].		: 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]].

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

WoWWiki>Syzgyn: /* Details */ fixed disambiguation

2007-08-29T01:20:54Z

Details: fixed disambiguation

← Older revision		Revision as of 01:20, 29 August 2007
Line 31:		Line 31:

	: 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.		: 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.
	: In [[The Burning Crusade]] this is used for more then just PvP, you can find it used for some instances like [[Black Morass]].		: 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]].

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

WoWWiki>OfTheTempest: sp

2007-08-18T14:38:56Z

← Older revision		Revision as of 14:38, 18 August 2007
Line 17:		Line 17:
	:;text : String - Score ([score]/2000 inside [[Arathi Basin]] and [[Eye of the Storm]]; [score]/3 inside [[Warsong Gulch]])		:;text : String - Score ([score]/2000 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]])		:;icon : String - Icon ({{Alliance Icon Small}} or {{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)		:;isFlashing : Boolean - Whether 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]])		:;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")		:;tooltip : String - Tooltip displayed when hovering over the row (eg "Horde flag captures")

WoWWiki>Shadowed: /* Details */

2007-05-23T00:57:24Z

Details

← Older revision		Revision as of 00:57, 23 May 2007
Line 11:		Line 11:

	=== Returns ===		=== Returns ===
	: state, text, icon, isFlashing, dynamicIcon, toolTip, dynamicTooltip, extendedUI, extendedUIState1, extendedUIState2, extendedUIState3		: uiType, state, text, icon, isFlashing, 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.		:;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]] 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]])		:;icon : String - Icon ({{Alliance Icon Small}} or {{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)		:;isFlashing : Boolean - Wether or not the dynamicIcon should be flashing (it flashes if somebody has the flag)
Line 24:		Line 25:
	:;extendedUIState2 : Integer - for CaptureBar: current objective position : 100 means left, 0 means right,		:;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.		:;extendedUIState3 : Integer - for CaptureBar: neutral zone width : 0 means no neutral zone, 90 means 5% Alliance, 90% neutral and 5% Horde.

			----

			=== Details ===

			: 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.
			: In [[The Burning Crusade]] this is used for more then just PvP, you can find it used for some instances like [[Black Morass]].

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

WoWWiki>WoWWiki-Elisios: /* Returns */

2007-01-25T13:58:39Z

Returns

← Older revision		Revision as of 13:58, 25 January 2007
Line 20:		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~~		:;extendedUI : String - "CAPTUREPOINT" for objective capture bar, "" for regular objectives,
	:;extendedUIState1 : ? - ~~unknown~~		:;extendedUIState1 : Integer - for CaptureBar: bar index,
	:;extendedUIState2 : ? - ~~unknown~~		:;extendedUIState2 : Integer - for CaptureBar: current objective position : 100 means left, 0 means right,
	:;extendedUIState3 : ? - ~~unknown~~		:;extendedUIState3 : Integer - for CaptureBar: neutral zone width : 0 means no neutral zone, 90 means 5% Alliance, 90% neutral and 5% Horde.

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

WoWWiki>Delee: /* Returns */

2006-09-20T11:07:12Z

Returns

← Older revision		Revision as of 11:07, 20 September 2006
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]])