WoW:API GetCurrentMapContinent: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Recategorized)
Line 3: Line 3:
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 13:
;''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.
::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.


----
----
Line 25: Line 28:


----
----
;''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}}
{{Template:WoW API}}
[[Category:API World Map Functions|GetCurrentMapContinent]]

Revision as of 19:18, 28 December 2004

GetCurrentMapContinent -Documentation by Meog-

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

Template:WoW API