Class PathfindingRequest

Describes a pathfinding request and holds its result.

Inheritance

System.Object

PathfindingRequest

Namespace: AlchemyBow.Navigation

Assembly: AlchemyBow.Navigation.dll

Syntax

public sealed class PathfindingRequest

Constructors

| Improve this Doc View Source

PathfindingRequest(Int32, Int32, Single, Vector3, Vector3, PathfindingRequest.PathType, IImmutableFace)

Creates a new instance of the PathfindingRequest class.

Declaration

public PathfindingRequest(int layer, int areaMask, float radius, Vector3 startPosition, Vector3 endPosition, PathfindingRequest.PathType pathType, IImmutableFace startFace = null)

Parameters

Type	Name	Description
System.Int32	layer	Index of the layer on which to search for the path.
System.Int32	areaMask	The area mask that specyfies which faces should be considered during pathfinding.
System.Single	radius	Defines how close the agent center can get to edges of the navigation mesh.
UnityEngine.Vector3	startPosition	The end point of a path.
UnityEngine.Vector3	endPosition	The end point of a path.
PathfindingRequest.PathType	pathType	How to calculate a path.
IImmutableFace	startFace	The start face of the path. (optional)

Fields

| Improve this Doc View Source

areaMask

The area mask that specyfies which faces should be considered during pathfinding.

Declaration

public readonly int areaMask

Field Value

Type	Description
System.Int32	TThe area mask that specyfies which faces should be considered during pathfinding.

| Improve this Doc View Source

endPosition

The end point of a path.

Declaration

public readonly Vector3 endPosition

Field Value

Type	Description
UnityEngine.Vector3	The end point of a path.

| Improve this Doc View Source

facePath

The result face path.

Declaration

public IImmutableFace[] facePath

Field Value

Type	Description
IImmutableFace[]	The result face path, or `null`.

| Improve this Doc View Source

layer

The index of the layer on which to search for the path.

Declaration

public readonly int layer

Field Value

Type	Description
System.Int32	The index of the layer on which to search for the path.

| Improve this Doc View Source

path

The result waypoint path.

Declaration

public Vector3[] path

Field Value

Type	Description
UnityEngine.Vector3[]	The result waypoint path, or `null`.

| Improve this Doc View Source

pathType

How to calculate a path.

Declaration

public readonly PathfindingRequest.PathType pathType

Field Value

Type	Description
PathfindingRequest.PathType	The type of a path.

| Improve this Doc View Source

radius

Defines how close the agent center can get to edges of the navigation mesh.

Declaration

public readonly float radius

Field Value

Type	Description
System.Single	The navigation radius of the agent.

| Improve this Doc View Source

startFace

The start face of the path. (optional)

Declaration

public readonly IImmutableFace startFace

Field Value

Type	Description
IImmutableFace	The start face of the path, or `null`.

| Improve this Doc View Source

startPosition

The start point of a path.

Declaration

public readonly Vector3 startPosition

Field Value

Type	Description
UnityEngine.Vector3	The start point of a path.

| Improve this Doc View Source

status

The current status of the pathfinding process calculation.

Declaration

public PathfindingRequest.Status status

Field Value

Type	Description
PathfindingRequest.Status	The current status of the pathfinding process calculation.