Skip to main content

Lighting

This item only works when running on the client. Client

A table of utility functions for working with Lighting that can be used to speed up the process of writing repository scripts for client objects.

Functions​

changeLighting​

</>
Lighting.changeLighting(
config: LightingManager_Types.LightingConfiguration,
scope: Scope?
) → ()

Changes the active lighting based on the given config. See LightingManager for more info.

resetLighting​

</>
Lighting.resetLighting() → ()

Resets all lighting properties back to their default state.

Show raw api
{
    "functions": [
        {
            "name": "changeLighting",
            "desc": "Changes the active lighting based on the given `config`.\nSee [LightingManager](/api/LightingManager#ChangeLighting) for more info.",
            "params": [
                {
                    "name": "config",
                    "desc": "",
                    "lua_type": "LightingManager_Types.LightingConfiguration"
                },
                {
                    "name": "scope",
                    "desc": "",
                    "lua_type": "Scope?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 30,
                "path": "mirror/Kit.Utility.Lighting.luau"
            }
        },
        {
            "name": "resetLighting",
            "desc": "Resets all lighting properties back to their default state.",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 55,
                "path": "mirror/Kit.Utility.Lighting.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Lighting",
    "desc": "A table of utility functions for working with Lighting that can be used to speed up the process of writing repository scripts for client objects.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 10,
        "path": "mirror/Kit.Utility.Lighting.luau"
    }
}