setMapVisible: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
(One intermediate revision by the same user not shown)
Line 2: Line 2:
|name=setMapVisible
|name=setMapVisible
|version=1.4.0.1
|version=1.4.0.1
|trusted=true
|description=
|description=
Sets a maps visibility to players to {{true}} or {{false}}. If no map is specified the current map is selected. May only be used by a trusted macro.
Sets a maps visibility to players to {{true}} or {{false}}. If no map is specified the current map is selected.
|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
Line 18: Line 19:
</source>
</source>
}}
}}
[[Category:Map Function]]

Revision as of 12:17, 3 May 2016

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) or false(0).
  • mapName - A string containing the name of the Map.

Examples

[r:setMapVisible(1)]
[r:setMapVisible(1, "Grasslands")]