WeatherMakerDayNightCycleProfileScript Class |
Day night cycle profile, contains all fields and properties for time of day and how they effect everything
Inheritance HierarchyNamespace: DigitalRuby.WeatherMaker
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxThe WeatherMakerDayNightCycleProfileScript type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WeatherMakerDayNightCycleProfileScript | Initializes a new instance of the WeatherMakerDayNightCycleProfileScript class |
Properties| Name | Description | |
|---|---|---|
 | DateTime |
Get a date time object representing the current year, month, day and time of day in local time
|
| DawnDuskMultiplier |
1 if it is fully dawn or dusk
|
| DayMultiplier |
1 if it is fully day
|
| hideFlags | Should the object be hidden, saved with the scene or modifiable by the user? |
| name | The name of the object. |
| NightMultiplier |
1 if it is fully night
|
| TimeOfDayCategory |
Time of day category
|
| TimeOfDayTimespan |
Time of day as a TimeSpan object
|
| TimeOfDayTimeSpan |
Get a TimeSpan from the TimeOfDay property
|
Methods| Name | Description | |
|---|---|---|
 | CalculateMoonPosition |
Calculate moon position
|
| CalculateSunPosition |
Calculate the position of the sun
|
| ConvertAzimuthAtltitudeToUnitVector |
Azimuth and atltidue unit vector
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetInstanceID | Returns the instance id of the object. |
| GetType | (Inherited from Object.) |
| JulianToDateTime |
Julian date to System.DateTime
|
| MemberwiseClone | (Inherited from Object.) |
| SetDirty | Obsolete. (Inherited from ScriptableObject.) |
| ToString | Returns the name of the GameObject. |
| UpdateFromProfile |
Update day night cycle using profile settings and light manager state
|
Fields| Name | Description | |
|---|---|---|
 | AdjustDateWhenDayEnds | Whether to adjust the date when the day ends. This is important to maintain accurate sun and moon positions as days begin and end, but if your time is static you can turn it off. |
| AmbientColorMode | Whether to set the Unity built in ambient colors to the day, dawn/dusk and night ambient colors. |
| AxisTilt | The amount of degrees your planet is tilted - Earth is about 23.439f |
| DawnDuskAmbientColor | Dawn/dusk ambient color, where far right is fully dawn or dusk - alpha is used for intensity |
| DawnDuskAmbientColorEquator | Dawn/dusk ambient equator color, where far right is fully dawn or dusk - alpha is used for intensity |
| DawnDuskAmbientColorEquatorIntensity | Additional daw/dusk ambient equator color intensity |
| DawnDuskAmbientColorGround | Dawn/dusk ambient ground color, where far right is fully dawn or dusk - alpha is used for intensity |
| DawnDuskAmbientColorGroundIntensity | Additional daw/dusk ambient ground color intensity |
| DawnDuskAmbientColorIntensity | Additional daw/dusk ambient color intensity |
| DawnDuskAmbientColorSky | Dawn/dusk ambient sky color, where far right is fully dawn or dusk - alpha is used for intensity |
| DawnDuskAmbientColorSkyIntensity | Additional daw/dusk ambient sky color intensity |
| Day | The day for simulating the sun and moon position - this can change during runtime. |
| DayAmbientColor | Day ambient color, where far right is fully day - alpha is used for intensity |
| DayAmbientColorEquator | Day ambient equator color, where far right is fully day - alpha is used for intensity |
| DayAmbientColorEquatorIntensity | Additional day ambient equator color intensity |
| DayAmbientColorGround | Day ambient ground color, where far right is fully day - alpha is used for intensity |
| DayAmbientColorGroundIntensity | Additional day ambient ground color intensity |
| DayAmbientColorIntensity | Additional day ambient color intensity |
| DayAmbientColorSky | Day ambient sky color, where far right is fully day - alpha is used for intensity |
| DayAmbientColorSkyIntensity | Additional day ambient sky color intensity |
| DayDawnDuskNightGradient | Determines when it is day, dawn/dusk or night, where center of gradient is sun at horizon. Green = day, Red = dawn/dusk, Blue = night. If it's dawn/dusk, the time of day before 12 p.m. will be dawn, after 12 p.m. will be dusk. |
| DynamicGIUpdateThresholdSeconds |
How many seconds must elapse in time of day time to update dynamic GI should that option be selected
|
| HighNoonTimeOfDay |
Time of day at high noon
|
| Latitude | The latitude in degrees on the planet that the camera is at - 90 (north pole) to -90 (south pole) |
| Longitude | The longitude in degrees on the planet that the camera is at. -180 to 180. |
| Month | The month for simulating the sun and moon position - this can change during runtime. |
| MoonDatas |
Current moon info
|
| NightAmbientColor | Night ambient color, where far right is fully night - alpha is used for intensity |
| NightAmbientColorEquator | Night ambient equator color, where far right is fully night - alpha is used for intensity |
| NightAmbientColorEquatorIntensity | Additional night ambient equator color intensity |
| NightAmbientColorGround | Night ambient ground color, where far right is fully night - alpha is used for intensity |
| NightAmbientColorGroundIntensity | Additional night ambient ground color intensity |
| NightAmbientColorIntensity | Additional night ambient color intensity |
| NightAmbientColorSky | Night ambient sky color, where far right is fully night - alpha is used for intensity |
| NightAmbientColorSkyIntensity | Additional night ambient sky color intensity |
| NightSpeed | The night speed of the cycle. Set to 0 to freeze the cycle and manually control it. At a speed of 1, the cycle is in real-time. A speed of 100 is 100 times faster than normal. Negative numbers run the cycle backwards. |
| SecondsForOneDegree |
Number of seconds in one degree
|
| SecondsPerDay |
Number of seconds per day
|
| SkyAddColor | Sky add color, center of gradient is sun at horizon. |
| SkyTintColor | Sky tint color, center of gradient is sun at horizon. |
| Speed | The day speed of the cycle. Set to 0 to freeze the cycle and manually control it. At a speed of 1, the cycle is in real-time. A speed of 100 is 100 times faster than normal. Negative numbers run the cycle backwards. |
| SunData |
Current sun info
|
| SunIntensityGradient | Control sun intensity where center of gradient is sun at horizon |
| SunTintColorGradient | Tint color of sun, where center is sun at horizon |
| TimeOfDay | The current time of day in seconds (local time). |
| TimeZoneOffsetSeconds | Offset for the time zone of the lat / lon in seconds. Set to -1111 to auto-calculate (just tab out of the text field after you type -1111). Note about -1111: during editor mode, a web service is used. During play mode, longitude is used for fast calculation. |
| UpdateInterval | How often the update cycle updates. Use higher values if you have issues with shadow flickering, etc. Turning on temporal anti-aliasing is also a good way to reduce flicker, though you may have to play with the settings. |
| Year | The year for simulating the sun and moon position - this can change during runtime. The calculation is only correct for dates in the range March 1 1900 to February 28 2100. |
Extension Methods| Name | Description | |
|---|---|---|
 | CachedName |
Get cached name
(Defined by WeatherMakerObjectExtensions.) |
| SetCachedName |
Put name in the cache
(Defined by WeatherMakerObjectExtensions.) |
See Also