Class NavigationSettings

The navigation system settings container.

System.Object
SettingsBase
NavigationSettings
Namespace: FlaxEditor.Content.Settings
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class NavigationSettings : SettingsBase

Constructors

NavigationSettings()

Initializes a new instance of the NavigationSettings class.

Declaration
public NavigationSettings()

Fields

AutoAddMissingNavMeshes

If checked, enables automatic navmesh actors spawning on a scenes that are using it during navigation building.

Declaration
[EditorOrder(100)]
[EditorDisplay("Navigation", null)]
public bool AutoAddMissingNavMeshes
Field Value
System.Boolean

AutoRemoveMissingNavMeshes

If checked, enables automatic navmesh actors removing from a scenes that are not using it during navigation building.

Declaration
[EditorOrder(110)]
[EditorDisplay("Navigation", null)]
public bool AutoRemoveMissingNavMeshes
Field Value
System.Boolean

CellHeight

The height of a grid cell in the navigation mesh building steps using heightfields. A lower number means higher precision on the vertical axis but longer build times.

Declaration
[Limit(1F, 400F, 1F)]
[EditorOrder(210)]
[EditorDisplay("Nav Mesh Options", null)]
public float CellHeight
Field Value
System.Single

CellSize

The width/height of a grid cell in the navigation mesh building steps using heightfields. A lower number means higher precision on the horizontal axes but longer build times.

Declaration
[Limit(1F, 400F, 1F)]
[EditorOrder(220)]
[EditorDisplay("Nav Mesh Options", null)]
public float CellSize
Field Value
System.Single

DetailSamplingDist

The sampling distance to use when generating the detail mesh.

Declaration
[Limit(1F, 3.40282347E+38F, 1F)]
[EditorOrder(280)]
[EditorDisplay("Nav Mesh Options", "Detail Sampling Distance")]
public float DetailSamplingDist
Field Value
System.Single

MaxDetailSamplingError

The maximum distance the detail mesh surface should deviate from heightfield data.

Declaration
[Limit(0F, 3F, 1F)]
[EditorOrder(290)]
[EditorDisplay("Nav Mesh Options", null)]
public float MaxDetailSamplingError
Field Value
System.Single

MaxEdgeError

The maximum distance a simplified contour's border edges should deviate from the original raw contour.

Declaration
[Limit(0.1F, 4F, 1F)]
[EditorOrder(270)]
[EditorDisplay("Nav Mesh Options", null)]
public float MaxEdgeError
Field Value
System.Single

MaxEdgeLen

The maximum allowed length for contour edges along the border of the mesh.

Declaration
[Limit(100F, 3.40282347E+38F, 1F)]
[EditorOrder(260)]
[EditorDisplay("Nav Mesh Options", "Max Edge Length")]
public float MaxEdgeLen
Field Value
System.Single

MergeRegionArea

Any regions with a span count smaller than this value will, if possible, be merged with larger regions.

Declaration
[Limit(0F, 100F, 1F)]
[EditorOrder(250)]
[EditorDisplay("Nav Mesh Options", null)]
public int MergeRegionArea
Field Value
System.Int32

MinRegionArea

The minimum number of cells allowed to form isolated island areas.

Declaration
[Limit(0F, 100F, 1F)]
[EditorOrder(240)]
[EditorDisplay("Nav Mesh Options", null)]
public int MinRegionArea
Field Value
System.Int32

NavAreas

The configuration for nav areas.

Declaration
[EditorOrder(2000)]
[EditorDisplay("Areas", "__inline__")]
public NavAreaProperties[] NavAreas
Field Value
NavAreaProperties[]

NavMeshes

The configuration for navmeshes.

Declaration
[EditorOrder(1000)]
[EditorDisplay("Agents", "__inline__")]
public NavMeshProperties[] NavMeshes
Field Value
NavMeshProperties[]

TileSize

Tile size used for Navigation mesh tiles, the final size of a tile is CellSize*TileSize.

Declaration
[Limit(8F, 4096F, 1F)]
[EditorOrder(230)]
[EditorDisplay("Nav Mesh Options", null)]
public int TileSize
Field Value
System.Int32

Extension Methods