1. Epic GamesDeveloper
  3. USubobjectDataSubsystem

USubobjectDataSubsystem

The Subobject Data Subsystem will produce the reflected subobject data based on a given root object.

API > API/Editor > API/Editor/SubobjectDataInterface

The Subobject Data Subsystem will produce the reflected subobject data based on a given root object. A root object can be anything, an actor instance clicked on via the level editor, a UBlueprint* by opening an asset, or something piped in from python or other scripting languages.

   
Name USubobjectDataSubsystem
Type class
Header File /Engine/Source/Editor/SubobjectDataInterface/Public/SubobjectDataSubsystem.h
Include Path #include "SubobjectDataSubsystem.h"

Syntax

UCLASS (MinimalAPI, Category="SubobjectDataSubsystem")  
class USubobjectDataSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Structs

Name Remarks
FSubobjectDataAdapterEntry  
FSubsystemAdapterEntry  

Typedefs

Name Type Remarks Include Path
FSubobjectDataAdapterFilter TFunction< bool(const FSubobjectData &)>   SubobjectDataSubsystem.h
FSubobjectSubsystemAdapterFilter TFunction< bool(const TInstancedStruct< FSubobjectDataSubsystemContextDataBase > &ContextData)>   SubobjectDataSubsystem.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DataAdapterHandleIndex uint64   SubobjectDataSubsystem.h  
DataAdapters TArray< FSubobjectDataAdapterEntry >   SubobjectDataSubsystem.h  
OnNewSubobjectAdded_Delegate FOnNewSubobjectAdded   SubobjectDataSubsystem.h  
SubsystemAdapterHandleIndex uint64   SubobjectDataSubsystem.h  
SubsystemAdapters TArray< FSubsystemAdapterEntry >   SubobjectDataSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FSubobjectDataHandle AddNewSubobject ( const FAddNewSubobjectParams& Params,
FText& FailReason
)

 Add a new subobject as a child to the given parent object SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

bool AttachSubobject ( const FSubobjectDataHandle& OwnerHandle,
const FSubobjectDataHandle& ChildToAddHandle
)

 Add the given subobject to a new owner. SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

FScopedTransaction * BeginTransaction ( const TArray< FSubobjectDataHandle >& Handles,
const FText& Description,
UBlueprint* Blueprint
)

   SubobjectDataSubsystem.h  

bool CanCopySubobjects ( const TArray< FSubobjectDataHandle >& Handles
) const

 Returns true if the given array of handles represents subobjects that can be copied. SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

bool CanPasteSubobjects ( const FSubobjectDataHandle& RootHandle,
UBlueprint* BPContext
) const

   SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

bool ChangeSubobjectClass ( const FSubobjectDataHandle& Handle,
const UClass* NewClass
)

 Attempts to change the subclass of a native component SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

void CopySubobjects ( const TArray< FSubobjectDataHandle >& Handles,
UBlueprint* BpContext
)

   SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

virtual void Deinitialize()

 Implement this for deinitialization of instances of the system SubobjectDataSubsystem.h  

int32 DeleteSubobject ( const FSubobjectDataHandle& ContextHandle,
const FSubobjectDataHandle& SubobjectToDelete,
UBlueprint* BPContext
)

 Attempts to delete the given subobject from its blueprint context SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"
  • Meta=(DisplayName="Delete Subobject from Blueprint")

int32 DeleteSubobjects ( const FSubobjectDataHandle& ContextHandle,
const TArray< FSubobjectDataHandle >& SubobjectsToDelete,
UBlueprint* BPContext
)

 Attempts to delete the given array of subobjects from their context SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"
  • Meta=(DisplayName="Delete Subobjects from Blueprint")

int32 DeleteSubobjects ( const FSubobjectDataHandle& ContextHandle,
const TArray< FSubobjectDataHandle >& SubobjectsToDelete,
FSubobjectDataHandle& OutComponentToSelect,
UBlueprint* BPContext,
bool bForce
)

 Attempts to delete the given array of subobjects from their context SubobjectDataSubsystem.h  

bool DetachSubobject ( const FSubobjectDataHandle& OwnerHandle,
const FSubobjectDataHandle& ChildToRemove
)

 Remove the child subobject from the owner SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

void DuplicateSubobjects ( const FSubobjectDataHandle& Context,
const TArray< FSubobjectDataHandle >& SubobjectsToDup,
UBlueprint* BpContext,
TArray< FSubobjectDataHandle >& OutNewSubobjects
)

 Duplicate the given array of subobjects on the context. SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

const FSubobjectDataAdapterBase * FindDataAdapter ( const FSubobjectData& SubobjectData
) const

   SubobjectDataSubsystem.h  

FSubobjectDataHandle FindHandleForObject ( const FSubobjectDataHandle& Context,
const UObject* ObjectToFind,
UBlueprint* BPContext
) const

 Attempt to find an existing handle for the given object. SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"
Find the scene root for a given subobject handle. SubobjectDataSubsystem.h  

void GatherSubobjectData ( UObject* Context,
TArray< FSubobjectDataHandle >& OutArray
)

 Gather all subobjects that the given UObject context has. SubobjectDataSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

 Implement this for initialization of instances of the system SubobjectDataSubsystem.h  

bool IsValidRename ( const FSubobjectDataHandle& Handle,
const FText& InNewText,
FText& OutErrorMessage
) const

 Returns true if the given new text is a valid option to rename the subobject with the given handle. SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

int32 K2_DeleteSubobjectFromInstance ( const FSubobjectDataHandle& ContextHandle,
const FSubobjectDataHandle& SubobjectToDelete
)

 Attempts to delete the given subobject from its context SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"
  • Meta=(DisplayName="Delete Subobject from Instance")

int32 K2_DeleteSubobjectsFromInstance ( const FSubobjectDataHandle& ContextHandle,
const TArray< FSubobjectDataHandle >& SubobjectsToDelete
)

 Attempts to delete the given array of subobjects from their context SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"
  • Meta=(DisplayName="Delete Subobjects from Instance")

bool K2_FindSubobjectDataFromHandle ( const FSubobjectDataHandle& Handle,
FSubobjectData& OutData
) const

 Attempt to find the subobject data for a given handle. SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"
  • Meta=(DisplayName="FindSubobjectDataFromHandle")

void K2_GatherSubobjectDataForBlueprint ( UBlueprint* Context,
TArray< FSubobjectDataHandle >& OutArray
)

 Gather all subobjects that the given Blueprint context has. SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"
  • Meta=(DisplayName="Gather Subobject Data For Blueprint")

void K2_GatherSubobjectDataForInstance ( AActor* Context,
TArray< FSubobjectDataHandle >& OutArray
)

 Gather all subobjects that the given actor instance has. SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"
  • Meta=(DisplayName="Gather Subobject Data For Instance")

bool MakeNewSceneRoot ( const FSubobjectDataHandle& Context,
const FSubobjectDataHandle& NewSceneRoot,
UBlueprint* BPContext
)

   SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

FOnNewSubobjectAdded & OnNewSubobjectAdded()

 Delegate invoked when a new subobject is successfully added SubobjectDataSubsystem.h  

void PasteSubobjects ( const FSubobjectDataHandle& PasteToContext,
const TArray< FSubobjectDataHandle >& NewParentHandles,
UBlueprint* BpContext,
TArray< FSubobjectDataHandle >& OutPastedHandles
)

 Pastes the given subobjects to the PasteToContext. SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

FSubobjectDataAdapterHandle RegisterSubobjectDataAdapter ( FSubobjectDataAdapterFilter InFilter,
TUniquePtr< FSubobjectDataAdapterBase > InDataAdapter
)

   SubobjectDataSubsystem.h  

FSubobjectDataSubsystemAdapterHandle RegisterSubsystemAdapter ( FSubobjectSubsystemAdapterFilter InFilter,
TUniquePtr< FSubobjectDataSubsystemAdapterBase > InAdapter
)

   SubobjectDataSubsystem.h  

bool RenameSubobject ( const FSubobjectDataHandle& Handle,
const FText& InNewName
)

 Attempts to rename the given subobject to the new name. SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

bool ReparentSubobject ( const FReparentSubobjectParams& Params,
const FSubobjectDataHandle& ToReparentHandle
)

 Attempts to reparent the given subobject to the new parent SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

bool ReparentSubobjects ( const FReparentSubobjectParams& Params,
const TArray< FSubobjectDataHandle >& HandlesToMove
)

 Attempts to reparent all subobjects in the HandlesToMove array to the new parent handle. SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

void UnregisterSubobjectDataAdapter ( FSubobjectDataAdapterHandle Handle
)

   SubobjectDataSubsystem.h  

void UnregisterSubsystemAdapter ( FSubobjectDataSubsystemAdapterHandle Handle
)

   SubobjectDataSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static UClass * CreateNewBPComponent ( TSubclassOf< UActorComponent > ComponentClass,
const FString& NewClassPath,
const FString& NewClassName
)

 Creates a new Blueprint component from the specified class type The user will be prompted to pick a new subclass name and a blueprint asset will be created SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"
  • Meta=(DisplayName="Create New Blueprint Component")

static UClass * CreateNewCPPComponent ( TSubclassOf< UActorComponent > ComponentClass,
const FString& NewClassPath,
const FString& NewClassName
)

 Creates a new C++ component from the specified class type The user will be prompted to pick a new subclass name and code will be recompiled SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"
  • Meta=(DisplayName="Create New C++ Component")
Static wrapper for getting this engine subsystem. SubobjectDataSubsystem.h  

static FSubobjectDataHandle GetActorRootHandle ( const FSubobjectDataHandle& StartingHandle
)

 Walk the hierarchy up to find the AActor root for the given handle SubobjectDataSubsystem.h  

static void RenameSubobjectMemberVariable ( UBlueprint* BPContext,
const FSubobjectDataHandle& InHandle,
const FName NewName
)

   SubobjectDataSubsystem.h
  • BlueprintCallable
  • Category="SubobjectDataSubsystem"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page