setMapDisplayName: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page SetMapDisplayName to setMapDisplayName: Converting page titles to lowercase) |
No edit summary |
||
| (One intermediate revision by the same 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= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setMapDisplayName( | setMapDisplayName(mapRef, newMapDisplayName) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{param|mapRef|Name or ID 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= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r:setMapDisplayName("Swamp Temple of the Lizardfolk","Swampy Marsh")] | [r:setMapDisplayName("Swamp Temple of the Lizardfolk","Swampy Marsh")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|setMapName}}, {{func|getMapDisplayName}} | {{func|setMapName}}, {{func|getMapDisplayName}} | ||
Latest revision as of 23:59, 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(mapRef, newMapDisplayName)Parameters
mapRef- Name or ID 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")]