1. Epic GamesDeveloper
  3. FLevelEditorModule

FLevelEditorModule

Level editor module

API > API/Editor > API/Editor/LevelEditor

Level editor module

   
Name FLevelEditorModule
Type class
Header File /Engine/Source/Editor/LevelEditor/Public/LevelEditor.h
Include Path #include "LevelEditor.h"

Syntax

class FLevelEditorModule :  
    public IModuleInterface,  
    public IHasMenuExtensibility,  
    public IHasToolBarExtensibility

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FLevelEditorModule()

 Constructor, set up console commands and variables LevelEditor.h  

Classes

Name Remarks
FActorSelectionChangedEvent Called when actor selection changes
FComponentsEditedEvent Called when an edit command is executed on components in the world
FElementSelectionChangedEvent Called when element selection changes
FMapChangedEvent Called when a new map is loaded
FOnLevelEditorCreated Called when a level editor widget has been created
FOnRegisterLayoutExtensions  
FOnRegisterTabs  
FOverridePropertyEditorSelectionEvent Called to set property editors to show the given actors, even if those actors aren't in the current selection set
FRedrawLevelEditingViewportsEvent Called when level editor viewports should be redrawn
FTabContentChangedEvent Called when the tab content is changed
FTabManagerChangedEvent Called when the tab manager is changed
FTakeHighResScreenShotsEvent Called when a high res screenshot is requested.
FTitleBarMessagesChanged Called when a new map is loaded

Structs

Name Remarks
FTitleBarItem Add / Remove title bar item

Typedefs

Name Type Remarks Include Path
FCaptureSingleFrameAnimSequence TBaseDelegate_OneParam< UAnimSequence *, USkeletalMeshComponent * > Delegate used to capture skeltal meshes to single-frame animations when 'keeping simulation changes' LevelEditor.h
FLevelEditorMenuExtender TBaseDelegate_OneParam< TSharedRef< FExtender >, const TSharedRef< FUICommandList > > Delegates to be called to extend the level viewport menus LevelEditor.h
FLevelViewportMenuExtender_SelectedActors TBaseDelegate_TwoParams< TSharedRef< FExtender >, const TSharedRef< FUICommandList >, const TArray< AActor * > >   LevelEditor.h
FLevelViewportMenuExtender_SelectedObjects TBaseDelegate_TwoParams< TSharedRef< FExtender >, const TSharedRef< FUICommandList >, const TArray< UObject * > >   LevelEditor.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActorSelectionChangedEvent FActorSelectionChangedEvent Multicast delegate executed when actor selection changes LevelEditor.h  
AreObjectsEditableDelegates TArray< FAreObjectsEditable > Array of delegates that are used to check if the specified objects should be editable on the details panel LevelEditor.h  
CaptureSingleFrameAnimSequenceDelegate FCaptureSingleFrameAnimSequence Delegate used to capture skeltal meshes to single-frame animations when 'keeping simulation changes' LevelEditor.h  
ComponentsEditedEvent FComponentsEditedEvent Multicast delegate executed after components are edited in the world LevelEditor.h  
CustomViewports TMap< FName, FViewportTypeDefinition > Map of named viewport types to factory functions LevelEditor.h  
ElementSelectionChangedEvent FElementSelectionChangedEvent Multicast delegate executed when element selection changes LevelEditor.h  
GlobalLevelEditorActions TSharedPtr< FUICommandList > A command list that can be passed around and isn't bound to an instance of a level editor. LevelEditor.h  
LevelEditorCreatedEvent FOnLevelEditorCreated Multicast delegate executed when a level editor has been created LevelEditor.h  
LevelEditorInstancePtr TWeakPtr< class SLevelEditor > Pointer to the current level Editor instance LevelEditor.h  
LevelEditorInstanceTabPtr TWeakPtr< class SDockTab > Pointer to the level editor tab LevelEditor.h  
LevelEditorLevelMenuExtenders TArray< FLevelEditorMenuExtender >   LevelEditor.h  
LevelEditorTabManager TSharedPtr< FTabManager > Holds the Editor's tab manager LevelEditor.h  
LevelEditorToolbarBlueprintsMenuExtenders TArray< TSharedPtr< FExtender > >   LevelEditor.h  
LevelEditorToolbarBuildMenuExtenders TArray< FLevelEditorMenuExtender >   LevelEditor.h  
LevelEditorToolbarCinematicsMenuExtenders TArray< TSharedPtr< FExtender > >   LevelEditor.h  
LevelEditorToolbarCompileMenuExtenders TArray< FLevelEditorMenuExtender >   LevelEditor.h  
LevelEditorToolbarCreateMenuExtenders TArray< FLevelEditorMenuExtender >   LevelEditor.h  
LevelEditorToolbarPlayMenuExtenders TArray< FLevelEditorMenuExtender >   LevelEditor.h  
LevelEditorToolbarSourceControlMenuExtenders TArray< FLevelEditorMenuExtender >   LevelEditor.h  
LevelEditorToolbarViewMenuExtenders TArray< FLevelEditorMenuExtender >   LevelEditor.h  
LevelViewportContextMenuExtenders TArray< FLevelViewportMenuExtender_SelectedActors >   LevelEditor.h  
LevelViewportDragDropContextMenuExtenders TArray< FLevelViewportMenuExtender_SelectedObjects > All extender delegates for the level viewport menus LevelEditor.h  
LevelViewportOptionsMenuExtenders TArray< FLevelEditorMenuExtender >   LevelEditor.h  
LevelViewportShowMenuExtenders TArray< FLevelEditorMenuExtender >   LevelEditor.h  
MapChangedEvent FMapChangedEvent Multicast delegate executed when a map is changed (loaded,saved,new map, etc) LevelEditor.h  
MenuExtensibilityManager TSharedPtr< FExtensibilityManager >   LevelEditor.h  
ModeBarExtensibilityManager TSharedPtr< FExtensibilityManager >   LevelEditor.h  
NotificationBarExtensibilityManager TSharedPtr< FExtensibilityManager >   LevelEditor.h  
OutlinerSettings TSharedPtr< FLevelEditorOutlinerSettings > The settings used to create any Outliners in the Level Editor LevelEditor.h  
OverridePropertyEditorSelectionEvent FOverridePropertyEditorSelectionEvent Multicast delegate executed to set property editors to show the given actors, even if those actors aren't in the current selection set LevelEditor.h  
RedrawLevelEditingViewportsEvent FRedrawLevelEditingViewportsEvent Multicast delegate executed when viewports should be redrawn LevelEditor.h  
RegisterLayoutExtensions FOnRegisterLayoutExtensions Register layout extensions event LevelEditor.h  
RegisterTabs FOnRegisterTabs Register external tabs event LevelEditor.h  
TabContentChangedEvent FTabContentChangedEvent Multicast delegate executed when the tab content is changed LevelEditor.h  
TabManagerChangedEvent FTabManagerChangedEvent Multicast delegate executed when the tab manager is changed LevelEditor.h  
TakeHighResScreenShotsEvent FTakeHighResScreenShotsEvent Multicast delegate executed when viewports should be redrawn LevelEditor.h  
TitleBarItems TMap< FName, FTitleBarItem >   LevelEditor.h  
TitleBarMessagesChangedEvent FTitleBarMessagesChanged   LevelEditor.h  
ToggleImmersiveConsoleCommand FAutoConsoleCommand   LevelEditor.h  
ToolBarExtensibilityManager TSharedPtr< FExtensibilityManager >   LevelEditor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddCustomClassFilterToOutliner ( TSharedRef< FCustomClassFilterData > InCustomClassFilterData
)

 Add a custom class filter to the outliner filter bar. LevelEditor.h  

virtual void AddCustomFilterToOutliner ( TSharedRef< FFilterBase< const ISceneOutlinerTreeItem& > > InCustomFilter
)

 Add a custom filter to the outliner filter bar. These are all AND'd together LevelEditor.h  

virtual void AddCustomFilterToOutliner ( FLevelEditorOutlinerSettings::FOutlinerFilterFactory InCreateCustomFilter
)

 Add a custom filter to the outliner filter bar. LevelEditor.h  

void AddEditableObjectPredicate ( const FAreObjectsEditable& InPredicate
)

 Add a delegate that will get called to check whether the specified objects should be editable on the details panel or not LevelEditor.h  

virtual void AddTitleBarItem ( FName InTitleBarIdentifier,
const FTitleBarItem& InTitleBarITem
)

   LevelEditor.h  

bool AreObjectsEditable ( const TArray< TWeakObjectPtr< UObject > >& InObjects
) const

 Check whether the specified objects are editable LevelEditor.h  

virtual TSharedPtr< FExtender > AssembleExtenders ( TSharedRef< FUICommandList >& InCommandList,
TArray< FLevelEditorMenuExtender >& MenuExtenderDelegates
) const

   LevelEditor.h  

virtual TSharedPtr< SDockTab > AttachSequencer ( TSharedPtr< SWidget > SequencerWidget,
TSharedPtr< class IAssetEditorInstance > SequencerAssetEditor
)

 Spawns a new sequencer tab if one doesn't exist already LevelEditor.h  

virtual void BroadcastActorSelectionChanged ( const TArray< UObject* >& NewSelection,
bool bForceRefresh
)

 Called when actor selection changes LevelEditor.h  

virtual void BroadcastComponentsEdited()

 Called when an edit command is executed on one or more components in the world LevelEditor.h  

virtual void BroadcastElementSelectionChanged ( const UTypedElementSelectionSet* SelectionSet,
bool bForceRefresh
)

 Called when element selection changes LevelEditor.h  

virtual void BroadcastMapChanged ( UWorld* World,
EMapChangeType MapChangeType
)

 Called by the engine when a new map is loaded LevelEditor.h  

virtual void BroadcastOverridePropertyEditorSelection ( const TArray< AActor* >& NewSelection,
bool bForceRefresh
)

 Called to set property editors to show the given actors, even if those actors aren't in the current selection set LevelEditor.h  

virtual void BroadcastRedrawViewports ( bool bInvalidateHitProxies
)

 Called by the engine when level editing viewports need to be redrawn LevelEditor.h  

virtual void BroadcastTakeHighResScreenShots()

 Called by the engine when level editing viewports need to take a high res screenshot LevelEditor.h  

virtual void BroadcastTitleBarMessagesChanged()

   LevelEditor.h  

TSharedRef< ILevelViewportLayoutEntity > FactoryViewport ( FName InTypeName,
const FAssetEditorViewportConstructionArgs& ConstructionArgs
) const

 Create an instance of a custom viewport from the specified viewport type name LevelEditor.h  

virtual void FocusPIEViewport()

 Called to focus the level editor that has a play in editor viewport LevelEditor.h  

virtual void FocusViewport()

 Called to focus the level editor viewport LevelEditor.h  

virtual TArray< FLevelEditorMenuExtender > & GetAllLevelEditorLevelMenuExtenders()

   LevelEditor.h  

virtual TArray< TSharedPtr< FExtender > > & GetAllLevelEditorToolbarBlueprintsMenuExtenders()

   LevelEditor.h  

virtual TArray< FLevelEditorMenuExtender > & GetAllLevelEditorToolbarBuildMenuExtenders()

   LevelEditor.h  

virtual TArray< TSharedPtr< FExtender > > & GetAllLevelEditorToolbarCinematicsMenuExtenders()

   LevelEditor.h  

virtual TArray< FLevelEditorMenuExtender > & GetAllLevelEditorToolbarCompileMenuExtenders()

   LevelEditor.h  

virtual TArray< FLevelEditorMenuExtender > & GetAllLevelEditorToolbarCreateMenuExtenders()

   LevelEditor.h  

virtual TArray< FLevelEditorMenuExtender > & GetAllLevelEditorToolbarPlayMenuExtenders()

   LevelEditor.h  

virtual TArray< FLevelEditorMenuExtender > & GetAllLevelEditorToolbarSourceControlMenuExtenders()

   LevelEditor.h  

virtual TArray< FLevelEditorMenuExtender > & GetAllLevelEditorToolbarViewMenuExtenders()

   LevelEditor.h  

virtual TArray< FLevelViewportMenuExtender_SelectedActors > & GetAllLevelViewportContextMenuExtenders()

   LevelEditor.h  

virtual TArray< FLevelViewportMenuExtender_SelectedObjects > & GetAllLevelViewportDragDropContextMenuExtenders()

   LevelEditor.h  

virtual TArray< FLevelEditorMenuExtender > & GetAllLevelViewportOptionsMenuExtenders()

   LevelEditor.h  

virtual TArray< FLevelEditorMenuExtender > & GetAllLevelViewportShowMenuExtenders()

   LevelEditor.h  

virtual TSharedPtr< class SLevelViewport > GetFirstActiveLevelViewport()

 Gets the first active viewport of all the viewports. LevelEditor.h  

virtual TSharedPtr< class IAssetViewport > GetFirstActiveViewport()

 Gets the first active viewport of all the viewports. LevelEditor.h  

virtual TSharedPtr< class ILevelEditor > GetFirstLevelEditor()

   LevelEditor.h  

virtual const TSharedRef< FUICommandList > GetGlobalLevelEditorActions()

   LevelEditor.h  

virtual const FLevelEditorCommands & GetLevelEditorCommands()

 Method for getting level editor commands outside of this module LevelEditor.h  

virtual TWeakPtr< class ILevelEditor > GetLevelEditorInstance()

   LevelEditor.h  

virtual TWeakPtr< class SDockTab > GetLevelEditorInstanceTab()

   LevelEditor.h  

virtual const FLevelEditorModesCommands & GetLevelEditorModesCommands()

 Method for getting level editor modes commands outside of this module LevelEditor.h  

virtual TSharedPtr< FLevelEditorOutlinerSettings > GetLevelEditorOutlinerSettings()

 Return the settings (containing the outliner filters) used to create the level editor's outliners LevelEditor.h  

virtual TSharedPtr< SDockTab > GetLevelEditorTab()

   LevelEditor.h  

virtual TSharedPtr< FTabManager > GetLevelEditorTabManager()

   LevelEditor.h  

virtual const FLevelViewportCommands & GetLevelViewportCommands()

 Method for getting level viewport commands outside of this module LevelEditor.h  

virtual TSharedPtr< FExtensibilityManager > GetMenuExtensibilityManager()

 Gets the extensibility managers for outside entities to extend static mesh editor's menus and toolbars LevelEditor.h  

virtual TSharedPtr< FExtensibilityManager > GetModeBarExtensibilityManager()

   LevelEditor.h  

virtual TSharedPtr< FFilterCategory > GetOutlinerFilterCategory ( const FName& CategoryName
) const

 Get the FFilterCategory attached to the given category name. LevelEditor.h  

const TMap< FName, FTitleBarItem > & GetTitleBarItems()

   LevelEditor.h  

virtual TSharedPtr< FExtensibilityManager > GetToolBarExtensibilityManager()

   LevelEditor.h  

virtual void GoImmersiveWithActiveLevelViewport ( const bool bForceGameView
)

 Takes the first active viewport and switches it to immersive mode. LevelEditor.h  

void IterateViewportTypes ( TFunctionRef< void(FName, const FViewportTypeDefinition&)> Iter
)

 Iterate all registered viewport types LevelEditor.h  

virtual FActorSelectionChangedEvent & OnActorSelectionChanged()

   LevelEditor.h  

virtual FCaptureSingleFrameAnimSequence & OnCaptureSingleFrameAnimSequence()

   LevelEditor.h  

virtual FComponentsEditedEvent & OnComponentsEdited()

   LevelEditor.h  

virtual FElementSelectionChangedEvent & OnElementSelectionChanged()

   LevelEditor.h  

virtual FOnLevelEditorCreated & OnLevelEditorCreated()

   LevelEditor.h  

virtual FMapChangedEvent & OnMapChanged()

   LevelEditor.h  

virtual FOverridePropertyEditorSelectionEvent & OnOverridePropertyEditorSelection()

   LevelEditor.h  

virtual FRedrawLevelEditingViewportsEvent & OnRedrawLevelEditingViewports()

   LevelEditor.h  

FOnRegisterLayoutExtensions & OnRegisterLayoutExtensions()

   LevelEditor.h  

FOnRegisterTabs & OnRegisterTabs()

   LevelEditor.h  

virtual FTabContentChangedEvent & OnTabContentChanged()

   LevelEditor.h  

virtual FTabManagerChangedEvent & OnTabManagerChanged()

   LevelEditor.h  

virtual FTakeHighResScreenShotsEvent & OnTakeHighResScreenShots()

   LevelEditor.h  

virtual FTitleBarMessagesChanged & OnTitleBarMessagesChanged()

   LevelEditor.h  

void RegisterViewportType ( FName InLayoutName,
const FViewportTypeDefinition& InDefinition
)

 Register a viewport type for the level editor LevelEditor.h  

void RemoveEditableObjectPredicate ( FDelegateHandle InPredicateHandle
)

 Remove a delegate that was added via AddEditableObjectPredicate LevelEditor.h  

virtual void RemoveTitleBarItem ( FName InTitleBarIdentifier
)

   LevelEditor.h  

virtual void SetLevelEditorInstance ( TWeakPtr< class SLevelEditor > LevelEditor
)

 Set the pointer to the current level Editor instance LevelEditor.h  

virtual void SetLevelEditorInstanceTab ( TWeakPtr< class SDockTab > LevelEditorTab
)

 Set the pointer to the level editor tab LevelEditor.h  

virtual void SetLevelEditorTabManager ( const TSharedPtr< SDockTab >& OwnerTab
)

 Create a tab manager for the level editor based on the given tab (or clears the tab manager if OwnerTab is null) LevelEditor.h  

virtual void ShutdownModule()

 Called before the module is unloaded, right before the module object is destroyed. LevelEditor.h  

virtual void StartPlayInEditorSession()

 Starts a play in editor session using the active viewport LevelEditor.h  

virtual void StartupModule ()

 Called right after the module DLL has been loaded and the module object has been created LevelEditor.h  

virtual void SummonBuildAndSubmit()

 Spawns a new build and submit widget LevelEditor.h  

virtual void SummonSelectionDetails()

 Spawns a new property viewer Spawns a new property viewer LevelEditor.h  

virtual void SummonWorldBrowserComposition()

   LevelEditor.h  

virtual void SummonWorldBrowserDetails()

   LevelEditor.h  

virtual void SummonWorldBrowserHierarchy()

   LevelEditor.h  

virtual bool SupportsDynamicReloading()

 Override this to set whether your module is allowed to be unloaded on the fly LevelEditor.h  

virtual void ToggleImmersiveOnActiveLevelViewport()

 Toggles immersive mode on the currently active level viewport LevelEditor.h  

void UnregisterViewportType ( FName InLayoutName
)

 Unregister a previously registered viewport type LevelEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page