WoW API: GetMapZones

From AddOn Studio
Revision as of 09:32, 20 January 2007 by WoWWiki>VoidvectorBot (Robot: converting/fixing HTML)
Jump to navigation Jump to search

WoW API < GetMapZones

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.
Beware : zone names depend on locale, and zone number too because GetMapZones() returns them in alphabetical order. So french and german clients do not have the zones returned in the same order than english ones, see the table of localized map zones.