Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > LevelEditor > FLevelEditorModule

Light Theme

Dark Theme

FLevelEditorModule

Level editor module

Inheritance Hierarchy

IModuleInterface

IHasMenuExtensibility

IHasToolBarExtensibility

FLevelEditorModule

References

Module	LevelEditor
Header	/Engine/Source/Editor/LevelEditor/Public/LevelEditor.h
Include	#include "LevelEditor.h"

Syntax

class FLevelEditorModule :
    public IModuleInterface,
    public IHasMenuExtensibility,
    public IHasToolBarExtensibility

Remarks

Level editor module

Constructors

	Name	Description
	FLevelEditorModule()	Constructor, set up console commands and variables

Functions

	Name	Description
void	AddCustomClassFilterToOutliner ( TSharedRef< FCustomClassFilterData ... )	Add a custom class filter to the outliner filter bar.
void	AddCustomFilterToOutliner ( FLevelEditorOutlinerSettings::FOutl... )	Add a custom filter to the outliner filter bar.
void	AddEditableObjectPredicate ( const FAreObjectsEditable& InPredi... )	Add a delegate that will get called to check whether the specified objects should be editable on the details panel or not
void	AddTitleBarItem ( FName InTitleBarIdentifier, const FTitleBarItem& InTitleBarITe... )
bool	AreObjectsEditable ( const TArray< TWeakObjectPtr< UObje... )	Check whether the specified objects are editable
TSharedPtr< ...	AssembleExtenders ( TSharedRef< FUICommandList >& InCo..., TArray< FLevelEditorMenuExtender > ... )
TSharedPtr< ...	AttachSequencer ( TSharedPtr< SWidget > SequencerWidg..., TSharedPtr< class IAssetEditorInsta... )	Spawns a new sequencer tab if one doesn't exist already
void	BroadcastActorSelectionChanged ( const TArray< UObject* >& New..., bool bForceRefresh )	Called when actor selection changes
void	BroadcastComponentsEdited()	Called when an edit command is executed on one or more components in the world
void	BroadcastElementSelectionChanged ( const UTypedElementSelectionSet..., bool bForceRefresh )	Called when element selection changes
void	BroadcastMapChanged ( UWorld* World, EMapChangeType MapChangeType )	Called by the engine when a new map is loaded
void	BroadcastOverridePropertyEditorSelection ( const TArray< AActor* >& NewS..., bool bForceRefresh )	Called to set property editors to show the given actors, even if those actors aren't in the current selection set
void	BroadcastRedrawViewports ( bool bInvalidateHitProxies )	Called by the engine when level editing viewports need to be redrawn
void	BroadcastTakeHighResScreenShots()	Called by the engine when level editing viewports need to take a high res screenshot
void	BroadcastTitleBarMessagesChanged()
void	FocusPIEViewport()	Called to focus the level editor that has a play in editor viewport
void	FocusViewport()	Called to focus the level editor viewport
TArray< FLev...	GetAllLevelEditorLevelMenuExtenders()
TArray< TSha...	GetAllLevelEditorToolbarBlueprintsMenuExtenders()
TArray< FLev...	GetAllLevelEditorToolbarBuildMenuExtenders()
TArray< TSha...	GetAllLevelEditorToolbarCinematicsMenuExtenders()
TArray< FLev...	GetAllLevelEditorToolbarCompileMenuExtenders()
TArray< FLev...	GetAllLevelEditorToolbarCreateMenuExtenders()
TArray< FLev...	GetAllLevelEditorToolbarPlayMenuExtenders()
TArray< FLev...	GetAllLevelEditorToolbarSourceControlMenuExtenders()
TArray< FLev...	GetAllLevelEditorToolbarViewMenuExtenders()
TArray< FLev...	GetAllLevelViewportContextMenuExtenders()
TArray< FLev...	GetAllLevelViewportDragDropContextMenuExtenders()
TArray< FLev...	GetAllLevelViewportOptionsMenuExtenders()
TArray< FLev...	GetAllLevelViewportShowMenuExtenders()
TSharedPtr< ...	GetFirstActiveLevelViewport()	Gets the first active viewport of all the viewports.
TSharedPtr< ...	GetFirstActiveViewport()	Gets the first active viewport of all the viewports.
TSharedPtr< ...	GetFirstLevelEditor()
const TShare...	GetGlobalLevelEditorActions()
const FLevel...	GetLevelEditorCommands()	Method for getting level editor commands outside of this module
TWeakPtr< cl...	GetLevelEditorInstance()
TWeakPtr< cl...	GetLevelEditorInstanceTab()
const FLevel...	GetLevelEditorModesCommands()	Method for getting level editor modes commands outside of this module
TSharedPtr< ...	GetLevelEditorOutlinerSettings()	Return the settings (containing the outliner filters) used to create the level editor's outliners
TSharedPtr< ...	GetLevelEditorTab()
TSharedPtr< ...	GetLevelEditorTabManager()
const FLevel...	GetLevelViewportCommands()	Method for getting level viewport commands outside of this module
TSharedPtr< ...	GetModeBarExtensibilityManager()
TSharedPtr< ...	GetOutlinerFilterCategory ( const FName& CategoryName )	Get the FFilterCategory attached to the given category name.
const TMap< ...	GetTitleBarItems()
void	GoImmersiveWithActiveLevelViewport ( const bool bForceGameView )	Takes the first active viewport and switches it to immersive mode.
void	IterateViewportTypes ( TFunctionRef< void(FName, const FVi... )	Iterate all registered viewport types
FActorSelect...	OnActorSelectionChanged()
FCaptureSing...	OnCaptureSingleFrameAnimSequence()
FComponentsE...	OnComponentsEdited()
FElementSele...	OnElementSelectionChanged()
FOnLevelEdit...	OnLevelEditorCreated()
FMapChangedE...	OnMapChanged()
FOverridePro...	OnOverridePropertyEditorSelection()
FRedrawLevel...	OnRedrawLevelEditingViewports()
FOnRegisterL...	OnRegisterLayoutExtensions()
FOnRegisterT...	OnRegisterTabs()
FTabContentC...	OnTabContentChanged()
FTabManagerC...	OnTabManagerChanged()
FTakeHighRes...	OnTakeHighResScreenShots()
FTitleBarMes...	OnTitleBarMessagesChanged()
void	RegisterViewportType ( FName InLayoutName, const FViewportTypeDefinition& InD... )	Register a viewport type for the level editor
void	RemoveEditableObjectPredicate ( FDelegateHandle InPredicateHandle )	Remove a delegate that was added via AddEditableObjectPredicate
void	RemoveTitleBarItem ( FName InTitleBarIdentifier )
void	SetLevelEditorInstance ( TWeakPtr< class SLevelEditor > Leve... )	Set the pointer to the current level Editor instance
void	SetLevelEditorInstanceTab ( TWeakPtr< class SDockTab > LevelEdi... )	Set the pointer to the level editor tab
void	SetLevelEditorTabManager ( const TSharedPtr< SDockTab >& Owne... )	Create a tab manager for the level editor based on the given tab (or clears the tab manager if OwnerTab is null)
void	StartPlayInEditorSession()	Starts a play in editor session using the active viewport
void	SummonBuildAndSubmit()	Spawns a new build and submit widget
void	SummonSelectionDetails()	Spawns a new property viewer Spawns a new property viewer
void	SummonWorldBrowserComposition()
void	SummonWorldBrowserDetails()
void	SummonWorldBrowserHierarchy()
void	ToggleImmersiveOnActiveLevelViewport()	Toggles immersive mode on the currently active level viewport
void	UnregisterViewportType ( FName InLayoutName )	Unregister a previously registered viewport type

Overridden from IModuleInterface

	Name	Description
void	ShutdownModule()	Called before the module is unloaded, right before the module object is destroyed.
void	StartupModule()	Called right after the module DLL has been loaded and the module object has been created
bool	SupportsDynamicReloading()	Override this to set whether your module is allowed to be unloaded on the fly

Overridden from IHasMenuExtensibility

		Name	Description
	TSharedPtr< ...	GetMenuExtensibilityManager()	Gets the extensibility managers for outside entities to extend static mesh editor's menus and toolbars

Overridden from IHasToolBarExtensibility

		Name	Description
	TSharedPtr< ...	GetToolBarExtensibilityManager()

Classes

	Name	Description
	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.
	FTitleBarItem	Add / Remove title bar item
	FTitleBarMessagesChanged	Called when a new map is loaded

Typedefs

Name	Description
FCaptureSingleFrameAnimSequence	Delegate used to capture skeltal meshes to single-frame animations when 'keeping simulation changes'
FLevelEditorMenuExtender	Delegates to be called to extend the level viewport menus
FLevelViewportMenuExtender_SelectedActors
FLevelViewportMenuExtender_SelectedObjects

Deprecated Functions

		Name	Description
	void	AddCustomFilterToOutliner ( TSharedRef< FFilterBase< const ISce... )	Use the AddCustomFilterToOutliner override that takes in a delegate instead so each Outliner can have a unique instance of the filter
	TSharedRef< ...	FactoryViewport ( FName InTypeName, const FAssetEditorViewportConstruct... )	Use FactoryViewport from inside of a FLevelViewportTabContent.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel