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

Light Theme

Dark Theme

TPersistentObjectPtr

[TPersistentObjectPtr](API\Runtime\CoreUObject\UObject\TPersistentObjectPtr) is a template base class for [FLazyObjectPtr](API\Runtime\CoreUObject\UObject\FLazyObjectPtr) and [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr)

Windows

MacOS

Linux

Inheritance Hierarchy

TPersistentObjectPtr

FLazyObjectPtr

TLazyObjectPtr

FSoftObjectPtr

References

Module	CoreUObject
Header	/Engine/Source/Runtime/CoreUObject/Public/UObject/PersistentObjectPtr.h
Include	#include "UObject/PersistentObjectPtr.h"

Syntax

template<class TObjectID>
struct TPersistentObjectPtr

Remarks

Constructors

	Name	Description
	TPersistentObjectPtr()	Default constructor, will be null
	TPersistentObjectPtr ( const TObjectID& InObjectID )	Construct from a unique object identifier

Functions

	Name	Description
UObject *...	Get()	Dereference the pointer, which may cause it to become valid again.
UObject *...	Get ( bool bEvenIfPendingKill )	Dereference the lazy pointer, which may cause it to become valid again.
TObjectID &	GetUniqueID()	Non-const version of the above
const TObjec...	GetUniqueID()	Gets the unique object identifier associated with this lazy pointer.
bool	IsNull()	Test if this can never point to a live UObject
bool	IsPending()	Test if this does not point to a live UObject, but may in the future
bool	IsStale()	Slightly different than !IsValid(), returns true if this used to point to a UObject, but doesn't any more and has not been assigned or reset in the mean time.
bool	IsValid()	Test if this points to a live UObject
void	Reset()	Reset the lazy pointer back to the null state
void	ResetWeakPtr()	Resets the weak ptr only, call this when ObjectId may change

Operators

	Name	Description
UObject &	operator*()	Dereference the pointer
void	operator= ( const TObjectID& InObjectID )	Copy from a unique object identifier
void	operator= ( const UObject* Object )	Copy from an object pointer
void	operator= ( const FWeakObjectPtr& Other )	Copy from an existing weak pointer, reserve IDs if required
UObject *...	operator->()	Dereference the pointer

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

Take our survey

Dismiss