Class NavigationLayerSettings

Describes the settings for a specific layer.

Inheritance

System.Object

NavigationLayerSettings

Namespace: AlchemyBow.Navigation.Settings

Assembly: AlchemyBow.Navigation.dll

Syntax

[Serializable]
public sealed class NavigationLayerSettings

Constructors

NavigationLayerSettings(String, Single, Single, Single)

Creates a new instance of the NavigationLayerSettings class.

Declaration

public NavigationLayerSettings(string name, float connectionRadius, float raycastLength, float maxEdgeLength)

Parameters

Type	Name	Description
System.String	name	A user-friendly name to appear in the Unity Editor
System.Single	connectionRadius	The maximum distance between vertices to be counted as one vertex.
System.Single	raycastLength	The length of rays that are used to find faces of the navigation mesh. (optimization)
System.Single	maxEdgeLength	The maximum length of edges declared by the user to be used. (optimization)

Properties

ConnectionRadius

The maximum distance between vertices to be counted as one vertex.

Declaration

public float ConnectionRadius { get; }

Property Value

Type	Description
System.Single	The maximum distance between vertices to be counted as one vertex for the layer.

MaxEdgeLength

The maximum length of edges declared by the user to be used. (optimization)

Declaration

public float MaxEdgeLength { get; }

Property Value

Type	Description
System.Single	The maximum length of edges declared by the user for the layer.

Name

A user-friendly name to appear in the Unity Editor

Declaration

public string Name { get; }

Property Value

Type	Description
System.String	The user-friendly of the layer.

RaycastLength

The length of rays that are used to find faces of the navigation mesh. (optimization)

Declaration

public float RaycastLength { get; }

Property Value

Type	Description
System.Single	The length of rays that are used to find faces of the navigation mesh for the layer.

Methods

CreateDefault()

Creates the default instance of the NavigationLayerSettings class.

Declaration

public static NavigationLayerSettings CreateDefault()

Returns

Type	Description
NavigationLayerSettings	A new instance of the NavigationLayerSettings class with default values.