WoW:API GetCurrentMapZone: Difference between revisions
Jump to navigation
Jump to search
GetCurrentMapZone -Documentation by Meog-
No edit summary |
m (Recategorizations) |
||
| 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 | ||
:; | :;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'' | ||
local zone = GetCurrentMapZone(); | local zone = GetCurrentMapZone(); | ||
;''Result'' | ;''Result'' | ||
10 | 10 | ||
---- | ---- | ||
;'' | ;''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. | |||
---- | ---- | ||
{{Template:WoW API}} | {{Template:WoW API}} | ||
[[Category:API World Map Functions|GetCurrentMapZone]] | |||
Revision as of 19:18, 28 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.