clearLights: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Provided more details for the function)
m (Unifying Current Token red link.)
Line 2: Line 2:
|name=clearLights
|name=clearLights
|version=1.3b48
|version=1.3b48
|description=Turns off all of the [[LightSource:light source|light source]]s for the [[Token:Current Token|Current Token]].
|description=Turns off all of the [[LightSource:light source|light source]]s for the [[Current Token]].


|usage=
|usage=

Revision as of 21:12, 4 April 2009

clearLights() Function

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

Usage

clearLights()

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