LsSetWindlightScene
From OpenSimulator
(Difference between revisions)
(created) |
m |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
= lsSetWindlightScene = | = lsSetWindlightScene = | ||
== Function == | == Function == | ||
| − | + | '''integer''' lsSetWindlightScene('''list''' rules); | |
| − | Set a list of [ | + | Set a list of [http://wiki.secondlife.com/wiki/WindLight_settings Windlight settings] in the scene to new values |
| − | * | + | * '''list''' rules - a list containing pairs of [[LightShare Parameters]] and values to set |
== Caveats == | == Caveats == | ||
| − | The list used by this function cannot be passed directly from [[lsGetWindlightScene]] without triggering C# exceptions from the | + | 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 | + | [[LightShare]] must be enabled in the Simulator. |
This script function is restricted to the region owner only. | This script function is restricted to the region owner only. | ||
== Examples == | == Examples == | ||
| + | <source lang="lsl"> | ||
list settings = [ WL_WATER_COLOR, <4.000000,38.000000,64.000000> ]; | list settings = [ WL_WATER_COLOR, <4.000000,38.000000,64.000000> ]; | ||
integer success; | integer success; | ||
| Line 26: | Line 27: | ||
} | } | ||
} | } | ||
| + | </source> | ||
== Notes == | == Notes == | ||
| Line 38: | Line 40: | ||
== See Also == | == See Also == | ||
=== Functions === | === Functions === | ||
| − | *[[lsGetWindlightScene]] | + | * [[lsGetWindlightScene]] |
| − | *[[lsSetWindlightSceneTargeted]] | + | * [[lsSetWindlightSceneTargeted]] |
| + | * [[lsClearWindlightScene]] | ||
=== Articles === | === Articles === | ||
| − | *[[LightShare]] | + | * [[LightShare]] |
| − | *[[LightShare Parameters]] | + | * [[LightShare Parameters]] |
== Deep Notes == | == Deep Notes == | ||
=== All Issues === | === All Issues === | ||
| − | *http://opensimulator.org/mantis/search.php?project_id=1&search=lsSetWindlightScene | + | * http://opensimulator.org/mantis/search.php?project_id=1&search=lsSetWindlightScene&hide_status_id=-2 |
| + | |||
| + | |||
| + | [[Category:Scripting]] | ||
Revision as of 15:53, 24 October 2015
Contents |
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.
