navcat docs
    Preparing search index...

    Type Alias FindPathResult

    type FindPathResult = {
        endNodeRef: NodeRef | null;
        endPosition: Vec3;
        flags: FindPathResultFlags;
        nodePath: FindNodePathResult | null;
        nodePathFlags: FindNodePathResultFlags;
        path: StraightPathPoint[];
        startNodeRef: NodeRef | null;
        startPosition: Vec3;
        straightPathFlags: FindStraightPathResultFlags;
        success: boolean;
    }
    Index

    Properties

    endNodeRef endPosition flags nodePath nodePathFlags path startNodeRef startPosition straightPathFlags success

    Properties

    endNodeRef: NodeRef | null

    the end poly node ref

    endPosition: Vec3

    the end closest point

    flags: FindPathResultFlags

    the status flags of the pathfinding operation

    nodePath: FindNodePathResult | null

    the node path result

    nodePathFlags: FindNodePathResultFlags

    the status flags of the node pathfinding operation

    path: StraightPathPoint[]

    the path, consisting of polygon node and offmesh link node references

    startNodeRef: NodeRef | null

    the start poly node ref

    startPosition: Vec3

    the start closest point

    straightPathFlags: FindStraightPathResultFlags

    the status flags of the straight pathfinding operation

    success: boolean

    whether the search completed successfully, with either a partial or complete path

    Settings

    Member Visibility

    On This Page

    Properties