1. Epic GamesDeveloper
  3. FWeakObjectPtr

FWeakObjectPtr

[FWeakObjectPtr](API\Runtime\CoreUObject\UObject\FWeakObjectPtr) is a weak pointer to a [UObject](API\Runtime\CoreUObject\UObject\UObject).

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

References

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

Syntax

struct FWeakObjectPtr

Remarks

FWeakObjectPtr is a weak pointer to a UObject. It can return nullptr later if the object is garbage collected. It has no impact on if the object is garbage collected or not. It can't be directly used across a network.

Most often it is used when you explicitly do NOT want to prevent something from being garbage collected.

Constructors

  Type Name Description
Public function   Null constructor
Public function   Construct from nullptr or something that can be implicitly converted to nullptr (eg: NULL)
Public function  

FWeakObjectPtr ( U&& Object
)

 Construct from an object pointer or something that can be implicitly converted to an object pointer
Public function  

FWeakObjectPtr ( const FWeakObjectPtr& Other
)

 Construct from another weak pointer

Functions

  Type Name Description
Public function Const UObject *

Get ( bool bEvenIfGarbage
)

 Dereference the weak pointer.
Public function Const UObject *

Get ()

 Dereference the weak pointer. This is an optimized version implying bEvenIfGarbage=false.
Public function Const UObject * Dereference the weak pointer even if it is marked as Garbage or Unreachable
Protected function Const int32  
Public function Const uint32 Hash function.
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 bIncludingGarbage,
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 ( bool bEvenIfGarbage,
bool bThreadsafeTest
)

 Test if this points to a live UObject This should be done only when needed as excess resolution of the underlying pointer can cause performance issues.
Public function Const bool

IsValid ()

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

Pin ()

 Get a strong object ptr to the weak pointer.
Public function Const TStrongObjectPtr< UObject >

Pin ( bool bEvenIfGarbage
)

 Get a strong object ptr to the weak pointer.
Public function Const TStrongObjectPtr< UObject > Get a strong object ptr even if it is marked as Garbage or Unreachable
Public function void

Reset ()

 Reset the weak pointer back to the null state
Public function void Weak object pointer serialization.

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 FWeakObjectPtr& Other
)

 Compare weak pointers for inequality
Public function void

operator= ( const UObject* Object
)

 Copy from an object pointer
Public function void

operator= ( TObjectPtr< UObject > Object
)

  
Public function FWeakObjectPtr &

operator= ( const FWeakObjectPtr& Other
)

 Construct from another weak pointer
Public function Const bool

operator== ( const FWeakObjectPtr& Other
)

 Compare weak pointers for equality.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page