Navigation
API > API/Editor > API/Editor/UnrealEd
Subsystem that allows the capture & restoration of editor states.
| Name | UEditorStateSubsystem |
| Type | class |
| Header File | /Engine/Source/Editor/UnrealEd/Public/EditorState/EditorStateSubsystem.h |
| Include Path | #include "EditorState/EditorStateSubsystem.h" |
Syntax
UCLASS (MinimalAPI)
class UEditorStateSubsystem : public UEditorSubsystem
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UEditorSubsystem → UEditorStateSubsystem
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsRestoringEditorState | bool | EditorState/EditorStateSubsystem.h | ||
| RegisteredEditorStateTypes | TArray< TSubclassOf< UEditorState > > | EditorState/EditorStateSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CaptureEditorState
(
FEditorStateCollection& OutState, |
Captures the state of the editor using all the registered EditorState subclasses. | EditorState/EditorStateSubsystem.h | |
void CaptureEditorState
(
FEditorStateCollection& OutState, |
Captures the state of the editor using all the registered EditorState subclasses. | EditorState/EditorStateSubsystem.h | |
virtual void Deinitialize() |
EditorState/EditorStateSubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
EditorState/EditorStateSubsystem.h | ||
bool IsRestoringEditorState() |
Returns true if the subsystem is currently restoring an editor state. | EditorState/EditorStateSubsystem.h | |
void RestoreEditorState
(
const FEditorStateCollection& InState |
Restore the state of the editor using a state collection previously captured with CaptureEditorState(). | EditorState/EditorStateSubsystem.h | |
void RestoreEditorState
(
const FEditorStateCollection& InState, |
Restore the state of the editor using a state collection previously captured with CaptureEditorState(). | EditorState/EditorStateSubsystem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UEditorStateSubsystem * Get () |
Utility method to retrieve the subsystem. | EditorState/EditorStateSubsystem.h | |
static TEnableIf< TIsDerivedFrom< TEditorStateType, UEditorState >::IsDerived, void >::Type RegisterEditorStateType () |
Register an EditorState type so that it can be captured in the next CaptureEditorState() calls. | EditorState/EditorStateSubsystem.h | |
static TEnableIf< TIsDerivedFrom< TEditorStateType, UEditorState >::IsDerived, void >::Type UnregisterEditorStateType () |
Unregister a previously registed EditorState type. | EditorState/EditorStateSubsystem.h |