getVisibleMapNames: 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 6: Line 6:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getVisibleMapNames()
getVisibleMapNames()
</syntaxhighlight>
</syntaxhighlight>
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getVisibleMapNames(delim)
getVisibleMapNames(delim)
</syntaxhighlight>
</syntaxhighlight>
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]].
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: maps = getVisibleMapNames()]
[h: maps = getVisibleMapNames()]
</syntaxhighlight>
</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]]
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: maps = getVisibleMapNames("json")]
[h: maps = getVisibleMapNames("json")]
</syntaxhighlight>
</syntaxhighlight>

Revision as of 20:55, 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

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")]

See Also