Class AgentAuthoring
Main component of agent that enables motion.
Inherited Members
Namespace: ProjectDawn.Navigation.Hybrid
Assembly: ProjectDawn.Navigation.Hybrid.dll
Syntax
[AddComponentMenu("Agents Navigation/Agent")]
[DisallowMultipleComponent]
[HelpURL("https://lukaschod.github.io/agents-navigation-docs/manual/game-objects/agent.html")]
public class AgentAuthoring : EntityBehaviour
  Fields
| Improve this Doc View SourceAcceleration
Main component of agent that enables motion.
Declaration
[SerializeField]
protected float Acceleration
  Field Value
| Type | Description | 
|---|---|
| float | 
AngularSpeed
Main component of agent that enables motion.
Declaration
[SerializeField]
protected float AngularSpeed
  Field Value
| Type | Description | 
|---|---|
| float | 
AutoBreaking
Main component of agent that enables motion.
Declaration
[SerializeField]
protected bool AutoBreaking
  Field Value
| Type | Description | 
|---|---|
| bool | 
Speed
Main component of agent that enables motion.
Declaration
[SerializeField]
protected float Speed
  Field Value
| Type | Description | 
|---|---|
| float | 
StoppingDistance
Main component of agent that enables motion.
Declaration
[SerializeField]
protected float StoppingDistance
  Field Value
| Type | Description | 
|---|---|
| float | 
m_Layers
Main component of agent that enables motion.
Declaration
[SerializeField]
protected NavigationLayers m_Layers
  Field Value
| Type | Description | 
|---|---|
| NavigationLayers | 
Properties
| Improve this Doc View SourceBody
AgentBody component of this AgentAuthoring Entity. Accessing this property is potentially heavy operation as it will require wait for agent jobs to finish.
Declaration
public ref AgentBody Body { get; }
  Property Value
| Type | Description | 
|---|---|
| AgentBody | 
DefaultAgent
Returns default component of Agent.
Declaration
public Agent DefaultAgent { get; }
  Property Value
| Type | Description | 
|---|---|
| Agent | 
DefaultBody
Returns default component of AgentBody.
Declaration
public AgentBody DefaultBody { get; }
  Property Value
| Type | Description | 
|---|---|
| AgentBody | 
DefaultLocomotion
Returns default component of AgentLocomotion.
Declaration
public AgentLocomotion DefaultLocomotion { get; }
  Property Value
| Type | Description | 
|---|---|
| AgentLocomotion | 
EntityAgent
Agent component of this AgentAuthoring Entity. Accessing this property is potentially heavy operation as it will require wait for agent jobs to finish.
Declaration
public Agent EntityAgent { get; set; }
  Property Value
| Type | Description | 
|---|---|
| Agent | 
EntityBody
AgentBody component of this AgentAuthoring Entity. Accessing this property is potentially heavy operation as it will require wait for agent jobs to finish.
Declaration
public AgentBody EntityBody { get; set; }
  Property Value
| Type | Description | 
|---|---|
| AgentBody | 
EntityLocomotion
AgentLocomotion component of this AgentAuthoring Entity. Accessing this property is potentially heavy operation as it will require wait for agent jobs to finish.
Declaration
public AgentLocomotion EntityLocomotion { get; set; }
  Property Value
| Type | Description | 
|---|---|
| AgentLocomotion | 
HasEntityBody
Returns true if AgentAuthoring entity has AgentBody.
Declaration
public bool HasEntityBody { get; }
  Property Value
| Type | Description | 
|---|---|
| bool | 
HasEntityLocomotion
Returns true if AgentAuthoring entity has AgentLocomotion.
Declaration
public bool HasEntityLocomotion { get; }
  Property Value
| Type | Description | 
|---|---|
| bool | 
Methods
| Improve this Doc View SourceSetDestination(float3)
Sets or updates the destination thus triggering the calculation for a new path. Calling this method is potentially heavy operation as it will require wait for agent jobs to finish.
Declaration
public void SetDestination(float3 target)
  Parameters
| Type | Name | Description | 
|---|---|---|
| float3 | target | 
SetDestinationDeferred(float3)
Sets or updates the destination thus triggering the calculation for a new path. This call is deferred and destination will only changed later in the frame.
Declaration
public void SetDestinationDeferred(float3 destination)
  Parameters
| Type | Name | Description | 
|---|---|---|
| float3 | destination | 
Stop()
Stop agent movement. Calling this method is potentially heavy operation as it will require wait for agent jobs to finish.
Declaration
public void Stop()