1. Epic GamesDeveloper
  3. TWeakObjectPtr

TWeakObjectPtr

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

Unreal Engine C++ API Reference > Runtime > Core > UObject

Inheritance Hierarchy

  • TWeakObjectPtrBase
  • TWeakObjectPtr

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

  Type Name Description
Public function    
Public function    
Public function   Construct from a null pointer
Public function  

TWeakObjectPtr ( U Object
)

 Construct from an object pointer
Public function  

TWeakObjectPtr ( const TWeakObjectPtr< OtherT, TWeakObjectPtrBase >& Other
)

 Construct from another weak pointer of another type, intended for derived-to-base conversions

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const T *

Get ( bool bEvenIfPendingKill
)

 Dereference the weak pointer
Public function Const T *

Get ()

 Dereference the weak pointer. This is an optimized version implying bEvenIfPendingKill=false.
Public function Const T * Deferences the weak pointer even if its marked RF_Unreachable.
Public function Const uint32 Hash function.
Public function Const bool

HasSameIndexAndSerialNumber ( const TWeakObjectPtr< OtherT, TWeakObjectPtrBase >& Other
)

 Returns true if two weak pointers were originally set to the same object, even if they are now stale
Public function Const bool Returns true if two weak pointers were originally set to the same object, even if they are now stale
Public function Const bool Returns true if this pointer was explicitly assigned to null, was reset, or was never initialized.
Public function Const 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.
Public function Const bool

IsValid ()

 Test if this points to a live UObject.
Public function Const bool

IsValid ( bool bEvenIfPendingKill,
bool bThreadsafeTest
)

 Test if this points to a live UObject.
Public function Const TStrongObjectPtr< T >

Pin ( bool bEvenIfPendingKill
)

 Pin the weak pointer and get a strongptr.
Public function Const TStrongObjectPtr< T >

Pin ()

 Pin the weak pointer as a strong ptr.
Public function void

Reset ()

 Reset the weak pointer back to the null state
Public function void Weak object pointer serialization, this forwards to FArchive::operator<<(struct FWeakObjectPtr&) or an override

Operators

  Type Name Description
Public function Const   This is explicitly not added to avoid resolving weak pointers too often - use Get() once in a function.
Public function Const bool

operator!= ( const TWeakObjectPtr< RhsT, TWeakObjectPtrBase >& Rhs
)

 Compare weak pointers for inequality
Public function Const bool

operator!= ( const RhsT* Rhs
)

  
Public function Const bool  
Public function Const T & Dereference the weak pointer
Public function TWeakObjectPtr &

operator= ( const TWeakObjectPtr< OtherT, TWeakObjectPtrBase >& Other
)

 Assign from another weak pointer, intended for derived-to-base conversions
Public function TWeakObjectPtr &  
Public function TWeakObjectPtr &

operator= ( U* Object
)

 Copy from an object pointer
Public function Const bool

operator== ( const TWeakObjectPtr< RhsT, TWeakObjectPtrBase >& Rhs
)

 Compare weak pointers for equality.
Public function Const bool

operator== ( const RhsT* Rhs
)

  
Public function Const bool  
Public function Const T * Dereference the weak pointer

Typedefs

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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page