Class PathProgress
A helper class to track the path progress of the SimpleAgent
.
Inheritance
Namespace: AlchemyBow.Navigation.Simple.Elements
Assembly: AlchemyBow.Navigation.dll
Syntax
public sealed class PathProgress
Constructors
| Improve this Doc View SourcePathProgress(Int32, Vector3[], Int32, IImmutableFace[])
Creates an instance of the PathProgress class.
Declaration
public PathProgress(int currentPoint, Vector3[] pointPath, int currentFace, IImmutableFace[] facePath)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | currentPoint | The index of the current waypoint. |
UnityEngine.Vector3[] | pointPath | The path of waypoints. |
System.Int32 | currentFace | The index of the current face. |
IImmutableFace[] | facePath | The path of faces. |
Fields
| Improve this Doc View SourcecurrentFace
The index of the current face.
Declaration
public int currentFace
Field Value
Type | Description |
---|---|
System.Int32 | The index of the current face. |
currentPoint
The index of the current waypoint.
Declaration
public int currentPoint
Field Value
Type | Description |
---|---|
System.Int32 | The index of the current waypoint. |
facePath
The faces.
Declaration
public readonly IImmutableFace[] facePath
Field Value
Type | Description |
---|---|
IImmutableFace[] | The faces. |
facesCount
The number of faces.
Declaration
public readonly int facesCount
Field Value
Type | Description |
---|---|
System.Int32 | The number of faces. |
pointPath
The waypoints.
Declaration
public readonly Vector3[] pointPath
Field Value
Type | Description |
---|---|
UnityEngine.Vector3[] | The waypoints. |
pointsCount
The number of waypoints.
Declaration
public readonly int pointsCount
Field Value
Type | Description |
---|---|
System.Int32 | The number of waypoints. |
Properties
| Improve this Doc View SourceCurrentFace
Gets the current face.
Declaration
public IImmutableFace CurrentFace { get; }
Property Value
Type | Description |
---|---|
IImmutableFace | The current face. |
CurrentPoint
Gets the current waypoint.
Declaration
public Vector3 CurrentPoint { get; }
Property Value
Type | Description |
---|---|
UnityEngine.Vector3 | The current waypoint. |
HasNextFace
Determines whether there is the next face.
Declaration
public bool HasNextFace { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasNextPoint
Determines whether there is the next waypoint.
Declaration
public bool HasNextPoint { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
IsFinished
Determines whether the agent has reached the last waypoint.
Declaration
public bool IsFinished { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
NextFace
Gets the next face.
Declaration
public IImmutableFace NextFace { get; }
Property Value
Type | Description |
---|---|
IImmutableFace | The next face. |
Methods
| Improve this Doc View SourceIsCurrentPointOnCurrentOrNextFaces()
Determines whether the current point is on the current face or on any of the following.
Declaration
public bool IsCurrentPointOnCurrentOrNextFaces()
Returns
Type | Description |
---|---|
System.Boolean |
|