SNavMeshAgent
Index
Functions Index
float GetAreaCost (int areaIndex)
void Move (SVector movement)
void Resume ()
void SetAreaCost (int areaIndex, float cost)
void Stop ()
void SetDestination (SVector position)
void Warp (SVector position)
Properties Index
bool Enabled get
set
float Accelleration get
set
float AngularSpeed get
set
int AreaMask get
set
bool AutoRepath get
set
bool AutoBraking get
set
bool AutoTraverseOffMeshLink get
set
int AvoidancePriority get
set
float BaseOffset get
set
SVector DesiredVelocity get
SVector Destination get
set
bool HasPath get
float Height get
set
bool IsOnNavMesh get
bool IsOnOffMeshLink get
bool IsPathStale get
SVector NextPosition get
set
SVector PathEndPosition get
bool PathPending get
float Radius get
set
float RemainingDistance get
float Speed get
set
SVector SteeringTarget get
float StoppingDistance get
set
bool UpdatePosition get
set
bool UpdateRotation get
set
SVector Velocity get
SGameObject GameObject get
Functions
GetAreaCost
float GetAreaCost (int areaIndex)
Function Description
Move
void Move (SVector movement)
Apply relative movement to current position.
Resume
void Resume ()
Resume the NavMesh agent.
SetAreaCost
void SetAreaCost (int areaIndex, float cost)
Sets the cost for traversing over areas of the area type.
Stop
void Stop ()
To stop the NavMesh agent.
SetDestination
void SetDestination (SVector position)
Set or update the destination.
Warp
void Warp (SVector position)
Warp to the position you want, also you can set agent's world position and vector to make this act as Move(SVector position).
Properties
Enabled
bool Enabled get
set
Enable or disable this component.
Accelleration
float Accelleration get
set
The maximum acceleration of an agent as it follows a path.
AngularSpeed
float AngularSpeed get
set
Maximum turning speed in while following a path.
AreaMask
int AreaMask get
set
Specifies which NavMesh area is passable.
AutoRepath
bool AutoRepath get
set
Set the agent attempt to acquire a new path if the existing path becomes invalid.
AutoBraking
bool AutoBraking get
set
Set the agent brake automatically to avoid overshooting the destination point.
AutoTraverseOffMeshLink
bool AutoTraverseOffMeshLink get
set
Set the agent move across OffMeshLinks automatically.
AvoidancePriority
int AvoidancePriority get
set
The avoidance priority level.
BaseOffset
float BaseOffset get
set
The relative vertical displacement of the GameObject.
DesiredVelocity
SVector DesiredVelocity get
The desired velocity of the agent including any potential contribution from avoidance.
Destination
SVector Destination get
set
The desired velocity of the agent including any potential contribution from avoidance.
HasPath
bool HasPath get
Does the agent currently have a path?
Height
float Height get
set
The height of the agent for purposes of passing under obstacles, etc.
IsOnNavMesh
bool IsOnNavMesh get
Is the agent currently bound to the navmesh?
IsOnOffMeshLink
bool IsOnOffMeshLink get
Is the agent currently positioned on an OffMeshLink?
IsPathStale
bool IsPathStale get
Is the current path stale?
NextPosition
SVector NextPosition get
set
Get or set the simulation position of the navmesh agent.
PathEndPosition
SVector PathEndPosition get
End positon of navigation.
PathPending
bool PathPending get
Is a path in the process of being computed but not yet ready?
Radius
float Radius get
set
The avoidance radius for the agent.
RemainingDistance
float RemainingDistance get
The distance between the agent's position and the destination on the current path.
Speed
float Speed get
set
Maximum movement speed when following a path.
SteeringTarget
SVector SteeringTarget get
Get the current steering target along the path.
StoppingDistance
float StoppingDistance get
set
Stop within this distance from the target position.
UpdatePosition
bool UpdatePosition get
set
Get or set whether the transform position is synchronized with the simulated agent position.
UpdateRotation
bool UpdateRotation get
set
Should the agent update the transform orientation?
Velocity
SVector Velocity get
access the current velocity of the NavMeshAgent component, or set a velocity to control the agent manually.
GameObject
SGameObject GameObject get
Property Description
Last updated