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 > CoreUObject > UObject > FSoftObjectPtr

Light Theme

Dark Theme

FSoftObjectPtr

[FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr) is a type of weak pointer to a [UObject](API\Runtime\CoreUObject\UObject\UObject), that also keeps track of the path to the object on disk.

Windows

MacOS

Linux

Inheritance Hierarchy

TPersistentObjectPtr

FSoftObjectPtr

References

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

Syntax

struct FSoftObjectPtr : public TPersistentObjectPtr< FSoftObjectPath >

Remarks

FSoftObjectPtr is a type of weak pointer to a UObject, that also keeps track of the path to the object on disk. It will change back and forth between being Valid and Pending as the referenced object loads or unloads. It has no impact on if the object is garbage collected or not.

This is useful to specify assets that you may want to asynchronously load on demand.

Constructors

	Name	Description
	FSoftObjectPtr()	Default constructor, will be null
	FSoftObjectPtr ( const FSoftObjectPtr& Other )	Construct from another soft pointer
	FSoftObjectPtr ( const FSoftObjectPath& ObjectPath )	Construct from a soft object path
	FSoftObjectPtr ( const UObject* Object )	Construct from an object already in memory

Functions

	Name	Description
UObject *...	Get()	Overridden to deal with PIE lookups
FString	GetAssetName()	Returns assetname string, leaving off the /package/path. part
FString	GetLongPackageName()	Returns /package/path string, leaving off the asset name
UObject *...	LoadSynchronous()	Synchronously load (if necessary) and return the asset object represented by this asset ptr
const FSoftO...	ToSoftObjectPath()	Returns the StringObjectPath that is wrapped by this SoftObjectPtr
FString	ToString()	Returns string representation of reference, in form /package/path.assetname

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