getVisibleMapDisplayNames: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{MacroFunction |name=getVisibleMapNames |version=1.9.0 |description= Returns the display names of all of the player visible maps as either a String List or JSON Array...") |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getVisibleMapDisplayNames() | getVisibleMapDisplayNames() | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getVisibleMapDisplayNames(delim) | getVisibleMapDisplayNames(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 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()] | ||
</ | </syntaxhighlight> | ||
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")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|getMapDisplayName}} {{func|getAllMapDisplayNames}} | {{func|getMapDisplayName}} {{func|getAllMapDisplayNames}} | ||
Latest revision as of 21:13, 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
getVisibleMapDisplayNames()getVisibleMapDisplayNames(delim)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.
[h: maps = getVisibleMapNames()]To get the display names of all of the player visible maps in a JSON Array
[h: maps = getVisibleMapNames("json")]