exposeAllOwnedArea: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=exposeAllOwnedArea |trusted=true |version=1.5.0 |description= Exposes all areas visible to tokens owned by the current player that have vision turned on...")
 
m (Text replacement - "<source" to "<syntaxhighlight")
 
(6 intermediate revisions by 3 users not shown)
Line 4: Line 4:
|version=1.5.0
|version=1.5.0
|description=
|description=
Exposes all areas visible to tokens owned by the current player that have vision turned on in the token editor.  The actual area exposed depends on server settings (like '''Individual Views''') and various MapTool Preferences.
Exposes all area visible to tokens owned by the current player that have vision turned on in the token editor.  The actual area exposed depends on server settings (like '''Individual Views''') and various MapTool Preferences.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
exposeAllOwnedArea(mapName)
exposeAllOwnedArea(mapRef)
</source>
</syntaxhighlight>
'''Parameter'''
'''Parameters'''
{{param|mapName|The name of an existing map within the campaign.  This map does not need to be the one currently visible.  If the map holds no tokens with vision owned by the current player, no additional fog-of-war is exposed, but fog already exposed is not reset.}}
{{param|mapRef|The Name or ID of an existing map within the campaign.  This map does not need to be the one currently visible.  If the map holds no tokens with vision owned by the current player, no additional fog-of-war is exposed, but fog already exposed is not reset.}}


|examples=
|examples=

Latest revision as of 23:59, 14 March 2023

exposeAllOwnedArea() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.5.0
Exposes all area visible to tokens owned by the current player that have vision turned on in the token editor. The actual area exposed depends on server settings (like Individual Views) and various MapTool Preferences.

Usage

exposeAllOwnedArea(mapRef)

Parameters

  • mapRef - The Name or ID of an existing map within the campaign. This map does not need to be the one currently visible. If the map holds no tokens with vision owned by the current player, no additional fog-of-war is exposed, but fog already exposed is not reset.


See Also