Vital.sandbox
GFXFog

gfx.fog.set_light_color

Client

The light color to be set for the fog post-processing effect


Syntax

local status = gfx.fog.set_light_color(color)
local status = gfx.fog.set_light_color(hex)

Parameters

TypeNameDescription
colorcolorLight color of the fog as {r, g, b, a}
stringhexAlternatively, a valid HTML hex color string (e.g. "#ffffff")

Returns

TypeNameDescription
boolstatustrue on successful execution, or false on failure

Examples

Set fog light color using a color table
--Set fog light color using a color table
gfx.fog.set_light_color({0.5, 0.6, 0.7, 1.0})
Set fog light color using a hex string
--Set fog light color using a hex string
gfx.fog.set_light_color("#8fa3b1")

On this page