FSubobjectData

A struct that represents a single subobject.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSubobjectData

FInheritedSubobjectData

FChildActorSubobjectData

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

	Name	Description
TArray< FSubobj...	ChildrenHandles	Set of child subobjects that use this subobject as a parent.
FSubobjectDataH...	Handle	Handle that will have a globally unique ID when it is constructed (i.e. when this is constructed)
FSubobjectDataH...	ParentObjectHandle	Handle to this object's parent. If this is invalid, then it is the root subobject.
TWeakObjectPtr<...	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.
TWeakObjectPtr<...	WeakObjectPtr	Weak ptr to the object instance represented by this node (e.g. component template)

Constructors

	Name	Description
	FSubobjectData()
	FSubobjectData ( UObject* ContextObject, const FSubobjectDataHandle& Parent... )

Destructors

	Name	Description
	~FSubobjectData()

Functions

	Name	Description
bool	AddChildHandleOnly ( const FSubobjectDataHandle& InHand... )	Add the given subobject handle as a child of this.
bool	AttemptToSetSCSNode()	Attempts to set the SCS node member variable based on the WeakObjectPtr.
bool	CanCopy()
bool	CanDelete()
bool	CanDuplicate()
bool	CanEdit()
bool	CanRename()
bool	CanReparent()
void	ClearParentHandle()
FSubobjectDa...	FindChild ( const FSubobjectDataHandle& ChildH... )	Attempt to find the given handle in out child array and return a pointer to it.
FSubobjectDa...	FindChildByObject ( UObject* ContextObject )	Attempt to find the given handle in out child array and return a pointer to it.
const UActor...	FindComponentInstanceInActor ( const AActor* InActor )
UActorCompon...	FindMutableComponentInstanceInActor ( const AActor* InActor )
USCS_Node &#...	FindSCSNodeForInstance ( const UActorComponent* Instanc..., UClass* ClassToSearch )	Anything related to an SCS node will be changed with an upcoming refactor and should remain private.
FText	GetActorDisplayText()
FText	GetAssetName()	Get the asset name of this subobject from the asset brokerage
FText	GetAssetPath()	Get the asset path of this subobject from the asset brokerage
UBlueprint &...	GetBlueprint()
const TArray...	GetChildrenHandles()
FText	GetComponentEditorOnlyTooltipText()	Retrieves a tooltip text describing if the component is marked Editor only or not
const UActor...	GetComponentTemplate ( bool bEvenIfPendingKill )	@note Deliberately non-virtual, for performance reasons.
FText	GetDisplayName()
FText	GetDisplayNameContextModifiers ( bool bShowNativeComponentNames )	Returns a string that gives details about this subobject.
FString	GetDisplayString ( bool bShowNativeComponentNames )
FText	GetDragDropDisplayText()	Get the display name of this subobject that should be used during drag/drop operations
FSubobjectDa...	GetHandle()
FText	GetIntroducedInToolTipText()	Retrieves tooltip text describing where the component was first introduced (for inherited components).
FText	GetMobilityToolTipText()	Retrieves tooltip text describing the specified component's mobility.
AActor *	GetMutableActorContext()	If this subobject is an actor, then return a pointer to that.
UActorCompon...	GetMutableComponentTemplate ( bool bEvenIfPendingKill )
T *	GetMutableObject ( bool bEvenIfPendingKill )
UObject *...	GetMutableObject ( bool bEvenIfPendingKill )	Muteable accessors for this subobject to be used by the subsystem.
T *	GetMutableObjectForBlueprint ( UBlueprint* Blueprint )
const T *...	GetObject ( bool bEvenIfPendingKill )	@note Deliberately non-virtual, for performance reasons.
const UObjec...	GetObject ( bool bEvenIfPendingKill )
const T *...	GetObjectForBlueprint ( UBlueprint* Blueprint )
const UObjec...	GetObjectForBlueprint ( UBlueprint* Blueprint )	@note May not be the same as the value returned by GetObject().
FSubobjectDa...	GetParentData()
FSubobjectDa...	GetParentHandle()
FSubobjectDa...	GetRootSubobject()	Walks the parent heirarchy and returns the root subobject in this case
USCS_Node &#...	GetSCSNode ( bool bEvenIfPendingKill )
FName	GetSocketFName()
FText	GetSocketName()	Sockets for attaching in the viewport.
FName	GetVariableName()
bool	HasChild ( const FSubobjectDataHandle& ChildH... )	Return true if the given handle is a child of this subobject.
bool	HasParent()
bool	HasValidSocket()
bool	IsActor()
bool	IsAssetVisible()	Returns true if the asset this object represents is visible
bool	IsAttachedTo ( const FSubobjectDataHandle& InHand... )
bool	IsBlueprintInheritedComponent()
bool	IsChildActor()
bool	IsChildActorSubtreeObject()	Returns true if this subobject is a part of a child actor's hierarchy and not the root actor.
bool	IsComponent()	Returns true if this subobject is a component.
bool	IsDefaultSceneRoot()
bool	IsInheritedComponent()
bool	IsInheritedSCSNode()	True if this SCS node's blueprint is a child of another Blueprint-generated class, which means that we must use the InheritableComponentHandler
bool	IsInstancedActor()
bool	IsInstancedComponent()
bool	IsInstancedInheritedComponent()	True if this subobject is an instance of an inherited component (its owner is an instanced actor)
bool	IsNativeComponent()
bool	IsRootActor()
bool	IsRootComponent()
bool	IsSceneComponent()
bool	IsValid()	True if this subobject's handle is valid
bool	RemoveChildHandleOnly ( const FSubobjectDataHandle& InHand... )	Add the given subobject handle as a child of this.
bool	SceneRootHasDefaultName()	Returns true if the component template's FName starts with USceneComponent::GetDefaultSceneRootVariableName
void	SetParentHandle ( const FSubobjectDataHandle& NewPar... )
void	SetSocketName ( FName InNewName )
void	SetupAttachment ( FName SocketName, const FSubobjectDataHandle& Attach... )