Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AIModule > Navigation > UCrowdFollowingComponent

Light Theme

Dark Theme

UCrowdFollowingComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UPathFollowingComponent

UCrowdFollowingComponent

References

Module	AIModule
Header	/Engine/Source/Runtime/AIModule/Classes/Navigation/CrowdFollowingComponent.h
Include	#include "Navigation/CrowdFollowingComponent.h"

Syntax

class UCrowdFollowingComponent :
public UPathFollowingComponent,
public ICrowdAgentInterface

Variables

	Name	Description
TEnumAsByte< EC...	AvoidanceQuality
float	AvoidanceRangeMultiplier	Multiplier for avoidance samples during detection, doesn't affect actual velocity
uint8: 1	bAffectFallingVelocity	If set, velocity will be updated even if agent is falling
uint8: 1	bCanCheckMovingTooFar	If set, destination overshot can be tested
uint8: 1	bCanUpdatePathPartInTick	If set, path parts can be switched in UpdatePathSegment, based on distance
uint8: 1	bCheckMovementAngle	If set, movement will be finished when velocity is opposite to path direction (runtime flag)
uint8: 1	bEnableAnticipateTurns
uint8: 1	bEnableObstacleAvoidance
uint8: 1	bEnableOptimizeTopology
uint8: 1	bEnableOptimizeVisibility
uint8: 1	bEnablePathOffset
uint8: 1	bEnableSeparation
uint8: 1	bEnableSimulationReplanOnResume
uint8: 1	bEnableSlowdownAtGoal
uint8: 1	bFinalPathPart	If set, agent if moving on final path part, skip further updates (runtime flag)
uint8: 1	bRegisteredWithCrowdSimulation	Set when agent is registered in crowd simulation (either controlled or an obstacle)
uint8: 1	bRotateToVelocity	If set, move focus will match velocity direction
uint8: 1	bSuspendCrowdSimulation	If set, avoidance and steering will be suspended (used for direct move requests)
uint8: 1	bUpdateDirectMoveVelocity	If set, move velocity will be updated in every tick
UCharacterMovem...	CharacterMovement
float	CollisionQueryRange
FVector	CrowdAgentMoveDirection
int32	LastPathPolyIndex	Last visited poly on path
float	PathOptimizationRange
int32	PathStartIndex	Start index of current path part
float	SeparationWeight
ECrowdSimulatio...	SimulationState
friend	UCrowdManager

Constructors

	Name	Description
	UCrowdFollowingComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	ApplyCrowdAgentPosition ( const FVector& NewPosition )	Pass desired position to movement component (after resolving collisions between crowd agents)
void	ApplyCrowdAgentVelocity ( const FVector& NewVelocity, const FVector& DestPathCorner, bool bTraversingLink )
void	ApplyCrowdAgentVelocity ( const FVector& NewVelocity, const FVector& DestPathCorner, bool bTraversingLink, bool bIsNearEndOfPath )	Pass agent velocity to movement component
int32	GetAvoidanceGroup()
ECrowdAvoida...	GetCrowdAvoidanceQuality()
float	GetCrowdAvoidanceRangeMultiplier()
float	GetCrowdCollisionQueryRange()
float	GetCrowdPathOptimizationRange()
float	GetCrowdSeparationWeight()
ECrowdSimula...	GetCrowdSimulationState()
int32	GetGroupsToAvoid()
int32	GetGroupsToIgnore()
bool	HasMovedDuringPause()
bool	IsCrowdAffectFallingVelocityEnabled()
bool	IsCrowdAnticipateTurnsActive()	Checks if bEnableAnticipateTurns is set to true, and if crowd simulation is not suspended
bool	IsCrowdAnticipateTurnsEnabled()
bool	IsCrowdObstacleAvoidanceActive()	Checks if bEnableObstacleAvoidance is set to true, and if crowd simulation is not suspended
bool	IsCrowdObstacleAvoidanceEnabled()
bool	IsCrowdOptimizeTopologyActive()	Checks if bEnableOptimizeTopology is set to true, and if crowd simulation is not suspended
bool	IsCrowdOptimizeTopologyEnabled()
bool	IsCrowdOptimizeVisibilityEnabled()
bool	IsCrowdPathOffsetEnabled()
bool	IsCrowdRotateToVelocityEnabled()
bool	IsCrowdSeparationActive()	Checks if bEnableSeparation is set to true, and if crowd simulation is not suspended
bool	IsCrowdSeparationEnabled()
bool	IsCrowdSimulationActive()
bool	IsCrowdSimulationEnabled()
bool	IsCrowdSimulatioSuspended()
bool	IsCrowdSlowdownAtGoalEnabled()
void	OnNavNodeChanged ( NavNodeRef NewPolyRef, NavNodeRef PrevPolyRef, int32 CorridorSize )	Called when agent moved to next nav node (poly)
void	RegisterCrowdAgent()
void	SetAvoidanceGroup ( int32 GroupFlags, bool bUpdateAgent )
void	SetCrowdAffectFallingVelocity ( bool bEnable )
void	SetCrowdAnticipateTurns ( bool bEnable, bool bUpdateAgent )
void	SetCrowdAvoidanceQuality ( ECrowdAvoidanceQuality::Type Qualit..., bool bUpdateAgent )
void	SetCrowdAvoidanceRangeMultiplier ( float Multiplier, bool bUpdateAgent )
void	SetCrowdCollisionQueryRange ( float Range, bool bUpdateAgent )
void	SetCrowdObstacleAvoidance ( bool bEnable, bool bUpdateAgent )
void	SetCrowdOptimizeTopology ( bool bEnable, bool bUpdateAgent )
void	SetCrowdOptimizeVisibility ( bool bEnable, bool bUpdateAgent )
void	SetCrowdPathOffset ( bool bEnable, bool bUpdateAgent )
void	SetCrowdPathOptimizationRange ( float Range, bool bUpdateAgent )
void	SetCrowdRotateToVelocity ( bool bEnable )
void	SetCrowdSeparation ( bool bEnable, bool bUpdateAgent )
void	SetCrowdSeparationWeight ( float Weight, bool bUpdateAgent )
void	SetCrowdSimulationState ( ECrowdSimulationState NewState )	Switch between crowd simulation and parent implementation (following path segments)
void	SetCrowdSlowdownAtGoal ( bool bEnable, bool bUpdateAgent )
void	SetGroupsToAvoid ( int32 GroupFlags, bool bUpdateAgent )
void	SetGroupsToIgnore ( int32 GroupFlags, bool bUpdateAgent )
bool	ShouldSwitchPathPart ( int32 CorridorSize )
bool	ShouldTrackMovingGoal ( FVector& OutGoalLocation )
void	SuspendCrowdSteering ( bool bSuspend )	Master switch for crowd steering & avoidance
void	SwitchToNextPathPart()
void	UpdateCachedDirections ( const FVector& NewVelocity, const FVector& NextPathCorner, bool bTraversingLink )
void	UpdateCrowdAgentParams()	Update params in crowd manager
void	UpdateDestinationForMovingGoal ( const FVector& NewDestination )

Overridden from UPathFollowingComponent

	Name	Description
void	AbortMove ( const UObject& Instigator, FPathFollowingResultFlags::Type Abo..., FAIRequestID RequestID, EPathFollowingVelocityMode Velocity... )	Aborts following path
void	Cleanup()	Cleanup component before destroying
void	DescribeSelfToVisLog ( FVisualLogEntry* Snapshot )
int32	DetermineStartingPathPoint ( const FNavigationPath* Conside... )	PathFollowingComponent BEGIN.
void	FinishUsingCustomLink ( INavLinkCustomInterface* Custo... )	Call when moving agent finishes using custom nav link, returns control back to path following
void	FollowPathSegment ( float DeltaTime )	Follow current path segment
int32	GetCurrentPathElement()	Returns index of the currently followed element of path.
void	GetDebugStringTokens ( TArray< FString >& Tokens, TArray< EPathFollowingDebugTokens::... )
FVector	GetMoveFocus ( bool bAllowStrafe )	Get current focal point of movement
void	Initialize()	PathFollowingComponent BEGIN.
bool	IsOnPath()	Check if agent is on path
void	OnNavigationInitDone()	Called when NavigationSystem finishes initial navigation data registration.
void	OnPathfindingQuery ( FPathFindingQuery& Query )	Called when owner is preparing new pathfinding request
void	OnPathFinished ( const FPathFollowingResult& Result )	Notify about finished movement
void	OnPathUpdated()	Notify about changing current path: new pointer or update from path event
void	PauseMove ( FAIRequestID RequestID, EPathFollowingVelocityMode Velocity... )	Pause path following
void	Reset()	Reset path following data
void	ResumeMove ( FAIRequestID RequestID )	Resume path following
void	SetMoveSegment ( int32 SegmentStartIndex )	Sets variables related to current move segment
bool	ShouldCheckPathOnResume()	Should verify if agent if still on path ater movement has been resumed?
bool	UpdateMovementComponent ( bool bForce )	Check if movement component is valid or tries to grab one from owner
void	UpdatePathSegment()	Check state of path following, update move segment if needed

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.

Overridden from IPathFollowingAgentInterface

		Name	Description
	void	OnLanded()	Called when falling movement ends.

Overridden from ICrowdAgentInterface

	Name	Description
int32	GetCrowdAgentAvoidanceGroup()	Group mask for this agent
void	GetCrowdAgentCollisions ( float& CylinderRadius, float& CylinderHalfHeight )	Fills information about agent's collision cylinder
int32	GetCrowdAgentGroupsToAvoid()	Will avoid other agents if they are in one of specified groups
int32	GetCrowdAgentGroupsToIgnore()	Will NOT avoid other agents if they are in one of specified groups, higher priority than GroupsToAvoid
FVector	GetCrowdAgentLocation()
float	GetCrowdAgentMaxSpeed()
FVector	GetCrowdAgentVelocity()

Deprecated Variables

	Name	Description
FNavAvoidanceMa...	AvoidanceGroup_DEPRECATED	DEPRECATED: Group mask for this agent - use property from CharacterMovementComponent instead
uint8: 1	bEnableCrowdSimulation	Please use IsCrowdSimulationEnabled(), SetCrowdSimulationState() and SimulationState member for initialization.
FNavAvoidanceMa...	GroupsToAvoid_DEPRECATED	DEPRECATED: Will avoid other agents if they are in one of specified groups - use property from CharacterMovementComponent instead
FNavAvoidanceMa...	GroupsToIgnore_DEPRECATED	DEPRECATED: Will NOT avoid other agents if they are in one of specified groups, higher priority than GroupsToAvoid - use property from CharacterMovementComponent instead

Deprecated Functions

		Name	Description
	void	SetCrowdSimulation ( bool bEnable )	Use SetCrowdSimulationState function instead.
	bool	UpdateCachedGoal ( FVector& NewGoalPos )	This function is now deprecated and was renamed to ShouldTrackMovingGoal.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss