Vital.sandbox
GFXVolumetric Fog

gfx.volumetric_fog.set_enabled

Client

Toggles the volumetric fog post-processing effect


Syntax

local status = gfx.volumetric_fog.set_enabled(state)

Parameters

TypeNameDescription
boolstateDetermines volumetric fog's state:
• When true - volumetric fog is enabled
• When false - volumetric fog is disabled

Returns

TypeNameDescription
boolstatustrue on successful execution, or false on failure

Examples

Enable and disable volumetric fog
--Enable volumetric fog
gfx.volumetric_fog.set_enabled(true)

--Disable volumetric fog
gfx.volumetric_fog.set_enabled(false)

On this page