Function computePath

  • computePath(query, start, end, options?): {
        error?: {
            name: string;
            status?: number;
        };
        path: Vector3[];
        success: boolean;
    }

  • Parameters

    • query: NavMeshQuery
    • start: Vector3
    • end: Vector3
    • Optionaloptions: {
          filter?: QueryFilter;
          halfExtents?: Vector3;
          maxPathPolys?: number;
          maxStraightPathPoints?: number;
      }
      • Optionalfilter?: QueryFilter

        The polygon filter to apply to the query.

        Default

        this.defaultFilter
      • OptionalhalfExtents?: Vector3

        The search distance along each axis. [(x, y, z)]

        Default

        this.defaultQueryHalfExtents
      • OptionalmaxPathPolys?: number

        The maximum number of polygons the path array can hold. [Limit: >= 1]

        Default

        256
      • OptionalmaxStraightPathPoints?: number

        The maximum number of points the straight path arrays can hold. [Limit: > 0]

        Default

        256

    Returns {
        error?: {
            name: string;
            status?: number;
        };
        path: Vector3[];
        success: boolean;
    }

    • Optionalerror?: {
          name: string;
          status?: number;
      }

      Error information if the path computation failed.

      • name: string

        Description of the error.

      • Optionalstatus?: number

        A dtStatus status code if relevant.

    • path: Vector3[]

      The result path.

    • success: boolean

      Whether a path was successfully computed.

Settings

Member Visibility