1. Epic GamesDeveloper
  3. FActorInstanceHandle

FActorInstanceHandle

Handle to a unique object.

Unreal Engine C++ API Reference > Runtime > Engine > Engine

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/ActorInstanceHandle.h
Include #include "Engine/ActorInstanceHandle.h"

Syntax

USTRUCT (BlueprintType )  
struct FActorInstanceHandle

Remarks

Handle to a unique object. This may specify a full weigh actor or it may only specify the actor instance that represents the same object.

The handle has game thread constraints related to UObjects and should be used carefully from other threads. Can only be used on the game thread

  • all constructors
  • all getters (GetXYZ, FetchActor, IsActorValid, DoesRepresent) *
  • comparison operators against live AActor pointer

Can be used on any thread

  • MakeActorHandleToResolve to create a handle that will be lazily resolved on the game thread since it only stores a weak object ptr without any access to the live object
  • handle validity and comparison operators against another handle (i.e. IsValid(), operator==|!=(const FActorInstanceHandle& Other))

Constructors

  Type Name Description
Public function    
Public function    
Public function    
Public function  

FActorInstanceHandle ( const UPrimitiveComponent* RelevantComponent,
int32 CollisionInstanceIndex
)

  
Public function  

FActorInstanceHandle ( FActorInstanceManagerInterface InManagerInterface,
int32 InstanceIndex
)

  
Public function  

FActorInstanceHandle ( AActor* InActor,
const UPrimitiveComponent* RelevantComponent,
int32 CollisionInstanceIndex
)

  

Functions

  Type Name Description
Public function Const bool  
Public function Const bool

DoesRepresentClass ( const UClass* OtherClass
)

  
Public function Const T *  
Public function Const AActor * Returns the actor specified by this handle. This may require loading and creating the actor object.
Public function Const AActor *  
Public function Const FName  
Public function Const int32 Returns the index used internally by the manager
Public function Const ULevel *  
Public function Const FVector  
Public function Const T *  
Public function Const FActorInstanceManagerInterface  
Public function Const AActor * If this handle has a valid actor, return it; otherwise return the actor responsible for managing the instances.
Public function Const FString

GetName ()

  
Public function Const UClass *  
Public function Const USceneComponent * Returns either the actor's root component or the root component for the manager associated with the handle
Public function Const FRotator  
Public function Const FTransform  
Public function Const bool

IsValid ()

  
Public function Static FActorInstanceHandle

MakeActorHandleToResolve ( const TWeakObjectPtr< UPrimitiveComponent >& WeakComponent,
int32 CollisionInstanceIndex
)

 A path dedicated to creation of handles from any threads.
Public function Static FActorInstanceHandle

MakeDehydratedActorHandle ( UObject& Manager,
int32 InInstanceIndex
)

 A path dedicated to creation of handles while converting actor to a dehydrated representation.
Public function Const void

SetCachedActor ( AActor* InActor
)

  

Operators

  Type Name Description
Public function Const    
Public function Const bool

operator!= ( const FActorInstanceHandle& Other
)

  
Public function Const bool

operator!= ( const AActor* OtherActor
)

  
Public function FActorInstanceHandle &

operator= ( const FActorInstanceHandle& Other
)

  
Public function FActorInstanceHandle &  
Public function FActorInstanceHandle &

operator= ( AActor* OtherActor
)

  
Public function Const bool

operator== ( const FActorInstanceHandle& Other
)

  
Public function Const bool

operator== ( const AActor* OtherActor
)

  

Enums

  Type Name Description
Private enum EResolutionStatus Enum to keep track of the resolution status of the handle.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page