dtCrowdAgentParams Struct Reference

#include <DetourCrowd.h>

Public Attributes
void *	userData
	User defined data attached to the agent.
TSharedPtr< dtQuerySpecialLinkFilter >	linkFilter
	UE: special link filter used by this agent.
dtReal	radius
	Agent radius. [Limit: >= 0].
dtReal	height
	Agent height. [Limit: > 0].
dtReal	maxAcceleration
	Maximum allowed acceleration. [Limit: >= 0].
dtReal	maxSpeed
	Maximum allowed speed. [Limit: >= 0].
dtReal	collisionQueryRange
	Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0].
dtReal	pathOptimizationRange
	The path visibility optimization range. [Limit: > 0].
dtReal	separationWeight
	How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0].
dtReal	avoidanceQueryMultiplier
	[UE] Mutliplier for avoidance velocities
unsigned int	avoidanceGroup
	[UE] Groups flags attached to the agent
unsigned int	groupsToAvoid
	[UE] Avoid agents when they group is matching mask
unsigned int	groupsToIgnore
	[UE] Don't avoid agents when they group is matching mask
unsigned short	updateFlags
	Flags that impact steering behavior. (See: UpdateFlags)
unsigned char	obstacleAvoidanceType
unsigned char	filter

Detailed Description

Configuration parameters for a crowd agent.

See also

dtCrowdAgent, dtCrowd::addAgent(), dtCrowd::updateAgentParameters()

Member Data Documentation

avoidanceGroup

unsigned int dtCrowdAgentParams::avoidanceGroup

[UE] Groups flags attached to the agent

avoidanceQueryMultiplier

dtReal dtCrowdAgentParams::avoidanceQueryMultiplier

[UE] Mutliplier for avoidance velocities

collisionQueryRange

dtCrowdAgentParams::collisionQueryRange

Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0].

Collision elements include other agents and navigation mesh boundaries.

This value is often based on the agent radius and/or maximum speed. E.g. radius * 8

filter

unsigned char dtCrowdAgentParams::filter

UE: Id of navigation filter used by this agent [Limits: 0 <= value <= DT_CROWD_MAX_FILTERS]

groupsToAvoid

unsigned int dtCrowdAgentParams::groupsToAvoid

[UE] Avoid agents when they group is matching mask

groupsToIgnore

unsigned int dtCrowdAgentParams::groupsToIgnore

[UE] Don't avoid agents when they group is matching mask

height

dtReal dtCrowdAgentParams::height

Agent height. [Limit: > 0].

linkFilter

TSharedPtr<dtQuerySpecialLinkFilter> dtCrowdAgentParams::linkFilter

UE: special link filter used by this agent.

maxAcceleration

dtReal dtCrowdAgentParams::maxAcceleration

Maximum allowed acceleration. [Limit: >= 0].

maxSpeed

dtReal dtCrowdAgentParams::maxSpeed

Maximum allowed speed. [Limit: >= 0].

obstacleAvoidanceType

dtCrowdAgentParams::obstacleAvoidanceType

The index of the avoidance configuration to use for the agent. [Limits: 0 <= value <= DT_CROWD_MAX_OBSTAVOIDANCE_PARAMS]

dtCrowd permits agents to use different avoidance configurations. This value is the index of the dtObstacleAvoidanceParams within the crowd.

See also

dtObstacleAvoidanceParams, dtCrowd::setObstacleAvoidanceParams(), dtCrowd::getObstacleAvoidanceParams()

pathOptimizationRange

dtCrowdAgentParams::pathOptimizationRange

The path visibility optimization range. [Limit: > 0].

Only applicalbe if updateFlags includes the DT_CROWD_OPTIMIZE_VIS flag.

This value is often based on the agent radius. E.g. radius * 30

See also

dtPathCorridor::optimizePathVisibility()

radius

dtReal dtCrowdAgentParams::radius

Agent radius. [Limit: >= 0].

separationWeight

dtCrowdAgentParams::separationWeight

How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0].

A higher value will result in agents trying to stay farther away from each other at the cost of more difficult steering in tight spaces.

updateFlags

unsigned short dtCrowdAgentParams::updateFlags

Flags that impact steering behavior. (See: UpdateFlags)

userData

void* dtCrowdAgentParams::userData

User defined data attached to the agent.

---

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

• Engine/Source/Runtime/Navmesh/Public/DetourCrowd/DetourCrowd.h