Wikia

WoWWiki

Changes: API GetCurrentMapZone

Edit

Back to page

m ({{wowapi}})
(localization detail + reformat)
 
Line 1: Line 1:
{{wowapi}}
+
{{wowapi}} __NOTOC__
 
Returns the index of the zone the world map is currently showing
 
Returns the index of the zone the world map is currently showing
   
 
zoneIndex = GetCurrentMapZone();
 
zoneIndex = GetCurrentMapZone();
   
----
+
==Returns==
;''Arguments''
 
 
:''none''
 
 
----
 
;''Returns''
 
 
 
:zoneIndex
 
: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.
 
:;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===
 
10
 
10
   
----
+
== 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.
 

Latest revision as of 15:39, May 27, 2007

WoW API < GetCurrentMapZone

Returns the index of the zone the world map is currently showing

zoneIndex = GetCurrentMapZone();

ReturnsEdit

zoneIndex
zoneIndex 
Number - The index of the currently displayed zone within the continent (obtained via GetMapZones(continentIndex)), or 0 if showing the entire continent.

ExampleEdit

message(GetCurrentMapZone());

ResultEdit

10

NotesEdit

  • Note that the value returned represents the map display, and not necessarily the player's actual location. The 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.

Around Wikia's network

Random Wiki