getAllMapDisplayNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
Line 7: Line 7:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getAllMapDisplayNames()
getAllMapDisplayNames()
getAllMapDisplayNames(delim)
getAllMapDisplayNames(delim)
Line 16: Line 16:
|examples=
|examples=
To get the display names of all of the maps in a [[String List]].
To get the display names of all of the maps in a [[String List]].
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: maps = getAllMapDisplayNames()]
[h: maps = getAllMapDisplayNames()]
</syntaxhighlight>
</syntaxhighlight>


To get the display names of all of the maps in a [[JSON Array]]
To get the display names of all of the maps in a [[JSON Array]]
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: maps = getAllMapDisplayNames("json")]
[h: maps = getAllMapDisplayNames("json")]
</syntaxhighlight>
</syntaxhighlight>

Revision as of 17:53, 14 March 2023

getAllMapDisplayNames() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.9.0
Returns the display names of all of the maps as either a String List or JSON Array.

Usage

getAllMapDisplayNames()
getAllMapDisplayNames(delim)

Parameters

Examples

To get the display names of all of the maps in a String List.
[h: maps = getAllMapDisplayNames()]

To get the display names of all of the maps in a JSON Array

[h: maps = getAllMapDisplayNames("json")]

See Also