WoW:API GetCurrentMapContinent: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API GetCurrentMapContinent to API GetCurrentMapContinent without leaving a redirect)
 
(12 intermediate revisions by 12 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


  GetCurrentMapContinent();
  continent = GetCurrentMapContinent();


----
----
Line 13: Line 12:
;''Returns''
;''Returns''


:Number continent
:continent
:;continent : 0, if showing the map with both continents<br>1, if showing Kalimdor or a zone map of Kalimdor<br>2, if showing the Eastern Kingdoms or a zone map of the Eastern Kingdoms
:;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. 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''
;''Example''
Line 25: Line 32:


----
----
;''Description''
;''Details''
 
: Returns the number of the continent the world map is currently showing


----
*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}}
*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.

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"