WoW:API GetMapContinents: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Recategorized)
m (Move page script moved page API GetMapContinents to API GetMapContinents without leaving a redirect)
 
(9 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<center>'''GetMapContinents''' ''-Documentation by [[user:Meog|Meog]]-''</center>
{{wowapi}} __NOTOC__
 
Returns a list of continent names.
Returns a list of continent names
 
  continent_1, continent_2, ..., continent_N = GetMapContinents();
  continent_1, continent_2, ..., continent_N = GetMapContinents();


----
==Parameters==
;''Arguments''
===Returns===
 
:''none''
 
----
;''Returns''
 
:continent_1, continent_2, ..., continent_N
:continent_1, continent_2, ..., continent_N
:;continent_<i>i</i> : String - The name of the <i>i</i>'th continent, (i corresponds to the value [[API GetCurrentMapContinent|GetCurrentMapContinent()]] returns)
:;continent_''i'' : String - The name of the ''<nowiki>i'</nowiki>''th continent, (i corresponds to the value [[API GetCurrentMapContinent|GetCurrentMapContinent()]] returns)
 
----
;''Example''


  continentNames = {};
==Example==
   
  local continentNames, key, val = { GetMapContinents() } ;
function LoadContinents(...)
  for key, val in pairs(continentNames) do
    for i=1, arg.n, 1 do
  DEFAULT_CHAT_FRAME:AddMessage("#" .. key .. ": " .. val);
      continentNames[i] = arg[i];
    end
  end
  end
LoadContinents(GetMapContinents());
Note that this can also be achieved with
continentNames = { GetMapContinents() } ;
;''Result''
The array ContinentNames holds all available continent names:
ContinentNames[1] == "Kalimdor"
ContinentNames[2] == "Eastern Kingdoms"


----
===Result===
;''Details''
A list of the continent names is displayed in the default chat frame.


: At release this will be only two: "Kalimdor" and "Eastern Kingdoms", but when using this function keep in mind, that there maybe more sometime after release, and that they may get added before the existing ones.
#1: Kalimdor
<nowiki>#</nowiki>2: Eastern Kingdoms
<nowiki>#3: Outland
#4: Northrend
#</nowiki>5: The Maelstrom
<nowiki>#6: Pandaria
#</nowiki>7: Draenor


----
==Details==
{{Template:WoW API}}
Note that as more expansions are releases, the output of this function may change.
[[Category:API World Map Functions|GetMapContinents]]

Latest revision as of 04:46, 15 August 2023

WoW API < GetMapContinents

Returns a list of continent names.

continent_1, continent_2, ..., continent_N = GetMapContinents();

Parameters

Returns

continent_1, continent_2, ..., continent_N
continent_i
String - The name of the i'th continent, (i corresponds to the value GetCurrentMapContinent() returns)

Example

local continentNames, key, val = { GetMapContinents() } ;
for key, val in pairs(continentNames) do
 DEFAULT_CHAT_FRAME:AddMessage("#" .. key .. ": " .. val);
end

Result

A list of the continent names is displayed in the default chat frame.

#1: Kalimdor
#2: Eastern Kingdoms
#3: Outland
 #4: Northrend
 #5: The Maelstrom
#6: Pandaria
 #7: Draenor

Details

Note that as more expansions are releases, the output of this function may change.