1. Epic GamesDeveloper
  3. UAvoidanceManager

UAvoidanceManager

API > API/Runtime > API/Runtime/Engine

   
Name UAvoidanceManager
Type class
Header File /Engine/Source/Runtime/Engine/Classes/AI/Navigation/AvoidanceManager.h
Include Path #include "AI/Navigation/AvoidanceManager.h"

Syntax

UCLASS (Config=Engine, Blueprintable, MinimalAPI)  
class UAvoidanceManager :  
    public UObject ,  
    public FSelfRegisteringExec

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAvoidanceManager ( const FObjectInitializer& ObjectInitializer
)

   AI/Navigation/AvoidanceManager.h  

Constants

Name Type Remarks Include Path
bSystemActive bool Main switch for avoidance system AI/Navigation/AvoidanceManager.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ArtificialRadiusExpansion float Multiply the radius of all STORED avoidance objects by this value to allow a little extra room for avoidance maneuvers. AI/Navigation/AvoidanceManager.h
  • EditAnywhere
  • Category="Avoidance"
  • Config
  • Meta=(ClampMin="0.0")
DefaultTimeToLive float How long an avoidance UID must not be updated before the system will put it back in the pool. AI/Navigation/AvoidanceManager.h
  • EditAnywhere
  • Category="Avoidance"
  • Config
  • Meta=(ClampMin="0.0")
DeltaTimeToPredict float This is how far forward in time (seconds) we extend our velocity cones and thus our prediction AI/Navigation/AvoidanceManager.h
  • EditAnywhere
  • Category="Avoidance"
  • Config
  • Meta=(ClampMin="0.0")
HeightCheckMargin float Allowable height margin between obstacles and agents. AI/Navigation/AvoidanceManager.h
  • EditAnywhere
  • Category="Avoidance"
  • Config
  • Meta=(ClampMin="0.0")
LockTimeAfterAvoid float How long to stay on course (barring collision) after making an avoidance move AI/Navigation/AvoidanceManager.h
  • EditAnywhere
  • Category="Avoidance"
  • Config
  • Meta=(ClampMin="0.0")
LockTimeAfterClean float How long to stay on course (barring collision) after making an unobstructed move (should be > 0.0, but can be less than a full frame) AI/Navigation/AvoidanceManager.h
  • EditAnywhere
  • Category="Avoidance"
  • Config
  • Meta=(ClampMin="0.0")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AvoidanceDebugForAll ( bool TurnOn
)

   AI/Navigation/AvoidanceManager.h  

void AvoidanceDebugForUID ( int32 AvoidanceUID,
bool TurnOn
)

   AI/Navigation/AvoidanceManager.h  

const FNavAvoidanceData * GetAvoidanceObjectForUID ( int32 AvoidanceUID
) const

   AI/Navigation/AvoidanceManager.h  

FNavAvoidanceData * GetAvoidanceObjectForUID ( int32 AvoidanceUID
)

 Get your latest data. AI/Navigation/AvoidanceManager.h  

FVector GetAvoidanceVelocity ( const FNavAvoidanceData& AvoidanceData,
float DeltaTime
)

 Only use if you want manual velocity planning. AI/Navigation/AvoidanceManager.h  
Fast-track GetAvoidanceVelocityForComponent(UMovementComponent) implementation for most common case of UCharacterMovementComponent AI/Navigation/AvoidanceManager.h  
Calculate avoidance velocity for component (avoids collisions with the supplied component) AI/Navigation/AvoidanceManager.h
  • BlueprintCallable
  • Category="AI"

FVector GetAvoidanceVelocityIgnoringUID ( const FNavAvoidanceData& AvoidanceData,
float DeltaTime,
int32 IgnoreThisUID
)

 Only use if you want manual velocity planning. AI/Navigation/AvoidanceManager.h  

int32 GetNewAvoidanceUID()

 Get appropriate UID for use when reporting to this function or requesting RVO assistance. AI/Navigation/AvoidanceManager.h
  • BlueprintCallable
  • Category="AI"

int32 GetObjectCount()

 Get the number of avoidance objects currently in the manager. AI/Navigation/AvoidanceManager.h
  • BlueprintCallable
  • Category="AI"

void HandleToggleAvoidance ( const TCHAR* Cmd,
FOutputDevice& Ar
)

   AI/Navigation/AvoidanceManager.h  

void HandleToggleDebugAll ( const TCHAR* Cmd,
FOutputDevice& Ar
)

 Exec command handlers AI/Navigation/AvoidanceManager.h  

bool IsAutoPurgeEnabled()

 Returns true if the avoidance objects are auto purged in RemoveOutdatedObjects AI/Navigation/AvoidanceManager.h  

bool IsDebugEnabled ( int32 AvoidanceUID
)

   AI/Navigation/AvoidanceManager.h  

bool IsDebugOnForAll()

   AI/Navigation/AvoidanceManager.h  

bool IsDebugOnForUID ( int32 AvoidanceUID
)

   AI/Navigation/AvoidanceManager.h  

void OverrideToMaxWeight ( int32 AvoidanceUID,
float Duration
)

 For Duration seconds, set this object to ignore all others. AI/Navigation/AvoidanceManager.h  

bool RegisterMovementComponent ( UMovementComponent* MovementComp,
float AvoidanceWeight
)

 Register with the given avoidance manager. AI/Navigation/AvoidanceManager.h
  • BlueprintCallable
  • Category="AI"

bool RegisterMovementComponent ( UCharacterMovementComponent* MovementComp,
float AvoidanceWeight
)

   AI/Navigation/AvoidanceManager.h  

void RemoveAvoidanceObject ( const int32 AvoidanceUID
)

 Used to manually mark data associated with given ID as 'dead' (and reusable) AI/Navigation/AvoidanceManager.h  

void SetNavEdgeProvider ( INavEdgeProviderInterface* InEdgeProvider
)

   AI/Navigation/AvoidanceManager.h  

void UpdateRVO ( UMovementComponent* MovementComp
)

 Update the RVO avoidance data for the participating UMovementComponent AI/Navigation/AvoidanceManager.h  

void UpdateRVO ( UCharacterMovementComponent* MovementComp
)

 Fast-track UpdateRVO(UMovementComponent) implementation for most common case of UCharacterMovementComponent AI/Navigation/AvoidanceManager.h  

Protected

Name Remarks Include Path Unreal Specifiers

FVector GetAvoidanceVelocity_Internal ( const FNavAvoidanceData& AvoidanceData,
float DeltaTime,
int32* IgnoreThisUID
)

 This is called by our blueprint-accessible functions, and permits the user to ignore self, or not. AI/Navigation/AvoidanceManager.h  

void RemoveOutdatedObjects()

 Cleanup AvoidanceObjects, called by timer AI/Navigation/AvoidanceManager.h  

void RequestUpdateTimer()

 Try to set a timer for RemoveOutdatedObjects AI/Navigation/AvoidanceManager.h  

void UpdateRVO_Internal ( int32 AvoidanceUID,
const FNavAvoidanceData& AvoidanceData
)

 This is called by our blueprint-accessible function after it has packed the data into an object. AI/Navigation/AvoidanceManager.h  

Overridden from FExec

Name Remarks Include Path Unreal Specifiers

virtual bool Exec_Dev ( UWorld* Inworld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

   AI/Navigation/AvoidanceManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AvoidanceSystemToggle ( bool TurnOn
)

   AI/Navigation/AvoidanceManager.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
TestHeightDifference_DEPRECATED float Deprecated - use HeightCheckMargin, generally a much smaller value. AI/Navigation/AvoidanceManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page