Struct NavMeshPath

Agent NavMesh path.

Implements

IComponentData

IQueryTypeParameter

IEnableableComponent

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: ProjectDawn.Navigation

Assembly: ProjectDawn.Navigation.dll

Syntax

public struct NavMeshPath : IComponentData, IQueryTypeParameter, IEnableableComponent

Fields

AgentTypeId

The type ID for the agent in NavMesh.

Declaration

public int AgentTypeId

Field Value

Type	Description
int

AreaMask

Specifies which NavMesh areas are passable. Changing areaMask will make the path stale (see isPathStale).

Declaration

public int AreaMask

Field Value

Type	Description
int

AutoRepath

Should the agent attempt to acquire a new path if the existing path becomes invalid?

Declaration

public bool AutoRepath

Field Value

Type	Description
bool

EndLocation

End location of the agent on NavMesh.

Declaration

public NavMeshLocation EndLocation

Field Value

Type	Description
NavMeshLocation

Grounded

Constraint agent to be on the surface. It is useful to disable then used with physics, to allow more freedom motion and precision.

Declaration

public bool Grounded

Field Value

Type	Description
bool

Location

Current location of the agent on NavMesh.

Declaration

public NavMeshLocation Location

Field Value

Type	Description
NavMeshLocation

MappingExtent

Maximum distance on each axis will be used when attempting to map the agent's position or destination onto navmesh. The higher the value, the bigger the performance cost.

Declaration

public float3 MappingExtent

Field Value

Type	Description
float3

QueryHandle

Query handle of current requested path.

Declaration

public NavMeshQueryHandle QueryHandle

Field Value

Type	Description
NavMeshQueryHandle

State

State of the path.

Declaration

public NavMeshPathState State

Field Value

Type	Description
NavMeshPathState

Properties

Constrained

Agent NavMesh path.

Declaration

[Obsolete("Constrained is deprecated, please use Grounded.")]
public bool Constrained { get; set; }

Property Value

Type	Description
bool

Default

Returns default configuration.

Declaration

public static NavMeshPath Default { get; }

Property Value

Type	Description
NavMeshPath

HasFullPath

Agent NavMesh path.

Declaration

public bool HasFullPath { get; }

Property Value

Type	Description
bool

HasPartialPath

Agent NavMesh path.

Declaration

public bool HasPartialPath { get; }

Property Value

Type	Description
bool

HasPath

Agent NavMesh path.

Declaration

public bool HasPath { get; }

Property Value

Type	Description
bool

Implements

Unity.Entities.IComponentData

Unity.Entities.IQueryTypeParameter

Unity.Entities.IEnableableComponent