getAllMapIDs: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=getAllMapMapIDs
|name=getAllMapIDs
|version=1.14.0
|version=1.14.0
|description=
|description=
Returns the unique IDs of all maps.
Returns the IDs of all maps with the given name.
|usage=
|usage=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getAllMapIDs()
getMapIDs()
getAllMapIDs(delim)</syntaxhighlight>
getMapIDs(delim)</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|delim|The delimiter to use for a String List. If the value is json, then a JSON Array is returned.}}
{{param|delim|The delimiter to use for a String List. If the value is json, then a JSON Array is returned. Defaults to {{code|,}}}}
|examples=
|examples=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:getAllMapMapIDs()]
[r:getMapIDs()]
</syntaxhighlight>
 
returns:
returns:
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
Line 18: Line 20:
</syntaxhighlight>
</syntaxhighlight>


</syntaxhighlight>
 


}}
}}

Latest revision as of 19:26, 16 February 2024

getAllMapIDs() Function

Introduced in version 1.14.0
Returns the IDs of all maps with the given name.

Usage

getMapIDs()
getMapIDs(delim)

Parameters

  • delim - The delimiter to use for a String List. If the value is json, then a JSON Array is returned. Defaults to ,

Examples

[r:getMapIDs()]

returns:

399418EA6B644119AD1A2FBA879BD59C,CFCC795805D54AA88997C960F57EC4D2