SNavMeshAgent

Index

Functions Index

Properties Index

Functions

GetAreaCost

float GetAreaCost (int areaIndex)

Function Description

Move

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

Set or update the destination.

Warp

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

The desired velocity of the agent including any potential contribution from avoidance.

Destination

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

Get or set the simulation position of the navmesh agent.

PathEndPosition

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

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

access the current velocity of the NavMeshAgent component, or set a velocity to control the agent manually.

GameObject

Property Description