1. Epic GamesDeveloper
  3. UEditorUtilitySubsystem

UEditorUtilitySubsystem

API > API/Editor > API/Editor/Blutility

   
Name UEditorUtilitySubsystem
Type class
Header File /Engine/Source/Editor/Blutility/Public/EditorUtilitySubsystem.h
Include Path #include "EditorUtilitySubsystem.h"

Syntax

UCLASS (MinimalAPI, Config=EditorPerProjectUserSettings)  
class UEditorUtilitySubsystem : public UEditorSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UEditorUtilitySubsystem()

   EditorUtilitySubsystem.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
LoadedUIs TArray< FSoftObjectPath >   EditorUtilitySubsystem.h
  • Config
OnBeginPIE FOnEditorUtilityPIEEvent Expose Begin PIE to blueprints. EditorUtilitySubsystem.h
  • BlueprintAssignable
OnEndPIE FOnEditorUtilityPIEEvent Expose End PIE to blueprints. EditorUtilitySubsystem.h
  • BlueprintAssignable
RegisteredTabs TMap< FName, UEditorUtilityWidgetBlueprint * >   EditorUtilitySubsystem.h  
RegisteredTabsByGeneratedClass TMap< FName, UWidgetBlueprintGeneratedClass * >   EditorUtilitySubsystem.h  
StartupObjects TArray< FSoftObjectPath >   EditorUtilitySubsystem.h
  • Config

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveTaskStack TArray< TObjectPtr< UEditorUtilityTask > >   EditorUtilitySubsystem.h
  • Transient
CancelAllTasksCommandObject IConsoleObject *   EditorUtilitySubsystem.h  
ObjectInstances TMap< TObjectPtr< UObject >, TObjectPtr< UObject > >   EditorUtilitySubsystem.h  
PendingTasks TMap< TObjectPtr< UEditorUtilityTask >, TArray< TObjectPtr< UEditorUtilityTask > > > AddReferencedObjects is used to report these references to GC. EditorUtilitySubsystem.h  
ReferencedObjects TSet< TObjectPtr< UObject > > List of objects that are being kept alive by this subsystem. EditorUtilitySubsystem.h  
RunTaskCommandBuffer TQueue< TArray< FString > >   EditorUtilitySubsystem.h  
RunTaskCommandObject IConsoleObject *   EditorUtilitySubsystem.h  
TickerHandle FTSTicker::FDelegateHandle   EditorUtilitySubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanRun ( UObject* Asset
) const

   EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

bool CloseTabByID ( FName NewTabID
)

 Given an ID for a tab, try to find and close an existing tab. EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

virtual void Deinitialize()

   EditorUtilitySubsystem.h  

bool DoesTabExist ( FName NewTabID
)

 Given an ID for a tab, try to find an existing tab. Returns true if it found a tab. EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"
Given an editor utility widget blueprint, get the widget it creates. EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

void HandleStartup()

   EditorUtilitySubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   EditorUtilitySubsystem.h  

void MainFrameCreationFinished ( TSharedPtr< SWindow > InRootWindow,
bool bIsRunningStartupDialog
)

   EditorUtilitySubsystem.h  

void RegisterAndExecuteTask ( UEditorUtilityTask* NewTask,
UEditorUtilityTask* OptionalParentTask
)

   EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

void RegisterReferencedObject ( UObject* ObjectToReference
)

   EditorUtilitySubsystem.h  

void RegisterTabAndGetID ( UEditorUtilityWidgetBlueprint* InBlueprint,
FName& NewTabID
)

   EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

void RegisterTabAndGetIDGeneratedClass ( UWidgetBlueprintGeneratedClass* InGeneratedWidgetBlueprint,
FName& NewTabID
)

   EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

void ReleaseInstanceOfAsset ( UObject* Asset
)

 Allow startup object to be garbage collected. EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

void RemoveTaskFromActiveList ( UEditorUtilityTask* Task
)

   EditorUtilitySubsystem.h  

UEditorUtilityWidget * SpawnAndRegisterTab ( UEditorUtilityWidgetBlueprint* InBlueprint
)

   EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

UEditorUtilityWidget * SpawnAndRegisterTabAndGetID ( UEditorUtilityWidgetBlueprint* InBlueprint,
FName& NewTabID
)

   EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

UEditorUtilityWidget * SpawnAndRegisterTabAndGetIDGeneratedClass ( UWidgetBlueprintGeneratedClass* InGeneratedWidgetBlueprint,
FName& NewTabID
)

   EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

UEditorUtilityWidget * SpawnAndRegisterTabGeneratedClass ( UWidgetBlueprintGeneratedClass* InGeneratedWidgetBlueprint
)

   EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

UEditorUtilityWidget * SpawnAndRegisterTabWithId ( UEditorUtilityWidgetBlueprint* InBlueprint,
FName InTabID
)

 Unlike SpawnAndRegisterTabAndGetID allows spawn tab while providing TabID from Python scripts or BP EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

UEditorUtilityWidget * SpawnAndRegisterTabWithIdGeneratedClass ( UWidgetBlueprintGeneratedClass* InGeneratedWidgetBlueprint,
FName InTabID
)

 Unlike SpawnAndRegisterTabAndGetID allows spawn tab while providing TabID from Python scripts or BP EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

bool SpawnRegisteredTabByID ( FName NewTabID
)

 Given an ID for a tab, try to find a tab spawner that matches, and then spawn a tab. EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

bool TryRun ( UObject* Asset
)

   EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

bool TryRunClass ( UClass* ObjectClass
)

   EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

void UnregisterReferencedObject ( UObject* ObjectToReference
)

   EditorUtilitySubsystem.h  

bool UnregisterTabByID ( FName TabID
)

 Given an ID for a tab, try to close and unregister a tab that was registered through this subsystem EditorUtilitySubsystem.h
  • BlueprintCallable
  • Category="Development|Editor"

Protected

Name Remarks Include Path Unreal Specifiers

void CancelAllTasksCommand ( const TArray< FString >& Params,
UWorld* InWorld,
FOutputDevice& Ar
)

   EditorUtilitySubsystem.h  

UClass * FindBlueprintClass ( const FString& TargetNameRaw
)

   EditorUtilitySubsystem.h  

UClass * FindClassByName ( const FString& RawTargetName
)

   EditorUtilitySubsystem.h  

UEditorUtilityTask * GetActiveTask()

   EditorUtilitySubsystem.h  

void HandleDynamicStartupAssets ( TConstArrayView< FAssetData > InAssets
)

   EditorUtilitySubsystem.h  

void HandleOnBeginPIE ( const bool bIsSimulating
)

 Called when Play in Editor begins. EditorUtilitySubsystem.h  

void HandleOnEndPIE ( const bool bIsSimulating
)

 Called when Play in Editor stops. EditorUtilitySubsystem.h  

void HandleStartupAssets()

   EditorUtilitySubsystem.h  

void OnBlueprintGeneratedClassUnloaded ( UBlueprintGeneratedClass* BPGC
)

   EditorUtilitySubsystem.h  

void OnMapChanged ( UWorld* World,
EMapChangeType MapChangeType
)

   EditorUtilitySubsystem.h  

void OnSpawnedFromGeneratedClassTabClosed ( TSharedRef< SDockTab > TabBeingClosed
)

   EditorUtilitySubsystem.h  

void ProcessRunTaskCommands()

   EditorUtilitySubsystem.h  

void RunTaskCommand ( const TArray< FString >& Params,
UWorld* InWorld,
FOutputDevice& Ar
)

   EditorUtilitySubsystem.h  

TSharedRef< SDockTab > SpawnEditorUITabFromGeneratedClass ( const FSpawnTabArgs& SpawnTabArgs,
UWidgetBlueprintGeneratedClass* InGeneratedWidgetBlueprint
)

   EditorUtilitySubsystem.h  

void StartTask ( UEditorUtilityTask* Task
)

   EditorUtilitySubsystem.h  

bool Tick ( float DeltaTime
)

   EditorUtilitySubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

   EditorUtilitySubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page