getVisibleMapDisplayNames: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetVisibleMapDisplayNames to getVisibleMapDisplayNames: Converting page titles to lowercase) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getVisibleMapDisplayNames() | getVisibleMapDisplayNames() | ||
</source> | </source> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getVisibleMapDisplayNames(delim) | getVisibleMapDisplayNames(delim) | ||
</source> | </source> | ||
| Line 17: | Line 17: | ||
|examples= | |examples= | ||
To get the display names of all of the player visible maps in a [[String List]]. | To get the display names of all of the player visible maps in a [[String List]]. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: maps = getVisibleMapNames()] | [h: maps = getVisibleMapNames()] | ||
</source> | </source> | ||
To get the display names of all of the player visible maps in a [[JSON Array]] | To get the display names of all of the player visible maps in a [[JSON Array]] | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: maps = getVisibleMapNames("json")] | [h: maps = getVisibleMapNames("json")] | ||
</source> | </source> | ||
Revision as of 21:11, 14 March 2023
getVisibleMapNames() Function
• Introduced in version 1.9.0
Returns the display names of all of the player visible maps as either a String List or JSON Array.
Usage
<syntaxhighlight lang="mtmacro" line> getVisibleMapDisplayNames() </source> <syntaxhighlight lang="mtmacro" line> getVisibleMapDisplayNames(delim) </source> Parameters
delim- The delimiter to use for the String List. If the value isjsonthen a JSON Array is returned.
Examples
To get the display names of all of the player visible maps in a String List.
<syntaxhighlight lang="mtmacro" line> [h: maps = getVisibleMapNames()] </source>
To get the display names of all of the player visible maps in a JSON Array <syntaxhighlight lang="mtmacro" line> [h: maps = getVisibleMapNames("json")]
</source>