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

Light Theme

Dark Theme

TSoftObjectPtr

[TSoftObjectPtr](API\Runtime\CoreUObject\UObject\TSoftObjectPtr) is templatized wrapper of the generic [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr), it can be used in UProperties

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

	Name	Description
	TSoftObjectPtr()	Default constructor, will be null
	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 )
	TSoftObjectPtr ( TYPE_OF_NULLPTR )	Construct from a nullptr
	TSoftObjectPtr ( FSoftObjectPath ObjectPath )	Construct from a soft object path

Functions

	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 FSoftO...	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 FSoftO...	ToSoftObjectPath()	Returns the StringObjectPath that is wrapped by this SoftObjectPtr
FString	ToString()	Returns string representation of reference, in form /package/path.assetname

Operators

	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
TSoftObjectP...	operator= ( const TWeakObjectPtr< U >& Other )	Copy from a weak pointer to an object already in memory
TSoftObjectP...	operator= ( TSoftObjectPtr< U > Other )	Copy from another soft pointer
TSoftObjectP...	operator= ( FSoftObjectPath ObjectPath )	Copy from a soft object path
TSoftObjectP...	operator= ( TYPE_OF_NULLPTR )	Assign from a nullptr
TSoftObjectP...	operator= ( const TObjectPtr< U > Object )
TSoftObjectP...	operator= ( const U* Object )	Copy from an object already in memory
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
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
T *	operator->()	Dereference the soft pointer

Typedefs

Name	Description
ElementType

Deprecated Functions

		Name	Description
	T *	Get()	TAssetSubclassOf was renamed to TSoftClassPtr

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

Take our survey

Cancel