Skip to main content

SPostProcessVolume

Index​

Properties Index​

Property Name
bool Enabled get set
bool IsGlobal get set
float? BlendDistance get set
float?? Weight get set
float Priority get set
SGameObject GameObject get

Properties​

Enabled​

bool Enabled get set

Enable or disable post effect volume.

Space.Host.ExecutingObject.PostProcessVolume.Enabled = true
--clicking this object will Enable/Disable it's Post Process Volume component
thisGameObject = Space.Host.ExecutingObject
component = thisGameObject.PostProcessVolume

OnClick = function()
component.Enabled =  not component.Enabled
end


thisGameObject.AddClickable()
thisGameObject.Clickable.OnClick(OnClick)

IsGlobal​

bool IsGlobal get set

Should this volume be applied to the whole scene?

Space.Host.ExecutingObject.PostProcessVolume.IsGlobal = true

BlendDistance​

float? BlendDistance get set

The outer distance to start blending from. A value of 0 means no blending and the volume overrides will be applied immediately upon entry.

Space.Host.ExecutingObject.PostProcessVolume.BlendDistance = 0

Weight​

float?? Weight get set

The total weight of this volume in the scene. 0 means it won't do anything, 1 means full effect.

Space.Host.ExecutingObject.PostProcessVolume.Weight = 1

Priority​

float Priority get set

The volume priority in the stack. Higher number means higher priority. Negative values are supported.

Space.Host.ExecutingObject.PostProcessVolume.Priority = 100

GameObject​

SGameObject GameObject get

Property Description

theGameObject = Space.Host.ExecutingObject.PostProcessVolume.GameObject