toggleFoW: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 8: Line 8:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
toggleFoW()
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'''.
Line 17: Line 17:
{{param|none|Has no parameters.}}
{{param|none|Has no parameters.}}


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


|also=
|also=

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