hasLightSource: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 1: | Line 1: | ||
==Function hasLightSource== | ==Function hasLightSource== | ||
Returns 1 if the | Returns 1 if the [[Token:Current Token|Current Token]] has any [[LightSource:light source|light source]]s 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 [[LightSource:light source|light source]] is on. If only the first argument is passed it will return 1 if any [[LightSource:light source|light source]] of that [[LightSource:light source type|light source type]] is on. If both arguments are passed to the function it will return 1 if the [[LightSource:light source|light source]] with the specified name and specified [[LightSource:light source type|light source type]] is on. | ||
===Usage=== | ===Usage=== | ||
Revision as of 13:14, 13 December 2008
Function hasLightSource
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
[h: hasLight = hasLightSource()]
[h: hasLight = hasLightSource(type)]
[h: hasLight = hasLightSource(type, name)]Where
- type is the light source type, (e.g. "Generic", "D20")
- name is the name of the light source.
If delim is specified then it is used to separate the values in the list, if it is not specified then it defaults to ','.
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")