setLight: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Sets the [[ | Sets the [[Introduction to Lights and Sights|light source]]s of the [[Current Token|Current Token]]. If the value is {{false}} then the [[Introduction to Lights and Sights|light source]] is turned off; otherwise, it is turned on. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setLight(type, name, value) | setLight(type, name, value) | ||
setLight(type, name, value, id) | setLight(type, name, value, id) | ||
setLight(type, name, value, id, | setLight(type, name, value, id, mapRef) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|type|The | {{param|type|The light source type, (e.g. "Generic", "D20").}} | ||
{{param|name|The name of the [[ | {{param|name|The name of the [[Introduction to Lights and Sights|light source]].}} | ||
{{param|value|If {{true}} sets the light on, if {{false}} turns it off.}} | {{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|id|The token {{code|id}} of the token to change the light sources, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param| | {{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | ||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setLight("D20", "Candle - 5", 1)] | [h: setLight("D20", "Candle - 5", 1)] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
| Line 29: | Line 29: | ||
}} | }} | ||
[[Category:Light Function]] | [[Category:Light Function]] | ||
[[Category:Token Function]] | |||
Latest revision as of 23:59, 22 August 2023
setLight() Function
• 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.Usage
setLight(type, name, value)
setLight(type, name, value, id)
setLight(type, name, value, id, mapRef)Parameters
type- The light source type, (e.g. "Generic", "D20").name- The name of the light source.value- Iftrue(1) sets the light on, iffalse(0) turns it off.id- The tokenidof the token to change the light sources, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapRef- The Name or ID of the map to find the token. Defaults to the current map.
Example
[h: setLight("D20", "Candle - 5", 1)]
Version Changes
- 1.5.4 - Added
idandmapnameparameter options.