Skip to main content

Hide

This item only works when running on the server. Server

Primarily used for authoring, this hides the tagged instance from render. Great for making bounding boxes in studio that are then hidden upon runtime.

See Binder for usage.

Functions​

new​

</>
Hide.new(adornee: Instance) → Hide

Hides the given instances

Destroy​

</>
Hide:Destroy() → ()

Cleans up the instance

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Hides the given instances",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Hide"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/hide/src/Server/Hide.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Cleans up the instance",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 52,
                "path": "src/hide/src/Server/Hide.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Hide",
    "desc": "Primarily used for authoring, this hides the tagged instance from render. Great for\nmaking bounding boxes in studio that are then hidden upon runtime.\n\nSee [Binder] for usage.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 10,
        "path": "src/hide/src/Server/Hide.lua"
    }
}