Meog37442@legacy41557445 (talk | contribs) No edit summary |
(localization detail + reformat) |
||
(8 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
+ | {{wowapi}} __NOTOC__ |
||
− | <center>'''GetCurrentMapZone''' ''-Documentation by [[user:Meog|Meog]]-''</center> |
||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
+ | :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. |
||
⚫ | |||
− | ---- |
||
⚫ | |||
− | ;''Arguments'' |
||
− | |||
− | :''none'' |
||
− | |||
− | ---- |
||
⚫ | |||
− | |||
− | :Number zone |
||
− | :;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. |
||
− | |||
− | ---- |
||
⚫ | |||
⚫ | |||
⚫ | |||
− | |||
⚫ | |||
10 |
10 |
||
+ | == Notes== |
||
− | ---- |
||
+ | * 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. |
||
− | ;''Description'' |
||
+ | * Note that zone IDs returned by this function are not the same across all localizations of World of Warcraft. |
||
− | |||
− | : Returns the number of the zone the world map is currently showing |
||
− | |||
− | ---- |
||
− | {{Template:WoW API}} |
Revision as of 15:39, 27 May 2007
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Returns the index of the zone the world map is currently showing
zoneIndex = GetCurrentMapZone();
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
message(GetCurrentMapZone());
Result
10
Notes
- 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.