The Crowd class manages pathfinding for multiple agents simulatenously. More...

Public Member Functions
	Crowd (int maxAgents, float maxAgentRadius, ref TiledNavMesh navMesh)
	Initializes a new instance of the Crowd class. More...

ObstacleAvoidanceQuery.ObstacleAvoidanceParams	GetObstacleAvoidanceParams (int idx)

void	SetObstacleAvoidanceParams (int idx, ObstacleAvoidanceQuery.ObstacleAvoidanceParams parameters)

int	GetAgentCount ()

Agent	GetAgent (int idx)

int	AddAgent (Vector3 pos, AgentParams parameters)
	Add an agent to the crowd. More...

bool	RemoveAgent (int index)
	The agent is deactivated and will no longer be processed. It can still be reused later. More...

int	GetActiveAgents (Agent[] agents)
	The crowd contains active and inactive agents. Only add all the active agents to a separate array. More...

int	GetAgentIndex (Agent agent)
	Get the agent's index in the array More...

void	Update (float dt)
	Update the crowd pathfinding periodically More...

void	UpdateMoveRequest ()
	Change the move requests for all the agents More...

void	UpdateTopologyOptimization (Agent[] agents, int numAgents, float dt)
	Reoptimize the path corridor for all agents More...

void	CheckPathValidity (Agent[] agents, int agentCount, float dt)
	Make sure that each agent is taking a valid path More...

bool	OverOffmeshConnection (Agent ag, float radius)

void	CalcSmoothSteerDirection (Agent ag, ref Vector3 dir)
	Calculate a vector based off of the map More...

void	CalcStraightSteerDirection (Agent ag, ref Vector3 dir)
	Calculate a straight vector to the destination More...

float	GetDistanceToGoal (Agent ag, float range)
	Find the crowd agent's distance to its goal More...

int	GetNeighbours (Vector3 pos, float height, float range, Agent skip, CrowdNeighbor[] result, int maxResult, Agent[] agents, ProximityGrid< Agent > grid)
	Get the crowd agent's neighbors. More...

int	AddNeighbour (Agent agent, float dist, CrowdNeighbor[] neis, int nneis, int maxNeis)
	Add a CrowdNeighbor to the array More...

int	AddToPathQueue (Agent newag, Agent[] agents, int numAgents, int maxAgents)
	Add the CrowdAgent to the path queue More...

int	AddToOptQueue (Agent newag, Agent[] agents, int numAgents, int maxAgents)
	Add the CrowdAgent to the optimization queue More...

Detailed Description

The Crowd class manages pathfinding for multiple agents simulatenously.

Definition at line 22 of file Crowd.cs.

Constructor & Destructor Documentation

◆ Crowd()

SharpNav.Crowds.Crowd.Crowd	(	int	maxAgents,
		float	maxAgentRadius,
		ref TiledNavMesh	navMesh
	)

Initializes a new instance of the Crowd class.

Parameters

maxAgents	The maximum agents allowed
maxAgentRadius	The maximum radius for an agent
navMesh	The navigation mesh

Definition at line 70 of file Crowd.cs.

Member Function Documentation

◆ AddAgent()

int SharpNav.Crowds.Crowd.AddAgent	(	Vector3	pos,
		AgentParams	parameters
	)

Add an agent to the crowd.

Parameters

pos	The agent's position
parameters	The settings

Returns: The id of the agent (-1 if there is no empty slot)

Definition at line 156 of file Crowd.cs.

◆ AddNeighbour()

int SharpNav.Crowds.Crowd.AddNeighbour	(	Agent	agent,
		float	dist,
		CrowdNeighbor[]	neis,
		int	nneis,
		int	maxNeis
	)

Add a CrowdNeighbor to the array

Parameters

Agent	The neighbor
dist	Distance from current agent
neis	The neighbors array
nneis	The number of neighbors
maxNeis	The maximum number of neighbors allowed

Returns: An updated neighbor count

Definition at line 1108 of file Crowd.cs.

◆ AddToOptQueue()

int SharpNav.Crowds.Crowd.AddToOptQueue	(	Agent	newag,
		Agent[]	agents,
		int	numAgents,
		int	maxAgents
	)

Add the CrowdAgent to the optimization queue

Parameters

newag	The new CrowdAgent
agents	The current CrowdAgent array
numAgents	The number of CrowdAgents
maxAgents	The maximum number of agents allowed

Returns: An updated agent count

Definition at line 1214 of file Crowd.cs.

◆ AddToPathQueue()

int SharpNav.Crowds.Crowd.AddToPathQueue	(	Agent	newag,
		Agent[]	agents,
		int	numAgents,
		int	maxAgents
	)

Add the CrowdAgent to the path queue

Parameters

newag	The new CrowdAgent
agents	The current CrowdAgent array
numAgents	The number of CrowdAgents
maxAgents	The maximum number of agents allowed

Returns: An updated agent count

Definition at line 1168 of file Crowd.cs.

◆ CalcSmoothSteerDirection()

void SharpNav.Crowds.Crowd.CalcSmoothSteerDirection	(	Agent	ag,
		ref Vector3	dir
	)

Calculate a vector based off of the map

Parameters

ag	The agent
dir	The resulting steer direction

Definition at line 991 of file Crowd.cs.

◆ CalcStraightSteerDirection()

void SharpNav.Crowds.Crowd.CalcStraightSteerDirection	(	Agent	ag,
		ref Vector3	dir
	)

Calculate a straight vector to the destination

Parameters

ag	The agent
dir	The resulting steer direction

Definition at line 1026 of file Crowd.cs.

◆ CheckPathValidity()

void SharpNav.Crowds.Crowd.CheckPathValidity	(	Agent[]	agents,
		int	agentCount,
		float	dt
	)

Make sure that each agent is taking a valid path

Parameters

agents	The agent array
agentCount	The number of agents
dt	Time until next update

Definition at line 863 of file Crowd.cs.

◆ GetActiveAgents()

int SharpNav.Crowds.Crowd.GetActiveAgents ( Agent[] agents )

The crowd contains active and inactive agents. Only add all the active agents to a separate array.

Parameters

agents The array of active agents

Returns: The number of active agents

Definition at line 208 of file Crowd.cs.

◆ GetAgentIndex()

int SharpNav.Crowds.Crowd.GetAgentIndex ( Agent agent )

Get the agent's index in the array

Parameters

agent The agent

Returns: The index

Definition at line 228 of file Crowd.cs.

◆ GetDistanceToGoal()

float SharpNav.Crowds.Crowd.GetDistanceToGoal	(	Agent	ag,
		float	range
	)

Find the crowd agent's distance to its goal

Parameters

ag	Thw crowd agent
range	The maximum range

Returns: Distance to goal

Definition at line 1045 of file Crowd.cs.

◆ GetNeighbours()

int SharpNav.Crowds.Crowd.GetNeighbours	(	Vector3	pos,
		float	height,
		float	range,
		Agent	skip,
		CrowdNeighbor[]	result,
		int	maxResult,
		Agent[]	agents,
		ProximityGrid< Agent >	grid
	)

Get the crowd agent's neighbors.

Parameters

pos	Current position
height	The height
range	The range to search within
skip	The current crowd agent
result	The neihbors array
maxResult	The maximum number of neighbors that can be stored
agents	Array of all crowd agents
grid	The ProximityGrid

Returns: The number of neighbors

Definition at line 1069 of file Crowd.cs.

◆ RemoveAgent()

bool SharpNav.Crowds.Crowd.RemoveAgent ( int index )

The agent is deactivated and will no longer be processed. It can still be reused later.

Parameters

index The agent's id

Returns: A value indicating whether the agent was successfully removed.

Definition at line 194 of file Crowd.cs.

◆ Update()

void SharpNav.Crowds.Crowd.Update ( float dt )

Update the crowd pathfinding periodically

Parameters

dt	Th time until the next update

Definition at line 243 of file Crowd.cs.

◆ UpdateMoveRequest()

void SharpNav.Crowds.Crowd.UpdateMoveRequest ( )

Change the move requests for all the agents

Definition at line 603 of file Crowd.cs.

◆ UpdateTopologyOptimization()

void SharpNav.Crowds.Crowd.UpdateTopologyOptimization	(	Agent[]	agents,
		int	numAgents,
		float	dt
	)

Reoptimize the path corridor for all agents

Parameters

agents	The agents array
numAgents	The number of agents
dt	Time until next update

Definition at line 826 of file Crowd.cs.

The documentation for this class was generated from the following file:

C:/gamedev/unity/DA20.1X/Assets/CodeRespawn/DungeonArchitect/ThirdParty/SharpNav/Crowds/Crowd.cs

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Crowd()

Member Function Documentation

◆ AddAgent()

◆ AddNeighbour()

◆ AddToOptQueue()

◆ AddToPathQueue()

◆ CalcSmoothSteerDirection()

◆ CalcStraightSteerDirection()

◆ CheckPathValidity()

◆ GetActiveAgents()

◆ GetAgentIndex()

◆ GetDistanceToGoal()

◆ GetNeighbours()

◆ RemoveAgent()

◆ Update()

◆ UpdateMoveRequest()

◆ UpdateTopologyOptimization()