getMapVisible: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by 3 users not shown)
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(mapRef)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|tableName|Optional. A string containing the name of the Table.}}
{{param|mapRef|Optional. The Name or ID 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]]

Latest revision as of 23:59, 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(mapRef)

Parameters

  • mapRef - Optional. The Name or ID of the Map.

Examples

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