LsGetWindlightScene

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(fixed deep note)
 
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
= lsGetWindlightScene =
 
= lsGetWindlightScene =
 
== Function ==
 
== Function ==
[[list]] lsGetWindlightScene([[list]] rules);
+
'''list''' lsGetWindlightScene('''list''' rules);
  
Get a list of the current [[Windlight]] settings in the scene
+
Get a list of the current [http://wiki.secondlife.com/wiki/WindLight_settings Windlight settings] in the scene
* [[list]] rules - a list of the parameters to retrieve
+
* '''list''' rules - a list of the [[LightShare Parameters]] to retrieve
 +
 
 +
An empty rules list will return an empty result list.
  
 
== Caveats ==
 
== Caveats ==
Line 10: Line 12:
  
 
== Examples ==
 
== Examples ==
  list rules_to_get = [ WL_WATER_COLOR ];
+
<source lang="lsl">
  list settings;
+
//
  default {
+
// lsGetWindlightScene Script Exemple
     state_entry() {
+
// Author: djphil
      settings = [[lsGetWindlightScene]](rules_to_get);
+
//
      llOwnerSay("Water color is: "+llList2String(settings,1));
+
 
 +
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.");
 
     }
 
     }
  }
 
  
  Water color is: <4.000000,38.000000,64.000000>
+
    // 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));
 +
    }
 +
}
 +
</source>
 +
 
 +
The current water color is: <4.000000, 38.000000, 64.000000>
  
 
== Notes ==
 
== Notes ==
Line 27: Line 50:
 
== See Also ==
 
== See Also ==
 
=== Functions ===
 
=== Functions ===
*[[lsSetWindlightScene]]
+
* [[lsGetWindlightScene]]
*[[lsSetWindlightSceneTargeted]]
+
* [[lsSetWindlightScene]]
 +
* [[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=lsGetWindlightScene&hide_status_id=-2
+
* http://opensimulator.org/mantis/search.php?project_id=1&search=lsGetWindlightScene&hide_status_id=-2
 +
 
 +
[[Category:Scripting]]

Latest revision as of 01: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