WoW:API GetCurrentMapZone: Difference between revisions

WoW:API GetCurrentMapZone (source)

27 bytes removed , 27 May 2007

localization detail + reformat

Anonymous user

@@ Line 1: / Line 1: @@
- <center>'''GetCurrentMapZone''' ''-Documentation by [[user:Meog|Meog]]-''</center>
+{{wowapi}} __NOTOC__
 Returns the index of the zone the world map is currently showing
   zoneIndex = GetCurrentMapZone();
-----
+==Returns==
-;''Arguments''
-:''none''
-----
-;''Returns''
 :zoneIndex
 :;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==
-;''Example''
+  message(GetCurrentMapZone());
-  local zone = GetCurrentMapZone();
-;''Result''
+===Result===
-----
+== Notes==
-;''Details''
+* 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.
+* Note that zone IDs returned by this function are not the same across all localizations of World of Warcraft.
-: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.
-----
-{{WoW API}}