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

C++

Copy

[SerializableAttribute]
public class WeatherMakerFullScreenFogProfileScript : WeatherMakerFogProfileScript

<SerializableAttribute>
Public Class WeatherMakerFullScreenFogProfileScript
	Inherits WeatherMakerFogProfileScript

[SerializableAttribute]
public ref class WeatherMakerFullScreenFogProfileScript : public WeatherMakerFogProfileScript

[<SerializableAttribute>]
type WeatherMakerFullScreenFogProfileScript =  
    class
        inherit WeatherMakerFogProfileScript
    end

The WeatherMakerFullScreenFogProfileScript type exposes the following members.

Constructors

	Name	Description
	WeatherMakerFullScreenFogProfileScript	Initializes a new instance of the WeatherMakerFullScreenFogProfileScript class

Top

Properties

	Name	Description
	FogGlobalShadow	Shadow created by fog
	FogIntensityMultiplier	Fog intensity multiplier
	FogScatterReduction	Density of fog for scattering reduction (Inherited from WeatherMakerFogProfileScript.)
	HasNoise	Whether this fog profile will render noise in the fog (Inherited from WeatherMakerFogProfileScript.)
	hideFlags	Should the object be hidden, saved with the scene or modifiable by the user? (Inherited from Object.)
	name	The name of the object. (Inherited from Object.)

Top

Methods

	Name	Description
	CopyStateTo	Copy state to another fog profile (Inherited from WeatherMakerFogProfileScript.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetInstanceID	Returns the instance id of the object. (Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	SetDirty	Obsolete. (Inherited from ScriptableObject.)
	ToString	Returns the name of the GameObject. (Inherited from Object.)
	Update	Update (Inherited from WeatherMakerFogProfileScript.)
	UpdateMaterialProperties	Update full screen fog material properties (Overrides WeatherMakerFogProfileScriptUpdateMaterialProperties(Material, Camera, Boolean).)

Top

Fields

	Name	Description
	DitherLevel	Dithering level. 0 to disable dithering. (Inherited from WeatherMakerFogProfileScript.)
	FogCloudShadowStrength	How much cloud shadows effect the fog, set to 0 for indoor fog. (Inherited from WeatherMakerFogProfileScript.)
	FogColor	Fog color (Inherited from WeatherMakerFogProfileScript.)
	FogDensity	Fog density (Inherited from WeatherMakerFogProfileScript.)
	FogDensityGradient	Fog density gradient based on sun position where center is sun at horizon. Use alpha, color is ignored. (Inherited from WeatherMakerFogProfileScript.)
	FogEdgeFalloffPower	Fog edge falloff power. Ignored for full screen fog. (Inherited from WeatherMakerFogProfileScript.)
	FogEdgeSmoothFactor	Fog edge smooth factor. Ignored for full screen fog. (Inherited from WeatherMakerFogProfileScript.)
	FogEmissionColor	Fog emission color, alpha is intensity (Inherited from WeatherMakerFogProfileScript.)
	FogEndDepth	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.)
	FogFactorMultiplier	Multiply the computed fog factor by this value (Inherited from WeatherMakerFogProfileScript.)
	FogGradientColor	Fog gradient color based on sun position where center is sun at horizon. (Inherited from WeatherMakerFogProfileScript.)
	FogHeight	Fog height. Set to 0 for unlimited height.
	FogHeightFalloffPower	Fog height falloff power. (Inherited from WeatherMakerFogProfileScript.)
	FogLightAbsorption	Fog light absorption - lower values absorb more light, higher values scatter and intensify light more. (Inherited from WeatherMakerFogProfileScript.)
	FogMode	Fog mode (Inherited from WeatherMakerFogProfileScript.)
	FogNoiseAdder	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.)
	FogNoiseMultiplier	How much the noise effects the fog. (Inherited from WeatherMakerFogProfileScript.)
	FogNoiseSampleCount	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.)
	FogNoiseScale	Fog noise scale. Lower values get less tiling. 0 to disable noise. (Inherited from WeatherMakerFogProfileScript.)
	FogNoiseVelocity	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.)
	FogNoiseVelocityRotation	Fog noise rotation speed in radians per second. W is rotation radius. (Inherited from WeatherMakerFogProfileScript.)
	FogShadowBrightness	Controls brightness of light in the fog vs in shadow. Higher values are brighter in the shadows. (Inherited from WeatherMakerFogProfileScript.)
	FogShadowDecay	Controls how light falls off from the light source. Lower values fall off faster. (Inherited from WeatherMakerFogProfileScript.)
	FogShadowDither	Fog shadow dither multiplier. Higher values dither more. (Inherited from WeatherMakerFogProfileScript.)
	FogShadowDitherMagic	Magic numbers for fog shadow dithering. Tweak if you don't like the dithering appearance. (Inherited from WeatherMakerFogProfileScript.)
	FogShadowMaxRayLength	Max ray length for fog shadows. Set to 0 to disable fog shadows. (Inherited from WeatherMakerFogProfileScript.)
	FogShadowMultiplier	Multiplier for fog shadow lighting. Higher values make brighter light rays. (Inherited from WeatherMakerFogProfileScript.)
	FogShadowPower	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.)
	FogShadowSampleCount	Number of shadow samples, 0 to disable fog shadows. (Inherited from WeatherMakerFogProfileScript.)
	FogShadowStrengthFactor	Control how fog casts shadow. Larger values cast more shadow. (Inherited from WeatherMakerFogProfileScript.)
	FogStartDepth	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.)
	MaxFogFactor	Maximum fog factor, where 1 is the maximum allowed fog. (Inherited from WeatherMakerFogProfileScript.)
	ShadowMultiplierPower	How much to increase shadow in fog. Lower numbers cause less shadow.
	SunShaftBackgroundColorMultiplier	Intensity of background color. Set to 0 to not blend in the background at all on the shafts.
	SunShaftBackgroundTintColor	Tint of background color
	SunShaftBrightness	Increases the sun shaft brightness
	SunShaftDecay	Determines light fall-off from start of sun shaft. Set to 1 for no fall-off.
	SunShaftDither	Controls dithering intensity of sun shafts.
	SunShaftDitherMagic	Controls dithering appearance of sun shafts.
	SunShaftSampleCount	The number of shaft samples. Set to 0 to disable sun shafts.
	SunShaftSpread	Sun shaft spread (0 - 1).
	SunShaftStepMultiplier	Combined with each ray march, this determines how much light is accumulated each step.
	SunShaftTintColor	Sun shaft tint color. Alpha value determines tint intensity.
	WindEffectsFogNoiseVelocity	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

	Name	Description
	CachedName	Get cached name (Defined by WeatherMakerObjectExtensions.)
	SetCachedName	Put name in the cache (Defined by WeatherMakerObjectExtensions.)

Top

Reference

DigitalRuby.WeatherMaker Namespace