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

TWeakObjectPtr

[TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr) is the templated version of the generic [FWeakObjectPtr](API\Runtime\CoreUObject\UObject\FWeakObjectPtr)

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

TWeakObjectPtrBase

TWeakObjectPtr

TAutoWeakObjectPtr

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/UObject/WeakObjectPtrTemplates.h
Include	#include "UObject/WeakObjectPtrTemplates.h"

Syntax

template<class T, class TWeakObjectPtrBase>
struct TWeakObjectPtr : private TWeakObjectPtrBase

Remarks

TWeakObjectPtr is the templated version of the generic FWeakObjectPtr

Constructors

	Name	Description
	TWeakObjectPtr()	Although templated, these parameters are not intended to be anything other than the default, and are only templates for module organization reasons.
	TWeakObjectPtr ( const TWeakObjectPtr& )
	TWeakObjectPtr ( TYPE_OF_NULLPTR )	Construct from a null pointer
	TWeakObjectPtr ( U Object )	Construct from an object pointer
	TWeakObjectPtr ( const TWeakObjectPtr< OtherT, TWeak... )	Construct from another weak pointer of another type, intended for derived-to-base conversions

Destructors

	Name	Description
	~TWeakObjectPtr()

Functions

	Name	Description
T *	Get()	Dereference the weak pointer. This is an optimized version implying bEvenIfPendingKill=false.
T *	Get ( bool bEvenIfPendingKill )	Dereference the weak pointer
T *	GetEvenIfUnreachable()	Deferences the weak pointer even if its marked RF_Unreachable.
bool	HasSameIndexAndSerialNumber ( const TWeakObjectPtr& Other )	Returns true if two weak pointers were originally set to the same object, even if they are now stale
bool	IsExplicitlyNull()	Returns true if this pointer was explicitly assigned to null, was reset, or was never initialized.
bool	IsStale ( bool bIncludingIfPendingKill, bool bThreadsafeTest )	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.
bool	IsValid ( bool bEvenIfPendingKill, bool bThreadsafeTest )	Test if this points to a live UObject
void	Reset()	Reset the weak pointer back to the null state

Operators

	Name	Description
T &	operator*()	Dereference the weak pointer
TWeakObjectP...	operator= ( const TWeakObjectPtr& )
TEnableIf<&#...	operator= ( U* Object )	Copy from an object pointer
TWeakObjectP...	operator= ( const TWeakObjectPtr< OtherT, TWeak... )	Assign from another weak pointer, intended for derived-to-base conversions
T *	operator->()	Dereference the weak pointer