FEditorModeRegistry

A registry of editor modes and factories

Windows
MacOS
Linux

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/EditorModeRegistry.h

Include

#include "EditorModeRegistry.h"

Syntax

class FEditorModeRegistry

Remarks

A registry of editor modes and factories

Functions

Name Description

Public function

TSharedPtr< FEdMode >

 

CreateMode

(
    FEditorModeID ModeID,
    FEditorModeTools& Owner
)

Create a new instance of the mode registered under the specified ID

Public function

UEdMode *

 

CreateScriptableMode

(
    FEditorModeID ModeID,
    FEditorModeTools& Owner
)

Create a new instance of the mode registered under the specified ID

Public function

 

DECLARE_EVENT

(
    FEditorModeRegistry,
    FRegisteredModesChangedEvent
)

Event that is triggered whenever a mode is registered or unregistered

Public function

 

DECLARE_EVENT_OneParam

(
    FEditorModeRegistry,
    FOnModeUnregistered,
    FEditorModeID
)

Event that is triggered whenever a mode is unregistered

Public function

 

DECLARE_EVENT_OneParam

(
    FEditorModeRegistry,
    FOnModeRegistered,
    FEditorModeID
)

Event that is triggered whenever a mode is registered

Public function Static

FEditorModeRegistry &

 

Get()

Singleton access

Public function Const

const FactoryMap &

 

GetFactoryMap()

Const access to the internal factory map

Public function Const

FEditorModeInfo

 

GetModeInfo

(
    FEditorModeID ModeID
)

Get a currently registered mode information for specified ID

Public function Const

TArray< FEditorModeInfo >

 

GetSortedModeInfo()

Get a list of information for all currently registered modes, sorted by UI priority order

Public function Static

void

 

Initialize()

Initialize this registry

Public function

FOnModeRegistered &

 

OnModeRegistered()

Public function

FOnModeUnregistered &

 

OnModeUnregistered()

Public function

FRegisteredModesChangedEvent &

 

OnRegisteredModesChanged()

Public function

void

 

RegisterMode

(
    FEditorModeID ModeID,
    TSharedRef< IEditorModeFactory > Factory
)

Registers an editor mode. Typically called from a module's StartupModule() routine.

Public function

void

 

RegisterMode

(
    FEditorModeID ModeID,
    FText Name,
    FSlateIcon IconBrush,
    bool bVisible,
    int32 PriorityOrder
)

Registers an editor mode type. Typically called from a module's StartupModule() routine.

Public function Static

void

 

Shutdown()

Shutdown this registry

Public function

void

 

UnregisterMode

(
    FEditorModeID ModeID
)

Unregisters an editor mode.

Typedefs

Name

Description

FactoryMap

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback