Skip to main content

FakeSkybox

Allow transitions between skyboxes

Functions​

new​

</>
FakeSkybox.new(skybox: Skybox) → FakeSkybox

Creates a new FakeSkybox

SetPartSize​

</>
FakeSkybox:SetPartSize(partSize: number) → FakeSkybox--

self

Show​

</>
FakeSkybox:Show(doNotAnimate: boolean) → ()

Hide​

</>
FakeSkybox:Hide(doNotAnimate: boolean) → ()

SetSkybox​

</>
FakeSkybox:SetSkybox(skybox: Skybox) → FakeSkybox--

self

IsVisible​

</>
FakeSkybox:IsVisible() → boolean

Returns whether the skybox is visible.

UpdateRender​

</>
FakeSkybox:UpdateRender(baseCFrame: CFrame) → ()

Updates the rendering

Destroy​

</>
FakeSkybox:Destroy() → ()

Cleans up the fake skybox

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new FakeSkybox",
            "params": [
                {
                    "name": "skybox",
                    "desc": "",
                    "lua_type": "Skybox"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "FakeSkybox"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 42,
                "path": "src/fakeskybox/src/Client/FakeSkybox.lua"
            }
        },
        {
            "name": "SetPartSize",
            "desc": "",
            "params": [
                {
                    "name": "partSize",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "self",
                    "lua_type": "FakeSkybox"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 77,
                "path": "src/fakeskybox/src/Client/FakeSkybox.lua"
            }
        },
        {
            "name": "Show",
            "desc": "",
            "params": [
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 90,
                "path": "src/fakeskybox/src/Client/FakeSkybox.lua"
            }
        },
        {
            "name": "Hide",
            "desc": "",
            "params": [
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 107,
                "path": "src/fakeskybox/src/Client/FakeSkybox.lua"
            }
        },
        {
            "name": "SetSkybox",
            "desc": "",
            "params": [
                {
                    "name": "skybox",
                    "desc": "",
                    "lua_type": "Skybox"
                }
            ],
            "returns": [
                {
                    "desc": "self",
                    "lua_type": "FakeSkybox"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 125,
                "path": "src/fakeskybox/src/Client/FakeSkybox.lua"
            }
        },
        {
            "name": "IsVisible",
            "desc": "Returns whether the skybox is visible.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 140,
                "path": "src/fakeskybox/src/Client/FakeSkybox.lua"
            }
        },
        {
            "name": "UpdateRender",
            "desc": "Updates the rendering",
            "params": [
                {
                    "name": "baseCFrame",
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 148,
                "path": "src/fakeskybox/src/Client/FakeSkybox.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Cleans up the fake skybox",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 160,
                "path": "src/fakeskybox/src/Client/FakeSkybox.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "FakeSkybox",
    "desc": "Allow transitions between skyboxes",
    "source": {
        "line": 5,
        "path": "src/fakeskybox/src/Client/FakeSkybox.lua"
    }
}