WoW:API GetCurrentMapZone: Difference between revisions

WoW:API GetCurrentMapZone (source)

246 bytes added , 28 December 2004

m

Recategorizations

Anonymous user

@@ Line 1: / Line 1: @@
   <center>'''GetCurrentMapZone''' ''-Documentation by [[user:Meog|Meog]]-''</center>
-Returns the number of the zone the world map is currently showing
+Returns the index of the zone the world map is currently showing
-  GetCurrentMapZone();
+  zoneIndex = GetCurrentMapZone();
 ----
@@ Line 13: / Line 13: @@
 ;''Returns''
-:Number zone
+:zoneIndex
-:;zone : 0, if showing one of the continent overviews<br>positive number, if showing a zone map. The zones are numbered alphabetically from 1 for each continent.
+:;zoneIndex : Number - The index of the currently displayed zone within the continent (obtained via [[API GetMapZones|GetMapZones(continentIndex)]]), or 0 if showing the entire continent.
 ----
 ;''Example''
   local zone = GetCurrentMapZone();
 ;''Result''
 ----
-;''Description''
+;''Details''
-: Returns the number of the zone the world map is currently showing
+:Note that the value returned represents the map display, and not necessarily the player's actual location. The [[API SetMapToCurrentZone|SetMapToCurrentZone()]] function will reset the values to represent the player's location.
 ----
 {{Template:WoW API}}
+[[Category:API World Map Functions|GetCurrentMapZone]]