Skip to main content

NoCollisionConstraintUtils

Utility functions to create and manipulate NoCollisionConstraint objects between Roblox parts.

See getMechanismParts.

Functions​

create​

</>
NoCollisionConstraintUtils.create(
part0: BasePart,
part1: BasePart,
parent: Instance?
) → NoCollisionConstraint

Creates a new NoCollisionConstraint between the two parts.

tempNoCollision​

</>
NoCollisionConstraintUtils.tempNoCollision(
parts0: {BasePart},
parts1: {BasePart},
parent: Instance | boolean | nil
) → Maid

Creates NoCollisionConstraint objects between the two part lists, and adds them all to a Maid for cleanup.

createBetweenPartsLists​

</>
NoCollisionConstraintUtils.createBetweenPartsLists(
parts0: {BasePart},
parts1: {BasePart},
parent: Instance | boolean | nil
) → {NoCollisionConstraint}

Creates NoCollisionConstraint objects between the two part lists.

createBetweenMechanisms​

</>
NoCollisionConstraintUtils.createBetweenMechanisms(
adornee0: BasePart,
adornee1: BasePart,
parent: Instance | boolean | nil
) → {NoCollisionConstraint}

Creates NoCollisionConstraint objects between the two mechanisms.

Show raw api
{
    "functions": [
        {
            "name": "create",
            "desc": "Creates a new [NoCollisionConstraint] between the two parts.",
            "params": [
                {
                    "name": "part0",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "part1",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "NoCollisionConstraint"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/nocollisionconstraintutils/src/Shared/NoCollisionConstraintUtils.lua"
            }
        },
        {
            "name": "tempNoCollision",
            "desc": "Creates [NoCollisionConstraint] objects between the two part lists, and adds them all to a [Maid]\nfor cleanup.",
            "params": [
                {
                    "name": "parts0",
                    "desc": "",
                    "lua_type": "{ BasePart }"
                },
                {
                    "name": "parts1",
                    "desc": "",
                    "lua_type": "{ BasePart }"
                },
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance | boolean | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Maid"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 42,
                "path": "src/nocollisionconstraintutils/src/Shared/NoCollisionConstraintUtils.lua"
            }
        },
        {
            "name": "createBetweenPartsLists",
            "desc": "Creates [NoCollisionConstraint] objects between the two part lists.",
            "params": [
                {
                    "name": "parts0",
                    "desc": "",
                    "lua_type": "{ BasePart }"
                },
                {
                    "name": "parts1",
                    "desc": "",
                    "lua_type": "{ BasePart }"
                },
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance | boolean | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ NoCollisionConstraint }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 62,
                "path": "src/nocollisionconstraintutils/src/Shared/NoCollisionConstraintUtils.lua"
            }
        },
        {
            "name": "createBetweenMechanisms",
            "desc": "Creates [NoCollisionConstraint] objects between the two mechanisms.",
            "params": [
                {
                    "name": "adornee0",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "adornee1",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance | boolean | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ NoCollisionConstraint }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 98,
                "path": "src/nocollisionconstraintutils/src/Shared/NoCollisionConstraintUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "NoCollisionConstraintUtils",
    "desc": "Utility functions to create and manipulate [NoCollisionConstraint] objects between Roblox parts.\n\nSee [getMechanismParts].",
    "source": {
        "line": 8,
        "path": "src/nocollisionconstraintutils/src/Shared/NoCollisionConstraintUtils.lua"
    }
}