OsGetWindParam
From OpenSimulator
(Difference between revisions)
m (some format conversions) |
|||
| Line 1: | Line 1: | ||
| − | {{osslfunc | + | {{osslfunc |
| − | threat_level = VeryLow | + | |threat_level=VeryLow |
| − | | | + | |function_syntax=osGetWindParam(string plugin, string param); |
| − | function_syntax = | + | |ossl_example=Gets all available properties of current active wind plugin module: |
| − | osGetWindParam(string plugin, string param); | + | |
| − | + | ||
| − | | | + | |
| − | ossl_example = Gets all available properties of current active wind plugin module: | + | |
<source lang="lsl"> | <source lang="lsl"> | ||
// osGetWindParam() sample | // osGetWindParam() sample | ||
| Line 40: | Line 36: | ||
} | } | ||
</source> | </source> | ||
| − | | | + | |description=*Gets the value of '''param''' property for '''plugin''' module. |
| − | + | ||
*NOTE: As of 0.7.1.1, this function is unavailable ([http://opensimulator.org/mantis/view.php?id=5562 Mantis #5562]). It will be available on 0.7.2-dev or later. | *NOTE: As of 0.7.1.1, this function is unavailable ([http://opensimulator.org/mantis/view.php?id=5562 Mantis #5562]). It will be available on 0.7.2-dev or later. | ||
| | | | ||
Revision as of 20:35, 1 July 2011
 |
Languages: |
|
osGetWindParam(string plugin, string param);
| |
| |
| Threat Level | VeryLow |
| Permissions | No permissions specified |
| Extra Delay | No function delay specified |
| Example(s) | |
Gets all available properties of current active wind plugin module:
// osGetWindParam() sample // Touch this object to see the current wind parameters default { touch_start(integer number) { string activePluginName = osWindActiveModelPluginName(); if(activePluginName == "SimpleRandomWind") { llSay(0, "[SimpleRandomWind]"); float strength = osGetWindParam("SimpleRandomWind", "strength"); llSay(0, "wind strength(strength) = " + (string)strength); } else if(activePluginName == "ConfigurableWind") { llSay(0, "[ConfigurableWind]"); float avgStrength = osGetWindParam("ConfigurableWind", "avgStrength"); llSay(0, "average wind strength(avg_strength) = " + (string)avgStrength); float avgDirection = osGetWindParam("ConfigurableWind", "avgDirection"); llSay(0, "average wind direction in degrees(avg_direction) = " + (string)avgDirection); float varStrength = osGetWindParam("ConfigurableWind", "varStrength"); llSay(0, "allowable variance in wind strength(var_strength) = " + (string)varStrength); float varDirection = osGetWindParam("ConfigurableWind", "varDirection"); llSay(0, "allowable variance in wind direction in +/- degrees(var_direction) = " + (string)varDirection); float rateChange = osGetWindParam("ConfigurableWind", "rateChange"); llSay(0, "rate of change(rate_change) = " + (string)rateChange); } } } | |
Available parameters:
| plugin | param | Description | Default | OpenSim.ini setting |
|---|---|---|---|---|
| SimpleRandomWind | strength | wind strength | 1.0f | strength |
| ConfigurableWind | avgStrength | average wind strength | 5.0f | avg_strength |
| avgDirection | average wind direction in degrees | 0.0f | avg_direction | |
| varStrength | allowable variance in wind strength | 5.0f | var_strength | |
| varDirection | allowable variance in wind direction in +/- degrees | 30.0f | var_direction | |
| rateChange | rate of change | 1.0f | rate_change |
