Vital.sandbox
GFXFog

gfx.fog.set_sun_scatter

Client

The sun scatter amount to be set for the fog post-processing effect


Syntax

local status = gfx.fog.set_sun_scatter(value)

Parameters

TypeNameDescription
floatvalueSun scatter value to be applied
Controls how much the sun's light scatters through the fog, producing a visible glow or halo effect in the direction of the sun

Returns

TypeNameDescription
boolstatustrue on successful execution, or false on failure

Examples

Add a visible sun glow through the fog
--Add a visible sun glow through the fog
gfx.fog.set_sun_scatter(0.5)

On this page