Class AgentAuthoring

Main component of agent that enables motion.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
EntityBehaviour
AgentAuthoring
Inherited Members
MonoBehaviour.IsInvoking()
MonoBehaviour.CancelInvoke()
MonoBehaviour.StopCoroutine(Coroutine)
MonoBehaviour.StopAllCoroutines()
MonoBehaviour.destroyCancellationToken
MonoBehaviour.useGUILayout
MonoBehaviour.runInEditMode
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Component.GetComponentIndex()
Component.transform
Component.gameObject
Component.tag
Object.GetInstanceID()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Scene)
Object.Instantiate(Object, Transform)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Object.ToString()
Object.name
Object.hideFlags
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 Source

Acceleration

Main component of agent that enables motion.

Declaration
[SerializeField]
protected float Acceleration
Field Value
Type Description
float
| Improve this Doc View Source

AngularSpeed

Main component of agent that enables motion.

Declaration
[SerializeField]
protected float AngularSpeed
Field Value
Type Description
float
| Improve this Doc View Source

AutoBreaking

Main component of agent that enables motion.

Declaration
[SerializeField]
protected bool AutoBreaking
Field Value
Type Description
bool
| Improve this Doc View Source

Speed

Main component of agent that enables motion.

Declaration
[SerializeField]
protected float Speed
Field Value
Type Description
float
| Improve this Doc View Source

StoppingDistance

Main component of agent that enables motion.

Declaration
[SerializeField]
protected float StoppingDistance
Field Value
Type Description
float
| Improve this Doc View Source

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 Source

Body

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
| Improve this Doc View Source

DefaultAgent

Returns default component of Agent.

Declaration
public Agent DefaultAgent { get; }
Property Value
Type Description
Agent
| Improve this Doc View Source

DefaultBody

Returns default component of AgentBody.

Declaration
public AgentBody DefaultBody { get; }
Property Value
Type Description
AgentBody
| Improve this Doc View Source

DefaultLocomotion

Returns default component of AgentLocomotion.

Declaration
public AgentLocomotion DefaultLocomotion { get; }
Property Value
Type Description
AgentLocomotion
| Improve this Doc View Source

DefaultSteering

Returns default component of AgentSteering.

Declaration
[Obsolete("DefaultSteering is deprecated, please use DefaultLocomotion!", false)]
public AgentSteering DefaultSteering { get; }
Property Value
Type Description
AgentSteering
| Improve this Doc View Source

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
| Improve this Doc View Source

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
| Improve this Doc View Source

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
| Improve this Doc View Source

EntitySteering

AgentSteering component of this AgentAuthoring Entity. Accessing this property is potentially heavy operation as it will require wait for agent jobs to finish.

Declaration
[Obsolete("EntitySteering is deprecated, please use EntityLocomotion!", false)]
public AgentSteering EntitySteering { get; set; }
Property Value
Type Description
AgentSteering
| Improve this Doc View Source

HasEntityBody

Returns true if AgentAuthoring entity has AgentBody.

Declaration
public bool HasEntityBody { get; }
Property Value
Type Description
bool
| Improve this Doc View Source

HasEntityLocomotion

Returns true if AgentAuthoring entity has AgentLocomotion.

Declaration
public bool HasEntityLocomotion { get; }
Property Value
Type Description
bool
| Improve this Doc View Source

HasEntitySteering

Returns true if AgentAuthoring entity has AgentSteering.

Declaration
[Obsolete("HasEntitySteering is deprecated, please use HasEntityLocomotion!", false)]
public bool HasEntitySteering { get; }
Property Value
Type Description
bool

Methods

| Improve this Doc View Source

SetDestination(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
| Improve this Doc View Source

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
| Improve this Doc View Source

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()