WoW:API GetCurrentMapContinent: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m ({{wowapi}})
Line 1: Line 1:
<center>'''GetCurrentMapContinent''' ''-Documentation by [[user:Meog|Meog]]-''</center>
{{wowapi}}
 
Returns the number of the continent the world map is currently showing
Returns the number of the continent the world map is currently showing


Line 32: Line 31:


: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 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.
----
{{WoW API}}

Revision as of 10:00, 18 June 2006

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 a Battleground map
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.

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.