1. Epic GamesDeveloper
  3. FSubobjectData

FSubobjectData

A struct that represents a single subobject.

API > API/Editor > API/Editor/SubobjectDataInterface

Inheritance Hierarchy

References

   
Module SubobjectDataInterface
Header /Engine/Source/Editor/SubobjectDataInterface/Public/SubobjectData.h
Include #include "SubobjectData.h"

Syntax

struct FSubobjectData

Remarks

A struct that represents a single subobject. This can be anything, but are most commonly components attached to an actor instance or blueprint. Keeps track of the handles to its parent object and any child that it has.

If you wish to modify a subobject, use the SubobjectDataSubsystem.

Variables

  Type Name Description
Protected variable TArray< FSubobjectDataHandle > ChildrenHandles Set of child subobjects that use this subobject as a parent.
Protected variable FSubobjectDataHandle Handle Handle that will have a globally unique ID when it is constructed (i.e. when this is constructed)
Protected variable FSubobjectDataHandle ParentObjectHandle Handle to this object's parent. If this is invalid, then it is the root subobject.
Protected variable TWeakObjectPtr< USCS_Node > SCSNodePtr For now, we need a pointer to the SCS node in order to have the correct component template and to be able to get the UBlueprint* from components.
Protected variable TWeakObjectPtr< UObject > WeakObjectPtr Weak ptr to the object instance represented by this node (e.g. component template)

Constructors

  Type Name Description
Public function    
Public function  

FSubobjectData ( UObject* ContextObject,
const FSubobjectDataHandle& ParentHandle
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function bool Add the given subobject handle as a child of this.
Protected function bool Attempts to set the SCS node member variable based on the WeakObjectPtr.
Public function Virtual Const bool

CanCopy ()

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool

CanEdit ()

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function void  
Public function Const FSubobjectDataHandle

FindChild ( const FSubobjectDataHandle& ChildHandle
)

 Attempt to find the given handle in out child array and return a pointer to it.
Public function Const FSubobjectDataHandle

FindChildByObject ( UObject* ContextObject
)

 Attempt to find the given handle in out child array and return a pointer to it.
Public function Const const UActorComponent *  
Protected function Const UActorComponent *  
Protected function Static USCS_Node *

FindSCSNodeForInstance ( const UActorComponent* InstanceComponent,
UClass* ClassToSearch
)

 Anything related to an SCS node will be changed with an upcoming refactor and should remain private.
Public function Virtual Const FText  
Public function Const FText Get the asset name of this subobject from the asset brokerage
Public function Const FText Get the asset path of this subobject from the asset brokerage
Public function Const UBlueprint *  
Public function Const const TArray< FSubobjectDataHandle > &  
Public function Const FText Retrieves a tooltip text describing if the component is marked Editor only or not
Public function Const const UActorComponent *

GetComponentTemplate ( bool bEvenIfPendingKill
)

 Deliberately non-virtual, for performance reasons.
Public function Virtual Const FText  
Public function Virtual Const FText

GetDisplayNameContextModifiers ( bool bShowNativeComponentNames
)

 Returns a string that gives details about this subobject.
Public function Virtual Const FString

GetDisplayString ( bool bShowNativeComponentNames
)

  
Public function Const FText Get the display name of this subobject that should be used during drag/drop operations
Public function Const FSubobjectDataHandle  
Public function Const FText Retrieves tooltip text describing where the component was first introduced (for inherited components).
Public function Const FText Retrieves tooltip text describing the specified component's mobility.
Protected function AActor * If this subobject is an actor, then return a pointer to that.
Protected function Const UActorComponent *

GetMutableComponentTemplate ( bool bEvenIfPendingKill
)

  
Protected function Const T *

GetMutableObject ( bool bEvenIfPendingKill
)

  
Protected function Const UObject *

GetMutableObject ( bool bEvenIfPendingKill
)

 Muteable accessors for this subobject to be used by the subsystem.
Protected function Const T *  
Public function Const const T *

GetObject ( bool bEvenIfPendingKill
)

 Deliberately non-virtual, for performance reasons.
Public function Const const UObject *

GetObject ( bool bEvenIfPendingKill
)

  
Public function Const const T *  
Public function Const const UObject * May not be the same as the value returned by GetObject().
Public function Const FSubobjectData *  
Public function Const FSubobjectDataHandle  
Public function Const FSubobjectDataHandle Walks the parent heirarchy and returns the root subobject in this case
Protected function Virtual Const USCS_Node *

GetSCSNode ( bool bEvenIfPendingKill
)

  
Public function Const FName  
Public function Const FText Sockets for attaching in the viewport.
Public function Virtual Const FName  
Public function Const bool

HasChild ( const FSubobjectDataHandle& ChildHandle
)

 Return true if the given handle is a child of this subobject.
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool

IsActor ()

  
Public function Const bool Returns true if the asset this object represents is visible
Public function Const bool

IsAttachedTo ( const FSubobjectDataHandle& InHandle
)

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool Returns true if this subobject is a part of a child actor's hierarchy and not the root actor.
Public function Virtual Const bool Returns true if this subobject is a component.
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function Virtual Const bool True if this SCS node's blueprint is a child of another Blueprint-generated class, which means that we must use the InheritableComponentHandler
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool True if this subobject is an instance of an inherited component (its owner is an instanced actor)
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const bool

IsValid ()

 True if this subobject's handle is valid
Protected function bool Add the given subobject handle as a child of this.
Public function Const bool Returns true if the component template's FName starts with USceneComponent::GetDefaultSceneRootVariableName
Protected function void

SetParentHandle ( const FSubobjectDataHandle& NewParentHandle
)

  
Public function void

SetSocketName ( FName InNewName
)

  
Public function void

SetupAttachment ( FName SocketName,
const FSubobjectDataHandle& AttachParentHandle
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page