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")
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
Returns the display name of a given map. If no map is specified the current map is selected.
Returns the display name of a given map. If no map is specified the current map is selected.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getMapDisplayName()
getMapDisplayName()
getMapDisplayName(mapName)
getMapDisplayName(mapRef)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|mapName|Optional. A string containing the name of the Map.}}
{{param|mapRef|Optional. The Name or ID of the Map.}}
|examples=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:getMapDisplayName()]
[r:getMapDisplayName()]
[r:getMapDisplayName("Grasslands")]
[r:getMapDisplayName("Grasslands")]
</source>
</syntaxhighlight>
}}
}}
[[Category:Map Function]]
[[Category:Map Function]]

Latest revision as of 23:59, 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

getMapDisplayName()
getMapDisplayName(mapRef)

Parameters

  • mapRef - Optional. The Name or ID of the Map.

Examples

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