NavAI.Settings

Inherits ScriptableObject.

Public Types
enum	AgentDrawMode { AgentDrawMode.CircleOnly, AgentDrawMode.CircleAndArrow }
enum	RenderCondition {   RenderCondition.AlwaysRender, RenderCondition.RenderIfNotPlaying, RenderCondition.RenderIfPlaying, RenderCondition.RenderIfSelected,   RenderCondition.NeverRender }
enum	TriangleDrawMode { TriangleDrawMode.Wireframe, TriangleDrawMode.Shaded }

Public Member Functions
void	ResetAgentSettings ()
void	ResetAllSettings ()
void	ResetDebugSettings ()
void	ResetPathfindingSettings ()
void	ResetRenderSettings ()
void	ResetRvoSettings ()

Public Attributes
float	agentAngularAcceleration
int	agentAngularStability
Color	agentDrawColor
float	agentDrawHeight
AgentDrawMode	agentDrawMode
float	agentIdleReturnDistance
float	agentMaxRadius
float	agentMaxSpeed
RenderCondition	agentRenderCondition
bool	agentReturnToIdle
bool	debugLogErrors
bool	debugLogMessages
bool	debugLogWarnings
bool	debugMode
bool	drawPaths
float	epsilon
Color	meshDrawColor
float	meshDrawHeight
TriangleDrawMode	meshDrawMode
RenderCondition	meshRenderCondition
Color	pathColor
float	pfAbandonTimer
bool	pfAbandonWorseningPaths
int	pfAIFrequency
float	pfOccupiedGoalStopDistance
float	pfRequiredClearance
bool	pfSearchImpossibleClearances
bool	pfSearchImpossiubleGoals
int	pfWorkerCount
bool	rvoAvoidancePriority
bool	rvoFixedUpdate
float	rvoHighSpeed
float	rvoHighSpeedTimer
bool	rvoIdlePriority
float	rvoLowSpeed
float	rvoLowSpeedTimer
int	rvoMaxPriorityPropagationDepth
float	rvoPriorityRadiusMultiplier
float	rvoPriorityRange
float	rvoSurroundBehaviorDuration
float	rvoTimeHorizon
bool	rvoUnmovingAvoidance
bool	rvoUnstuckPriority
int	rvoWorkerCount
float	rvoZeroSpeed

Detailed Description

The Settings file is used to configure zones and customize the output of the navigation algorithm. Multiple zones can share the same settings file, and a global settings file can be used as a preset for quick settings of all zones.

Directly setting the Settings variable is not recommended. Use the editor inspector to properly setup the settings variables.

To create a new settings file, use the Create option under the Project window, and select NavAI/New Settings File.

For more detailed information, read the AdvancedSettings documentation

Member Enumeration Documentation

AgentDrawMode

enum NavAI.Settings.AgentDrawMode

strong

Mode to draw the agents.

For more detailed information, read the AdvancedSettings documentation

Enumerator
CircleOnly	Draw only the collision circle of the agent.
CircleAndArrow	Draw the collision circle of the agent and and arrow pointing it's orientation.

RenderCondition

enum NavAI.Settings.RenderCondition

strong

Condition to render.

For more detailed information, read the AdvancedSettings documentation

Enumerator
AlwaysRender	Render at all times.
RenderIfNotPlaying	Render only when not playing.
RenderIfPlaying	Render only when playing.
RenderIfSelected	Render only if object is selected in the editor.
NeverRender	Never render.

TriangleDrawMode

enum NavAI.Settings.TriangleDrawMode

strong

Mode to draw the navmesh triangles.

For more detailed information, read the AdvancedSettings documentation

Enumerator
Wireframe	Draw only the edges of the triangles.
Shaded	Draw the interior of the triangles.

Member Function Documentation

ResetAgentSettings()

void NavAI.Settings.ResetAgentSettings

(

)

Resets all agent settings to the default values.

For more detailed information, read the AdvancedSettings documentation

ResetAllSettings()

void NavAI.Settings.ResetAllSettings

(

)

Resets all settings to the default values.

For more detailed information, read the AdvancedSettings documentation

ResetDebugSettings()

void NavAI.Settings.ResetDebugSettings

(

)

Resets all debug settings to the default values.

For more detailed information, read the AdvancedSettings documentation

ResetPathfindingSettings()

void NavAI.Settings.ResetPathfindingSettings

(

)

Resets all pathfinding settings to the default values.

For more detailed information, read the AdvancedSettings documentation

ResetRenderSettings()

void NavAI.Settings.ResetRenderSettings

(

)

Resets all render settings to the default values.

For more detailed information, read the AdvancedSettings documentation

ResetRvoSettings()

void NavAI.Settings.ResetRvoSettings

(

)

Resets all collision avoidance settings to the default values.

For more detailed information, read the AdvancedSettings documentation

Member Data Documentation

agentAngularAcceleration

float NavAI.Settings.agentAngularAcceleration

Maximum agent angular acceleration.

For more detailed information, read the AdvancedSettings documentation

agentAngularStability

int NavAI.Settings.agentAngularStability

Angular stability array size.

For more detailed information, read the AdvancedSettings documentation

agentDrawColor

Color NavAI.Settings.agentDrawColor

Color to render the agents.

For more detailed information, read the AdvancedSettings documentation

agentDrawHeight

float NavAI.Settings.agentDrawHeight

Height offset to render the agents.

For more detailed information, read the AdvancedSettings documentation

agentDrawMode

AgentDrawMode NavAI.Settings.agentDrawMode

Mode to render the agents.

For more detailed information, read the AdvancedSettings documentation

agentIdleReturnDistance

float NavAI.Settings.agentIdleReturnDistance

Distance in meters for agents to return to their idle position.

For more detailed information, read the AdvancedSettings documentation

agentMaxRadius

float NavAI.Settings.agentMaxRadius

Maximum agent collision radius.

For more detailed information, read the AdvancedSettings documentation

agentMaxSpeed

float NavAI.Settings.agentMaxSpeed

Maximum agent movement speed.

For more detailed information, read the AdvancedSettings documentation

agentRenderCondition

RenderCondition NavAI.Settings.agentRenderCondition

Condition to render the agents.

For more detailed information, read the AdvancedSettings documentation

agentReturnToIdle

bool NavAI.Settings.agentReturnToIdle

Toggles agents return to idle position behavior.

For more detailed information, read the AdvancedSettings documentation

debugLogErrors

bool NavAI.Settings.debugLogErrors

Toggles error messages.

For more detailed information, read the AdvancedSettings documentation

debugLogMessages

bool NavAI.Settings.debugLogMessages

Toggles informative messages.

For more detailed information, read the AdvancedSettings documentation

debugLogWarnings

bool NavAI.Settings.debugLogWarnings

Toggles warning messages.

For more detailed information, read the AdvancedSettings documentation

debugMode

bool NavAI.Settings.debugMode

Toggles debug messages.

For more detailed information, read the AdvancedSettings documentation

drawPaths

bool NavAI.Settings.drawPaths

Toggles drawing agent paths when rendering agents.

For more detailed information, read the AdvancedSettings documentation

epsilon

float NavAI.Settings.epsilon

Epsilon value used internally.

For more detailed information, read the AdvancedSettings documentation

meshDrawColor

Color NavAI.Settings.meshDrawColor

Color to render the triangulation.

For more detailed information, read the AdvancedSettings documentation

meshDrawHeight

float NavAI.Settings.meshDrawHeight

Height offset to render the triangulation.

For more detailed information, read the AdvancedSettings documentation

meshDrawMode

TriangleDrawMode NavAI.Settings.meshDrawMode

Mode to render the triangulation.

For more detailed information, read the AdvancedSettings documentation

meshRenderCondition

RenderCondition NavAI.Settings.meshRenderCondition

Condition to render the triangulation.

For more detailed information, read the AdvancedSettings documentation

pathColor

Color NavAI.Settings.pathColor

Color to render the agents paths.

For more detailed information, read the AdvancedSettings documentation

pfAbandonTimer

float NavAI.Settings.pfAbandonTimer

Time in seconds to abandon worsening paths.

For more detailed information, read the AdvancedSettings documentation

pfAbandonWorseningPaths

bool NavAI.Settings.pfAbandonWorseningPaths

Toggles abandonning of worsening paths.

For more detailed information, read the AdvancedSettings documentation

pfAIFrequency

int NavAI.Settings.pfAIFrequency

Frequency in steps to take AI path decisions.

For more detailed information, read the AdvancedSettings documentation

pfOccupiedGoalStopDistance

float NavAI.Settings.pfOccupiedGoalStopDistance

Distance to stop from goal if occupied relative to collision radius.

For more detailed information, read the AdvancedSettings documentation

pfRequiredClearance

float NavAI.Settings.pfRequiredClearance

Path clearance requirement multiplier.

For more detailed information, read the AdvancedSettings documentation

pfSearchImpossibleClearances

bool NavAI.Settings.pfSearchImpossibleClearances

Toggles searching for paths with impossible clearances.

For more detailed information, read the AdvancedSettings documentation

pfSearchImpossiubleGoals

bool NavAI.Settings.pfSearchImpossiubleGoals

Toggles searching for paths with impossible goals.

For more detailed information, read the AdvancedSettings documentation

pfWorkerCount

int NavAI.Settings.pfWorkerCount

Number of worker threads to use for pathfinding.

For more detailed information, read the AdvancedSettings documentation

rvoAvoidancePriority

bool NavAI.Settings.rvoAvoidancePriority

Toggles use of collision avoidance priority.

For more detailed information, read the AdvancedSettings documentation

rvoFixedUpdate

bool NavAI.Settings.rvoFixedUpdate

If true, then the objects will be updated during the FixedUpdate. If false, the update will occur during frame update.

For more detailed information, read the AdvancedSettings documentation

rvoHighSpeed

float NavAI.Settings.rvoHighSpeed

High speed percentage.

For more detailed information, read the AdvancedSettings documentation

rvoHighSpeedTimer

float NavAI.Settings.rvoHighSpeedTimer

High speed timer.

For more detailed information, read the AdvancedSettings documentation

rvoIdlePriority

bool NavAI.Settings.rvoIdlePriority

Toggles use of idle priority.

For more detailed information, read the AdvancedSettings documentation

rvoLowSpeed

float NavAI.Settings.rvoLowSpeed

Low speed percentage.

For more detailed information, read the AdvancedSettings documentation

rvoLowSpeedTimer

float NavAI.Settings.rvoLowSpeedTimer

Low speed timer.

For more detailed information, read the AdvancedSettings documentation

rvoMaxPriorityPropagationDepth

int NavAI.Settings.rvoMaxPriorityPropagationDepth

Maximuim propagation depth for unstuck priority.

For more detailed information, read the AdvancedSettings documentation

rvoPriorityRadiusMultiplier

float NavAI.Settings.rvoPriorityRadiusMultiplier

Priority collision radius multiplier.

For more detailed information, read the AdvancedSettings documentation

rvoPriorityRange

float NavAI.Settings.rvoPriorityRange

Priority detection range relative to radius.

For more detailed information, read the AdvancedSettings documentation

rvoSurroundBehaviorDuration

float NavAI.Settings.rvoSurroundBehaviorDuration

Duration of the unmoving avoidance behavior.

For more detailed information, read the AdvancedSettings documentation

rvoTimeHorizon

float NavAI.Settings.rvoTimeHorizon

Time horizon in secondsd to detect and avoid incoming collisions.

For more detailed information, read the AdvancedSettings documentation

rvoUnmovingAvoidance

bool NavAI.Settings.rvoUnmovingAvoidance

Toggles the unmoving avoidance algorithm.

For more detailed information, read the AdvancedSettings documentation

rvoUnstuckPriority

bool NavAI.Settings.rvoUnstuckPriority

Toggles use of unstuck priority.

For more detailed information, read the AdvancedSettings documentation

rvoWorkerCount

int NavAI.Settings.rvoWorkerCount

Number of workers threads to use for collision avoidance.

For more detailed information, read the AdvancedSettings documentation

rvoZeroSpeed

float NavAI.Settings.rvoZeroSpeed

Zero speed percentage.

For more detailed information, read the AdvancedSettings documentation