Nav3DAgent: Methods
As mentioned above, you should use the Nav3DAgent script as a component for your game object and access it via GetComponent() .
The following public methods have been implemented to operate with Nav3DAgent:
- Applies the description for your agent.
public void SetDescription(Nav3DAgentDescription _Description)
- Begins agent movement to the target point.
public void MoveTo(
Vector3 _Point,
Action _OnReach = null,
Action<PathfindingError> _OnPathfindingFail = null,
float? _ReachGap = null)
Parameters:
Vector3 _Point– target point.Action _OnReach– a callback that invokes on target point has reached.Action<PathfindingError> _OnPathfindingFail– pathfinding failure callback.float? _ReachGap– target point reach distance.
- Starts agent movement through the set of points. Pathfinding performs sequentially from each point to the next one, therefore the resulting path passes through all given goal points
public void MoveToPoints(
Vector3[] _Points,
bool _Loop = false,
bool _StartFromClosest = false,
bool _SkipUnpassableGoals = false,
float? _ReachGap = null,
Action<Vector3> _OnGoalPointPassed = null,
Action _OnFinished = null,
Action<PathfindingError> _OnPathfindingFail = null)
Parameters:
Vector3[]_Points– a goal points.bool_Loop– whether loop movement through the points. If true, then the agent will move through the points infinitely, going to the first one every time he reaches the last one.bool_StartFromClosest– whether to start movement from the nearest point, and not from the first one.bool_SkipUnpassableGoals– whether any point to which pathfinding was failed will be skipped. If option is disabled, the pathfinding failure for any pair of points will cause pathfinding to be aborted and _OnFail callback to be invoked.float?_ReachGap– distance to reach any goal point.Action<Vector3> _OnGoalPointPassed– a callback that invokes when any of the goal points are passed.Action_OnFinished– a callback that invokes when the last goal is reached. This callback will never invoke if _Loop = true.Action<PathfindingError> _OnPathfindingFail– pathfinding failure callback.
Starts the following of the transform movable target.
public void FollowTarget(
Transform _Target,
bool _FollowContinuously,
float _TargetOffsetUpdate,
float _TargetReachDistance = 0,
Action _OnReach = null,
Action _OnFail = null,
Action<PathfindingError> _OnPathfindingFail = null)
Parameters:
Transform _Target– a target transform to follow.bool _FollowContinuously– whether to follow the target infinitely. If true, the agent will never finish following and never call _OnReach. When the target is reached the agent will merely wait until it continues the movement.float _TargetOffsetUpdate– minimum target position delta that causes path re-search.float _TargetReachDistance– distance to target transform required to finish following and invoke _OnReach.Action _OnReach– on target reach callback.Action _OnFail– callback that invokes if the target was destroyed or switched to inactive condition at the scene.Action<PathfindingError> _OnPathfindingFail– pathfinding failure callback.
- Stops any previous command (MoveTo, MoveToPoints, FollowTarget).
public void Stop()
- Returns agents array within radius _Radius that satisfy the given predicate _Predicate.
public Nav3DAgent[] GetAgentsInRadius(float _Radius, Predicate<Nav3DAgent> _Predicate = null)
Examples of using Nav3DAgent can be found in the demo scenes located in Nav3D/Demo.
English 
Russian