Click or drag to resize

WeatherMakerFullScreenFogProfileScript Class

Full screen fog profile, contains all full screen fog rendering configuration
Inheritance Hierarchy
SystemObject
  Object
    ScriptableObject
      DigitalRuby.WeatherMakerWeatherMakerFogProfileScript
        DigitalRuby.WeatherMakerWeatherMakerFullScreenFogProfileScript

Namespace:  DigitalRuby.WeatherMaker
Assembly:  Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
Syntax
[SerializableAttribute]
public class WeatherMakerFullScreenFogProfileScript : WeatherMakerFogProfileScript

The WeatherMakerFullScreenFogProfileScript type exposes the following members.

Constructors
  NameDescription
Public methodWeatherMakerFullScreenFogProfileScript
Initializes a new instance of the WeatherMakerFullScreenFogProfileScript class
Top
Properties
  NameDescription
Public propertyFogGlobalShadow
Shadow created by fog
Public propertyFogIntensityMultiplier
Fog intensity multiplier
Public propertyFogScatterReduction
Density of fog for scattering reduction
(Inherited from WeatherMakerFogProfileScript.)
Public propertyHasNoise
Whether this fog profile will render noise in the fog
(Inherited from WeatherMakerFogProfileScript.)
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.)
Top
Methods
  NameDescription
Public methodCopyStateTo
Copy state to another fog profile
(Inherited from WeatherMakerFogProfileScript.)
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
Update
(Inherited from WeatherMakerFogProfileScript.)
Public methodUpdateMaterialProperties
Update full screen fog material properties
(Overrides WeatherMakerFogProfileScriptUpdateMaterialProperties(Material, Camera, Boolean).)
Top
Fields
  NameDescription
Public fieldDitherLevel
Dithering level. 0 to disable dithering.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogCloudShadowStrength
How much cloud shadows effect the fog, set to 0 for indoor fog.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogColor
Fog color
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogDensity
Fog density
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogDensityGradient
Fog density gradient based on sun position where center is sun at horizon. Use alpha, color is ignored.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogEdgeFalloffPower
Fog edge falloff power. Ignored for full screen fog.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogEdgeSmoothFactor
Fog edge smooth factor. Ignored for full screen fog.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogEmissionColor
Fog emission color, alpha is intensity
(Inherited from WeatherMakerFogProfileScript.)
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.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogFactorMultiplier
Multiply the computed fog factor by this value
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogGradientColor
Fog gradient color based on sun position where center is sun at horizon.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogHeight
Fog height. Set to 0 for unlimited height.
Public fieldFogHeightFalloffPower
Fog height falloff power.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogLightAbsorption
Fog light absorption - lower values absorb more light, higher values scatter and intensify light more.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogMode
Fog mode
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogNoiseAdder
Controls how the noise value is calculated. Negative values allow areas of no noise, higher values increase the intensity of the noise.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogNoiseMultiplier
How much the noise effects the fog.
(Inherited from WeatherMakerFogProfileScript.)
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.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogNoiseScale
Fog noise scale. Lower values get less tiling. 0 to disable noise.
(Inherited from WeatherMakerFogProfileScript.)
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).
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogNoiseVelocityRotation
Fog noise rotation speed in radians per second. W is rotation radius.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogShadowBrightness
Controls brightness of light in the fog vs in shadow. Higher values are brighter in the shadows.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogShadowDecay
Controls how light falls off from the light source. Lower values fall off faster.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogShadowDither
Fog shadow dither multiplier. Higher values dither more.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogShadowDitherMagic
Magic numbers for fog shadow dithering. Tweak if you don't like the dithering appearance.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogShadowMaxRayLength
Max ray length for fog shadows. Set to 0 to disable fog shadows.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogShadowMultiplier
Multiplier for fog shadow lighting. Higher values make brighter light rays.
(Inherited from WeatherMakerFogProfileScript.)
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.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogShadowSampleCount
Number of shadow samples, 0 to disable fog shadows.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogShadowStrengthFactor
Control how fog casts shadow. Larger values cast more shadow.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldFogStartDepth
The depth where fog starts (in world space units). Ignored if fog is not full screen or fog has a height limit.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldMaxFogFactor
Maximum fog factor, where 1 is the maximum allowed fog.
(Inherited from WeatherMakerFogProfileScript.)
Public fieldShadowMultiplierPower
How much to increase shadow in fog. Lower numbers cause less shadow.
Public fieldSunShaftBackgroundColorMultiplier
Intensity of background color. Set to 0 to not blend in the background at all on the shafts.
Public fieldSunShaftBackgroundTintColor
Tint of background color
Public fieldSunShaftBrightness
Increases the sun shaft brightness
Public fieldSunShaftDecay
Determines light fall-off from start of sun shaft. Set to 1 for no fall-off.
Public fieldSunShaftDither
Controls dithering intensity of sun shafts.
Public fieldSunShaftDitherMagic
Controls dithering appearance of sun shafts.
Public fieldSunShaftSampleCount
The number of shaft samples. Set to 0 to disable sun shafts.
Public fieldSunShaftSpread
Sun shaft spread (0 - 1).
Public fieldSunShaftStepMultiplier
Combined with each ray march, this determines how much light is accumulated each step.
Public fieldSunShaftTintColor
Sun shaft tint color. Alpha value determines tint intensity.
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.
(Inherited from WeatherMakerFogProfileScript.)
Top
Extension Methods
  NameDescription
Public Extension MethodCachedName
Get cached name
(Defined by WeatherMakerObjectExtensions.)
Public Extension MethodSetCachedName
Put name in the cache
(Defined by WeatherMakerObjectExtensions.)
Top
See Also