getVisibleMapNames: Difference between revisions
Jump to navigation
Jump to search
(New page: {{MacroFunction |name=getVisibleMapNames |version=1.3b55 |description= Returns the names of all of the player visible maps as either a String List or JSON Array. |usage= <source ...) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getVisibleMapNames() | getVisibleMapNames() | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getVisibleMapNames(delim) | getVisibleMapNames(delim) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|delim|The delimiter to use for the [[String List]]. If the value is {{code|json}} then a [[JSON Array]] is returned.}} | {{param|delim|The delimiter to use for the [[String List]]. If the value is {{code|json}} then a [[JSON Array]] is returned.}} | ||
| Line 17: | Line 17: | ||
|examples= | |examples= | ||
To get the names of all of the player visible maps in a [[String List]]. | To get the names of all of the player visible maps in a [[String List]]. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: maps = getVisibleMapNames()] | [h: maps = getVisibleMapNames()] | ||
</ | </syntaxhighlight> | ||
To get the names of all of the player visible maps in a [[JSON Array]] | To get the names of all of the player visible maps in a [[JSON Array]] | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: maps = getVisibleMapNames("json")] | [h: maps = getVisibleMapNames("json")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|getCurrentMapName}} {{func|getAllMapNames}} | {{func|getCurrentMapName}} {{func|getAllMapNames}} | ||
}} | }} | ||
[[Category: | [[Category:Map Function]] | ||
Latest revision as of 23:59, 14 March 2023
getVisibleMapNames() Function
• Introduced in version 1.3b55
Returns the names of all of the player visible maps as either a String List or JSON Array.
Usage
getVisibleMapNames()getVisibleMapNames(delim)Parameters
delim- The delimiter to use for the String List. If the value isjsonthen a JSON Array is returned.
Examples
To get the names of all of the player visible maps in a String List.
[h: maps = getVisibleMapNames()]To get the names of all of the player visible maps in a JSON Array
[h: maps = getVisibleMapNames("json")]