OsSetRegionSunSettings

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(usage syntax added)
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
'''Function Syntax:''' osSetRegionSunSettings(bool useEstateSun, bool sunFixed, double sunHour);<br>'''Returns:''' NULL
+
{{osslfunc
 +
|threat_level=Nuisance
 +
|function_syntax= osSetRegionSunSettings(integer useEstateSun, integer sunFixed, float sunHour)
 +
|ossl_example=<source lang="lsl">
 +
default
 +
{
 +
  state_entry( )
 +
  {
 +
          osSetRegionSunSettings( FALSE, TRUE, 12.0 );
 +
              //Sets the region/ terrain-tab to non-estate, fixed-sun and at dusk settings.
 +
  }
 +
}
 +
</source>
 +
|description= Sets the Sun parameters for the Region. 
  
Example Required !<br>
+
The useEstateSun flag enables/disables synchronization with the Sun settings for the Estate.
 +
 
 +
sunFixed determines whether the Sun will remain fixed in place or proceed through its cycle.
 +
 
 +
sunHour determines the time of day the Sun will be set to.
 +
|
 +
}}

Revision as of 17:36, 1 May 2019

osSetRegionSunSettings(integer useEstateSun, integer sunFixed, float sunHour)
Sets the Sun parameters for the Region.

The useEstateSun flag enables/disables synchronization with the Sun settings for the Estate.

sunFixed determines whether the Sun will remain fixed in place or proceed through its cycle.

sunHour determines the time of day the Sun will be set to.

Threat Level Nuisance
Permissions No permissions specified
Extra Delay No function delay specified
Example(s)
default
 {
   state_entry( )
   {
           osSetRegionSunSettings( FALSE, TRUE, 12.0 );
               //Sets the region/ terrain-tab to non-estate, fixed-sun and at dusk settings.
   }
 }
Personal tools
General
About This Wiki