getMapVisible: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetMapVisible to getMapVisible: Converting page titles to lowercase)
No edit summary
Line 5: Line 5:
Returns {{true}} or {{false}} indicating whether the specified map is visible to players. If no map is specified the current map is selected.
Returns {{true}} or {{false}} indicating whether the specified map is visible to players. If no map is specified the current map is selected.
|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getMapVisible()
getMapVisible()
getMapVisible(mapName)
getMapVisible(mapName)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|mapName|Optional. A string containing the name of the Map.}}
{{param|mapName|Optional. A string containing the name of the Map.}}
|examples=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:getMapVisible()]
[r:getMapVisible()]
[r:getMapVisible("Grasslands")]
[r:getMapVisible("Grasslands")]
</source>
</syntaxhighlight>
}}
}}
[[Category:Map Function]]
[[Category:Map Function]]

Revision as of 18:39, 14 March 2023

getMapVisible() Function

Introduced in version 1.4.0.1
Returns true(1) or false(0) indicating whether the specified map is visible to players. If no map is specified the current map is selected.

Usage

getMapVisible()
getMapVisible(mapName)

Parameters

  • mapName - Optional. A string containing the name of the Map.

Examples

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