Skip to main content

Collider

Internal class for colliders

Caution:

Changes to the syntax in this class will not count to the major version in semver.

Properties​

Type​

</>
Collider.Type: string

Scale​

</>
Collider.Scale: Vector3

Offset​

</>
Collider.Offset: Vector3

Rotation​

</>
Collider.Rotation: Vector3

PreviousScale​

</>
Collider.PreviousScale: Vector3

PreviousOffset​

</>
Collider.PreviousOffset: Vector3

PreviousRotation​

</>
Collider.PreviousRotation: Vector3

InNarrowphase​

</>
Collider.InNarrowphase: boolean

ObjectConnection​

</>
Collider.ObjectConnection: RBXScriptConnection

Transform​

</>
Collider.Transform: CFrame

Size​

</>
Collider.Size: Vector3

GUID​

</>
Collider.GUID: string

Functions​

new​

</>
Collider.new() → ()

SetObject​

</>
Collider:SetObject(Object: BasePart) → ()

UpdateTransform​

</>
Collider:UpdateTransform() → ()

GetClosestPoint​

</>
Collider:GetClosestPoint(
Point: Vector3,
Radius: number
) → Vector3 | nil--

Returns nil if specified collider shape is invalid

Step​

</>
Collider:Step() → ()

DrawDebug​

</>
Collider:DrawDebug(
ColliderObject: ColliderObject,
FILL_COLLIDER: boolean,
SHOW_INFLUENCE: boolean,
SHOW_AWAKE: boolean,
SHOW_BROADPHASE: boolean
) → ()

Destroy​

</>
Collider:Destroy() → ()
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 76,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "SetObject",
            "desc": "",
            "params": [
                {
                    "name": "Object",
                    "desc": "",
                    "lua_type": "BasePart"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 105,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "UpdateTransform",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 112,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "GetClosestPoint",
            "desc": "",
            "params": [
                {
                    "name": "Point",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "Radius",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "Returns nil if specified collider shape is invalid",
                    "lua_type": "Vector3 | nil"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 137,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "Step",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 182,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "DrawDebug",
            "desc": "",
            "params": [
                {
                    "name": "ColliderObject",
                    "desc": "",
                    "lua_type": "ColliderObject"
                },
                {
                    "name": "FILL_COLLIDER",
                    "desc": "",
                    "lua_type": "boolean"
                },
                {
                    "name": "SHOW_INFLUENCE",
                    "desc": "",
                    "lua_type": "boolean"
                },
                {
                    "name": "SHOW_AWAKE",
                    "desc": "",
                    "lua_type": "boolean"
                },
                {
                    "name": "SHOW_BROADPHASE",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 194,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 286,
                "path": "src/Components/Collision/Collider.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "Type",
            "desc": "",
            "lua_type": "string",
            "source": {
                "line": 33,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "Scale",
            "desc": "",
            "lua_type": "Vector3",
            "source": {
                "line": 36,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "Offset",
            "desc": "",
            "lua_type": "Vector3",
            "source": {
                "line": 39,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "Rotation",
            "desc": "",
            "lua_type": "Vector3",
            "source": {
                "line": 42,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "PreviousScale",
            "desc": "",
            "lua_type": "Vector3",
            "source": {
                "line": 45,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "PreviousOffset",
            "desc": "",
            "lua_type": "Vector3",
            "source": {
                "line": 48,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "PreviousRotation",
            "desc": "",
            "lua_type": "Vector3",
            "source": {
                "line": 51,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "m_Object",
            "desc": "",
            "lua_type": "BasePart",
            "private": true,
            "readonly": true,
            "source": {
                "line": 56,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "InNarrowphase",
            "desc": "",
            "lua_type": "boolean",
            "source": {
                "line": 59,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "ObjectConnection",
            "desc": "",
            "lua_type": "RBXScriptConnection",
            "source": {
                "line": 62,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "Transform",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 65,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "Size",
            "desc": "",
            "lua_type": "Vector3",
            "source": {
                "line": 68,
                "path": "src/Components/Collision/Collider.lua"
            }
        },
        {
            "name": "GUID",
            "desc": "",
            "lua_type": "string",
            "source": {
                "line": 71,
                "path": "src/Components/Collision/Collider.lua"
            }
        }
    ],
    "types": [],
    "name": "Collider",
    "desc": "Internal class for colliders\n:::caution Caution:\nChanges to the syntax in this class will not count to the major version in semver.\n:::\r",
    "source": {
        "line": 30,
        "path": "src/Components/Collision/Collider.lua"
    }
}