TSoftObjectPtr | Unreal Engine 5.1 Documentation

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

References


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

Syntax

template<class T>  
struct TSoftObjectPtr

Remarks

TSoftObjectPtr is templatized wrapper of the generic FSoftObjectPtr, it can be used in UProperties

Constructors

	Type	Name	Description
		TSoftObjectPtr ()
		TSoftObjectPtr ( const TSoftObjectPtr& Other )
		TSoftObjectPtr ( TSoftObjectPtr&& Other )
		TSoftObjectPtr ( const TSoftObjectPtr< U >& Other )	Construct from another soft pointer
		TSoftObjectPtr ( TSoftObjectPtr< U >&& Other )	Construct from a moveable soft pointer
		TSoftObjectPtr ( const U* Object )	Construct from an object already in memory
		TSoftObjectPtr ( const TObjectPtr< U > Object )	Construct from a TObjectPtr which may or may not be in memory.
		TSoftObjectPtr ( TYPE_OF_NULLPTR )	Construct from a nullptr
		TSoftObjectPtr ( FSoftObjectPath ObjectPath )	Construct from a soft object path

Destructors

	Type	Name	Description
		~TSoftObjectPtr ()

Functions

Type	Name	Description
FString	GetAssetName ()	Returns assetname string, leaving off the /package/path part
FString	GetLongPackageName ()	Returns /package/path string, leaving off the asset name
uint32	GetPtrTypeHash ()	Hash function
const FSoftObjectPath &	GetUniqueID ()	Returns the StringObjectPath that is wrapped by this SoftObjectPtr
bool	IsNull ()	Test if this can never point to a live UObject
bool	IsPending ()	Test if this does not point to a live UObject, but may in the future
bool	IsValid ()	Test if this points to a live UObject
T *	LoadSynchronous ()	Synchronously load (if necessary) and return the asset object represented by this asset ptr
void	Reset ()	Reset the soft pointer back to the null state
void	ResetWeakPtr ()	Resets the weak ptr only, call this when ObjectId may change
void	Serialize ( FArchive& Ar )
const FSoftObjectPath &	ToSoftObjectPath ()	Returns the StringObjectPath that is wrapped by this SoftObjectPtr
FString	ToString ()	Returns string representation of reference, in form /package/path.assetname

Operators

Type	Name	Description
	operator bool ()	Dereference soft pointer to see if it points somewhere valid
bool	operator!= ( const TSoftObjectPtr& Rhs )	Compare soft pointers for inequality Caution: Two soft pointers might not be equal to each other, but they both might return nullptr
bool	operator!= ( TYPE_OF_NULLPTR )	Compare soft pointers for inequality Caution: Two soft pointers might not be equal to each other, but they both might return nullptr
T &	operator* ()	Dereference the soft pointer
TSoftObjectPtr &	operator= ( FSoftObjectPath ObjectPath )	Copy from a soft object path
TSoftObjectPtr &	operator= ( TSoftObjectPtr< U > Other )	Copy from another soft pointer
TSoftObjectPtr &	operator= ( const TWeakObjectPtr< U >& Other )	Copy from a weak pointer to an object already in memory
TSoftObjectPtr &	operator= ( const TSoftObjectPtr& Other )
TSoftObjectPtr &	operator= ( TSoftObjectPtr&& Other )
TSoftObjectPtr &	operator= ( const U* Object )	Copy from an object already in memory
TSoftObjectPtr &	operator= ( const TObjectPtr< U > Object )	Copy from a TObjectPtr which may or may not be in memory.
TSoftObjectPtr &	operator= ( TYPE_OF_NULLPTR )	Assign from a nullptr
bool	operator== ( TYPE_OF_NULLPTR )	Compare soft pointers for equality Caution: Two soft pointers might not be equal to each other, but they both might return nullptr
bool	operator== ( const TSoftObjectPtr& Rhs )	Compare soft pointers for equality Caution: Two soft pointers might not be equal to each other, but they both might return nullptr
T *	operator-> ()	Dereference the soft pointer