LsGetWindlightScene

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(fixed deep note)
(added note about passing an empty list into function)
Line 5: Line 5:
 
Get a list of the current [[Windlight]] settings in the scene
 
Get a list of the current [[Windlight]] settings in the scene
 
* [[list]] rules - a list of the parameters to retrieve
 
* [[list]] rules - a list of the parameters to retrieve
 +
 +
An empty rules list will return an empty result list.
  
 
== Caveats ==
 
== Caveats ==

Revision as of 00:03, 6 November 2010

Contents

lsGetWindlightScene

Function

list lsGetWindlightScene(list rules);

Get a list of the current Windlight settings in the scene

  • list rules - a list of the parameters to retrieve

An empty rules list will return an empty result list.

Caveats

The list returned by this function cannot be passed directly to lsSetWindlightScene without triggering C# exceptions from the Simulator.

Examples

 list rules_to_get = [ WL_WATER_COLOR ];
 list settings;
 default {
   state_entry() {
     settings = lsGetWindlightScene(rules_to_get);
     llOwnerSay("Water color is: "+llList2String(settings,1));
   }
 }
 Water color is: <4.000000,38.000000,64.000000>

Notes

Returned rules contain pairs of data in the form of the parameter requested followed by the current value. In the example above, the request returns [ 0, <4.000000,38.000000,64.000000> ] when used with default LightShare settings in a region.

See Also

Functions

Articles

Deep Notes

All Issues

Personal tools
General
About This Wiki