Click or drag to resize

WeatherMakerFogProfileScript Class

Base fog profile
Inheritance Hierarchy

Namespace:  DigitalRuby.WeatherMaker
Assembly:  Assembly-CSharp (in Assembly-CSharp.dll) Version:
public class WeatherMakerFogProfileScript : ScriptableObject

The WeatherMakerFogProfileScript type exposes the following members.

Public methodWeatherMakerFogProfileScript
Initializes a new instance of the WeatherMakerFogProfileScript class
Public propertyFogScatterReduction
Density of fog for scattering reduction
Public propertyHasNoise
Whether this fog profile will render noise in the fog
Public propertyhideFlags

Should the object be hidden, saved with the scene or modifiable by the user?

(Inherited from Object.)
Public propertyname

The name of the object.

(Inherited from Object.)
Public methodCopyStateTo
Copy state to another fog profile
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetInstanceID

Returns the instance id of the object.

(Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodSetDirty Obsolete. (Inherited from ScriptableObject.)
Public methodToString

Returns the name of the GameObject.

(Inherited from Object.)
Public methodUpdate
Public methodUpdateMaterialProperties
Update a fog material with fog properties from this object
Public fieldDitherLevel
Dithering level. 0 to disable dithering.
Public fieldFogCloudShadowStrength
How much cloud shadows effect the fog, set to 0 for indoor fog.
Public fieldFogColor
Fog color
Public fieldFogDensity
Fog density
Public fieldFogDensityGradient
Fog density gradient based on sun position where center is sun at horizon. Use alpha, color is ignored.
Public fieldFogEdgeFalloffPower
Fog edge falloff power. Ignored for full screen fog.
Public fieldFogEdgeSmoothFactor
Fog edge smooth factor. Ignored for full screen fog.
Public fieldFogEmissionColor
Fog emission color, alpha is intensity
Public fieldFogEndDepth
The depth where fog ends (in world space units). Ignored if 0 or fog is not full screen or fog has a height limit.
Public fieldFogFactorMultiplier
Multiply the computed fog factor by this value
Public fieldFogGradientColor
Fog gradient color based on sun position where center is sun at horizon.
Public fieldFogHeightFalloffPower
Fog height falloff power.
Public fieldFogLightAbsorption
Fog light absorption - lower values absorb more light, higher values scatter and intensify light more.
Public fieldFogMode
Fog mode
Public fieldFogNoiseAdder
Controls how the noise value is calculated. Negative values allow areas of no noise, higher values increase the intensity of the noise.
Public fieldFogNoiseMultiplier
How much the noise effects the fog.
Public fieldFogNoiseSampleCount
Number of samples to take for 3D fog. If the player will never enter the fog, this can be a lower value. If the player can move through the fog, 40 or higher is better, but will cost some performance.
Public fieldFogNoiseScale
Fog noise scale. Lower values get less tiling. 0 to disable noise.
Public fieldFogNoiseVelocity
Fog noise velocity, determines how fast the fog moves. Not all fog scripts support 3d velocity, some only support 2d velocity (x and y).
Public fieldFogNoiseVelocityRotation
Fog noise rotation speed in radians per second. W is rotation radius.
Public fieldFogShadowBrightness
Controls brightness of light in the fog vs in shadow. Higher values are brighter in the shadows.
Public fieldFogShadowDecay
Controls how light falls off from the light source. Lower values fall off faster.
Public fieldFogShadowDither
Fog shadow dither multiplier. Higher values dither more.
Public fieldFogShadowDitherMagic
Magic numbers for fog shadow dithering. Tweak if you don't like the dithering appearance.
Public fieldFogShadowMaxRayLength
Max ray length for fog shadows. Set to 0 to disable fog shadows.
Public fieldFogShadowMultiplier
Multiplier for fog shadow lighting. Higher values make brighter light rays.
Public fieldFogShadowPower
Controls how light falls off from the light source. Higher values fall off faster. Setting this to a value that is a power of two is recommended.
Public fieldFogShadowSampleCount
Number of shadow samples, 0 to disable fog shadows.
Public fieldFogShadowStrengthFactor
Control how fog casts shadow. Larger values cast more shadow.
Public fieldFogStartDepth
The depth where fog starts (in world space units). Ignored if fog is not full screen or fog has a height limit.
Public fieldMaxFogFactor
Maximum fog factor, where 1 is the maximum allowed fog.
Public fieldWindEffectsFogNoiseVelocity
True to have wind affect fog noise velocity, false otherwise. This does require scanning for wind zones, so disable if you see any performance issues.
Extension Methods
Public Extension MethodCachedName
Get cached name
(Defined by WeatherMakerObjectExtensions.)
Public Extension MethodSetCachedName
Put name in the cache
(Defined by WeatherMakerObjectExtensions.)
See Also