Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Delegates > TObjectPtr

Light Theme

Dark Theme

TObjectPtr

[TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr) is a type of pointer to a [UObject](API\Runtime\CoreUObject\UObject\UObject) that is meant to function as a drop-in replacement for raw pointer member properties.

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Delegates/DelegateSignatureImpl.inl
Include	#include "Delegates/DelegateSignatureImpl.inl"

Syntax

template<typename T>
struct TObjectPtr

Remarks

TObjectPtr is a type of pointer to a UObject that is meant to function as a drop-in replacement for raw pointer member properties. It is size equivalent to a 64-bit pointer and supports access tracking and optional lazy load behavior in editor builds. It stores either the address to the referenced object or (in editor builds) an index in the object handle table that describes a referenced object that hasn't been loaded yet. It is serialized identically to a raw pointer to a UObject. When resolved, its participation in garbage collection is identical to a raw pointer to a UObject.

This is useful for automatic replacement of raw pointers to support advanced cook-time dependency tracking and editor-time lazy load use cases. See UnrealObjectPtrTool for tooling to automatically replace raw pointer members with FObjectPtr/TObjectPtr members instead.

Variables

		Name	Description
	T *	DebugPtr	DebugPtr allows for easier dereferencing of a resolved TObjectPtr in watch windows of debuggers.
	FObjectPtr	ObjectPtr

Constructors

	Name	Description
	TObjectPtr()
	TObjectPtr ( TPrivateObjectPtr< T >&& PrivatePt... )
	TObjectPtr ( TObjectPtr< T >&& Other )
	TObjectPtr ( const TObjectPtr< T >& Other )
	TObjectPtr ( ENoInit )
	TObjectPtr ( TYPE_OF_NULLPTR )
	TObjectPtr ( FObjectPtr ObjPtr )
	TObjectPtr ( const TObjectPtr< U >& Other )
	TObjectPtr ( U&& Object )
	TObjectPtr ( T& Object )

Functions

	Name	Description
T *	Get()	: OBJPTR: There is a risk that the FObjectPtr is storing a reference to the wrong type.
UClass *	GetClass()
FName	GetFName()
FString	GetFullName ( EObjectFullNameFlags Flags )
FObjectHandl...	GetHandle()
FString	GetName()
TObjectPtr< ...	GetOuter()
TObjectPtr< ...	GetPackage()
FString	GetPath()
FString	GetPathName()
uint32	GetPtrTypeHash()
bool	IsA ( const UClass* SomeBase )
bool	IsA()
bool	IsResolved()
void	SerializePtrStructured ( FStructuredArchiveSlot Slot )

Operators

	Name	Description
	operator bool()
	operator T *()
	operator T *&()
	operator U *()
	operator UPTRINT()
bool	operator!()
bool	operator!= ( const TObjectPtr< U >& Other )
bool	operator!= ( TYPE_OF_NULLPTR )
bool	operator!= ( U&& Other )
T &	operator*()
TObjectPtr< ...	operator= ( TYPE_OF_NULLPTR )
TObjectPtr< ...	operator= ( U&& Object )
TObjectPtr< ...	operator= ( const TObjectPtr< U >& Other )
TObjectPtr< ...	operator= ( TPrivateObjectPtr< T >&& PrivatePt... )
TObjectPtr< ...	operator= ( const TObjectPtr< T >& )
TObjectPtr< ...	operator= ( TObjectPtr< T >&& )
bool	operator== ( const TObjectPtr< U >& Other )	Equality/Inequality comparisons against other TObjectPtr.
bool	operator== ( TYPE_OF_NULLPTR )	Equality/Inequality comparisons against nullptr.
bool	operator== ( U&& Other )	Equality/Inequality comparisons against another type that can be implicitly converted to the pointer type kept in a TObjectPtr.
T *	operator->()

Typedefs

Name	Description
ElementType	TObjectPtr should only be used on types T that are EITHER:

Deprecated Functions

		Name	Description
	bool	IsNull()	IsNull is deprecated, please use operator bool instead. if (!MyObjectPtr) { ... }
	bool	IsNullNoResolve()	IsNullNoResolve is deprecated, please use operator bool instead. if (!MyObjectPtr) { ... }

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel