getLights

From RPTools Wiki
Revision as of 22:13, 1 December 2008 by Craig (talk | contribs) (New page: ==Function getLights== {{ProposedChange}} Returns a Macros:string list containing the names of the Map:light sources that are on for the current Token:token. ===Usage=== <s...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Function getLights

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

Returns a string list containing the names of the light sources that are on for the current token.

Usage

[h: lights = getLights()]
[h: lights = getLights(type)]
[h: lights = getLights(type, delim)]
[h: lights = getLights("*", delim)]

Where

If you want to specify the delimiter but still want to fetch all of the light source types then you can use the special value "*" for type.

Examples

To get a string list of all of the [LightSource:light source|]]s that the current token has on.

[getLights()]

To get a string list of the [LightSource:light source|]]s that the current token has on with the lighet source type| of "Generic".

[getLibProperty("Generic")]