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

> Unreal Engine API Reference > Runtime > Core > Templates > TWeakPtr

Light Theme

Dark Theme

TWeakPtr

[TWeakPtr](API\Runtime\Core\Templates\TWeakPtr) is a non-intrusive reference-counted weak object pointer.

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Templates/SharedPointer.h
Include	#include "Templates/SharedPointer.h"

Syntax

template<class ObjectType, ESPMode InMode>
class TWeakPtr

Remarks

TWeakPtr is a non-intrusive reference-counted weak object pointer. This weak pointer will be conditionally thread-safe when the optional Mode template argument is set to ThreadSafe.

Constructors

	Name	Description
	TWeakPtr ( SharedPointerInternals::FNullTag&#... )	NOTE: FNullTag parameter is an Unreal extension to standard shared_ptr behavior.
	TWeakPtr ( TSharedRef< OtherType, Mode > const... )	NOTE: The following is an Unreal extension to standard shared_ptr behavior.
	TWeakPtr ( TSharedPtr< OtherType, Mode > const... )	Constructs a weak pointer from a shared pointer
	TWeakPtr ( TWeakPtr< OtherType, Mode > const&... )	Constructs a weak pointer from a weak pointer of another type.
	TWeakPtr ( TWeakPtr< OtherType, Mode >&& InWe... )
	TWeakPtr ( TWeakPtr const& InWeakPtr )
	TWeakPtr ( TWeakPtr&& InWeakPtr )
	TWeakPtr ( TWeakPtr< OtherType, Mode > const&..., SharedPointerInternals::FStaticCast... )	Special constructor used internally to statically cast one weak pointer type to another.
	TWeakPtr ( TWeakPtr< OtherType, Mode > const&..., SharedPointerInternals::FConstCastT... )	Special constructor used internally to cast a 'const' weak pointer a 'mutable' pointer.

Functions

	Name	Description
uint32	GetWeakPtrTypeHash()
bool	HasSameObject ( const void* InOtherPtr )	Returns true if the object this weak pointer points to is the same as the specified object pointer.
bool	IsValid()	Checks to see if this weak pointer actually has a valid reference to an object
TSharedPtr< ...	Pin()	Converts this weak pointer to a shared pointer that you can use to access the object (if it hasn't expired yet.) Remember, if there are no more shared references to the object, the returned shared pointer will not be valid.
TSharedPtr< ...	Pin()	Converts this weak pointer to a shared pointer that you can use to access the object (if it hasn't expired yet.) Remember, if there are no more shared references to the object, the returned shared pointer will not be valid.
void	Reset()	Resets this weak pointer, removing a weak reference to the object.

Operators

	Name	Description
TWeakPtr &	operator= ( TSharedRef< OtherType, Mode > const... )	NOTE: The following is an Unreal extension to standard shared_ptr behavior.
TWeakPtr &	operator= ( TWeakPtr< OtherType, Mode >&& InWe... )
TWeakPtr &	operator= ( TWeakPtr< OtherType, Mode > const&... )	Assignment operator adds a weak reference to the object referenced by the specified weak pointer.
TWeakPtr &	operator= ( TSharedPtr< OtherType, Mode > const... )	Assignment operator sets this weak pointer from a shared pointer
TWeakPtr &	operator= ( TWeakPtr const& InWeakPtr )	Assignment operator adds a weak reference to the object referenced by the specified weak pointer
TWeakPtr &	operator= ( SharedPointerInternals::FNullTag&#... )	NOTE: The following is an Unreal extension to standard shared_ptr behavior.
TWeakPtr &	operator= ( TWeakPtr&& InWeakPtr )

Typedefs

Name	Description
ElementType

Constants

Name	Description
Mode

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

Take our survey

Cancel