getAllMapIDs: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=getAllMapMapIDs |version=1.14.0 |description= Returns the unique IDs of all maps. |usage= <syntaxhighlight lang="mtmacro" line> getAllMapIDs() getAllMapIDs(delim)</syntaxhighlight> '''Parameters''' {{param|delim|The delimiter to use for a String List. If the value is json, then a JSON Array is returned.}} |examples= <syntaxhighlight lang="mtmacro" line> [r:getAllMapMapIDs()] </syntaxhighlight> }} Category:Map Function")
 
m (Corrected function names in usage and examples. Was using getMapIDs.)
 
(6 intermediate revisions by 3 users 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>
Line 9: Line 9:
getAllMapIDs(delim)</syntaxhighlight>
getAllMapIDs(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:getAllMapIDs()]
</syntaxhighlight>
</syntaxhighlight>
returns:
<syntaxhighlight lang="mtmacro" line>
399418EA6B644119AD1A2FBA879BD59C,CFCC795805D54AA88997C960F57EC4D2
</syntaxhighlight>


}}
}}

Latest revision as of 23:59, 11 November 2024

getAllMapIDs() Function

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

Usage

getAllMapIDs()
getAllMapIDs(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:getAllMapIDs()]

returns:

399418EA6B644119AD1A2FBA879BD59C,CFCC795805D54AA88997C960F57EC4D2