Scripting API

Scripting API

NavigationSettings

Struct in Abyss.Navigation, from Abyss.Navigation.

The project's navigation, Project Settings ▸ Navigation: the kinds of agent its navmeshes are baked for, Humanoid first, and the kinds of floor, the project's own after Walkable and Not Walkable. Kept in settings/navigation.json.

public struct NavigationSettings

Remarks

An area is named by its place: 0 Walkable, 1 Not Walkable, then each of NavigationSettings.Areas from 2. An agent's Area Mask has a bit an area but Not Walkable's: Walkable the lowest, then each of the project's own. Detour tells sixteen apart by a polygon's flags, so the sixteenth of the project's own is ticked or not with Walkable, though its cost is its own.

Constructors

public NavigationSettings()

The agent types and areas as the project has them.

Methods

AgentType

public readonly NavAgentType3D AgentType(int agentType)

The agent type of place agentType, or Humanoid where there is none there.

Parameters

  • agentType

AreaNames

public readonly IReadOnlyList<string> AreaNames()

Every area's name by its place: Walkable, Not Walkable, then the project's own.

AreaCosts

public readonly float[] AreaCosts()

What a meter of each area costs, by its place: 1 for Walkable, each of the project's own its own, what SetAreaCosts takes.

AreaColor

public readonly Vector4? AreaColor(int area)

What an area of place area is drawn in, as a screen shows it; null for Walkable's own and for none.

Parameters

  • area

Fields

AgentTypes

public FixedList8<NavAgentType3D> AgentTypes

The kinds of agent, each a navmesh of its own where a surface is baked for it.

Areas

public FixedList16<NavArea3D> Areas

The project's own kinds of floor, after Walkable and Not Walkable.

Constants

Walkable

public const int Walkable = 0

The place of Walkable among the areas: any floor flat enough, at a cost of 1 a meter.

NotWalkable

public const int NotWalkable = 1

The place of Not Walkable among the areas: what is baked as a wall, however flat it is.