UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
PathFollowingComponent.h File Reference
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/WeakObjectPtr.h"
#include "Engine/EngineTypes.h"
#include "Components/ActorComponent.h"
#include "EngineDefines.h"
#include "AI/Navigation/NavigationTypes.h"
#include "NavigationData.h"
#include "AITypes.h"
#include "AIResourceInterface.h"
#include "GameFramework/NavMovementComponent.h"
#include "AI/Navigation/PathFollowingAgentInterface.h"
#include "PathFollowingComponent.generated.h"

Go to the source code of this file.

Classes

struct  FPathFollowingResult
 
struct  FPathFollowingRequestResult
 
class  UPathFollowingComponent
 

Namespaces

namespace  EPathFollowingStatus
 
namespace  EPathFollowingResult
 
namespace  FPathFollowingResultFlags
 
namespace  EPathFollowingAction
 
namespace  EPathFollowingRequestResult
 
namespace  EPathFollowingDebugTokens
 
namespace  EPathFollowingMessage
 

Typedefs

typedef uint16 FPathFollowingResultFlags::Type
 

Enumerations

enum  EPathFollowingStatus::Type : int { EPathFollowingStatus::Idle , EPathFollowingStatus::Waiting , EPathFollowingStatus::Paused , EPathFollowingStatus::Moving }
 
enum  EPathFollowingResult::Type : int {
  EPathFollowingResult::Success , EPathFollowingResult::Blocked , EPathFollowingResult::OffPath , EPathFollowingResult::Aborted ,
  EPathFollowingResult::UMETA =(Hidden) , EPathFollowingResult::Invalid
}
 
enum  EPathFollowingAction::Type : int {
  EPathFollowingAction::Error , EPathFollowingAction::NoMove , EPathFollowingAction::DirectMove , EPathFollowingAction::PartialPath ,
  EPathFollowingAction::PathToGoal
}
 
enum  EPathFollowingRequestResult::Type : int { EPathFollowingRequestResult::Failed , EPathFollowingRequestResult::AlreadyAtGoal , EPathFollowingRequestResult::RequestSuccessful }
 
enum  EPathFollowingDebugTokens::Type : int { EPathFollowingDebugTokens::Description , EPathFollowingDebugTokens::ParamName , EPathFollowingDebugTokens::FailedValue , EPathFollowingDebugTokens::PassedValue }
 
enum  EPathFollowingMessage::Type : int { EPathFollowingMessage::NoPath , EPathFollowingMessage::OtherRequest }
 
enum class  EPathFollowingVelocityMode : uint8 { Reset , Keep }
 
enum class  EPathFollowingReachMode : uint8 { ExactLocation , OverlapAgent , OverlapGoal , OverlapAgentAndGoal }
 

Functions

AIMODULE_API DECLARE_LOG_CATEGORY_EXTERN (LogPathFollowing, Warning, All)
 
FString FPathFollowingResultFlags::ToString (uint16 Value)
 

Variables

const Type FPathFollowingResultFlags::None = 0
 
const Type FPathFollowingResultFlags::Success = (1 << 0)
 
const Type FPathFollowingResultFlags::Blocked = (1 << 1)
 
const Type FPathFollowingResultFlags::OffPath = (1 << 2)
 
const Type FPathFollowingResultFlags::UserAbort = (1 << 3)
 
const Type FPathFollowingResultFlags::OwnerFinished = (1 << 4)
 
const Type FPathFollowingResultFlags::InvalidPath = (1 << 5)
 
const Type FPathFollowingResultFlags::MovementStop = (1 << 6)
 
const Type FPathFollowingResultFlags::NewRequest = (1 << 7)
 
const Type FPathFollowingResultFlags::ForcedScript = (1 << 8)
 
const Type FPathFollowingResultFlags::AlreadyAtGoal = (1 << 9)
 
const Type FPathFollowingResultFlags::FirstGameplayFlagShift = 10
 
const Type FPathFollowingResultFlags::UserAbortFlagMask = ~(Success | Blocked | OffPath)
 

Enumeration Type Documentation

◆ EPathFollowingReachMode

Enumerator
ExactLocation 

reach test uses only AcceptanceRadius

OverlapAgent 

reach test uses AcceptanceRadius increased by modified agent radius

OverlapGoal 

reach test uses AcceptanceRadius increased by goal actor radius

OverlapAgentAndGoal 

reach test uses AcceptanceRadius increased by modified agent radius AND goal actor radius

◆ EPathFollowingVelocityMode

Enumerator
Reset 
Keep 

Function Documentation

◆ DECLARE_LOG_CATEGORY_EXTERN()

AIMODULE_API DECLARE_LOG_CATEGORY_EXTERN ( LogPathFollowing  ,
Warning  ,
All   
)