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

Inheritance Hierarchy

References

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

Syntax

class USubobjectDataSubsystem : public UEngineSubsystem

Remarks

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.

Functions

  Type Name Description
Public function FSubobjectDataHandle

AddNewSubobject ( const FAddNewSubobjectParams& Params,
FText& FailReason
)

 Add a new subobject as a child to the given parent object
Public function bool

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

 Add the given subobject to a new owner.
Public function FScopedTransaction *

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

  
Public function Const bool Returns true if the given array of handles represents subobjects that can be copied.
Public function Const bool

CanPasteSubobjects ( const FSubobjectDataHandle& RootHandle,
UBlueprint* BPContext
)

  
Public function bool

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

 Attempts to change the subclass of a native component
Public function void

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

  
Public function 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
Public function 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
Public function int32

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

 Attempts to delete the given subobject from its blueprint context
Public function int32

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

 Attempts to delete the given array of subobjects from their context
Public function 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
Public function bool

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

 Remove the child subobject from the owner
Public function void

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

 Duplicate the given array of subobjects on the context.
Public function Const FSubobjectDataHandle

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

 Attempt to find an existing handle for the given object.
Public function Const FSubobjectDataHandle Find the scene root for a given subobject handle.
Public function void Gather all subobjects that the given UObject context has.
Public function Static USubobjectDataSubsystem *

Get ()

 Static wrapper for getting this engine subsystem.
Public function Static FSubobjectDataHandle

GetActorRootHandle ( const FSubobjectDataHandle& StartingHandle
)

 Walk the hierarchy up to find the AActor root for the given handle
Public function Const FSubobjectFactoryManager *  
Public function Const bool

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

 Returns true if the given new text is a valid option to rename the subobject with the given handle.
Public function int32

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

 Attempts to delete the given subobject from its context
Public function int32

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

 Attempts to delete the given array of subobjects from their context
Public function Const bool Attempt to find the subobject data for a given handle.
Public function void Gather all subobjects that the given Blueprint context has.
Public function void Gather all subobjects that the given actor instance has.
Public function bool

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

  
Public function FOnNewSubobjectAdded & Delegate invoked when a new subobject is successfully added
Public function void

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

  
Public function bool

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

 Attempts to rename the given subobject to the new name.
Public function Static void

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

  
Public function bool

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

 Attempts to reparent the given subobject to the new parent
Public function bool

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

 Attempts to reparent all subobjects in the HandlesToMove array to the new parent handle.

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system
Public function Virtual void Implement this for initialization of instances of the system

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page