Meog37442@legacy41557445 (talk | contribs) No edit summary |
Flickering19966@legacy41540688 (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
<center>'''GetCurrentMapZone''' ''-Documentation by [[user:Meog|Meog]]-''</center> |
<center>'''GetCurrentMapZone''' ''-Documentation by [[user:Meog|Meog]]-''</center> |
||
− | Returns the |
+ | Returns the index of the zone the world map is currently showing |
− | GetCurrentMapZone(); |
+ | zoneIndex = GetCurrentMapZone(); |
---- |
---- |
||
Line 13: | Line 13: | ||
;''Returns'' |
;''Returns'' |
||
+ | :zoneIndex |
||
− | :Number zone |
||
+ | :;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. |
||
− | :;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. |
||
---- |
---- |
||
;''Example'' |
;''Example'' |
||
+ | |||
local zone = GetCurrentMapZone(); |
local zone = GetCurrentMapZone(); |
||
− | |||
;''Result'' |
;''Result'' |
||
10 |
10 |
||
---- |
---- |
||
− | ;'' |
+ | ;''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}} |
{{Template:WoW API}} |
Revision as of 20:59, 26 December 2004
Returns the index of the zone the world map is currently showing
zoneIndex = GetCurrentMapZone();
- Arguments
- none
- Returns
- zoneIndex
- zoneIndex
- Number - The index of the currently displayed zone within the continent (obtained via GetMapZones(continentIndex), or 0 if showing the entire continent.
- Example
local zone = GetCurrentMapZone();
- Result
10
- Details
- 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.
Template:WoW API