setLight: Difference between revisions

Revision as of 19:58, 16 August 2019

• Introduced in version 1.3b48

Sets the light sources of the Current Token. If the value is false(0) then the light source is turned off; otherwise, it is turned on.

setLight(type, name, value)
setLight(type, name, value, id)
setLight(type, name, value, id, mapname)

Parameters

type - The light source type, (e.g. "Generic", "D20").
name - The name of the light source.
value - If true(1) sets the light on, if false(0) turns it off.
id - The token id of the token to change the 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.

[h: setLight("D20", "Candle - 5", 1)]

@@ Line 3: / Line 3: @@
 |version=1.3b48
 |description=
-Sets the [[Map:light source|light source]]s of the [[Token:Current Token|Current Token]]. If the value is 0 then the [[Map:light source|light source]] is turned off; otherwise, it is turned on.
+Sets the [[Map:light source|light source]]s of the [[Token:Current Token|Current Token]]. If the value is {{false}} then the [[Map:light source|light source]] is turned off; otherwise, it is turned on.
 |usage=
 <source lang="mtmacro" line>
 setLight(type, name, value)
+setLight(type, name, value, id)
+setLight(type, name, value, id, mapname)
 </source>
-Where
-* type is the [[LightSource:type |type of light source]] (e.g. "Generic" or "D20").
+'''Parameters'''
-* name is the name of the [[LightSource:Light Source|Light Source]] to change (e.g. "Candle - 5").
+{{param|type|The [[LightSource:light source type|light source type]], (e.g. "Generic", "D20").}}
+{{param|name|The name of the [[LightSource:light source|light source]].}}
+{{param|value|If {{true}} sets the light on, if {{false}} turns it off.}}
+{{param|id|The token {{code|id}} of the token to change the light sources, defaults to the [[Current Token]]. {{TrustedParameter}} }}
+{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
 |example=
@@ Line 17: / Line 23: @@
 [h: setLight("D20", "Candle - 5", 1)]
 </source>
+|changes=
+{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
 }}
 [[Category:Light Function]]