1. Epic GamesDeveloper
  3. FSoftObjectPath

FSoftObjectPath

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

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

Inheritance Hierarchy

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

  Type Name Description
Public function    
Public function    
Public function    
Public function  

FSoftObjectPath ( const TObjectPtr< T >& InObject
)

  
Public function  

FSoftObjectPath ( const FObjectPtr& InObject
)

  
Public function  

FSoftObjectPath ( const UObject* InObject
)

 Construct from an existing object in memory
Public function  

FSoftObjectPath ( FTopLevelAssetPath InAssetPath,
FString InSubPathString
)

  
Public function  

FSoftObjectPath ( FName InAssetPathName,
FString InSubPathString
)

 Construct from an asset FName and subobject pair
Public function  

FSoftObjectPath ( FName InPackageName,
FName InAssetName,
FString InSubPathString
)

  
Public function  

FSoftObjectPath ( const FSoftObjectPath& Other
)

  
Public function    
Public function  

FSoftObjectPath ( const FString& Path
)

 Construct from a path string. Non-explicit for backwards compatibility.
Public function   Explicitly extend a top-level object path with an empty subobject path.
Public function    
Public function    
Public function  

FSoftObjectPath ( const WIDECHAR* Path
)

  
Public function  

FSoftObjectPath ( const ANSICHAR* Path
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static void

AddPIEPackageName ( FName NewPIEPackageName
)

 Adds list of packages names that have been created specifically for PIE, this is used for editor fixup
Public function Const void  
Public function Const void  
Public function Const void

AppendString ( FString& Builder
)

 Append string representation of reference, in form /package/path.assetname[:subpath]
Public function Static void Disables special PIE path handling, call when PIE finishes to clear list
Public function Static FSoftObjectPath  
Public function Static FSoftObjectPath

ConstructFromObject ( const TObjectPtr< T >& InObject
)

  
Public function Static FSoftObjectPath

ConstructFromObject ( const FObjectPtr& InObject
)

  
Public function Static FSoftObjectPath

ConstructFromObject ( const UObject* InObject
)

  
Public function Static FSoftObjectPath

ConstructFromPackageAsset ( FName InPackageName,
FName InAssetName
)

  
Public function Static FSoftObjectPath

ConstructFromPackageAssetSubpath ( FName InPackageName,
FName InAssetName,
FString&& InSubPathString
)

  
Public function Static FSoftObjectPath

ConstructFromPackageAssetSubpath ( FName InPackageName,
FName InAssetName,
const FString& InSubPathString
)

 Static methods for more meaningful construction sites.
Public function Static FSoftObjectPath  
Public function Static FSoftObjectPath  
Public function Static FSoftObjectPath  
Public function Const bool

ExportTextItem ( FString& ValueStr,
FSoftObjectPath const& DefaultValue,
UObject* Parent,
int32 PortFlags,
UObject* ExportRootScope
)

  
Public function Const bool

FastLess ( const FSoftObjectPath& Other
)

 Return true if this path appears before Other using fast index-based fname order
Public function bool Fixes soft object path for CoreRedirects to handle renamed native objects, returns true if it was modified
Public function bool

FixupForPIE ( int32 PIEInstance,
TFunctionRef< void(int32, FSoftObjectPath&)> InPreFixupForPIECustomFunction
)

 Fixes up this SoftObjectPath to add the PIE prefix for the given PIEInstance index, returns true if it was modified
Public function bool

FixupForPIE ( TFunctionRef< void(int32, FSoftObjectPath&)> InPreFixupForPIECustomFunction
)

 Fixes up this SoftObjectPath to add the PIE prefix depending on what is currently active, returns true if it was modified.
Public function Const FName Returns assetname string, leaving off the /package/path part and sub object
Public function Const FString Returns assetname string, leaving off the /package/path part and sub object
Public function Const FTopLevelAssetPath Returns the top-level asset part of this path, without the subobject path.
Public function Const FName Returns the entire asset path as an FName, including both package and asset but not sub object
Public function Const FString Returns string version of asset path, including both package and asset but not sub object
Public function Static int32  
Public function Const FName Returns /package/path, leaving off the asset name and sub object
Public function Const FString Returns /package/path, leaving off the asset name and sub object
Public function Static FSoftObjectPath

GetOrCreateIDForObject ( const UObject* Object
)

  
Public function Const const FString & Returns the sub path, which is often empty
Public function Const FSoftObjectPath 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.
Public function bool

ImportTextItem ( const TCHAR*& Buffer,
int32 PortFlags,
UObject* Parent,
FOutputDevice* ErrorText,
FArchive* InSerializingArchive
)

  
Public function Static int32  
Public function Const bool

IsAsset ()

 Check if this represents an asset, meaning it is not null but does not have a sub path
Public function Const bool

IsNull ()

 Checks to see if this is initialized to null
Public function Const bool Check if this represents a sub object, meaning it has a sub path
Public function Const bool

IsValid ()

 Check if this could possibly refer to a real object, or was initialized to null
Public function Const bool

LexicalLess ( const FSoftObjectPath& Other
)

 Return true if this path appears before Other in lexical order
Public function Const int32

LoadAsync ( FLoadSoftObjectPathAsyncDelegate InCompletionDelegate,
FLoadAssetAsyncOptionalParams InOptionalParams
)

 Attempts to asynchronously load the object referenced by this path.
Public function Const void

PostLoadPath ( FArchive* InArchive
)

 Handles when a path has been loaded, call if loading with a method that skips SerializePath.
Public function bool

PreSavePath ( bool* bReportSoftObjectPathRedirects
)

 Fixes up path for saving, call if saving with a method that skips SerializePath.
Public function void

Reset ()

 Resets reference to point to null
Public function Const UObject * Attempts to find a currently loaded object that matches this path
Public function bool Struct overrides
Public function bool  
Public function bool  
Public function void Serializes the internal path and also handles save/PIE fixups.
Public function void Serializes the internal path without any save/PIE fixups.
Public function void

SetAssetPathName ( FName InAssetPathName
)

  
Public function void  
Public function void  
Public function void

SetPath ( FName Path
)

  
Public function void

SetPath ( const FString& Path
)

  
Public function void

SetPath ( const FTopLevelAssetPath& InAssetPath,
FString InSubPathString
)

 Sets asset path of this reference based on a string path
Public function void

SetPath ( const WIDECHAR* Path
)

  
Public function void  
Public function void

SetPath ( const ANSICHAR* Path
)

  
Public function void

SetSubPathString ( const FString& InSubPathString
)

  
Public function Const FName

ToFName ()

  
Public function Const void Append string representation of reference, in form /package/path.assetname[:subpath]
Public function Const FString Returns string representation of reference, in form /package/path.assetname[:subpath]
Public function Const void  
Public function Const UObject *

TryLoad ( FUObjectSerializeContext* InLoadContext
)

 Attempts to load the asset, this will call LoadObject which can be very slow

Operators

  Type Name Description
Public function Const bool

operator!= ( FSoftObjectPath const& Other
)

  
Public function FSoftObjectPath &

operator= ( const ANSICHAR* Path
)

  
Public function FSoftObjectPath &

operator= ( const WIDECHAR* Path
)

  
Public function FSoftObjectPath &

operator= ( const FSoftObjectPath& Path
)

  
Public function FSoftObjectPath &  
Public function FSoftObjectPath &

operator= ( const FTopLevelAssetPath Path
)

  
Public function FSoftObjectPath &  
Public function FSoftObjectPath &

operator= ( const FString& Path
)

  
Public function FSoftObjectPath &

operator= ( FName Path
)

  
Public function FSoftObjectPath &  
Public function FSoftObjectPath &  
Public function Const bool

operator== ( FSoftObjectPath const& Other
)

  

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page