clearLights: Difference between revisions

Latest 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.

@@ Line 1: / Line 1: @@
-{{stub}}
 {{MacroFunction
 |name=clearLights
-|description=Clears all of the [[LightSource:light source|light source]]s for the[[Token:Current Token|Current Token]].
+|version=1.3b48
+|description=Turns off all of the [[Introduction to Lights and Sights|light source]]s for the [[Current Token]].
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
+clearLights()
+clearLights(id)
+clearLights(id, mapname)
+</syntaxhighlight>
+'''Parameters'''
+{{param|id|The token {{code|id}} of the token for which to turn off all light sources, defaults to the [[Current Token]]. {{TrustedParameter}} }}
+{{param|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.
+<syntaxhighlight lang="mtmacro" line>
 [h: clearLights()]
-</source>
+</syntaxhighlight>
+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.
+<syntaxhighlight lang="mtmacro" line>
+Ok Kids lights out!
+[h,foreach(tok, getTokens()), code: { [token(tok): clearLights()]}]
+</syntaxhighlight>
+|changes=
+{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
 }}
 [[Category: Light Function]]