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

TSoftClassPtr

[TSoftClassPtr](API\Runtime\CoreUObject\UObject\TSoftClassPtr) is a templatized wrapper around [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr) that works like a [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf), it can be used in UProperties for blueprint subclasses

Windows

MacOS

Linux

References

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

Syntax

template<class TClass>
class TSoftClassPtr

Remarks

TSoftClassPtr is a templatized wrapper around FSoftObjectPtr that works like a TSubclassOf, it can be used in UProperties for blueprint subclasses

Constructors

	Name	Description
	TSoftClassPtr()	Default constructor, will be null
	TSoftClassPtr ( const TSoftClassPtr< TClassA >& Ot... )	Construct from another soft pointer
	TSoftClassPtr ( const UClass* From )	Construct from a class already in memory
	TSoftClassPtr ( const FSoftObjectPath& ObjectPath )	Construct from a soft object path

Functions

	Name	Description
UClass *	Get()	Dereference the soft pointer
FString	GetAssetName()	Returns assetname string, leaving off the /package/path part
FString	GetLongPackageName()	Returns /package/path string, leaving off the asset name
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
UClass *	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
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
UClass &	operator*()	Dereference the soft pointer
TSoftClassPt...	operator= ( const TSoftObjectPtr< TClassA >& O... )	Copy from another soft pointer
TSoftClassPt...	operator= ( const TWeakObjectPtr< TClassA >& O... )	Copy from a weak pointer already in memory
void	operator= ( const FSoftObjectPath& ObjectPath )	Copy from a soft object path
void	operator= ( const UClass* From )	Copy from a class already in memory
UClass *	operator->()	Dereference the soft pointer

Deprecated Functions

		Name	Description
	const FSoftO...	ToStringReference()	ToStringReference was renamed to ToSoftObjectPath

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

Take our survey

Dismiss