Class NavigationAreaSettings
Describes the settings for a specific area.
Inheritance
System.Object
NavigationAreaSettings
Namespace: AlchemyBow.Navigation.Settings
Assembly: AlchemyBow.Navigation.dll
Syntax
[Serializable]
public sealed class NavigationAreaSettingsConstructors
| Improve this Doc View SourceNavigationAreaSettings(String, Single, Color)
Creates a new instance of the NavigationAreaSettings class.
Declaration
public NavigationAreaSettings(string name, float weight, Color color)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | A user-friendly name to appear in the Unity Editor. |
| System.Single | weight | The greater the weight, the less frequently paths through the certain area are chosen. (1 is a standard value.) |
| UnityEngine.Color | color | The preview color. |
Properties
| Improve this Doc View SourceColor
The preview color.
Declaration
public Color Color { get; }Property Value
| Type | Description |
|---|---|
| UnityEngine.Color | The color of the area. |
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 name of the area. |
Weight
The greater the weight, the less frequently paths through the certain area are chosen. (1 is a standard value.)
Declaration
public float Weight { get; }Property Value
| Type | Description |
|---|---|
| System.Single | The weight of the area. |
Methods
| Improve this Doc View SourceCreateDefault(Int32)
Creates the default instance of the NavigationAreaSettings class.
Declaration
public static NavigationAreaSettings CreateDefault(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The index of the area. |
Returns
| Type | Description |
|---|---|
| NavigationAreaSettings | A new instance of the NavigationAreaSettings class with default values. |