Revision as of 04:35, 17 November 2012

lsSetWindlightScene

Function

integer lsSetWindlightScene(list rules);

Set a list of Windlight settings in the scene to new values

• list rules - a list containing pairs of LightShare Parameters and values to set

Caveats

The list used by this function cannot be passed directly from lsGetWindlightScene without triggering C# exceptions from the Simulator.

LightShare must be enabled in the Simulator.

This script function is restricted to the region owner only.

Examples

list settings = [ WL_WATER_COLOR, <4.000000,38.000000,64.000000> ];
  integer success;
  default {
    state_entry() {
      success = lsSetWindlightScene(settings);
      if ( success == TRUE ) {
        llOwnerSay("Success!");
      } else {
        llOwnerSay("Failed!");
      }
    }
  }

Notes

Rules contain pairs of data in the form of the parameter followed by the value to set.

Setting new parameters with this function commits the new changes to the regionwindlight database table immediately.

Excessive use of this function can cause unnecessary database requests.

Use lsSetWindlightSceneTargeted if you wish to avoid database loading with this function.

See Also

Functions

• lsGetWindlightScene
• lsSetWindlightSceneTargeted
• lsClearWindlightScene

Articles

• LightShare
• LightShare Parameters

Deep Notes

All Issues

• http://opensimulator.org/mantis/search.php?project_id=1&search=lsSetWindlightScene&hide_status_id=-2