setMapDisplayName: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 6: Line 6:
Changes the display name of a specified map.
Changes the display name of a specified map.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setMapDisplayName(mapName, newMapDisplayName)
setMapDisplayName(mapName, newMapDisplayName)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|mapName|String specifying the name of the map you wish to give a new display name.}}
{{param|mapName|String specifying the name of the map you wish to give a new display name.}}
{{param|newMapDisplayName|A string containing the name to which the display name should be set.}}
{{param|newMapDisplayName|A string containing the name to which the display name should be set.}}
|examples=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:setMapDisplayName("Swamp Temple of the Lizardfolk","Swampy Marsh")]
[r:setMapDisplayName("Swamp Temple of the Lizardfolk","Swampy Marsh")]
</source>
</syntaxhighlight>
|also=
|also=
{{func|setMapName}}, {{func|getMapDisplayName}}
{{func|setMapName}}, {{func|getMapDisplayName}}

Latest revision as of 20:50, 14 March 2023

setMapDisplayName() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.9.0
Changes the display name of a specified map.

Usage

setMapDisplayName(mapName, newMapDisplayName)

Parameters

  • mapName - String specifying the name of the map you wish to give a new display name.
  • newMapDisplayName - A string containing the name to which the display name should be set.

Examples

[r:setMapDisplayName("Swamp Temple of the Lizardfolk","Swampy Marsh")]

See Also