Skip to main content

PartTouchingCalculator

Determines if parts are touching or not

Functions

new

PartTouchingCalculator.new() → ()

Constructs a new PartTouchingCalculator

GetTouching

PartTouchingCalculator:GetTouching(
basePartBasePart,--

item to identify touching. Geometry matters

paddingnumber--

studs of padding around the part

) → {BasePart}

Retrieves parts touching a base part

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new PartTouchingCalculator",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/parttouchingcalculator/src/Shared/PartTouchingCalculator.lua"
            }
        },
        {
            "name": "GetTouching",
            "desc": "Retrieves parts touching a base part",
            "params": [
                {
                    "name": "basePart",
                    "desc": "item to identify touching. Geometry matters",
                    "lua_type": "BasePart"
                },
                {
                    "name": "padding",
                    "desc": "studs of padding around the part",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ BasePart }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 133,
                "path": "src/parttouchingcalculator/src/Shared/PartTouchingCalculator.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PartTouchingCalculator",
    "desc": "Determines if parts are touching or not",
    "source": {
        "line": 5,
        "path": "src/parttouchingcalculator/src/Shared/PartTouchingCalculator.lua"
    }
}