getMapIDs: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=getMapIDs |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:getAllMapIDs()] </syntaxhighlight> returns: <syntaxhighlight lang="mtmacro" line> 399418EA6B644119A...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
|version=1.14.0
|version=1.14.0
|description=
|description=
Returns the unique IDs of all maps.
Returns the unique ID of a map.
|usage=
|usage=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getAllMapIDs()
getMapIDs(existingMapDisplayName)
getAllMapIDs(delim)</syntaxhighlight>
</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|existingMapDisplayName|An existing map display name. }}
|examples=
|examples=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:getAllMapIDs()]
[r:getMapIDs("Grasslands")]
</syntaxhighlight>
</syntaxhighlight>


returns:
returns:
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
399418EA6B644119AD1A2FBA879BD59C,CFCC795805D54AA88997C960F57EC4D2
399418EA6B644119AD1A2FBA879BD59C
</syntaxhighlight>
</syntaxhighlight>



Latest revision as of 19:35, 16 February 2024

getMapIDs() Function

Introduced in version 1.14.0
Returns the unique ID of a map.

Usage

getMapIDs(existingMapDisplayName)

Parameters

  • existingMapDisplayName - An existing map display name.

Examples

[r:getMapIDs("Grasslands")]

returns:

399418EA6B644119AD1A2FBA879BD59C