1. Epic GamesDeveloper
  3. UCrowdManager

UCrowdManager

API > API/Runtime > API/Runtime/AIModule > API/Runtime/AIModule/Navigation

Inheritance Hierarchy

  • UCrowdManagerBase
  • UCrowdManager

References

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

Syntax

UCLASS (Config=Engine, defaultconfig, MinimalAPI)  
class UCrowdManager : public UCrowdManagerBase

Variables

  Type Name Description
Protected variable TMap< ICrowdAgentInterface *, FCrowdAgentData > ActiveAgents Agents registered in crowd manager
Protected variable TArray< uint8 > AgentFlags Temporary flags for crowd agents
Protected variable UProperty Category, EditAnywhere Config TArray< FCrowdAvoidanceConfig > AvoidanceConfig Obstacle avoidance params
Protected variable uint32: 1 bAllowPathReplan  
Protected variable uint32: 1 bEarlyReachTestOptimization  
Protected variable uint32: 1 bPruneStartedOffmeshConnections  
Protected variable UProperty Category, EditAnywhere Config uint32: 1 bResolveCollisions Should crowd simulation resolve collisions between agents? if not, this will be handled by their movement components
Protected variable uint32: 1 bSingleAreaVisibilityOptimization  
Protected variable UProperty Category, EditAnywhere Config float MaxAgentRadius Max radius of agent that can be added to crowd
Protected variable UProperty Category, EditAnywhere Config int32 MaxAgents Max number of agents supported by crowd
Protected variable UProperty Category, EditAnywhere Config int32 MaxAvoidedAgents Max number of neighbor agents for velocity avoidance
Protected variable UProperty Category, EditAnywhere Config int32 MaxAvoidedWalls Max number of wall segments for velocity avoidance
Protected variable UProperty Transient TObjectPtr< ANavigationData > MyNavData  
Protected variable UProperty Category, EditAnywhere Config float NavmeshCheckInterval How often should agents check their position after moving off navmesh?
Protected variable UProperty Category, EditAnywhere Config float PathOffsetRadiusMultiplier Agent radius multiplier for offsetting path around corners
Protected variable UProperty Category, EditAnywhere Config float PathOptimizationInterval How often should agents try to optimize their paths?
Protected variable UProperty Category, EditAnywhere Config TArray< FCrowdAvoidanceSamplingPattern > SamplingPatterns Obstacle avoidance params
Protected variable UProperty Category, EditAnywhere Config float SeparationDirClamp Clamp separation force to left/right when neighbor is behind (dot between forward and dirToNei, -1 = disabled)
Protected variable FCrowdTickHelper * TickHelper  

Constructors

  Type Name Description
Public function  

UCrowdManager ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const void

AdjustAgentPathStart ( const UCrowdFollowingComponent* AgentComponent,
const FNavMeshPath* Path,
int32& PathStartIdx
)

 Adjust current position in path's corridor, starting test from PathStartIdx
Public function Virtual void  
Public function Virtual void

CleanUp ( float DeltaTime
)

  
Public function Const void Clears move target for crowd agent (only for fully simulated)
Public function Const void  
Public function Const bool Reads existing avoidance config or returns false
Public function Static UCrowdManager *

GetCurrent ( UWorld* World
)

  
Public function Static UCrowdManager *

GetCurrent ( UObject* WorldContextObject
)

  
Public function Const const ANavigationData *  
Public function Const int32

GetNearbyAgentLocations ( const ICrowdAgentInterface* Agent,
TArray< FVector >& OutLocations
)

 Returns a list of locations of nearby agents
Public function Const int32 Returns number of nearby agents
Public function Const UWorld *  
Public function Const bool

IsAgentValid ( const UCrowdFollowingComponent* AgentComponent
)

 Check if object is a valid crowd agent
Public function Const bool  
Public function Virtual Const bool

IsSuitableNavData ( const ANavigationData& NavData
)

 Tests if NavData is a suitable nav data type to be used by this CrowdManager instance.
Public function Const void Update agent after using custom link
Public function Virtual void

OnNavDataRegistered ( ANavigationData& NavData
)

 Called by the nav system when a new navigation data instance is registered.
Public function Virtual void

OnNavDataUnregistered ( ANavigationData& NavData
)

 Called by the nav system when a navigation data instance is removed.
Public function void Notify called when detour navmesh is changed
Public function Const void

PauseAgent ( const UCrowdFollowingComponent* AgentComponent
)

 Switch agent to waiting state
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Protected function Virtual void Called from tick, after move points were updated, before any steering/avoidance
Protected function Virtual void Called from tick, just after updating agents proximity data
Public function void Adds new agent to crowd
Public function Const void

ResumeAgent ( const UCrowdFollowingComponent* AgentComponent,
bool bForceReplanPath
)

 Resumes agent movement
Public function Const bool

SetAgentMoveDirection ( const UCrowdFollowingComponent* AgentComponent,
const FVector& MoveDirection
)

 Sets move direction for crowd agent (only for fully simulated)
Public function Const bool

SetAgentMovePath ( const UCrowdFollowingComponent* AgentComponent,
const FNavMeshPath* Path,
int32 PathSectionStart,
int32 PathSectionEnd,
const FVector& PathSectionEndLocation
)

 Sets move target using path (only for fully simulated)
Public function Const bool

SetAgentMoveTarget ( const UCrowdFollowingComponent* AgentComponent,
const FVector& MoveTarget,
FSharedConstNavQueryFilter Filter
)

 Sets move target for crowd agent (only for fully simulated)
Public function bool Updates existing avoidance config or returns false
Protected function void

SetNavData ( ANavigationData* NavData,
const bool bFindNewNavDataIfNull
)

 Sets NavData as MyNavData.
Public function void

SetOffmeshConnectionPruning ( bool bRemoveFromCorridor
)

 Remove started offmesh connections from corridor
Public function void Block path visibility raycasts when crossing different nav areas
Public function Virtual void

Tick ( float DeltaTime
)

  
Public function void Removes agent from crowd
Public function Const void Updates agent data
Public function Const void Refresh agent state
Protected function Virtual void Setup params of crowd avoidance
Protected function Virtual void Try to initialize nav data from already existing ones

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page