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 > FSoftObjectPath

Light Theme

Dark Theme

FSoftObjectPath

A struct that contains a string reference to an object, either a top level asset or a subobject.

Windows

MacOS

Linux

Inheritance Hierarchy

FSoftObjectPath

FSoftClassPath

References

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

Syntax

struct FSoftObjectPath

Remarks

A struct that contains a string reference to an object, either a top level asset or a subobject. This can be used to make soft references to assets that are loaded on demand. This is stored internally as an FName pointing to the top level asset (/package/path.assetname) and an option a string subobject path. If the MetaClass metadata is applied to a FProperty with this the UI will restrict to that type of asset.

Constructors

	Name	Description
	FSoftObjectPath()
	FSoftObjectPath ( TYPE_OF_NULLPTR )
	FSoftObjectPath ( const UObject* InObject )	Construct from an existing object in memory
	FSoftObjectPath ( FName InAssetPathName, FString InSubPathString )	Construct from an asset FName and subobject pair
	FSoftObjectPath ( const FSoftObjectPath& Other )	Construct from another soft object path
	FSoftObjectPath ( FSoftObjectPath&& Other )	Construct from a moveable soft object path
	FSoftObjectPath ( const FString& Path )	Construct from a path string. Non-explicit for backwards compatibility.
	FSoftObjectPath ( FWideStringView Path )
	FSoftObjectPath ( FAnsiStringView Path )
	FSoftObjectPath ( FName Path )
	FSoftObjectPath ( const WIDECHAR* Path )
	FSoftObjectPath ( const ANSICHAR* Path )

Destructors

	Name	Description
	~FSoftObjectPath()

Functions

	Name	Description
void	AddPIEPackageName ( FName NewPIEPackageName )	Adds list of packages names that have been created specifically for PIE, this is used for editor fixup
void	ClearPIEPackageNames()	Disables special PIE path handling, call when PIE finishes to clear list
bool	ExportTextItem ( FString& ValueStr, FSoftObjectPath const& DefaultValu..., UObject* Parent, int32 PortFlags, UObject* ExportRootScope )
bool	FixupCoreRedirects()	Fixes soft object path for CoreRedirects to handle renamed native objects, returns true if it was modified
bool	FixupForPIE ( int32 PIEInstance )	Fixes up this SoftObjectPath to add the PIE prefix for the given PIEInstance index, returns true if it was modified
bool	FixupForPIE()	Fixes up this SoftObjectPath to add the PIE prefix depending on what is currently active, returns true if it was modified.
FString	GetAssetName()	Returns assetname string, leaving off the /package/path part and sub object
FName	GetAssetPathName()	Returns the entire asset path as an FName, including both package and asset but not sub object
FString	GetAssetPathString()	Returns string version of asset path, including both package and asset but not sub object
int32	GetCurrentTag()	Code needed by FSoftObjectPtr internals
FString	GetLongPackageName()	Returns /package/path, leaving off the asset name and sub object
FSoftObjectP...	GetOrCreateIDForObject ( const UObject* Object )
const FStrin...	GetSubPathString()	Returns the sub path, which is often empty
bool	ImportTextItem ( const TCHAR& Buffer, int32 PortFlags, UObject Parent, FOutputDevice* ErrorText, FArchive* InSerializingArchive )
int32	InvalidateTag()
bool	IsAsset()	Check if this represents an asset, meaning it is not null but does not have a sub path
bool	IsNull()	Checks to see if this is initialized to null
bool	IsSubobject()	Check if this represents a sub object, meaning it has a sub path
bool	IsValid()	Check if this could possibly refer to a real object, or was initialized to null
void	PostLoadPath ( FArchive* InArchive )	Handles when a path has been loaded, call if loading with a method that skips SerializePath.
bool	PreSavePath ( bool* bReportSoftObjectPathRed... )	Fixes up path for saving, call if saving with a method that skips SerializePath.
void	Reset()	Resets reference to point to null
UObject *...	ResolveObject()	Attempts to find a currently loaded object that matches this path
bool	Serialize ( FStructuredArchive::FSlot Slot )	Struct overrides
bool	Serialize ( FArchive& Ar )	Struct overrides
bool	SerializeFromMismatchedTag ( FPropertyTag const& Tag, FStructuredArchive::FSlot Slot )
void	SerializePath ( FArchive& Ar )	Serializes the internal path and also handles save/PIE fixups.
void	SetPath ( const FString& Path )
void	SetPath ( FWideStringView Path )	Sets asset path of this reference based on a string path
void	SetPath ( FAnsiStringView Path )	Sets asset path of this reference based on a string path
void	SetPath ( FName Path )	Sets asset path of this reference based on a string path
void	SetPath ( const WIDECHAR* Path )
void	SetPath ( const ANSICHAR* Path )
void	ToString ( FStringBuilderBase& Builder )	Append string representation of reference, in form /package/path.assetname[:subpath]
FString	ToString()	Returns string representation of reference, in form /package/path.assetname[:subpath]
UObject *...	TryLoad ( FUObjectSerializeContext* InLo... )	Attempts to load the asset, this will call LoadObject which can be very slow

Operators

		Name	Description
	bool	operator!= ( FSoftObjectPath const& Other )
	FSoftObjectP...	operator= ( const FString& Path )
	FSoftObjectP...	operator= ( FWideStringView Path )
	FSoftObjectP...	operator= ( FAnsiStringView Path )
	FSoftObjectP...	operator= ( FName Path )
	FSoftObjectP...	operator= ( const WIDECHAR* Path )
	FSoftObjectP...	operator= ( const ANSICHAR* Path )
	FSoftObjectP...	operator= ( TYPE_OF_NULLPTR )
	FSoftObjectP...	operator= ( FSoftObjectPath&& Path )
	FSoftObjectP...	operator= ( const FSoftObjectPath& Path )
	bool	operator== ( FSoftObjectPath const& Other )

Constants

Name	Description
CurrentTag	Global counter that determines when we need to re-search based on path because more objects have been loaded
PIEPackageNames	Package names currently being duplicated, needed by FixupForPIE

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

Take our survey

Dismiss