getMapName: Difference between revisions
Jump to navigation
Jump to search
(#2775) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| (6 intermediate revisions by 3 users not shown) | |||
| 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= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getMapName(mapDisplayName) | getMapName(mapDisplayName) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|mapDisplayName|A string containing the display name of the Map.}} | {{param|mapDisplayName|A string containing the display name of the Map.}} | ||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r:getMapName("Grasslands")] | [r:getMapName("Grasslands")] | ||
</ | </syntaxhighlight> | ||
|also= | |||
{{func|setMapName}}, {{func|setMapDisplayName}}, {{func|getMapDisplayName}} | |||
}} | }} | ||
[[Category:Map Function]] | [[Category:Map Function]] | ||
Latest revision as of 23:59, 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
getMapName(mapDisplayName)Parameters
mapDisplayName- A string containing the display name of the Map.
Examples
[r:getMapName("Grasslands")]