UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FObjectPtr Struct Reference

#include <ObjectPtr.h>

Public Member Functions

constexpr FObjectPtr ()
 
constexpr FObjectPtr (ENoInit)
 
FORCEINLINE constexpr FObjectPtr (TYPE_OF_NULLPTR)
 
FORCEINLINE constexpr FObjectPtr (UObject *Object)
 
FORCEINLINE FObjectPtr (void *IncompleteObject)
 
FORCEINLINE FObjectPtr (FRemoteObjectId ObjectId)
 
FORCEINLINE UObjectGet () const
 
FORCEINLINE UClassGetClass () const
 
constexpr FObjectPtr (FObjectPtr &&InOther)
 
constexpr FObjectPtr (const FObjectPtr &InOther)
 
FObjectPtroperator= (FObjectPtr &&InOther)
 
FObjectPtroperator= (const FObjectPtr &InOther)
 
FObjectPtroperator= (UObject *Other)
 
FObjectPtroperator= (void *IncompleteOther)
 
FObjectPtroperator= (TYPE_OF_NULLPTR)
 
FORCEINLINE bool UEOpEquals (const FObjectPtr &Other) const
 
FORCEINLINE TObjectPtr< UObject > & ToTObjectPtr ()
 
FORCEINLINE const TObjectPtr< UObject > & ToTObjectPtr () const
 
FORCEINLINE UObjectoperator-> () const
 
FORCEINLINE UObjectoperator* () const
 
FORCEINLINE bool operator! () const
 
FORCEINLINE operator bool () const
 
FORCEINLINE bool IsResolved () const
 
FORCEINLINE bool IsRemote () const
 
FString GetPath () const
 
FString GetPathName () const
 
FName GetFName () const
 
FString GetName () const
 
FObjectPtr GetOuter () const
 
FObjectPtr GetPackage () const
 
bool IsIn (FObjectPtr SomeOuter) const
 
FString GetFullName (EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
FORCEINLINE FObjectHandle GetHandle () const
 
FORCEINLINE FObjectHandleGetHandleRef () const
 
COREUOBJECT_API bool IsA (const UClass *SomeBase) const
 
template<typename T >
FORCEINLINE bool IsA () const
 
FORCEINLINE FRemoteObjectId GetRemoteId () const
 

Friends

FORCEINLINE uint32 GetTypeHash (const FObjectPtr &Object)
 

Detailed Description

FObjectPtr is the basic, minimally typed version of TObjectPtr

Constructor & Destructor Documentation

◆ FObjectPtr() [1/8]

constexpr FObjectPtr::FObjectPtr ( )
inlineconstexpr

◆ FObjectPtr() [2/8]

constexpr FObjectPtr::FObjectPtr ( ENoInit  )
inlineexplicitconstexpr

◆ FObjectPtr() [3/8]

FORCEINLINE constexpr FObjectPtr::FObjectPtr ( TYPE_OF_NULLPTR  )
inlineconstexpr

◆ FObjectPtr() [4/8]

FORCEINLINE constexpr FObjectPtr::FObjectPtr ( UObject Object)
inlineexplicitconstexpr

◆ FObjectPtr() [5/8]

FORCEINLINE FObjectPtr::FObjectPtr ( void IncompleteObject)
inlineexplicit

◆ FObjectPtr() [6/8]

FORCEINLINE FObjectPtr::FObjectPtr ( FRemoteObjectId  ObjectId)
inlineexplicit

◆ FObjectPtr() [7/8]

constexpr FObjectPtr::FObjectPtr ( FObjectPtr &&  InOther)
inlineconstexpr

◆ FObjectPtr() [8/8]

constexpr FObjectPtr::FObjectPtr ( const FObjectPtr InOther)
inlineconstexpr

Member Function Documentation

◆ Get()

FORCEINLINE UObject * FObjectPtr::Get ( ) const
inline

◆ GetClass()

FORCEINLINE UClass * FObjectPtr::GetClass ( ) const
inline

◆ GetFName()

FName FObjectPtr::GetFName ( ) const
inline

◆ GetFullName()

FString FObjectPtr::GetFullName ( EObjectFullNameFlags  Flags = EObjectFullNameFlags::None) const
inline

Returns the fully qualified pathname for this object as well as the name of the class, in the format: 'ClassName Outermost.[Outer:]Name'.

◆ GetHandle()

FORCEINLINE FObjectHandle FObjectPtr::GetHandle ( ) const
inline

◆ GetHandleRef()

FORCEINLINE FObjectHandle & FObjectPtr::GetHandleRef ( ) const
inline

◆ GetName()

FString FObjectPtr::GetName ( ) const
inline

◆ GetOuter()

FObjectPtr FObjectPtr::GetOuter ( ) const
inline

◆ GetPackage()

FObjectPtr FObjectPtr::GetPackage ( ) const
inline

◆ GetPath()

FString FObjectPtr::GetPath ( ) const
inline

◆ GetPathName()

FString FObjectPtr::GetPathName ( ) const
inline

◆ GetRemoteId()

FORCEINLINE FRemoteObjectId FObjectPtr::GetRemoteId ( ) const
inline

◆ IsA() [1/2]

template<typename T >
FORCEINLINE bool FObjectPtr::IsA ( ) const
inline

◆ IsA() [2/2]

bool FObjectPtr::IsA ( const UClass SomeBase) const

◆ IsIn()

bool FObjectPtr::IsIn ( FObjectPtr  SomeOuter) const
inline

◆ IsRemote()

FORCEINLINE bool FObjectPtr::IsRemote ( ) const
inline

FObjectPtr::IsRemote is only used when UE_WITH_REMOTE_OBJECT_HANDLE is true, and is mutually exclusive with other uses of unresolved FObjectPtr. When using UE_WITH_REMOTE_OBJECT_HANDLE, unresolved FObjectPtrs mean the object is not locally available and is present on another server, see @RemoteObject.h

◆ IsResolved()

FORCEINLINE bool FObjectPtr::IsResolved ( ) const
inline

◆ operator bool()

FORCEINLINE FObjectPtr::operator bool ( ) const
inlineexplicit

◆ operator!()

FORCEINLINE bool FObjectPtr::operator! ( ) const
inline

◆ operator*()

FORCEINLINE UObject & FObjectPtr::operator* ( ) const
inline

◆ operator->()

FORCEINLINE UObject * FObjectPtr::operator-> ( ) const
inline

◆ operator=() [1/5]

FObjectPtr & FObjectPtr::operator= ( const FObjectPtr InOther)
inline

◆ operator=() [2/5]

FObjectPtr & FObjectPtr::operator= ( FObjectPtr &&  InOther)
inline

◆ operator=() [3/5]

FObjectPtr & FObjectPtr::operator= ( TYPE_OF_NULLPTR  )
inline

◆ operator=() [4/5]

FObjectPtr & FObjectPtr::operator= ( UObject Other)
inline

◆ operator=() [5/5]

FObjectPtr & FObjectPtr::operator= ( void IncompleteOther)
inline

◆ ToTObjectPtr() [1/2]

FORCEINLINE TObjectPtr< UObject > & FObjectPtr::ToTObjectPtr ( )

◆ ToTObjectPtr() [2/2]

FORCEINLINE const TObjectPtr< UObject > & FObjectPtr::ToTObjectPtr ( ) const

◆ UEOpEquals()

FORCEINLINE bool FObjectPtr::UEOpEquals ( const FObjectPtr Other) const
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

FORCEINLINE uint32 GetTypeHash ( const FObjectPtr Object)
friend

Member Data Documentation

◆ DebugPtr

UObject* FObjectPtr::DebugPtr

◆ Handle

FObjectHandle FObjectPtr::Handle
mutable

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