clearLights: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
Line 5: Line 5:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
clearLights()
clearLights()
clearLights(id)
clearLights(id)
Line 17: Line 17:
|examples=
|examples=
To turn off all of the light sources for the current token.
To turn off all of the light sources for the current token.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: clearLights()]
[h: clearLights()]
</syntaxhighlight>
</syntaxhighlight>
Line 23: Line 23:
To turn off all the lights sources on the map you could run the following script, note you will have to be the GM or run it
To turn off all the lights sources on the map you could run the following script, note you will have to be the GM or run it
as part of a trusted macro.
as part of a trusted macro.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
Ok Kids lights out!
Ok Kids lights out!
[h,foreach(tok, getTokens()), code: { [token(tok): clearLights()]}]
[h,foreach(tok, getTokens()), code: { [token(tok): clearLights()]}]

Revision as of 18:34, 14 March 2023

clearLights() Function

Introduced in version 1.3b48
Turns off all of the light sources for the Current Token.

Usage

clearLights()
clearLights(id)
clearLights(id, mapname)

Parameters

  • id - The token id of the token for which to turn off all light sources, defaults to the Current Token.

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

  • mapname - The name of the map to find the token. Defaults to the current map.

Examples

To turn off all of the light sources for the current token.
[h: clearLights()]

To turn off all the lights sources on the map you could run the following script, note you will have to be the GM or run it as part of a trusted macro.

Ok Kids lights out!
[h,foreach(tok, getTokens()), code: { [token(tok): clearLights()]}]

Version Changes

  • 1.5.4 - Added id and mapname parameter options.