Class NavigationSettings

The navigation system settings container.

ISerializable
SettingsBase
NavigationSettings
Assembly: FlaxEngine.dll
File: Engine/Navigation/NavigationSettings.h
public class NavigationSettings : public SettingsBase

Constructors

NavigationSettings()

Declaration
public NavigationSettings()

Fields

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

Declaration
public bool AutoAddMissingNavMeshes = true
Field Value
bool

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

Declaration
public bool AutoRemoveMissingNavMeshes = true
Field Value
bool

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
public float CellHeight = 10.0f
Field Value
float

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
public float CellSize = 30.0f
Field Value
float

The sampling distance to use when generating the detail mesh.

Declaration
public float DetailSamplingDist = 600.0f
Field Value
float

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

Declaration
public float MaxDetailSamplingError = 1.0f
Field Value
float

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

Declaration
public float MaxEdgeError = 1.3f
Field Value
float

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

Declaration
public float MaxEdgeLen = 1200.0f
Field Value
float

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

Declaration
public int32 MergeRegionArea = 20
Field Value
int32

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

Declaration
public int32 MinRegionArea = 0
Field Value
int32

The configuration for nav areas.

Declaration
public Array<NavAreaProperties> NavAreas
Field Value
Array<NavAreaProperties>

The configuration for navmeshes.

Declaration
public Array<NavMeshProperties> NavMeshes
Field Value
Array<NavMeshProperties>

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

Declaration
public int32 TileSize = 64
Field Value
int32

Methods

Apply()

Applies the settings to the target system.

Declaration
public virtual void Apply() override
Overrides

Deserialize(DeserializeStream& stream, ISerializeModifier* modifier)

Deserializes object from the input stream.

Declaration
public virtual void Deserialize(DeserializeStream& stream, ISerializeModifier* modifier) final override
Parameters
DeserializeStream stream

The input stream.
ISerializeModifier modifier

The deserialization modifier object. Always valid.
Overrides

Get()

Gets the instance of the settings asset (default value if missing). Object returned by this method is always loaded with valid data to use.

Declaration
public static NavigationSettings* Get()
Returns
NavigationSettings

Serialize(SerializeStream& stream, const void* otherObj)

Serializes object to the output stream compared to the values of the other object instance (eg. default class object). If other object is null then serialize all properties.

Declaration
public virtual void Serialize(SerializeStream& stream, const void* otherObj) override
Parameters
SerializeStream stream

The output stream.
void otherObj

The instance of the object to compare with and serialize only the modified properties. If null, then serialize all properties.
Overrides