1. Epic GamesDeveloper
  3. UCrowdFollowingComponent

UCrowdFollowingComponent

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UCrowdFollowingComponent :  
    public UPathFollowingComponent ,  
    public ICrowdAgentInterface

Variables

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

Constructors

  Type Name Description
Public function  

UCrowdFollowingComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

ApplyCrowdAgentPosition ( const FVector& NewPosition
)

 Pass desired position to movement component (after resolving collisions between crowd agents)
Public function Virtual void

ApplyCrowdAgentVelocity ( const FVector& NewVelocity,
const FVector& DestPathCorner,
bool bTraversingLink,
bool bIsNearEndOfPath
)

 Pass agent velocity to movement component
Public function Virtual void  
Public function Const int32  
Public function Const ECrowdAvoidanceQuality::Type  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const ECrowdSimulationState  
Public function Const int32  
Public function Const int32  
Protected function Const bool  
Public function Const bool  
Public function Const bool Checks if bEnableAnticipateTurns is set to true, and if crowd simulation is not suspended
Public function Const bool  
Public function Const bool Checks if bEnableObstacleAvoidance is set to true, and if crowd simulation is not suspended
Public function Const bool  
Public function Const bool Checks if bEnableOptimizeTopology is set to true, and if crowd simulation is not suspended
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Checks if bEnableSeparation is set to true, and if crowd simulation is not suspended
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual void

OnNavNodeChanged ( NavNodeRef NewPolyRef,
NavNodeRef PrevPolyRef,
int32 CorridorSize
)

 Called when agent moved to next nav node (poly)
Protected function void  
Public function void

SetAvoidanceGroup ( int32 GroupFlags,
bool bUpdateAgent
)

  
Public function void  
Public function void

SetCrowdAnticipateTurns ( bool bEnable,
bool bUpdateAgent
)

  
Public function void  
Public function void

SetCrowdAvoidanceRangeMultiplier ( float Multiplier,
bool bUpdateAgent
)

  
Public function void

SetCrowdCollisionQueryRange ( float Range,
bool bUpdateAgent
)

  
Public function void

SetCrowdObstacleAvoidance ( bool bEnable,
bool bUpdateAgent
)

  
Public function void

SetCrowdOptimizeTopology ( bool bEnable,
bool bUpdateAgent
)

  
Public function void

SetCrowdOptimizeVisibility ( bool bEnable,
bool bUpdateAgent
)

  
Public function void

SetCrowdPathOffset ( bool bEnable,
bool bUpdateAgent
)

  
Public function void

SetCrowdPathOptimizationRange ( float Range,
bool bUpdateAgent
)

  
Public function void

SetCrowdRotateToVelocity ( bool bEnable
)

  
Public function void

SetCrowdSeparation ( bool bEnable,
bool bUpdateAgent
)

  
Public function void

SetCrowdSeparationWeight ( float Weight,
bool bUpdateAgent
)

  
Public function Virtual void Switch between crowd simulation and parent implementation (following path segments)
Public function void

SetCrowdSlowdownAtGoal ( bool bEnable,
bool bUpdateAgent
)

  
Public function void

SetGroupsToAvoid ( int32 GroupFlags,
bool bUpdateAgent
)

  
Public function void

SetGroupsToIgnore ( int32 GroupFlags,
bool bUpdateAgent
)

  
Protected function Const bool

ShouldSwitchPathPart ( int32 CorridorSize
)

  
Protected function Virtual Const bool

ShouldTrackMovingGoal ( FVector& OutGoalLocation
)

  
Public function Virtual UFunction BlueprintCallable, Category void

SuspendCrowdSteering ( bool bSuspend
)

 Main switch for crowd steering & avoidance
Protected function void  
Public function Const  

UE_DEPRECATED_FORGAME (

  1. 16,
    "Use ApplyCrowdAgentVelocity function with bIsNearEndOfPath param instead."
    )
  
Protected function void

UpdateCachedDirections ( const FVector& NewVelocity,
const FVector& NextPathCorner,
bool bTraversingLink
)

  
Public function Const void Update params in crowd manager

Overridden from UPathFollowingComponent

  Type Name Description
Public function Virtual void

AbortMove ( const UObject& Instigator,
FPathFollowingResultFlags::Type AbortFlags,
FAIRequestID RequestID,
EPathFollowingVelocityMode VelocityMode
)

 Aborts following path
Public function Virtual void

Cleanup ()

 Cleanup component before destroying
Public function Virtual Const void

DescribeSelfToVisLog ( FVisualLogEntry* Snapshot
)

  
Protected function Virtual Const int32

DetermineStartingPathPoint ( const FNavigationPath* ConsideredPath
)

 PathFollowingComponent BEGIN.
Public function Virtual void Call when moving agent finishes using custom nav link, returns control back to path following
Protected function Virtual void

FollowPathSegment ( float DeltaTime
)

 Follow current path segment
Public function Virtual Const int32 Returns index of the currently followed element of path.
Public function Virtual Const void  
Public function Virtual Const FVector

GetMoveFocus ( bool bAllowStrafe
)

 Get current focal point of movement
Public function Virtual void PathFollowingComponent BEGIN.
Protected function Virtual Const bool Check if agent is on path
Public function Virtual void  
Public function Virtual void Called when NavigationSystem finishes initial navigation data registration.
Public function Virtual void Called when owner is preparing new pathfinding request
Public function Virtual void Notify about finished movement
Public function Virtual void Notify about changing current path: new pointer or update from path event
Public function Virtual void

PauseMove ( FAIRequestID RequestID,
EPathFollowingVelocityMode VelocityMode
)

 Pause path following
Protected function Virtual void

Reset ()

 Reset path following data
Public function Virtual void

ResumeMove ( FAIRequestID RequestID
)

 Resume path following
Protected function Virtual void

SetMoveSegment ( int32 SegmentStartIndex
)

 Sets variables related to current move segment
Protected function Virtual Const bool Should verify if agent if still on path ater movement has been resumed?
Protected function Virtual bool

UpdateMovementComponent ( bool bForce
)

 Check if movement component is valid or tries to grab one from owner
Protected function Virtual void Check state of path following, update move segment if needed

Overridden from ICrowdAgentInterface

  Type Name Description
Public function Virtual Const int32 Group mask for this agent
Public function Virtual Const void

GetCrowdAgentCollisions ( float& CylinderRadius,
float& CylinderHalfHeight
)

 Fills information about agent's collision cylinder
Public function Virtual Const int32 Will avoid other agents if they are in one of specified groups
Public function Virtual Const int32 Will NOT avoid other agents if they are in one of specified groups, higher priority than GroupsToAvoid
Public function Virtual Const FVector  
Public function Virtual Const float  
Public function Virtual Const FVector  

Deprecated Variables

  Type Name Description
Protected variable UProperty FNavAvoidanceMask AvoidanceGroup_DEPRECATED DEPRECATED: Group mask for this agent - use IRVOAvoidanceInterface instead
Protected variable UProperty FNavAvoidanceMask GroupsToAvoid_DEPRECATED DEPRECATED: Will avoid other agents if they are in one of specified groups - use IRVOAvoidanceInterface instead
Protected variable UProperty FNavAvoidanceMask GroupsToIgnore_DEPRECATED DEPRECATED: Will NOT avoid other agents if they are in one of specified groups, higher priority than GroupsToAvoid - use IRVOAvoidanceInterface instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page