WoW:API GetCurrentMapContinent: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Recategorized)
m (Move page script moved page API GetCurrentMapContinent to API GetCurrentMapContinent without leaving a redirect)
 
(11 intermediate revisions by 11 users not shown)
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 15: 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.
::0 - if showing the entire world (both continents)
::-1 - if showing the cosmic map or a Battleground map. Also when showing The Scarlet Enclave, the Death Knights' starting area.
::1 - if showing the first continent (currently Kalimdor), or a zone map within it.
::0 - if showing the entire world of Azeroth (all three continents - Kalimdor, Eastern Kingdoms & Northrend)
::2 - if showing the second continent (currently Eastern Kingdoms), or a zone map within it.
::1 - if showing Kalimdor, or a zone map within it
 
::2 - if showing Eastern Kingdoms, or a zone map within it
::3 - if showing Outland, or a zone map within it
::4 - if showing Northrend, or a zone map within it
::5 - if showing The Maelstrom, or a zone map within it
::6 - if showing Pandaria, or a zone map within it
::7 - if showing Draenor, or a zone map within it
----
----
;''Example''
;''Example''
Line 30: Line 34:
;''Details''
;''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.
*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.
 
*However for macros since, the map display is reset to the players location when the world map is closed, this can be used as the players location.
----
{{Template:WoW API}}
[[Category:API World Map Functions|GetCurrentMapContinent]]

Latest revision as of 04:45, 15 August 2023

← 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 of Azeroth (all three continents - Kalimdor, Eastern Kingdoms & Northrend)
1 - if showing Kalimdor, or a zone map within it
2 - if showing Eastern Kingdoms, or a zone map within it
3 - if showing Outland, or a zone map within it
4 - if showing Northrend, or a zone map within it
5 - if showing The Maelstrom, or a zone map within it
6 - if showing Pandaria, or a zone map within it
7 - if showing Draenor, 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.
  • However for macros since, the map display is reset to the players location when the world map is closed, this can be used as the players location.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetCurrentMapContinent&oldid=18999"