getMapDisplayName: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetMapDisplayName to getMapDisplayName: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 8: Line 8:
getMapDisplayName()
getMapDisplayName()
getMapDisplayName(mapName)
getMapDisplayName(mapName)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|mapName|Optional. A string containing the name of the Map.}}
{{param|mapName|Optional. A string containing the name of the Map.}}
Line 15: Line 15:
[r:getMapDisplayName()]
[r:getMapDisplayName()]
[r:getMapDisplayName("Grasslands")]
[r:getMapDisplayName("Grasslands")]
</source>
</syntaxhighlight>
}}
}}
[[Category:Map Function]]
[[Category:Map Function]]

Revision as of 18:26, 14 March 2023

getMapDisplayName() Function

Introduced in version 1.9.0
Returns the display name of a given map. If no map is specified the current map is selected.

Usage

<source lang="mtmacro" line> getMapDisplayName() getMapDisplayName(mapName) </syntaxhighlight> Parameters

  • mapName - Optional. A string containing the name of the Map.

Examples

<source lang="mtmacro" line>

[r:getMapDisplayName()] [r:getMapDisplayName("Grasslands")]

</syntaxhighlight>