clearLights: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Added version.) |
(Provided more details for the function) |
||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=clearLights | |name=clearLights | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description=Turns off all of the [[LightSource:light source|light source]]s for the [[Token:Current Token|Current Token]]. | ||
|usage= | |usage= | ||
| Line 9: | Line 8: | ||
clearLights() | clearLights() | ||
</source> | </source> | ||
|examples= | |||
To turn off all of the light sources for the current token. | |||
<source lang="mtmacro" line> | |||
[h: clearLights()] | |||
</source> | |||
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. | |||
<source lang="mtmacro" line> | |||
Ok Kids lights out! | |||
[h,foreach(tok, getTokens()), code: { [token(tok): clearLights()]}] | |||
</source> | |||
}} | }} | ||
[[Category: Light Function]] | [[Category: Light Function]] | ||
Revision as of 12:36, 26 March 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()]}]