toggleFoW: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=toggleFoW |proposed=false |trusted=true |version=1.4.1.3 |description=directly transfers vbl from token to normal VBL if true, otherwise it transfers fro...")
 
(Fixed description. Extended text.)
Line 4: Line 4:
|trusted=true
|trusted=true
|version=1.4.1.3
|version=1.4.1.3
|description=directly transfers vbl from token to normal VBL if true, otherwise it transfers from VBL to token
|description=toggles the state of Fog of War (FoW) on the current map.


|usage=
|usage=
Line 11: Line 11:
</source>
</source>


This function toggles the state of FoW on the current map either off or on.
This function toggles the state of Fog of War (FoW) on the current map either off or on. This functions identically to the menu option Map -> Fog-of-War or the hotkey Meta-W.


'''Parameters'''
'''Parameters'''

Revision as of 20:48, 20 August 2018

toggleFoW() Function

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

Introduced in version 1.4.1.3
toggles the state of Fog of War (FoW) on the current map.

Usage

toggleFoW(value, id)

This function toggles the state of Fog of War (FoW) on the current map either off or on. This functions identically to the menu option Map -> Fog-of-War or the hotkey Meta-W.

Parameters

  • none - Has no parameters.


Example:

[h:toggleFoW()]



See Also