WoW:API GetCurrentMapContinent: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Add cosmic map)
No edit summary
Line 14: Line 14:
:continent
:continent
:;continent : Number - Indicates which continent (from [[API GetMapContinents | GetMapContinents()]]) the map is currently showing, or 0 for all.
:;continent : Number - Indicates which continent (from [[API GetMapContinents | GetMapContinents()]]) the map is currently showing, or 0 for all.
::-1 - if showing the cosmic map or a Battleground map
::-1 - if showing the cosmic map or a Battleground map. Also when showing The Scarlet Enclave, the Death Knights' starting area.
::0 - if showing the entire world (both continents)
::0 - if showing the entire world (both continents)
::1 - if showing the first continent (currently Kalimdor), or a zone map within it.
::1 - if showing the first continent (currently Kalimdor), or a zone map within it.
::2 - if showing the second continent (currently Eastern Kingdoms), or a zone map within it.
::2 - if showing the second continent (currently Eastern Kingdoms), or a zone map within it.
::3 - if showing the Outland, or a zone map within it.
::3 - if showing the Outland, or a zone map within it.
 
::4 - if showing Northrend, or a zone map within it.
----
----
;''Example''
;''Example''

Revision as of 01:38, 14 November 2008

WoW API < GetCurrentMapContinent

Returns the number of the continent the world map is currently showing

continent = GetCurrentMapContinent();

Arguments
none

Returns
continent
continent
Number - Indicates which continent (from GetMapContinents()) the map is currently showing, or 0 for all.
-1 - if showing the cosmic map or a Battleground map. Also when showing The Scarlet Enclave, the Death Knights' starting area.
0 - if showing the entire world (both continents)
1 - if showing the first continent (currently Kalimdor), or a zone map within it.
2 - if showing the second continent (currently Eastern Kingdoms), or a zone map within it.
3 - if showing the Outland, or a zone map within it.
4 - if showing Northrend, or a zone map within it.

Example
local continent = GetCurrentMapContinent();

Result
2

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.