|
| override void | OnPulse () |
| override MoveResult | MoveTo (MoveToParameters parameters) |
| override bool | AtLocation (Vector3 point1, Vector3 point2) |
| override bool | Clear () |
| | Clears the current path in this nav provider.- Returns
|
| override void | ClearStuckInfo () |
| | Clears the stuck handler information.
|
| override PathInformation | LookupPathInfo (GameObject obj, float distanceTolerance=3) |
| | Looks up the information of a path going to an object.- Parameters
-
| obj | The object. |
| distanceTolerance | The distance to get within obj . |
- Exceptions
-
| ArgumentNullException | obj is null. |
- Returns
- The path information. Always non-
null.
Path information lookups are in general extremely fast to perform. They require minimal CPU computation.
|
| override void | OnSetAsCurrent () |
| | Called when this NavigationProvider is set as the current by assigning it to Navigator.NavigationProvider.When this is called, the current has not yet been updated, so IsCurrent will still be false.
|
| override void | OnRemoveAsCurrent () |
| | Called when this NavigationProvider is removed as the current by assigning a different provider to Navigator.NavigationProvider.When this is called, the current has not yet been updated, so IsCurrent will still be true.
|
| override Task< List< Vector3 > > | SamplePointsAsync (SamplePointsParameters parameters) |
| | Samples the navigator for points.- Parameters
-
| parameters | The parameters. |
- Exceptions
-
| ArgumentNullException | parameters is null. |
| ArgumentException | parameters is in an invalid state. |
- Returns
- The result of the sampling.
This is an external asynchronous task, and should not be awaited directly from coroutines. See Coroutine.ExternalTask(Func<Task>).
|
| void | OnPulse () |
| | Pulses this provider. Called every tick.
|
| MoveResult | MoveTo (MoveToParameters parameters) |
| | Moves towards the specified locations.
|
| virtual Task< List< CanFullyNavigateResult > > | CanFullyNavigateTo (ICollection< CanFullyNavigateTarget > targets, Vector3 start, ushort zoneid) |
| | Check if multiple locations can be pathed to on the given zoneid.
|
| virtual Task< List< CanFullyNavigateResult > > | CanFullyNavigateFrom (ICollection< CanFullyNavigateTarget > starts, Vector3 target, ushort zoneid) |
| | Check if multiple locations can be path from to one specific spot.
|
| async Task< List< CanFullyNavigateResult > > | CanFullyNavigateTo (ICollection< CanFullyNavigateTarget > targets) |
| | Check if multiple locations can be pathed to on the current zone.
|
| bool | AtLocation (Vector3 point1, Vector3 point2) |
| | Gets a bool that indicates whether one position is considered to be at another position. Can be used to check if the player has reached a destination, for example.
|
Provides a helper for wrapping a different navigation provider.
This class is meant to be derived from when wrapping a different navigation provider to extend or remove certain features from it.
