1. Epic GamesDeveloper
  3. TSoftObjectPtr

TSoftObjectPtr

[TSoftObjectPtr](API\Runtime\CoreUObject\UObject\TSoftObjectPtr) is templatized wrapper of the generic [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr), it can be used in UProperties

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

References

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

Syntax

template<class T>  
struct TSoftObjectPtr

Remarks

TSoftObjectPtr is templatized wrapper of the generic FSoftObjectPtr, it can be used in UProperties

Constructors

  Type Name Description
Public function    
Public function  

TSoftObjectPtr ( const TObjectPtr< U > Object
)

 Construct from a TObjectPtr which may or may not be in memory.
Public function  

TSoftObjectPtr ( const TObjectPtr< U > Object
)

  
Public function   Construct from a nullptr
Public function  

TSoftObjectPtr ( SoftObjectPathType ObjectPath
)

 Construct from a soft object path
Public function  

TSoftObjectPtr ( const FString& Path
)

  
Public function  

TSoftObjectPtr ( const TSoftObjectPtr& Other
)

  
Public function    
Public function  

TSoftObjectPtr ( const TSoftObjectPtr< U >& Other
)

 Construct from another soft pointer
Public function  

TSoftObjectPtr ( const TSoftObjectPtr< U >& Other
)

  
Public function  

TSoftObjectPtr ( TSoftObjectPtr< U >&& Other
)

 Construct from a moveable soft pointer
Public function  

TSoftObjectPtr ( TSoftObjectPtr< U >&& Other
)

  
Public function  

TSoftObjectPtr ( U* Object
)

 Construct from an object already in memory
Public function  

TSoftObjectPtr ( U* Object
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const T *

Get ()

 Dereference the soft pointer.
Public function Const FString Returns assetname string, leaving off the /package/path part
Public function Const FName Returns /package/path name, leaving off the asset name
Public function Const FString Returns /package/path string, leaving off the asset name
Public function Const uint32 Hash function
Public function Const const FSoftObjectPath & Returns the StringObjectPath that is wrapped by this SoftObjectPtr
Public function Const bool

IsNull ()

 Test if this can never point to a live UObject
Public function Const bool Test if this does not point to a live UObject, but may in the future
Public function Const bool

IsValid ()

 Test if this points to a live UObject
Public function Const T * Synchronously load (if necessary) and return the asset object represented by this asset ptr
Public function void

Reset ()

 Reset the soft pointer back to the null state
Public function void Resets the weak ptr only, call this when ObjectId may change
Public function void  
Public function Const const FSoftObjectPath & Returns the StringObjectPath that is wrapped by this SoftObjectPtr
Public function Const FString Returns string representation of reference, in form /package/path.assetname

Operators

  Type Name Description
Public function Const   Dereference soft pointer to see if it points somewhere valid
Public function Const T & Dereference the soft pointer
Public function TSoftObjectPtr &

operator= ( TSoftObjectPtr< U > Other
)

  
Public function TSoftObjectPtr &

operator= ( TSoftObjectPtr< U > Other
)

 Copy from another soft pointer
Public function TSoftObjectPtr &

operator= ( const TWeakObjectPtr< U >& Other
)

  
Public function TSoftObjectPtr &

operator= ( const TWeakObjectPtr< U >& Other
)

 Copy from a weak pointer to an object already in memory
Public function TSoftObjectPtr &

operator= ( FSoftObjectPath ObjectPath
)

 Copy from a soft object path
Public function TSoftObjectPtr &

operator= ( const TObjectPtr< U > Object
)

  
Public function TSoftObjectPtr &

operator= ( const TObjectPtr< U > Object
)

 Copy from a TObjectPtr which may or may not be in memory.
Public function TSoftObjectPtr &

operator= ( U* Object
)

  
Public function TSoftObjectPtr & Assign from a nullptr
Public function TSoftObjectPtr &  
Public function TSoftObjectPtr &

operator= ( const TSoftObjectPtr& Other
)

  
Public function TSoftObjectPtr &

operator= ( U* Object
)

 Copy from an object already in memory
Public function Const bool

operator== ( U* Rhs
)

  
Public function Const bool

operator== ( U* Rhs
)

  
Public function Const bool

operator== ( const TSoftObjectPtr< U >& Rhs
)

  
Public function Const bool

operator== ( const TSoftObjectPtr< U >& Rhs
)

  
Public function Const bool

operator== ( const TSoftObjectPtr& Rhs
)

 Compare soft pointers for equality Caution: Two soft pointers might not be equal to each other, but they both might return nullptr
Public function Const bool  
Public function Const T * Dereference the soft pointer

Typedefs

Name Description
ElementType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page