WoW:API GetMapContinents: Difference between revisions

← Older edit

WoW:API GetMapContinents (source)

Revision as of 04:46, 15 August 2023

48 bytes removed , 15 August 2023

m

Move page script moved page API GetMapContinents to WoW:API GetMapContinents without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-  <center>'''GetMapContinents''' ''-Documentation by [[user:Meog|Meog]]-''</center>
+{{wowapi}} __NOTOC__
+Returns a list of continent names.
+  continent_1, continent_2, ..., continent_N = GetMapContinents();
-Returns the continent names
+==Parameters==
+===Returns===
+:continent_1, continent_2, ..., continent_N
+:;continent_''i'' : String - The name of the ''<nowiki>i'</nowiki>''th continent, (i corresponds to the value [[API GetCurrentMapContinent|GetCurrentMapContinent()]] returns)
-  GetMapContinents();
+==Example==
+  local continentNames, key, val = { GetMapContinents() } ;
-----
+ for key, val in pairs(continentNames) do
-;''Arguments''
+  DEFAULT_CHAT_FRAME:AddMessage("#" .. key .. ": " .. val);
-:''none''
-----
-;''Returns''
-:String continent_1, String continent_2, ..., String continent_n
-:;continent_i : string, holds one continent name (i is equal to the value [[API_GetCurrentMapContinent]] returns)
-----
-;''Example''
- ContinentNames = {};
- function LoadContinents(...)
-    for i=1, arg.n, 1 do
-       ContinentNames[i] = arg[i];
-    end
   end
- LoadContinents(GetMapContinents());
-;''Result''
- The array ContinentNames holds all available continent names:
- ContinentNames[1] == "Kalimdor"
- ContinentNames[2] == "Eastern Kingdoms"
-----
+===Result===
-;''Description''
+A list of the continent names is displayed in the default chat frame.
-: Returns the continent names. 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.
+ #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.