TWeakObjectPtr | Unreal Engine 4.27 Documentation

Inheritance Hierarchy


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

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

TWeakObjectPtr is the templated version of the generic FWeakObjectPtr

	Type	Name	Description
		TWeakObjectPtr ()
		TWeakObjectPtr ( const TWeakObjectPtr& )
		TWeakObjectPtr ( TYPE_OF_NULLPTR )	Construct from a null pointer
		TWeakObjectPtr ( U Object )	Construct from an object pointer
		TWeakObjectPtr ( const TWeakObjectPtr< OtherT, TWeakObjectPtrBase >& Other )	Construct from another weak pointer of another type, intended for derived-to-base conversions

	Type	Name	Description
		~TWeakObjectPtr ()

Type	Name	Description
T *	Get ( bool bEvenIfPendingKill )	Dereference the weak pointer
T *	Get ()	Dereference the weak pointer. This is an optimized version implying bEvenIfPendingKill=false.
T *	GetEvenIfUnreachable ()	Deferences the weak pointer even if its marked RF_Unreachable.
uint32	GetWeakPtrTypeHash ()	Hash function.
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
void	Serialize ( FArchive& Ar )	Weak object pointer serialization, this forwards to FArchive::operator<<(struct FWeakObjectPtr&) or an override

Type	Name	Description
	operator bool ()	This is explicitly not added to avoid resolving weak pointers too often - use Get() once in a function.
bool	operator!= ( const TWeakObjectPtr< RhsT, TWeakObjectPtrBase >& Rhs )	Compare weak pointers for inequality
bool	operator!= ( const RhsT* Rhs )
bool	operator!= ( TYPE_OF_NULLPTR )
T &	operator* ()	Dereference the weak pointer
TEnableIfTLosesQualifiersFromTo< U, T >::Value, TWeakObjectPtr & >::Type	operator= ( U* Object )	Copy from an object pointer
TWeakObjectPtr &	operator= ( const TWeakObjectPtr& )
TWeakObjectPtr &	operator= ( const TWeakObjectPtr< OtherT, TWeakObjectPtrBase >& Other )	Assign from another weak pointer, intended for derived-to-base conversions
bool	operator== ( TYPE_OF_NULLPTR )
bool	operator== ( const TWeakObjectPtr< RhsT, TWeakObjectPtrBase >& Rhs )	Compare weak pointers for equality.
bool	operator== ( const RhsT* Rhs )
T *	operator-> ()	Dereference the weak pointer

Name	Description
ElementType	Although templated, these parameters are not intended to be anything other than the default, and are only templates for module organization reasons.