Language:
Discover
By Skill Level
By Category

FEditorModeRegistry

Choose your OS:

Syntax

class FEditorModeRegistry

Remarks

A registry of editor modes and factories

Functions

Name Description

Public function

TSharedPtr < ...

 

CreateMode

(
    FEditorModeID ModeID,
    FEditorModeTools & Owner
)

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

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

Get()

Singleton access

Public function

const Factor ...

 

GetFactoryMap()

Const access to the internal factory map

Public function

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

GetModeInfo

(
    FEditorModeID ModeID
)

Get a currently registered mode information for specified ID

Public function

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

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

FOnModeRegis ...

 

OnModeRegistered()

Public function

FOnModeUnreg ...

 

OnModeUnregistered()

Public function

FRegisteredM ...

 

OnRegisteredModesChanged()

Public function

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

RegisterMode

(
    FEditorModeID ModeID,
    TSharedRef < IEditorModeFactory > Fa...
)

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

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

UnregisterMode

(
    FEditorModeID ModeID
)

Unregisters an editor mode.

Classes

Name

Description

Public class

FOnModeRegistered

Event that is triggered whenever a mode is registered

Public class

FOnModeUnregistered

Event that is triggered whenever a mode is unregistered

Public class

FRegisteredModesChangedEvent

Event that is triggered whenever a mode is registered or unregistered

Typedefs

Name

Description

FactoryMap

References

Module

UnrealEd

Header

Editor/UnrealEd/Public/EditorModeRegistry.h