Skip to main content

SurfaceUtils

Utility functions for surfaces

Functions​

getSurfaceCFrame​

</>
SurfaceUtils.getSurfaceCFrame(
part: Part,
lnormal: Vector3
) → CFrame

Finds a CFrame on the surface.

warning

This only works with Part objects that are rectangles.

Show raw api
{
    "functions": [
        {
            "name": "getSurfaceCFrame",
            "desc": "Finds a CFrame on the surface.\n\n:::warning\nThis only works with Part objects that are rectangles.\n:::",
            "params": [
                {
                    "name": "part",
                    "desc": "",
                    "lua_type": "Part"
                },
                {
                    "name": "lnormal",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "src/geometryutils/src/Shared/SurfaceUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SurfaceUtils",
    "desc": "Utility functions for surfaces",
    "source": {
        "line": 5,
        "path": "src/geometryutils/src/Shared/SurfaceUtils.lua"
    }
}