Skip to main content

TouchingPartUtils

Utility to get touching parts on a Roblox part. This acts as a performance-friendly way to query Roblox's spatial tree.

Functions​

getAllTouchingParts​

</>
TouchingPartUtils.getAllTouchingParts(part: BasePart) → {BasePart}

Gets all the touching parts to a base part

getBoundingBoxParts​

</>
TouchingPartUtils.getBoundingBoxParts(
cframe: CFrame,
size: Vector3
) → {BasePart}

Returns all parts that are touching the given part.

Show raw api
{
    "functions": [
        {
            "name": "getAllTouchingParts",
            "desc": "Gets all the touching parts to a base part",
            "params": [
                {
                    "name": "part",
                    "desc": "",
                    "lua_type": "BasePart"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ BasePart }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 22,
                "path": "src/touchingpartutils/src/Shared/TouchingPartUtils.lua"
            }
        },
        {
            "name": "getBoundingBoxParts",
            "desc": "Returns all parts that are touching the given part.",
            "params": [
                {
                    "name": "cframe",
                    "desc": "",
                    "lua_type": "CFrame"
                },
                {
                    "name": "size",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ BasePart }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/touchingpartutils/src/Shared/TouchingPartUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TouchingPartUtils",
    "desc": "Utility to get touching parts on a Roblox part.\nThis acts as a performance-friendly way to query\nRoblox's spatial tree.",
    "source": {
        "line": 9,
        "path": "src/touchingpartutils/src/Shared/TouchingPartUtils.lua"
    }
}