Skip to main content

FakeSkybox

Allow transitions between skyboxes

Functions​

new​

</>
FakeSkybox.new() → FakeSkybox

Constructs a new skybox defaulting to the current lighting + camera.

SetPartSize​

</>
FakeSkybox.SetPartSize(
self: FakeSkybox,
skyboxWidth: ValueObject.Mountable<number>
) → ()

Set the part size

SetSpeed​

</>
FakeSkybox.SetSpeed(
self: FakeSkybox,
speed: number
) → ()

Sets the transition speed of the fake skybox

SetRenderMethod​

</>
FakeSkybox.SetRenderMethod(
self: FakeSkybox,
renderMethod: ValueObject.Mountable<FakeSkyboxRenderMethod.FakeSkyboxRenderMethod>
) → ()

Sets the render method for the skybox parts

SetSky​

</>
FakeSkybox.SetSky(
self: FakeSkybox,
sky: ValueObject.Mountable<Sky?>?
) → () → ()

Sets the skybox

SetAtmosphere​

</>
FakeSkybox.SetAtmosphere(
self: FakeSkybox,
atmosphere: ValueObject.Mountable<Atmosphere?>?
) → () → ()

Sets the atmosphere

SetCamera​

</>
FakeSkybox.SetCamera(
self: FakeSkybox,
camera: ValueObject.Mountable<Camera?>?
) → () → ()

Sets the camera to track to

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new skybox defaulting to the current lighting + camera.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "FakeSkybox\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 91,
                "path": "src/fakeskybox/src/Client/Render/FakeSkybox.lua"
            }
        },
        {
            "name": "SetPartSize",
            "desc": "Set the part size",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FakeSkybox"
                },
                {
                    "name": "skyboxWidth",
                    "desc": "",
                    "lua_type": "ValueObject.Mountable<number>"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 129,
                "path": "src/fakeskybox/src/Client/Render/FakeSkybox.lua"
            }
        },
        {
            "name": "SetSpeed",
            "desc": "Sets the transition speed of the fake skybox",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FakeSkybox"
                },
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 136,
                "path": "src/fakeskybox/src/Client/Render/FakeSkybox.lua"
            }
        },
        {
            "name": "SetRenderMethod",
            "desc": "Sets the render method for the skybox parts",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FakeSkybox"
                },
                {
                    "name": "renderMethod",
                    "desc": "",
                    "lua_type": "ValueObject.Mountable<FakeSkyboxRenderMethod.FakeSkyboxRenderMethod>\n"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 143,
                "path": "src/fakeskybox/src/Client/Render/FakeSkybox.lua"
            }
        },
        {
            "name": "SetSky",
            "desc": "Sets the skybox",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FakeSkybox"
                },
                {
                    "name": "sky",
                    "desc": "",
                    "lua_type": "ValueObject.Mountable<Sky?>?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "() -> ()\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 153,
                "path": "src/fakeskybox/src/Client/Render/FakeSkybox.lua"
            }
        },
        {
            "name": "SetAtmosphere",
            "desc": "Sets the atmosphere",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FakeSkybox"
                },
                {
                    "name": "atmosphere",
                    "desc": "",
                    "lua_type": "ValueObject.Mountable<Atmosphere?>?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "() -> ()\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 160,
                "path": "src/fakeskybox/src/Client/Render/FakeSkybox.lua"
            }
        },
        {
            "name": "SetCamera",
            "desc": "Sets the camera to track to",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FakeSkybox"
                },
                {
                    "name": "camera",
                    "desc": "",
                    "lua_type": "ValueObject.Mountable<Camera?>?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "() -> ()\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 183,
                "path": "src/fakeskybox/src/Client/Render/FakeSkybox.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "FakeSkybox",
    "desc": "Allow transitions between skyboxes",
    "source": {
        "line": 7,
        "path": "src/fakeskybox/src/Client/Render/FakeSkybox.lua"
    }
}