Vital.sandbox
GFXFog

gfx.fog.set_height

Client

The height threshold to be set for the fog post-processing effect


Syntax

local status = gfx.fog.set_height(value)

Parameters

TypeNameDescription
floatvalueHeight value to be applied
Sets the world-space Y position at which the height fog effect begins

Returns

TypeNameDescription
boolstatustrue on successful execution, or false on failure

Examples

Set the height at which fog begins
--Set the height at which fog begins
gfx.fog.set_height(0.0)

On this page