WeatherMakerFogProfileScript Class

Base fog profile

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

public class WeatherMakerFogProfileScript : ScriptableObject

Public Class WeatherMakerFogProfileScript
	Inherits ScriptableObject

public ref class WeatherMakerFogProfileScript : public ScriptableObject

type WeatherMakerFogProfileScript =  
    class
        inherit ScriptableObject
    end

The WeatherMakerFogProfileScript type exposes the following members.

Constructors

	Name	Description
	WeatherMakerFogProfileScript	Initializes a new instance of the WeatherMakerFogProfileScript class

Top

Properties

	Name	Description
	FogScatterReduction	Density of fog for scattering reduction
	HasNoise	Whether this fog profile will render noise in the fog
	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
	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
	UpdateMaterialProperties	Update a fog material with fog properties from this object

Top

Fields

	Name	Description
	DitherLevel	Dithering level. 0 to disable dithering.
	FogCloudShadowStrength	How much cloud shadows effect the fog, set to 0 for indoor fog.
	FogColor	Fog color
	FogDensity	Fog density
	FogDensityGradient	Fog density gradient based on sun position where center is sun at horizon. Use alpha, color is ignored.
	FogEdgeFalloffPower	Fog edge falloff power. Ignored for full screen fog.
	FogEdgeSmoothFactor	Fog edge smooth factor. Ignored for full screen fog.
	FogEmissionColor	Fog emission color, alpha is intensity
	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.
	FogFactorMultiplier	Multiply the computed fog factor by this value
	FogGradientColor	Fog gradient color based on sun position where center is sun at horizon.
	FogHeightFalloffPower	Fog height falloff power.
	FogLightAbsorption	Fog light absorption - lower values absorb more light, higher values scatter and intensify light more.
	FogMode	Fog mode
	FogNoiseAdder	Controls how the noise value is calculated. Negative values allow areas of no noise, higher values increase the intensity of the noise.
	FogNoiseMultiplier	How much the noise effects the fog.
	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.
	FogNoiseScale	Fog noise scale. Lower values get less tiling. 0 to disable noise.
	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).
	FogNoiseVelocityRotation	Fog noise rotation speed in radians per second. W is rotation radius.
	FogShadowBrightness	Controls brightness of light in the fog vs in shadow. Higher values are brighter in the shadows.
	FogShadowDecay	Controls how light falls off from the light source. Lower values fall off faster.
	FogShadowDither	Fog shadow dither multiplier. Higher values dither more.
	FogShadowDitherMagic	Magic numbers for fog shadow dithering. Tweak if you don't like the dithering appearance.
	FogShadowMaxRayLength	Max ray length for fog shadows. Set to 0 to disable fog shadows.
	FogShadowMultiplier	Multiplier for fog shadow lighting. Higher values make brighter light rays.
	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.
	FogShadowSampleCount	Number of shadow samples, 0 to disable fog shadows.
	FogShadowStrengthFactor	Control how fog casts shadow. Larger values cast more shadow.
	FogStartDepth	The depth where fog starts (in world space units). Ignored if fog is not full screen or fog has a height limit.
	MaxFogFactor	Maximum fog factor, where 1 is the maximum allowed fog.
	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.

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