toggleFoW: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Fixed description. Extended text.)
No edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 4: Line 4:
|trusted=true
|trusted=true
|version=1.4.1.3
|version=1.4.1.3
|description=toggles the state of Fog of War (FoW) on the current map.
|description=
Toggles the state of Fog of War (FoW) on the current map.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
toggleFoW(value, id)
toggleFoW()
</source>
</syntaxhighlight>


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.
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'''
{{param|none|Has no parameters.}}
{{param|none|Has no parameters.}}


 
''Example:''<syntaxhighlight  lang="mtmacro">
 
[h: toggleFoW()]
''Example:''<source lang="mtmacro">
</syntaxhighlight>
[h:toggleFoW()]
</source><br />


|also=
|also=
Line 26: Line 25:
}}
}}
[[Category:Miscellaneous Function]]
[[Category:Miscellaneous Function]]
[[Category:FoW Function]]
[[Category:FoW]]

Latest revision as of 17:10, 14 March 2023

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()

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