WoW:API GetMapZones: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Recategorization)
Line 1: Line 1:
  <center>'''GetMapZones''' ''-Documentation by [[user:Meog|Meog]]-''</center>
  <center>'''GetMapZones''' ''-Documentation by [[user:Meog|Meog]]-''</center>


Returns the zone names of one continent
Returns the zone names of a continent


  GetMapZones(continent);
  zone_1, zone_2, ..., zone_N = GetMapZones(continentIndex);


----
----
;''Arguments''
;''Arguments''


:Number continent
:(continentIndex)
:;continent : number of the continent you want to get the zones. The numbers equal the values of [[API_GetCurrentMapContinent]].<br>1: Kalimdor<br>2: Eastern Kingdoms
:;continentIndex : Number - Which continent to fetch the zone list from (continent indexes refer to the result of [[API GetMapContinents|GetMapContinents()]]). Currently the values are 1 for Kalimdor, and 2 for Eastern Kingdoms.


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


:String zone_1, String zone_2, ..., String zone_n
:zone_1, zone_2, ..., zone_N
:;zone_i : string, holds one zone name (i is equal to the value [[API_GetCurrentMapZone]] returns)
:;zone_<i>i</i> : String - The name of the <i>i</i>'th zone within the continent (<i>i</i> corresponds to the value [[API_GetCurrentMapZone|GetCurrentMapZone()]] returns)


----
----
Line 28: Line 28:
   
   
  LoadZones(GetMapZones(2)); -- Eastern Kingdoms
  LoadZones(GetMapZones(2)); -- Eastern Kingdoms
Note that this is equivalent to
ZoneNames = { GetMapZones(2) } ;


;''Result''
;''Result''
Line 37: Line 41:


----
----
;''Description''
;''Details''
 
: There are a different number of zones on each continent and these may change without notice as new content is added. Use the name of a zone if you wish to make your code future-proof.


: Returns the zone names. There is a different number of zones on each continent.
----
----
{{Template:WoW API}}
{{Template:WoW API}}
[[Category:API World Map Functions|GetMapZones]]

Revision as of 19:19, 28 December 2004

GetMapZones -Documentation by Meog-

Returns the zone names of a continent

zone_1, zone_2, ..., zone_N = GetMapZones(continentIndex);

Arguments
(continentIndex)
continentIndex
Number - Which continent to fetch the zone list from (continent indexes refer to the result of GetMapContinents()). Currently the values are 1 for Kalimdor, and 2 for Eastern Kingdoms.

Returns
zone_1, zone_2, ..., zone_N
zone_i
String - The name of the i'th zone within the continent (i corresponds to the value GetCurrentMapZone() returns)

Example
ZoneNames = {};

function LoadZones(...)
   for i=1, arg.n, 1 do
      ZoneNames[i] = arg[i];
   end
end

LoadZones(GetMapZones(2)); -- Eastern Kingdoms

Note that this is equivalent to

ZoneNames = { GetMapZones(2) } ;
Result
The array ZoneNames holds all available zone names of the Eastern Kingdoms:
ZoneNames[1] == "Alterac Mountains"
ZoneNames[2] == "Arathi Highlands"
...
ZoneNames[25] == "Wetlands"

Details
There are a different number of zones on each continent and these may change without notice as new content is added. Use the name of a zone if you wish to make your code future-proof.

Template:WoW API