getMapName: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetMapName to getMapName: Converting page titles to lowercase)
m (Text replacement - "<source" to "<syntaxhighlight")
Line 5: Line 5:
Returns the GM name of a given map. If the specified map does not exist, an error is produced.
Returns the GM name of a given map. If the specified map does not exist, an error is produced.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getMapName(mapDisplayName)
getMapName(mapDisplayName)
</source>
</source>
Line 11: Line 11:
{{param|mapDisplayName|A string containing the display name of the Map.}}
{{param|mapDisplayName|A string containing the display name of the Map.}}
|examples=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:getMapName("Grasslands")]
[r:getMapName("Grasslands")]
</source>
</source>

Revision as of 18:34, 14 March 2023

getMapName() Function

Introduced in version 1.10.0
Returns the GM name of a given map. If the specified map does not exist, an error is produced.

Usage

<syntaxhighlight lang="mtmacro" line> getMapName(mapDisplayName) </source> Parameters

  • mapDisplayName - A string containing the display name of the Map.

Examples

<syntaxhighlight lang="mtmacro" line>

[r:getMapName("Grasslands")]

</source>

See Also