Skip to main content

PathfindingUtils

Utilities involving pathfinding in Roblox

Functions​

promiseComputeAsync​

</>
PathfindingUtils.promiseComputeAsync(
path: Path,
start: Vector3,
finish: Vector3
) → Promise<Path>

Computes a path wrapped in a promise.

promiseCheckOcclusion​

</>
PathfindingUtils.promiseCheckOcclusion(
path: Path,
startIndex: number
) → Promise<number>

Checks occlusion wrapped in a promise

visualizePath​

</>
PathfindingUtils.visualizePath(path: Path) → MaidTask

Visualizes the current waypoints in the path. Will put the visualization in Draw libraries default parent.

Show raw api
{
    "functions": [
        {
            "name": "promiseComputeAsync",
            "desc": "Computes a path wrapped in a promise.",
            "params": [
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "Path"
                },
                {
                    "name": "start",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "finish",
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Path>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 22,
                "path": "src/pathfindingutils/src/Shared/PathfindingUtils.lua"
            }
        },
        {
            "name": "promiseCheckOcclusion",
            "desc": "Checks occlusion wrapped in a promise",
            "params": [
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "Path"
                },
                {
                    "name": "startIndex",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 46,
                "path": "src/pathfindingutils/src/Shared/PathfindingUtils.lua"
            }
        },
        {
            "name": "visualizePath",
            "desc": "Visualizes the current waypoints in the path. Will put the visualization in\nDraw libraries default parent.",
            "params": [
                {
                    "name": "path",
                    "desc": "",
                    "lua_type": "Path"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "MaidTask"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "src/pathfindingutils/src/Shared/PathfindingUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PathfindingUtils",
    "desc": "Utilities involving pathfinding in Roblox",
    "source": {
        "line": 5,
        "path": "src/pathfindingutils/src/Shared/PathfindingUtils.lua"
    }
}