Skip to main content

Light

The global lighting interface

Light.ambient = 0.6

Properties​

ambient​

</>
Light.ambient: number

Get/Set the global ambient value

The global background lightness. A dark room needs extra lights for you to see its contents.

bleed​

</>
Light.bleed: number

Get/Set the light bleed value

Affects the color mixing of the lights.

factor​

</>
Light.factor: number

Get/Set the light factor value

Affects the color mixing of the lights.

smooth​

</>
Light.smooth: number

Get/Set the light smooth value

For smoothing the sharp edges of the shadows.

smooth_amplitude​

</>
Light.smooth_amplitude: number

Get/Set the smooth amplitude value

For alternating the light smoothness over time.

env_radius​

</>
Light.env_radius: number

Get/Set the light environment radius

This affects all lighting sources of the room.

env_strength​

</>
Light.env_strength: number

Get/Set the light environment strength

This affects all lighting sources of the room.

smooth_passes​

</>
Light.smooth_passes: number

Get/Set the amount of smooth passes per frame

Used to calibrate the smoothing algorithm. This determines the maximum range of a cell. Higher values have a bigger performance impact.

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "ambient",
            "desc": "Get/Set the global ambient value\n\nThe global background lightness.\nA dark room needs extra lights for you to see its contents.",
            "lua_type": "number",
            "source": {
                "line": 20,
                "path": "../../res/data/script/lib/system/light.lua"
            }
        },
        {
            "name": "bleed",
            "desc": "Get/Set the light bleed value\n\nAffects the color mixing of the lights.",
            "lua_type": "number",
            "source": {
                "line": 29,
                "path": "../../res/data/script/lib/system/light.lua"
            }
        },
        {
            "name": "factor",
            "desc": "Get/Set the light factor value\n\nAffects the color mixing of the lights.",
            "lua_type": "number",
            "source": {
                "line": 38,
                "path": "../../res/data/script/lib/system/light.lua"
            }
        },
        {
            "name": "smooth",
            "desc": "Get/Set the light smooth value\n\nFor smoothing the sharp edges of the shadows.",
            "lua_type": "number",
            "source": {
                "line": 47,
                "path": "../../res/data/script/lib/system/light.lua"
            }
        },
        {
            "name": "smooth_amplitude",
            "desc": "Get/Set the smooth amplitude value\n\nFor alternating the light smoothness over time.",
            "lua_type": "number",
            "source": {
                "line": 56,
                "path": "../../res/data/script/lib/system/light.lua"
            }
        },
        {
            "name": "env_radius",
            "desc": "Get/Set the light environment radius\n\nThis affects all lighting sources of the room.",
            "lua_type": "number",
            "source": {
                "line": 65,
                "path": "../../res/data/script/lib/system/light.lua"
            }
        },
        {
            "name": "env_strength",
            "desc": "Get/Set the light environment strength\n\nThis affects all lighting sources of the room.",
            "lua_type": "number",
            "source": {
                "line": 74,
                "path": "../../res/data/script/lib/system/light.lua"
            }
        },
        {
            "name": "smooth_passes",
            "desc": "Get/Set the amount of smooth passes per frame\n\nUsed to calibrate the smoothing algorithm.\nThis determines the maximum range of a cell.\nHigher values have a bigger performance impact.",
            "lua_type": "number",
            "source": {
                "line": 85,
                "path": "../../res/data/script/lib/system/light.lua"
            }
        }
    ],
    "types": [],
    "name": "Light",
    "desc": "The global lighting interface\n\n```lua\nLight.ambient = 0.6\n```",
    "source": {
        "line": 9,
        "path": "../../res/data/script/lib/system/light.lua"
    }
}