UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UPathFollowingComponent Class Reference

#include <PathFollowingComponent.h>

+ Inheritance diagram for UPathFollowingComponent:

Public Attributes

uint8 DEBUG_bMovingDirectlyToGoal: 1
 
- Public Attributes inherited from UActorComponent
struct FActorComponentTickFunction PrimaryComponentTick
 
TArray< FNameComponentTags
 
uint8 bAutoRegister:1
 
uint8 bTickInEditor:1
 
uint8 bNeverNeedsRenderUpdate:1
 
uint8 bAllowConcurrentTick:1
 
uint8 bAllowAnyoneToDestroyMe:1
 
uint8 bAutoActivate:1
 
uint8 bEditableWhenInherited:1
 
uint8 bNavigationRelevant: 1
 
uint8 bWantsInitializeComponent:1
 
uint8 bIsEditorOnly:1
 
EComponentCreationMethod CreationMethod
 
FActorComponentActivatedSignature OnComponentActivated
 
FActorComponentDeactivateSignature OnComponentDeactivated
 

Static Public Attributes

static AIMODULE_API const float DefaultAcceptanceRadius = -1.f
 
- Static Public Attributes inherited from UActorComponent
static ENGINE_API FActorComponentGlobalCreatePhysicsSignature GlobalCreatePhysicsDelegate
 
static ENGINE_API FActorComponentGlobalDestroyPhysicsSignature GlobalDestroyPhysicsDelegate
 
static ENGINE_API FTransactionallySafeRWLock AllUCSModifiedPropertiesLock
 
static ENGINE_API TMap< UActorComponent *, TArray< FSimpleMemberReference > > AllUCSModifiedProperties
 
static ENGINE_API const FString ComponentTemplateNameSuffix
 
static ENGINE_API FOnMarkRenderStateDirty MarkRenderStateDirtyEvent
 

Protected Member Functions

AIMODULE_API void SetStatus (EPathFollowingStatus::Type InStatus)
 
AIMODULE_API FSharedConstNavQueryFilter ExtractNavigationFilter (const FAIMoveRequest &RequestData, FNavPathSharedPtr InPath) const
 
virtual AIMODULE_API void Reset ()
 
virtual AIMODULE_API void OnNewPawn (APawn *NewPawn)
 
virtual AIMODULE_API bool ShouldCheckPathOnResume () const
 
virtual AIMODULE_API void SetMoveSegment (int32 SegmentStartIndex)
 
virtual AIMODULE_API void FollowPathSegment (float DeltaTime)
 
virtual AIMODULE_API void UpdatePathSegment ()
 
virtual AIMODULE_API void StartUsingCustomLink (INavLinkCustomInterface *CustomNavLink, const FVector &DestPoint)
 
virtual AIMODULE_API bool UpdateBlockDetection ()
 
virtual AIMODULE_API void UpdateDecelerationData ()
 
virtual AIMODULE_API bool HasReachedDestination (const FVector &CurrentLocation) const
 
virtual AIMODULE_API bool HasReachedCurrentTarget (const FVector &CurrentLocation) const
 
AIMODULE_API bool HasReachedInternal (const FVector &GoalLocation, float GoalRadius, float GoalHalfHeight, const FVector &AgentLocation, float RadiusThreshold, float AgentRadiusMultiplier) const
 
AIMODULE_API void ResetMoveSegmentCustomLinkCache ()
 
virtual AIMODULE_API bool IsOnPath () const
 
AIMODULE_API bool IsBlocked () const
 
void SetNextMoveSegment ()
 
void StoreRequestId ()
 
virtual AIMODULE_API int32 DetermineStartingPathPoint (const FNavigationPath *ConsideredPath) const
 
virtual AIMODULE_API int32 DetermineCurrentTargetPathPoint (int32 StartIndex)
 
virtual AIMODULE_API bool UpdateMovementComponent (bool bForce=false)
 
virtual AIMODULE_API bool HandlePathUpdateEvent ()
 
virtual AIMODULE_API void OnWaitingPathTimeout ()
 
AIMODULE_API void ResetBlockDetectionData ()
 
AIMODULE_API void ForceBlockDetectionUpdate ()
 
virtual AIMODULE_API void UpdateMoveFocus ()
 
virtual AIMODULE_API bool ShouldStopMovementOnPathFinished () const
 
AIMODULE_API int32 FindPreciseAcceptanceRadiusTestsStartNodeIndex (const FNavigationPath &PathInstance, const FVector &GoalLocation) const
 
AIMODULE_API float GetFinalAcceptanceRadius (const FNavigationPath &PathInstance, const FVector OriginalGoalLocation, const FVector *PathEndOverride=nullptr) const
 
AIMODULE_API void DebugReachTest (float &CurrentDot, float &CurrentDistance, float &CurrentHeight, uint8 &bDotFailed, uint8 &bDistanceFailed, uint8 &bHeightFailed) const
 
virtual AIMODULE_API void OnNavigationInitDone ()
 
AIMODULE_API void OnNavDataRegistered (ANavigationData *NavData)
 
- Protected Member Functions inherited from UActorComponent
virtual ENGINE_API bool ShouldActivate () const
 
virtual ENGINE_API bool ShouldAsyncCreatePhysicsState (UWorld *WorldContext) const
 
virtual ENGINE_API bool ShouldAsyncDestroyPhysicsState () const
 
virtual ENGINE_API void OnPreRegister ()
 
virtual ENGINE_API void OnPreRegistered ()
 
virtual ENGINE_API void OnPreUnregister ()
 
virtual ENGINE_API void OnPreUnregistered ()
 
virtual ENGINE_API void OnUnregister ()
 
virtual void PrecachePSOs ()
 
virtual bool ShouldCreateRenderState () const
 
virtual ENGINE_API void CreateRenderState_Concurrent (FRegisterComponentContext *Context)
 
virtual ENGINE_API void SendRenderTransform_Concurrent ()
 
virtual ENGINE_API void SendRenderDynamicData_Concurrent ()
 
virtual ENGINE_API void SendRenderInstanceData_Concurrent ()
 
virtual ENGINE_API void DestroyRenderState_Concurrent ()
 
virtual ENGINE_API void OnCreatePhysicsState ()
 
virtual ENGINE_API void OnDestroyPhysicsState ()
 
virtual bool ShouldCreatePhysicsState () const
 
virtual bool HasValidPhysicsState () const
 
virtual ENGINE_API void RegisterComponentTickFunctions (bool bRegister)
 
ENGINE_API void HandleCanEverAffectNavigationChange (bool bForceUpdate=false)
 
ENGINE_API void SetAsyncPhysicsTickEnabled (bool bEnabled)
 
ENGINE_API void DeferRemoveAsyncPhysicsTick ()
 
ENGINE_API void SetIsReplicatedByDefault (const bool bNewReplicates)
 
ENGINE_API bool OwnerNeedsInitialization () const
 
ENGINE_API bool NeedsInitialization () const
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Static Protected Member Functions

static uint32 GetNextRequestId ()
 
- Static Protected Member Functions inherited from UActorComponent
static ENGINE_API bool CanBeHLODRelevant (const UActorComponent *ActorComponent)
 
static const FName GetReplicatesPropertyName ()
 

Protected Attributes

TObjectPtr< UNavMovementComponentMovementComp
 
TWeakInterfacePtr< INavMovementInterfaceNavMovementInterface
 
FWeakObjectPtr CurrentCustomLinkOb
 
FWeakObjectPtr MoveSegmentCustomLinkOb
 
TObjectPtr< ANavigationDataMyNavData
 
FNavPathSharedPtr Path
 
FSharedConstNavQueryFilter NavigationFilter
 
float MyDefaultAcceptanceRadius
 
float AcceptanceRadius
 
float CurrentAcceptanceRadius
 
float MinAgentRadiusPct
 
float MinAgentHalfHeightPct
 
float WaitingTimeout
 
FCustomMoveSharedPtr GameData
 
TWeakObjectPtr< AActorDestinationActor
 
const INavAgentInterfaceDestinationAgent
 
FBasedPosition CurrentDestination
 
FVector CurrentMoveInput
 
FVector MoveOffset
 
FVector LocationWhenPaused
 
FVector OriginalMoveRequestGoalLocation
 
double PathTimeWhenPaused
 
int32 PreciseAcceptanceRadiusCheckStartNodeIndex
 
TEnumAsByte< EPathFollowingStatus::TypeStatus
 
uint8 bReachTestIncludesAgentRadius: 1
 
uint8 bReachTestIncludesGoalRadius: 1
 
uint8 bMoveToGoalOnLastSegment: 1
 
uint8 bMoveToGoalClampedToNavigation: 1
 
uint8 bUseBlockDetection: 1
 
uint8 bCollidedWithGoal: 1
 
uint8 bLastMoveReachedGoal: 1
 
uint8 bStopMovementOnFinish: 1
 
uint8 bIsUsingMetaPath: 1
 
uint8 bWalkingNavLinkStart: 1
 
uint8 bIsDecelerating: 1
 
uint8 bMoveSegmentIsUsingCustomLinkReachCondition: 1
 
uint8 bTickComponentOnlyWhenMoving: 1
 
float BlockDetectionDistance
 
float BlockDetectionInterval
 
int32 BlockDetectionSampleCount
 
double LastSampleTime
 
int32 NextSampleIdx
 
TArray< FBasedPositionLocationSamples
 
int32 MoveSegmentStartIndex
 
int32 MoveSegmentEndIndex
 
NavNodeRef MoveSegmentStartRef
 
NavNodeRef MoveSegmentEndRef
 
FVector MoveSegmentDirection
 
float CachedBrakingDistance
 
float CachedBrakingMaxSpeed
 
int32 DecelerationSegmentIndex
 
FAIResourceLock ResourceLock
 
FTimerHandle WaitingForPathTimer
 
- Protected Attributes inherited from UActorComponent
TArray< TObjectPtr< UAssetUserData > > AssetUserData
 
EComponentRegistrationState RegistrationState
 
uint8 bRegistered:1
 
uint8 bRenderStateCreated:1
 
uint8 bRenderStateRecreating:1
 
uint8 bPhysicsStateCreated:1
 
uint8 bCallAsyncPhysicsStateCreatedDelegate:1
 
uint8 bNetAddressable:1
 
uint8 bReplicateUsingRegisteredSubObjectList: 1
 
uint8 bAllowReregistration:1
 
uint8 bCanEverAffectNavigation: 1
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Public Member Functions inherited from UActorComponent
ENGINE_API UActorComponent (const FObjectInitializer &ObjectInitializer=FObjectInitializer::Get())
 
int32 GetUCSSerializationIndex () const
 
bool IsAsyncCreatePhysicsStateRunning () const
 
bool IsAsyncDestroyPhysicsStateRunning () const
 
uint32 GetMarkedForEndOfFrameUpdateState () const
 
uint32 GetMarkedForPreEndOfFrameSync () const
 
ENGINE_API void DetermineUCSModifiedProperties ()
 
ENGINE_API void GetUCSModifiedProperties (TSet< const FProperty * > &ModifiedProperties) const
 
ENGINE_API void RemoveUCSModifiedProperties (const TArray< FProperty * > &Properties)
 
ENGINE_API void ClearUCSModifiedProperties ()
 
ENGINE_API bool IsEditableWhenInherited () const
 
bool HasBeenCreated () const
 
bool HasBeenInitialized () const
 
bool IsReadyForReplication () const
 
bool HasBegunPlay () const
 
bool IsBeingDestroyed () const
 
ENGINE_API bool IsCreatedByConstructionScript () const
 
virtual ENGINE_API void OnRep_IsActive ()
 
AActorGetOwner () const
 
template<class T >
T * GetOwner () const
 
virtual UWorldGetWorld () const override final
 
ENGINE_API bool ComponentHasTag (FName Tag) const
 
virtual ENGINE_API void Activate (bool bReset=false)
 
virtual ENGINE_API void Deactivate ()
 
virtual ENGINE_API void SetActive (bool bNewActive, bool bReset=false)
 
virtual ENGINE_API void ToggleActive ()
 
bool IsActive () const
 
virtual ENGINE_API void SetAutoActivate (bool bNewAutoActivate)
 
ENGINE_API void SetTickableWhenPaused (bool bTickableWhenPaused)
 
ENGINE_API void CreatePhysicsState (bool bAllowDeferral=false)
 
ENGINE_API void DestroyPhysicsState ()
 
ENGINE_API void SetNetAddressable ()
 
ENGINE_API void SetIsReplicated (bool ShouldReplicate)
 
bool GetIsReplicated () const
 
virtual ENGINE_API bool ReplicateSubobjects (class UActorChannel *Channel, class FOutBunch *Bunch, FReplicationFlags *RepFlags)
 
bool IsUsingRegisteredSubObjectList () const
 
virtual ELifetimeCondition GetReplicationCondition () const
 
virtual void PreReplication (IRepChangedPropertyTracker &ChangedPropertyTracker)
 
virtual ENGINE_API bool GetComponentClassCanReplicate () const
 
ENGINE_API void AddReplicatedSubObject (UObject *SubObject, ELifetimeCondition NetCondition=COND_None)
 
ENGINE_API void RemoveReplicatedSubObject (UObject *SubObject)
 
ENGINE_API void DestroyReplicatedSubObjectOnRemotePeers (UObject *SubObject)
 
ENGINE_API void TearOffReplicatedSubObjectOnRemotePeers (UObject *SubObject)
 
ENGINE_API bool IsReplicatedSubObjectRegistered (const UObject *SubObject) const
 
bool IsNetSimulating () const
 
ENGINE_API ENetRole GetOwnerRole () const
 
ENetMode GetNetMode () const
 
bool IsNetMode (ENetMode Mode) const
 
bool IsNetStartupComponent () const
 
void SetIsNetStartupComponent (const bool bInIsNetStartupComponent)
 
virtual void OnEndOfFrameUpdateDuringTick ()
 
virtual void OnPreEndOfFrameSync ()
 
virtual ENGINE_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags) override
 
virtual ENGINE_API void OnReplicationStartedForIris (const FOnReplicationStartedParams &)
 
virtual ENGINE_API void OnStopReplicationForIris (const FOnStopReplicationParams &)
 
virtual ENGINE_API void BeginReplication ()
 
virtual ENGINE_API void EndReplication ()
 
virtual ENGINE_API bool ShouldIncrementalPreRegister (UWorld *WorldContext) const
 
virtual ENGINE_API bool ShouldIncrementalPreUnregister () const
 
virtual bool AllowsAsyncPhysicsStateCreation () const
 
virtual bool AllowsAsyncPhysicsStateDestruction () const
 
virtual ENGINE_API bool IsAsyncPhysicsStateCreated () const override final
 
virtual ENGINE_API UObjectGetAsyncPhysicsStateObject () const override final
 
virtual ENGINE_API bool OnAsyncCreatePhysicsState (const UE::FTimeout &Timeout) override
 
virtual ENGINE_API void OnAsyncCreatePhysicsStateEnd_GameThread () override
 
virtual bool OnAsyncDestroyPhysicsState (const UE::FTimeout &Timeout) override
 
virtual ENGINE_API void OnAsyncDestroyPhysicsStateBegin_GameThread () override
 
virtual ENGINE_API void OnAsyncDestroyPhysicsStateEnd_GameThread () override
 
virtual ENGINE_API void InitializeComponent ()
 
virtual ENGINE_API void ReadyForReplication ()
 
virtual ENGINE_API void BeginPlay ()
 
ENGINE_API void ReceiveBeginPlay ()
 
virtual ENGINE_API void EndPlay (const EEndPlayReason::Type EndPlayReason)
 
virtual ENGINE_API void UninitializeComponent ()
 
ENGINE_API void ReceiveEndPlay (EEndPlayReason::Type EndPlayReason)
 
ENGINE_API void RegisterAllComponentTickFunctions (bool bRegister)
 
virtual void AsyncPhysicsTickComponent (float DeltaTime, float SimTime)
 
ENGINE_API bool SetupActorComponentTickFunction (struct FTickFunction *TickFunction)
 
virtual ENGINE_API void SetComponentTickEnabled (bool bEnabled)
 
virtual ENGINE_API void SetComponentTickEnabledAsync (bool bEnabled)
 
virtual ENGINE_API bool IsComponentTickEnabled () const
 
ENGINE_API void SetComponentTickInterval (float TickInterval)
 
ENGINE_API void SetComponentTickIntervalAndCooldown (float TickInterval)
 
ENGINE_API float GetComponentTickInterval () const
 
ENGINE_API void PreRegisterComponentWithWorld (UWorld *InWorld)
 
ENGINE_API void PreUnregisterComponentFromWorld ()
 
ENGINE_API void RegisterComponentWithWorld (UWorld *InWorld, FRegisterComponentContext *Context=nullptr)
 
virtual bool IsReadyForOwnerToAutoDestroy () const
 
ENGINE_API bool IsOwnerSelected () const
 
bool IsRenderTransformDirty () const
 
bool IsRenderInstancesDirty () const
 
bool IsRenderStateDirty () const
 
void InvalidateLightingCache ()
 
virtual void InvalidateLightingCacheDetailed (bool bInvalidateBuildEnqueuedLighting, bool bTranslationOnly)
 
ENGINE_API void DoDeferredRenderUpdates_Concurrent ()
 
virtual void UpdateComponentToWorld (EUpdateTransformFlags UpdateTransformFlags=EUpdateTransformFlags::None, ETeleportType Teleport=ETeleportType::None)
 
ENGINE_API void MarkRenderStateDirty ()
 
ENGINE_API void MarkRenderDynamicDataDirty ()
 
ENGINE_API void MarkRenderTransformDirty ()
 
ENGINE_API void MarkRenderInstancesDirty ()
 
ENGINE_API void MarkForNeededEndOfFrameUpdate (bool bReadyForEarlyUpdate=false)
 
ENGINE_API void MarkForNeededEndOfFrameRecreate ()
 
bool IsReadyForEarlyEndOfFrameUpdate () const
 
void ClearNeedEndOfFrameUpdate ()
 
virtual ENGINE_API bool RequiresGameThreadEndOfFrameUpdates () const
 
virtual ENGINE_API bool RequiresGameThreadEndOfFrameRecreate () const
 
virtual ENGINE_API bool RequiresPreEndOfFrameSync () const
 
ENGINE_API void RecreateRenderState_Concurrent ()
 
ENGINE_API void RecreatePhysicsState ()
 
bool IsRenderStateCreated () const
 
bool IsRenderStateRecreating () const
 
bool IsPhysicsStateCreated () const
 
bool IsRenderStateUpdating () const
 
ENGINE_API class FSceneInterfaceGetScene () const
 
ENGINE_API ULevelGetComponentLevel () const
 
ENGINE_API bool ComponentIsInLevel (const class ULevel *TestLevel) const
 
ENGINE_API bool ComponentIsInPersistentLevel (bool bIncludeLevelStreamingPersistent) const
 
virtual void OnActorVisibilityChanged ()
 
virtual void OnActorEnableCollisionChanged ()
 
virtual ENGINE_API FString GetReadableName () const
 
virtual UObject const * AdditionalStatObject () const
 
virtual ENGINE_API TStructOnScope< FActorComponentInstanceDataGetComponentInstanceData () const
 
virtual ENGINE_API void PostApplyToComponent ()
 
virtual void GetComponentChildElements (TArray< FTypedElementHandle > &OutElementHandles, const bool bAllowCreate=true)
 
virtual ENGINE_API void BeginDestroy () override
 
virtual ENGINE_API bool NeedsLoadForClient () const override
 
virtual ENGINE_API bool NeedsLoadForServer () const override
 
virtual ENGINE_API bool NeedsLoadForEditorGame () const override
 
virtual ENGINE_API bool IsNameStableForNetworking () const override
 
virtual ENGINE_API bool IsSupportedForNetworking () const override
 
virtual ENGINE_API void GetLifetimeReplicatedProps (TArray< FLifetimeProperty > &OutLifetimeProps) const override
 
virtual ENGINE_API int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack) override
 
virtual ENGINE_API bool CallRemoteFunction (UFunction *Function, void *Parameters, FOutParmRec *OutParms, FFrame *Stack) override
 
virtual ENGINE_API void PostInitProperties () override
 
virtual ENGINE_API void PostLoad () override
 
virtual ENGINE_API bool Rename (const TCHAR *NewName=NULL, UObject *NewOuter=NULL, ERenameFlags Flags=REN_None) override
 
virtual ENGINE_API void PostRename (UObject *OldOuter, const FName OldName) override
 
virtual ENGINE_API void Serialize (FArchive &Ar) override
 
virtual ENGINE_API void AddAssetUserData (UAssetUserData *InUserData) override
 
virtual ENGINE_API void RemoveUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API UAssetUserDataGetAssetUserDataOfClass (TSubclassOf< UAssetUserData > InUserDataClass) override
 
virtual ENGINE_API const TArray< UAssetUserData * > * GetAssetUserDataArray () const override
 
ENGINE_API void OnCreatedFromReplication ()
 
ENGINE_API void OnDestroyedFromReplication ()
 
ENGINE_API bool IsOwnerRunningUserConstructionScript () const
 
bool IsPreRegistering () const
 
bool IsPreRegistered () const
 
bool IsPreUnregistering () const
 
bool IsPreUnregistered () const
 
bool IsRegistered () const
 
bool AllowReregistration () const
 
ENGINE_API void RegisterComponent ()
 
ENGINE_API void UnregisterComponent ()
 
virtual ENGINE_API void DestroyComponent (bool bPromoteChildren=false)
 
virtual ENGINE_API void OnComponentCreated ()
 
virtual ENGINE_API void OnComponentDestroyed (bool bDestroyingHierarchy)
 
ENGINE_API void K2_DestroyComponent (UObject *Object)
 
ENGINE_API void ReregisterComponent ()
 
ENGINE_API void SetTickGroup (ETickingGroup NewTickGroup)
 
virtual ENGINE_API void AddTickPrerequisiteActor (AActor *PrerequisiteActor)
 
virtual ENGINE_API void AddTickPrerequisiteComponent (UActorComponent *PrerequisiteComponent)
 
virtual ENGINE_API void RemoveTickPrerequisiteActor (AActor *PrerequisiteActor)
 
virtual ENGINE_API void RemoveTickPrerequisiteComponent (UActorComponent *PrerequisiteComponent)
 
ENGINE_API void ReceiveTick (float DeltaSeconds)
 
ENGINE_API void ReceiveAsyncPhysicsTick (float DeltaSeconds, float SimSeconds)
 
virtual void ApplyWorldOffset (const FVector &InOffset, bool bWorldShift)
 
bool CanEverAffectNavigation () const
 
ENGINE_API void SetCanEverAffectNavigation (bool bRelevant)
 
virtual bool IsNavigationRelevant () const
 
virtual bool IsHLODRelevant () const
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnMarkRenderStateDirty, UActorComponent &)
 
ENGINE_API void SetActiveFlag (const bool bNewIsActive)
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 
- Public Member Functions inherited from IAsyncPhysicsStateProcessor
virtual void CollectBodySetupsWithPhysicsMeshesToCreate (TSet< UBodySetup * > &OutBodySetups) const
 
virtual void OnAsyncCreatePhysicsStateBegin_GameThread ()
 
- Static Public Member Functions inherited from UActorComponent
static ENGINE_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 
- Protected Types inherited from UActorComponent
enum class  EComponentRegistrationState {
  None , PreRegistering , PreRegistered , PreUnregistering ,
  PreUnregistered
}
 

Member Function Documentation

◆ DebugReachTest()

void UPathFollowingComponent::DebugReachTest ( float CurrentDot,
float CurrentDistance,
float CurrentHeight,
uint8 bDotFailed,
uint8 bDistanceFailed,
uint8 bHeightFailed 
) const
protected

debug point reach test values

◆ DetermineCurrentTargetPathPoint()

int32 UPathFollowingComponent::DetermineCurrentTargetPathPoint ( int32  StartIndex)
protectedvirtual
Returns
index of path point, that should be target of current move segment

◆ DetermineStartingPathPoint()

int32 UPathFollowingComponent::DetermineStartingPathPoint ( const FNavigationPath ConsideredPath) const
protectedvirtual

Checks if this PathFollowingComponent is already on path, and if so determines index of next path point

Returns
what PathFollowingComponent thinks should be next path point. INDEX_NONE if given path is invalid
Note
this function does not set MoveSegmentEndIndex

Reimplemented in UCrowdFollowingComponent.

◆ ExtractNavigationFilter()

FSharedConstNavQueryFilter UPathFollowingComponent::ExtractNavigationFilter ( const FAIMoveRequest RequestData,
FNavPathSharedPtr  InPath 
) const
protected

extract the navigation filter that should be used based on the provided MoveRequest and NavPath

◆ FindPreciseAcceptanceRadiusTestsStartNodeIndex()

int32 UPathFollowingComponent::FindPreciseAcceptanceRadiusTestsStartNodeIndex ( const FNavigationPath PathInstance,
const FVector GoalLocation 
) const
protected

For given path finds a path node at which PathfollowingComponent should start doing precise is-goal-in-acceptance-radius tests

◆ FollowPathSegment()

void UPathFollowingComponent::FollowPathSegment ( float  DeltaTime)
protectedvirtual

follow current path segment

Reimplemented in UCrowdFollowingComponent.

◆ ForceBlockDetectionUpdate()

void UPathFollowingComponent::ForceBlockDetectionUpdate ( )
protected

force creating new location sample for block detection

◆ GetFinalAcceptanceRadius()

float UPathFollowingComponent::GetFinalAcceptanceRadius ( const FNavigationPath PathInstance,
const FVector  OriginalGoalLocation,
const FVector PathEndOverride = nullptr 
) const
protected

Based on Path's properties, original move goal location and requested AcceptanceRadius this function calculates actual acceptance radius to apply when testing if the agent has successfully reached requested goal's vicinity

◆ GetNextRequestId()

static uint32 UPathFollowingComponent::GetNextRequestId ( )
inlinestaticprotected

◆ HandlePathUpdateEvent()

bool UPathFollowingComponent::HandlePathUpdateEvent ( )
protectedvirtual

called after receiving update event from current path

Returns
false if path was not accepted and move request needs to be aborted

◆ HasReachedCurrentTarget()

bool UPathFollowingComponent::HasReachedCurrentTarget ( const FVector CurrentLocation) const
protectedvirtual

check if segment is completed

◆ HasReachedDestination()

bool UPathFollowingComponent::HasReachedDestination ( const FVector CurrentLocation) const
protectedvirtual

check if move is completed

◆ HasReachedInternal()

bool UPathFollowingComponent::HasReachedInternal ( const FVector GoalLocation,
float  GoalRadius,
float  GoalHalfHeight,
const FVector AgentLocation,
float  RadiusThreshold,
float  AgentRadiusMultiplier 
) const
protected

check if moving agent has reached goal defined by cylinder

◆ IsBlocked()

bool UPathFollowingComponent::IsBlocked ( ) const
protected

check if movement is blocked

◆ IsOnPath()

bool UPathFollowingComponent::IsOnPath ( ) const
protectedvirtual

check if agent is on path

Reimplemented in UCrowdFollowingComponent.

◆ OnNavDataRegistered()

void UPathFollowingComponent::OnNavDataRegistered ( ANavigationData NavData)
protected

called when NavigationSystem registers new navigation data type while this component instance has empty MyNavData. This is usually the case for AI agents hand-placed on levels.

◆ OnNavigationInitDone()

void UPathFollowingComponent::OnNavigationInitDone ( )
protectedvirtual

called when NavigationSystem finishes initial navigation data registration. This is usually required by AI agents hand-placed on levels to find MyNavData

◆ OnNewPawn()

void UPathFollowingComponent::OnNewPawn ( APawn *  NewPawn)
protectedvirtual

Called if owning Controller possesses new pawn or ends up pawn-less. Doesn't get called if owner is not an AContoller

◆ OnWaitingPathTimeout()

void UPathFollowingComponent::OnWaitingPathTimeout ( )
protectedvirtual

called from timer if component spends too much time in Waiting state

◆ Reset()

void UPathFollowingComponent::Reset ( )
protectedvirtual

reset path following data

Reimplemented in UCrowdFollowingComponent, and UGridPathFollowingComponent.

◆ ResetBlockDetectionData()

void UPathFollowingComponent::ResetBlockDetectionData ( )
protected

clears Block Detection stored data effectively resetting the mechanism

◆ ResetMoveSegmentCustomLinkCache()

void UPathFollowingComponent::ResetMoveSegmentCustomLinkCache ( )
protected

reset the cached information about CustomLinks on the next MoveSegment

◆ SetMoveSegment()

void UPathFollowingComponent::SetMoveSegment ( int32  SegmentStartIndex)
protectedvirtual

sets variables related to current move segment

Reimplemented in UCrowdFollowingComponent.

◆ SetNextMoveSegment()

void UPathFollowingComponent::SetNextMoveSegment ( )
inlineprotected

switch to next segment on path

◆ SetStatus()

void UPathFollowingComponent::SetStatus ( EPathFollowingStatus::Type  InStatus)
protected

Sets the current status and activates/deactivates the component if necessary

◆ ShouldCheckPathOnResume()

bool UPathFollowingComponent::ShouldCheckPathOnResume ( ) const
protectedvirtual

should verify if agent if still on path ater movement has been resumed?

Reimplemented in UCrowdFollowingComponent.

◆ ShouldStopMovementOnPathFinished()

bool UPathFollowingComponent::ShouldStopMovementOnPathFinished ( ) const
protectedvirtual

defines if the agent should reset his velocity when the path is finished

◆ StartUsingCustomLink()

void UPathFollowingComponent::StartUsingCustomLink ( INavLinkCustomInterface CustomNavLink,
const FVector DestPoint 
)
protectedvirtual

next path segment if custom nav link, try passing control to it

◆ StoreRequestId()

void UPathFollowingComponent::StoreRequestId ( )
inlineprotected

assign new request Id

◆ UpdateBlockDetection()

bool UPathFollowingComponent::UpdateBlockDetection ( )
protectedvirtual

update blocked movement detection,

Returns
true if new sample was added

◆ UpdateDecelerationData()

void UPathFollowingComponent::UpdateDecelerationData ( )
protectedvirtual

updates braking distance and deceleration segment

◆ UpdateMoveFocus()

void UPathFollowingComponent::UpdateMoveFocus ( )
protectedvirtual

set move focus in AI owner

◆ UpdateMovementComponent()

bool UPathFollowingComponent::UpdateMovementComponent ( bool  bForce = false)
protectedvirtual

check if movement component is valid or tries to grab one from owner

Parameters
bForceresults in looking for owner's movement component even if pointer to one is already cached

Reimplemented in UCrowdFollowingComponent.

◆ UpdatePathSegment()

void UPathFollowingComponent::UpdatePathSegment ( )
protectedvirtual

check state of path following, update move segment if needed

it's possible that finishing this move request will result in another request which won't be easily detectable from this function. This simple local variable gives us this knowledge.

Reimplemented in UCrowdFollowingComponent, and UGridPathFollowingComponent.

Member Data Documentation

◆ AcceptanceRadius

float UPathFollowingComponent::AcceptanceRadius
protected

min distance to destination to consider request successful. If following a partial path movement request will finish when the original goal gets within AcceptanceRadius or pathfollowing agent gets within MyDefaultAcceptanceRadius of the end of the path

◆ bCollidedWithGoal

uint8 UPathFollowingComponent::bCollidedWithGoal
protected

set when agent collides with goal actor

◆ bIsDecelerating

uint8 UPathFollowingComponent::bIsDecelerating
protected

True if pathfollowing is doing deceleration at the end of the path.

See also
FollowPathSegment().

◆ bIsUsingMetaPath

uint8 UPathFollowingComponent::bIsUsingMetaPath
protected

if set, path following is using FMetaNavMeshPath

◆ bLastMoveReachedGoal

uint8 UPathFollowingComponent::bLastMoveReachedGoal
protected

set when last move request was finished at goal

◆ BlockDetectionDistance

float UPathFollowingComponent::BlockDetectionDistance
protected

detect blocked movement when distance between center of location samples and furthest one (centroid radius) is below threshold

◆ BlockDetectionInterval

float UPathFollowingComponent::BlockDetectionInterval
protected

interval for collecting location samples

◆ BlockDetectionSampleCount

int32 UPathFollowingComponent::BlockDetectionSampleCount
protected

number of samples required for block detection

◆ bMoveSegmentIsUsingCustomLinkReachCondition

uint8 UPathFollowingComponent::bMoveSegmentIsUsingCustomLinkReachCondition
protected

True if the next segment is a custom link that has its own reach conditions.

◆ bMoveToGoalClampedToNavigation

uint8 UPathFollowingComponent::bMoveToGoalClampedToNavigation
protected

Whether to clamp the goal location to reachable navigation data when trying to track the goal actor (Only used when bMoveToGoalOnLastSegment is true) False: (default) while following the last segment, the path is allowed to adjust through obstacles and off navigation data without checks. True: the last segment's destination will be clamped at the furthest reachable location towards the goal actor.

◆ bMoveToGoalOnLastSegment

uint8 UPathFollowingComponent::bMoveToGoalOnLastSegment
protected

if set, target location will be constantly updated to match goal actor while following last segment of full path

◆ bReachTestIncludesAgentRadius

uint8 UPathFollowingComponent::bReachTestIncludesAgentRadius
protected

increase acceptance radius with agent's radius

◆ bReachTestIncludesGoalRadius

uint8 UPathFollowingComponent::bReachTestIncludesGoalRadius
protected

increase acceptance radius with goal's radius

◆ bStopMovementOnFinish

uint8 UPathFollowingComponent::bStopMovementOnFinish
protected

if set, movement will be stopped on finishing path

◆ bTickComponentOnlyWhenMoving

uint8 UPathFollowingComponent::bTickComponentOnlyWhenMoving
protected

Indicates if the component activation/ticking is controlled by setting the Status (Moving --> Activated, other --> Deactivated) Note that this optimization is not used for any derived classes since those might need to tick in other cases.

◆ bUseBlockDetection

uint8 UPathFollowingComponent::bUseBlockDetection
protected

if set, movement block detection will be used

◆ bWalkingNavLinkStart

uint8 UPathFollowingComponent::bWalkingNavLinkStart
protected

gets set when agent starts following a navigation link. Cleared after agent starts falling or changes segment to a non-link one

◆ CachedBrakingDistance

float UPathFollowingComponent::CachedBrakingDistance
protected

braking distance for acceleration driven path following

◆ CachedBrakingMaxSpeed

float UPathFollowingComponent::CachedBrakingMaxSpeed
protected

max speed used for CachedBrakingDistance

◆ CurrentAcceptanceRadius

float UPathFollowingComponent::CurrentAcceptanceRadius
protected

min distance to end of current path segment to consider segment finished

◆ CurrentCustomLinkOb

FWeakObjectPtr UPathFollowingComponent::CurrentCustomLinkOb
protected

currently traversed custom nav link

◆ CurrentDestination

FBasedPosition UPathFollowingComponent::CurrentDestination
protected

destination for current path segment

◆ CurrentMoveInput

FVector UPathFollowingComponent::CurrentMoveInput
protected

last MoveInput calculated and passed over to MovementComponent. Valid only if MovementComp->UseAccelerationForPathFollowing() == true

◆ DEBUG_bMovingDirectlyToGoal

uint8 UPathFollowingComponent::DEBUG_bMovingDirectlyToGoal

◆ DecelerationSegmentIndex

int32 UPathFollowingComponent::DecelerationSegmentIndex
protected

index of path point for starting deceleration

◆ DefaultAcceptanceRadius

const float UPathFollowingComponent::DefaultAcceptanceRadius = -1.f
static

special float constant to symbolize "use default value". This does not contain value to be used, it's used to detect the fact that it's requested, and appropriate value from querier/doer will be pulled

◆ DestinationActor

TWeakObjectPtr<AActor> UPathFollowingComponent::DestinationActor
protected

destination actor. Use SetDestinationActor to set this

◆ DestinationAgent

const INavAgentInterface* UPathFollowingComponent::DestinationAgent
protected

cached DestinationActor cast to INavAgentInterface. Use SetDestinationActor to set this

◆ GameData

FCustomMoveSharedPtr UPathFollowingComponent::GameData
protected

game specific data

◆ LastSampleTime

double UPathFollowingComponent::LastSampleTime
protected

timestamp of last location sample

◆ LocationSamples

TArray<FBasedPosition> UPathFollowingComponent::LocationSamples
protected

location samples for stuck detection

◆ LocationWhenPaused

FVector UPathFollowingComponent::LocationWhenPaused
protected

agent location when movement was paused

◆ MinAgentHalfHeightPct

float UPathFollowingComponent::MinAgentHalfHeightPct
protected

part of agent height used as min acceptable height difference

◆ MinAgentRadiusPct

float UPathFollowingComponent::MinAgentRadiusPct
protected

part of agent radius used as min acceptance radius

◆ MovementComp

TObjectPtr<UNavMovementComponent> UPathFollowingComponent::MovementComp
protected

deprecated associated movement component

◆ MoveOffset

FVector UPathFollowingComponent::MoveOffset
protected

relative offset from goal actor's location to end of path

◆ MoveSegmentCustomLinkOb

FWeakObjectPtr UPathFollowingComponent::MoveSegmentCustomLinkOb
protected

the custom link for the next segment if there is one

◆ MoveSegmentDirection

FVector UPathFollowingComponent::MoveSegmentDirection
protected

direction of current move segment

◆ MoveSegmentEndIndex

int32 UPathFollowingComponent::MoveSegmentEndIndex
protected

index of path point being current move target

◆ MoveSegmentEndRef

NavNodeRef UPathFollowingComponent::MoveSegmentEndRef
protected

reference of node at segment end

◆ MoveSegmentStartIndex

int32 UPathFollowingComponent::MoveSegmentStartIndex
protected

index of path point being current move beginning

◆ MoveSegmentStartRef

NavNodeRef UPathFollowingComponent::MoveSegmentStartRef
protected

reference of node at segment start

◆ MyDefaultAcceptanceRadius

float UPathFollowingComponent::MyDefaultAcceptanceRadius
protected

value based on navigation agent's properties that's used for AcceptanceRadius when DefaultAcceptanceRadius is requested

◆ MyNavData

TObjectPtr<ANavigationData> UPathFollowingComponent::MyNavData
protected

navigation data for agent described in movement component

◆ NavigationFilter

FSharedConstNavQueryFilter UPathFollowingComponent::NavigationFilter
protected

Navigation query filter of the current move request

◆ NavMovementInterface

TWeakInterfacePtr<INavMovementInterface> UPathFollowingComponent::NavMovementInterface
protected

associated movement interface

◆ NextSampleIdx

int32 UPathFollowingComponent::NextSampleIdx
protected

index of next location sample in array

◆ OriginalMoveRequestGoalLocation

FVector UPathFollowingComponent::OriginalMoveRequestGoalLocation
protected

This is needed for partial paths when trying to figure out if following a path should finish before reaching path end, due to reaching requested acceptance radius away from original move goal Is being set for non-partial paths as well

◆ Path

FNavPathSharedPtr UPathFollowingComponent::Path
protected

requested path

◆ PathTimeWhenPaused

double UPathFollowingComponent::PathTimeWhenPaused
protected

timestamp of path update when movement was paused

◆ PreciseAcceptanceRadiusCheckStartNodeIndex

int32 UPathFollowingComponent::PreciseAcceptanceRadiusCheckStartNodeIndex
protected

Indicates a path node index at which precise "is at goal" tests are going to be performed every frame, in regards to acceptance radius

◆ ResourceLock

FAIResourceLock UPathFollowingComponent::ResourceLock
protected

used to keep track of which subsystem requested this AI resource be locked

◆ Status

TEnumAsByte<EPathFollowingStatus::Type> UPathFollowingComponent::Status
protected

current status

◆ WaitingForPathTimer

FTimerHandle UPathFollowingComponent::WaitingForPathTimer
protected

timer handle for OnWaitingPathTimeout function

◆ WaitingTimeout

float UPathFollowingComponent::WaitingTimeout
protected

timeout for Waiting state, negative value = infinite


The documentation for this class was generated from the following files: