LsGetWindlightScene

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (Change See Also)
 
Line 20: Line 20:
 
default
 
default
 
{
 
{
 +
    // Event handler triggered when the script is initialized
 
     state_entry()
 
     state_entry()
 
     {
 
     {
 +
        // Send a message to public channel informing users to touch to see usage
 
         llSay(PUBLIC_CHANNEL, "Touch to see lsGetWindlightScene usage.");
 
         llSay(PUBLIC_CHANNEL, "Touch to see lsGetWindlightScene usage.");
 
     }
 
     }
  
 +
    // Event handler triggered when the object is touched
 
     touch_start(integer number)
 
     touch_start(integer number)
 
     {
 
     {
 +
        // Define a list of rules to retrieve Windlight settings (e.g., water color)
 
         list rules = [WL_WATER_COLOR];
 
         list rules = [WL_WATER_COLOR];
 +
 +
        // Call lsGetWindlightScene function to retrieve Windlight settings based on the rules
 
         list settings = lsGetWindlightScene(rules);
 
         list settings = lsGetWindlightScene(rules);
 +
 +
        // Extract the water color setting from the retrieved settings list and display it
 
         llSay(PUBLIC_CHANNEL, "The current water color is: " + llList2String(settings, 1));
 
         llSay(PUBLIC_CHANNEL, "The current water color is: " + llList2String(settings, 1));
 
     }
 
     }

Latest revision as of 02:57, 5 March 2024

Contents

[edit] lsGetWindlightScene

[edit] Function

list lsGetWindlightScene(list rules);

Get a list of the current Windlight settings in the scene

An empty rules list will return an empty result list.

[edit] Caveats

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

[edit] Examples

//
// lsGetWindlightScene Script Exemple
// Author: djphil
//
 
default
{
    // Event handler triggered when the script is initialized
    state_entry()
    {
        // Send a message to public channel informing users to touch to see usage
        llSay(PUBLIC_CHANNEL, "Touch to see lsGetWindlightScene usage.");
    }
 
    // Event handler triggered when the object is touched
    touch_start(integer number)
    {
        // Define a list of rules to retrieve Windlight settings (e.g., water color)
        list rules = [WL_WATER_COLOR];
 
        // Call lsGetWindlightScene function to retrieve Windlight settings based on the rules
        list settings = lsGetWindlightScene(rules);
 
        // Extract the water color setting from the retrieved settings list and display it
        llSay(PUBLIC_CHANNEL, "The current water color is: " + llList2String(settings, 1));
    }
}

The current water color is: <4.000000, 38.000000, 64.000000>

[edit] 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.

[edit] See Also

[edit] Functions

[edit] Articles

[edit] Deep Notes

[edit] All Issues

Personal tools
General
About This Wiki