setMapVisible: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page SetMapVisible to setMapVisible: Converting page titles to lowercase) |
No edit summary |
||
Line 6: | Line 6: | ||
Sets a maps visibility to players to {{true}} or {{false}}. If no map is specified the current map is selected. | Sets a maps visibility to players to {{true}} or {{false}}. If no map is specified the current map is selected. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setMapVisible(visible) | setMapVisible(visible) | ||
setMapVisible(visible, mapName) | setMapVisible(visible, mapName) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|visible|Whether or not the map can be seen by players, {{true}} or {{false}}.}} | {{param|visible|Whether or not the map can be seen by players, {{true}} or {{false}}.}} | ||
{{param|mapName|A string containing the name of the Map.}} | {{param|mapName|A string containing the name of the Map.}} | ||
|examples= | |examples= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r:setMapVisible(1)] | [r:setMapVisible(1)] | ||
[r:setMapVisible(1, "Grasslands")] | [r:setMapVisible(1, "Grasslands")] | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
[[Category:Map Function]] | [[Category:Map Function]] |
Latest revision as of 20:49, 14 March 2023
setMapVisible() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.4.0.1
Sets a maps visibility to players to
true
(1
) or false
(0
). If no map is specified the current map is selected.Usage
setMapVisible(visible)
setMapVisible(visible, mapName)
Parameters
visible
- Whether or not the map can be seen by players,true
(1
) orfalse
(0
).mapName
- A string containing the name of the Map.
Examples
[r:setMapVisible(1)]
[r:setMapVisible(1, "Grasslands")]