Changes: Arcanist

Revision as of 13:06, 18 April 2011

Get score and flag status within a battlefield.

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

Arguments

index: Number : between 1 and GetNumWorldStateUI().

Returns

uiType: Number - 1 if the element should be conditionally displayed (based on the state of the "Show World PvP Objectives" setting and the player's location).
state: Number - 0 indicates the element will not be displayed. In Warsong Gulch, returns 1 if the team does not hold the enemy flag and 2 if the team does.
text: String - Score ([score]/1600 inside Arathi Basin and Eye of the Storm; [score]/3 inside Warsong Gulch)
icon: String - Icon ( or 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: Number - for CaptureBar: bar index,
extendedUIState2: Number - for CaptureBar: current objective position : 100 means left, 0 means right,
extendedUIState3: Number - 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.
- 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.

@@ Line 1: / Line 1: @@
-{{RPG}}
+{{wowapi}}
+Get score and flag status within a battlefield.
-[[Image:Arcanist.JPG|thumb]]Arcane magic is a volatile and inebriating drug, pure power distilled and channeled through the body to create arcane effects.  Many races wield arcane power carelessly, disregarding the lessons of the past.  The arcanist class encompasses all users of arcane magic - those who seek power without regard for consequences, and those who think arcane might can be handled responsibly; each arcane spellcaster chooses a distinct path.  Those who wish to manipulate arcane magic often choose between the way of the mage, necromancer or warlock.  Each path specializes in a particular kind of magic, which reflects the nature and practice of the arcane arts on Azeroth.  In a world forged in war and beset by pervasive evils such as the Scourge and the Burning Legion, arcanists have gradually come to excel in specific areas of arcane magic.  What Azeroth's arcanists lack in versatility, however, they more than make up for in the abilities they acquire and the powers they wield within their chosen paths.
+ uiType, state, text, icon, dynamicIcon, tooltip, dynamicTooltip,
+  extendedUI, extendedUIState1, extendedUIState2, extendedUIState3 = GetWorldStateUIInfo(index);
+== Arguments ==
-Dwarves, gnomes, high elves, humans, trolls and Forsaken are all capable of becoming mages.  The dark path of the necromancer is rarely taken. Humans and the Forsaken practice this black art, while most other races seem not to have the stomach for such magic.  Warlocks are uncommon. Some exist among the Forsaken, outcast gnomes, or humans and orcs foolish enough to toy with the forces of demonic energy.  The few remaining high elves who are warlocks have long since become blood elves. Arcanists can have the best of intentions, and while mages mostly tend to be from the good and lawful alignments, necromancers and warlocks tend to come form the more unsavory levels of morality.
+; index : Number : between 1 and [[API GetNumWorldStateUI|GetNumWorldStateUI()]].
+== Returns ==
-Arcanists are found among all of the affiliations, regardless of their practices, in both the Horde and the Alliance.  Warlocks are far more common in the Alliance, surprisingly enough - the fact that the use of arcane magic is so prevalent in the Alliance possibly allows for such reckless practices.  Still, mages are far more common in the Alliance, outnumbering warlocks immensely. Necromancers are almost unheard of until someone encounters one.{{Cite|WoWRPG|56-57}}
+;uiType : Number - 1 if the element should be conditionally displayed (based on the state of the "Show World PvP Objectives" setting and the player's location).
+;state : Number - 0 indicates the element will not be displayed. In [[Warsong Gulch]], returns 1 if the team does not hold the enemy flag and 2 if the team does.
+;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 : Number - for CaptureBar: bar index,
+;extendedUIState2 : Number - for CaptureBar: current objective position : 100 means left, 0 means right,
+;extendedUIState3 : Number - for CaptureBar: neutral zone width : 0 means no neutral zone, 90 means 5% Alliance, 90% neutral and 5% Horde.
+== Details ==
-Not all arcanists devote themselves to one type of arcane art.  One of the most famous arcanists is [[Arcanist Doan]], the keeper of the [[Scarlet Monastery]]'s Library. Other arcanists include [[Arcanist Nozzlespring]] and [[Arcanist Vandril]].
+* 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.
-==Arcanist Paths==
+** 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]]())
-*[[Wizard]]
+* 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]].
-*[[Sorcerer]]
-*[[Mage lore|Mage]]
-*[[Focused mage]]
-*[[Warlock lore|Warlock]]
-*[[Inscriber]]
-*[[Archmage]]
-*[[Necromancer]]
-*[[Necrolyte]]
-*[[Warmage]]
-*[[Conjuror]]
-*[[Enchanter]]
-*[[Ley Walker]]
-*[[Runemaster]]
-*[[Graven One]]
-*[[Techno Mage]]
-==Famous/Named==
-*[[Arcanist Doan]]
-*[[Arcanist Nozzlespring]]
-*[[Arcanist Vandril]]
-[[Category:Classes]][[Category:Core Classes]][[Category:RPG Classes]]