hasLightSource: Difference between revisions
Jump to navigation
Jump to search
m (Fixing broken wikiLinks, connecting to Lights and Sights tutorial) |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
hasLightSource() | hasLightSource() | ||
hasLightSource(type) | hasLightSource(type) | ||
hasLightSource(type, name) | hasLightSource(type, name) | ||
hasLightSource(type, name, | hasLightSource(type, name, tokenRef) | ||
hasLightSource(type, name, | hasLightSource(type, name, tokenRef, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|type|The light source type, (e.g. "Generic", "D20"). If "*" is entered, all light sources types are checked. Defaults to "*".}} | {{param|type|The light source type, (e.g. "Generic", "D20"). If "*" is entered, all light sources types are checked. Defaults to "*".}} | ||
{{param|name|the name of the [[Introduction to Lights and Sights|light source]]. If "*" is entered, all light sources names are checked. Defaults to "*".}} | {{param|name|the name of the [[Introduction to Lights and Sights|light source]]. If "*" is entered, all light sources names are checked. Defaults to "*".}} | ||
{{param| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token which is checked for light sources, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | {{param|mapname|The name of the map to find the token. Defaults to the current map.}} | ||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|examples= | |examples= | ||
Check to see if any light source is on. | Check to see if any light source is on. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: l = hasLightSource()] | [h: l = hasLightSource()] | ||
</ | </syntaxhighlight> | ||
Check to see if a "D20" lamp is on. | Check to see if a "D20" lamp is on. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: l = hasLightSource("D20", "Lamp - 15")] | [h: l = hasLightSource("D20", "Lamp - 15")] | ||
</ | </syntaxhighlight> | ||
Check to see if any "D20" light source is on. | Check to see if any "D20" light source is on. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: l = hasLightSource("D20") | [h: l = hasLightSource("D20") | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
Latest revision as of 22:14, 16 May 2024
hasLightSource() Function
• Introduced in version 1.3b48
Returns 1 if the Current Token has any light sources that match the criteria passed in or 0 if there are no matches. If no arguments are passed to the function then it will return 1 if any light source is on. If only the first argument is passed it will return 1 if any light source of that light source type is on. If both arguments are passed to the function it will return 1 if the light source with the specified name and specified light source type is on.
Usage
hasLightSource()
hasLightSource(type)
hasLightSource(type, name)
hasLightSource(type, name, tokenRef)
hasLightSource(type, name, tokenRef, mapname)Parameters
type- The light source type, (e.g. "Generic", "D20"). If "*" is entered, all light sources types are checked. Defaults to "*".name- the name of the light source. If "*" is entered, all light sources names are checked. Defaults to "*".tokenRef- Either the tokenidor Token Name of the token which is checked for 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.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
Examples
Check to see if any light source is on.
[h: l = hasLightSource()]Check to see if a "D20" lamp is on.
[h: l = hasLightSource("D20", "Lamp - 15")]Check to see if any "D20" light source is on.
[h: l = hasLightSource("D20")Version Changes
- 1.5.4 - Added
idandmapnameparameter options. Changed behavior iftypeornameare set to "*".