WeatherMakerAuroraProfileScript Class |
Aurora profile script, contains all aurora configuration fields
Inheritance HierarchyNamespace: DigitalRuby.WeatherMaker
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxThe WeatherMakerAuroraProfileScript type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WeatherMakerAuroraProfileScript | Initializes a new instance of the WeatherMakerAuroraProfileScript class |
Properties| Name | Description | |
|---|---|---|
 | AnimationAmbientColor |
Aurora ambient color influence
|
| AnimationAnimationSpeed |
Animation speed, how fast aurora animates
|
| AnimationColor |
Animation color, tints the aurora
|
| AnimationDistanceFade |
Aurora distance fade
|
| AnimationDither |
Aurora dithering
|
| AnimationHeight |
Animation height, determines min/max height of aurora
|
| AnimationHeightFadePower |
Animation height power, determines aurora fade as height increases
|
| AnimationIntensity |
Animation intensity, modified brightness of the aurora
|
| AnimationMarchScale |
Animation march scale, determines how fine detailed the aurora ray-march is
|
| AnimationOctave |
Aurora octave, modifies noise generation
|
| AnimationPlanetRadius |
Aurora planet radius
|
| AnimationPower |
Animation power, determines fade of the aurora
|
| AnimationSampleCount |
Animation sample count for ray march
|
| AnimationScale |
Animation scale, determines how fine detailed the aurora noise is
|
| AnimationSubSampleCount |
Animation sub-sample count for ray march
|
| AuroraEnabled |
Whether the aurora should render
|
| hideFlags | Should the object be hidden, saved with the scene or modifiable by the user? |
| name | The name of the object. |
Methods| Name | Description | |
|---|---|---|
| AnimateFrom |
Animate from one aurora profile to another
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetInstanceID | Returns the instance id of the object. |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| SetDirty | Obsolete. (Inherited from ScriptableObject.) |
| ToString | Returns the name of the GameObject. |
| UpdateAnimationProperties |
Updates internal animation properties
|
| UpdateShaderVariables |
Update aurora shader variables
|
Fields| Name | Description | |
|---|---|---|
 | AmbientLight | Aurora ambient light |
| AnimationSpeed | Aurora animation speed (xy scroll, z wobble) |
| Color | Gradient with 4 colors. Left of gradient is bottom of aurora, right of gradient is top of aurora. |
| DistanceFade | Aurora distance fade, fade by distance more as this approaches 1 |
| Dither | Aurora dither |
| Height | The min and max height (in world space units) for the aurora |
| HeightFadePower | Controls how aurora fades as it reaches max height |
| Intensity | Aurora intensity |
| MarchScale | Aurora march scale (xyz) |
| Octave | Aurora noise octave, x = decay, y = amplitude |
| PlanetRadius | Radius (in world space units) of planet to render aurora around |
| Power | Aurora power, controls how dim areas fade out more |
| SampleCount | Sample count for ray march |
| Scale | Aurora detail scale, controls finer details of the aurora, x = shape scale, y = detail scale, z = detail influence (0 - 1). |
| SubSampleCount | Noise sample count |
Extension Methods| Name | Description | |
|---|---|---|
 | CachedName |
Get cached name
(Defined by WeatherMakerObjectExtensions.) |
| SetCachedName |
Put name in the cache
(Defined by WeatherMakerObjectExtensions.) |
See Also