LsSetWindlightScene

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Replace script exemple)
m (Change See Also)
Line 68: Line 68:
 
=== Functions ===
 
=== Functions ===
 
* [[lsGetWindlightScene]]
 
* [[lsGetWindlightScene]]
 +
* [[lsSetWindlightScene]]
 
* [[lsSetWindlightSceneTargeted]]
 
* [[lsSetWindlightSceneTargeted]]
 
* [[lsClearWindlightScene]]
 
* [[lsClearWindlightScene]]

Revision as of 01:12, 19 December 2020

Contents

lsSetWindlightScene

Function

integer lsSetWindlightScene(list rules);

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

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

//
// lsSetWindlightScene Script Exemple
// Author: djphil
//
 
integer switch;
 
default
{
    state_entry()
    {
        llSay(PUBLIC_CHANNEL, "Touch to see lsSetWindlightScene usage.");
        llSetText("lsSetWindlightScene", <1.0, 1.0, 1.0>, 1.0);
    }
 
    touch_start(integer number)
    {
        vector color = <4.0, 38.0, 64.0>;
 
        if (switch = !switch)
        {
            color = <llFrand(255.0), llFrand(255.0), llFrand(255.0)>;
        }
 
        list settings = [WL_WATER_COLOR, color];
        integer result = lsSetWindlightScene(settings);
 
        if (result == TRUE)
        {
            llSay(PUBLIC_CHANNEL, "The Windlight Scene was changed with success.");
            llSay(PUBLIC_CHANNEL, "The current water color is: " + (string)color);
        }
 
        else
        {
            llSay(PUBLIC_CHANNEL, "The Windlight Scene was changed without success.");
        }
    }
}

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

Articles

Deep Notes

All Issues

Personal tools
General
About This Wiki