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 package, a top level asset or a subobject.

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 package, 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 FTopLevelAssetPath pointing to the top level asset (/package/path.assetname) and an optional 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 ( FName Path )	Asset path FNames have been deprecated. This constructor should be used only temporarily to fix up old codepaths that produce an FName.
	FSoftObjectPath ( const TObjectPtr< T >& InObject )
	FSoftObjectPath ( const FObjectPtr& InObject )
	FSoftObjectPath ( const UObject* InObject )	Construct from an existing object in memory
	FSoftObjectPath ( FTopLevelAssetPath InAssetPath, FString InSubPathString )
	FSoftObjectPath ( FName InAssetPathName, FString InSubPathString )	Asset path FNames have been deprecated. This constructor should be used only temporarily to fix up old codepaths that produce an FName.
	FSoftObjectPath ( FName InPackageName, FName InAssetName, FString InSubPathString )
	FSoftObjectPath ( const FSoftObjectPath& Other )
	FSoftObjectPath ( FSoftObjectPath&& Other )
	FSoftObjectPath ( const FString& Path )	Construct from a path string. Non-explicit for backwards compatibility.
	FSoftObjectPath ( FTopLevelAssetPath InAssetPath )	Explicitly extend a top-level object path with an empty subobject path.
	FSoftObjectPath ( FWideStringView Path )
	FSoftObjectPath ( FAnsiStringView 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	AppendString ( FStringBuilderBase& Builder )	Append string representation of reference, in form /package/path.assetname[:subpath]
void	AppendString ( FString& Builder )	Append string representation of reference, in form /package/path.assetname[:subpath]
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	FastLess ( const FSoftObjectPath& Other )	Return true if this path appears before Other using fast index-based fname order
bool	FixupCoreRedirects()	Fixes soft object path for CoreRedirects to handle renamed native objects, returns true if it was modified
bool	FixupForPIE ( int32 PIEInstance, TFunctionRef< void(int32, FSoftObje... )	Fixes up this SoftObjectPath to add the PIE prefix for the given PIEInstance index, returns true if it was modified
bool	FixupForPIE ( TFunctionRef< void(int32, FSoftObje... )	Fixes up this SoftObjectPath to add the PIE prefix depending on what is currently active, returns true if it was modified.
FName	GetAssetFName()	Returns assetname string, leaving off the /package/path part and sub object
FString	GetAssetName()	Returns assetname string, leaving off the /package/path part and sub object
FTopLevelAss...	GetAssetPath()	Returns the top-level asset part of this path, without the subobject path.
FString	GetAssetPathString()	Returns string version of asset path, including both package and asset but not sub object
int32	GetCurrentTag()	These will be deprecated in a followup change as they are no longer used by FSoftObjectPtr
FName	GetLongPackageFName()	Returns /package/path, leaving off the asset name and sub object
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
FSoftObjectP...	GetWithoutSubPath()	Returns this path without the SubPath component, restricting the result to a top level asset but keeping the type as FSoftObjectPath in contrast to GetAssetPath.
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
bool	LexicalLess ( const FSoftObjectPath& Other )	Return true if this path appears before Other in lexical order
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 ( FArchive& Ar )	Struct overrides
bool	Serialize ( FStructuredArchive::FSlot Slot )	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	SerializePathWithoutFixup ( FArchive& Ar )	Serializes the internal path without any save/PIE fixups.
void	SetPath ( FWideStringView Path )
void	SetPath ( FAnsiStringView Path )
void	SetPath ( FUtf8StringView Path )	Sets asset path of this reference based on a string path
void	SetPath ( const WIDECHAR* Path )
void	SetPath ( const ANSICHAR* Path )
void	SetPath ( const FString& Path )
void	SetPath ( const FTopLevelAssetPath& InAssetP..., FString InSubPathString )	Sets asset path of this reference based on a string path
void	SetSubPathString ( const FString& InSubPathString )
FString	ToString()	Returns string representation of reference, in form /package/path.assetname[:subpath]
void	ToString ( FStringBuilderBase& Builder )	Append 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= ( TYPE_OF_NULLPTR )
	FSoftObjectP...	operator= ( FWideStringView Path )
	FSoftObjectP...	operator= ( const FString& Path )
	FSoftObjectP...	operator= ( const FTopLevelAssetPath Path )
	FSoftObjectP...	operator= ( FSoftObjectPath&& Path )
	FSoftObjectP...	operator= ( const FSoftObjectPath& Path )
	FSoftObjectP...	operator= ( const WIDECHAR* Path )
	FSoftObjectP...	operator= ( const ANSICHAR* Path )
	FSoftObjectP...	operator= ( FAnsiStringView Path )
	bool	operator== ( FSoftObjectPath const& Other )

Constants

Name	Description
PIEPackageNames	Package names currently being duplicated, needed by FixupForPIE

Deprecated Functions

	Name	Description
	FSoftObjectPath ( FName Path )	Asset path FNames have been deprecated. This constructor should be used only temporarily to fix up old codepaths that produce an FName.
	FSoftObjectPath ( FName InAssetPathName, FString InSubPathString )	Asset path FNames have been deprecated. This constructor should be used only temporarily to fix up old codepaths that produce an FName.
FName	GetAssetPathName()	Asset path FNames have been deprecated. Use GetAssetPath instead.
FSoftObjectP...	operator= ( FName Path )	Asset path FNames have been deprecated. This assignment operator should be used only temporarily to fix up old codepaths that produce an FName.
void	SetAssetPathName ( FName InAssetPathName )	Asset path FNames have been deprecated. Use SetAssetPath instead.
void	SetPath ( FName Path )	Asset path FNames have been deprecated. This function should be used only temporarily to fix up old codepaths that produce an FName.
FName	ToFName()	Asset path FNames have been deprecated. This function should be used only temporarily to interface with old APIs that require an FName.

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

Take our survey

Cancel