Class NavAreaProperties

The navigation area properties container for navmesh building and navigation runtime.

System.Object
NavAreaProperties
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class NavAreaProperties : ValueType

Fields

Color

The area type color (for debugging). Alpha channel is used to blend with navmesh color (alpha 0 to use navmesh color only).

Declaration
[EditorOrder(10)]
public Color Color
Field Value
Color

Cost

The cost scale for the area traversal for agents. The higher the cost, the less likely agent wil choose the path that goes over it. For instance, areas that are harder to move like sand should have higher cost for proper path finding.

Declaration
[EditorOrder(30)]
[Limit(0F, 3.40282347E+38F, 0.1F)]
public float Cost
Field Value
System.Single

Id

The area id. It must be unique for the project. Valid range 0-63. Value 0 is reserved for Null areas (empty, non-navigable areas).

Declaration
[EditorOrder(20)]
[Limit(0F, 63F, 1F)]
public byte Id
Field Value
System.Byte

Name

The area type name. Identifies different types of the areas.

Declaration
[EditorOrder(0)]
public string Name
Field Value
System.String

Properties

Default

The default NavAreaProperties.

Declaration
public static NavAreaProperties Default { get; }
Property Value
NavAreaProperties

Extension Methods