Skip to main content

ClipCharacters

Clip characters locally on the client of other clients so they don't interfer with physics.

Functions​

initServer​

This item only works when running on the server. Server
</>
ClipCharacters.initServer() → ()

Initialize on server

new​

This item only works when running on the client. Client
</>
ClipCharacters.new() → ClipCharacters

Initialize clipping on the client. Returns a new inst

Destroy​

</>
ClipCharacters:Destroy() → ()

Stop clipping on client

Show raw api
{
    "functions": [
        {
            "name": "initServer",
            "desc": "Initialize on server",
            "params": [],
            "returns": [],
            "function_type": "static",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 25,
                "path": "src/clipcharacters/src/Shared/ClipCharacters.lua"
            }
        },
        {
            "name": "new",
            "desc": "Initialize clipping on the client. Returns a new inst",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ClipCharacters"
                }
            ],
            "function_type": "static",
            "realm": [
                "Client"
            ],
            "source": {
                "line": 40,
                "path": "src/clipcharacters/src/Shared/ClipCharacters.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Stop clipping on client",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 134,
                "path": "src/clipcharacters/src/Shared/ClipCharacters.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ClipCharacters",
    "desc": "Clip characters locally on the client of other clients so they don't interfer with physics.",
    "source": {
        "line": 5,
        "path": "src/clipcharacters/src/Shared/ClipCharacters.lua"
    }
}