1. Epic GamesDeveloper
  3. TSoftClassPtr

TSoftClassPtr

[TSoftClassPtr](API\Runtime\CoreUObject\UObject\TSoftClassPtr) is a templatized wrapper around [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr) that works like a [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf), it can be used in UProperties for blueprint subclasses

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 TClass>  
class TSoftClassPtr

Remarks

TSoftClassPtr is a templatized wrapper around FSoftObjectPtr that works like a TSubclassOf, it can be used in UProperties for blueprint subclasses

Constructors

  Type Name Description
Public function    
Public function  

TSoftClassPtr ( const TSoftClassPtr& Other
)

  
Public function    
Public function  

TSoftClassPtr ( const TSoftClassPtr< TClassA >& Other
)

 Construct from another soft pointer
Public function  

TSoftClassPtr ( const UClass* From
)

 Construct from a class already in memory
Public function  

TSoftClassPtr ( const FSoftObjectPath& ObjectPath
)

 Construct from a soft object path

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const UClass *

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 UClass * 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 bool

operator!= ( const TSoftClassPtr& Rhs
)

 Compare soft pointers for inequality Caution: Two soft pointers might not be equal to each other, but they both might return nullptr
Public function Const UClass & Dereference the soft pointer
Public function TSoftClassPtr &

operator= ( const TSoftObjectPtr< TClassA >& Other
)

 Copy from another soft pointer
Public function TSoftClassPtr &

operator= ( const TWeakObjectPtr< TClassA >& Other
)

 Copy from a weak pointer already in memory
Public function void

operator= ( const FSoftObjectPath& ObjectPath
)

 Copy from a soft object path
Public function void

operator= ( const UClass* From
)

 Copy from a class already in memory
Public function TSoftClassPtr &

operator= ( TSoftClassPtr&& Other
)

  
Public function TSoftClassPtr &

operator= ( const TSoftClassPtr& Other
)

  
Public function Const bool

operator== ( const TSoftClassPtr& 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 UClass * 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