1. Epic GamesDeveloper
  3. FLevelEditorModule

FLevelEditorModule

Level editor module

Unreal Engine C++ API Reference > Editor > LevelEditor

Inheritance Hierarchy

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

  Type Name Description
Public function   Constructor, set up console commands and variables

Functions

  Type Name Description
Public function Virtual void Add a custom class filter to the outliner filter bar.
Public function void Add a custom filter to the outliner filter bar.
Public function 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
Public function Virtual void

AddTitleBarItem ( FName InTitleBarIdentifier,
const FTitleBarItem& InTitleBarITem
)

  
Public function Const bool

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

 Check whether the specified objects are editable
Public function Virtual Const TSharedPtr< FExtender >

AssembleExtenders ( TSharedRef< FUICommandList >& InCommandList,
TArray< FLevelEditorMenuExtender >& MenuExtenderDelegates
)

  
Public function Virtual TSharedPtr< SDockTab >

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

 Spawns a new sequencer tab if one doesn't exist already
Public function Virtual void

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

 Called when actor selection changes
Public function Virtual void Called when an edit command is executed on one or more components in the world
Public function Virtual void

BroadcastElementSelectionChanged ( const UTypedElementSelectionSet* SelectionSet,
bool bForceRefresh
)

 Called when element selection changes
Public function Virtual void

BroadcastMapChanged ( UWorld* World,
EMapChangeType MapChangeType
)

 Called by the engine when a new map is loaded
Public function 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
Public function Virtual void

BroadcastRedrawViewports ( bool bInvalidateHitProxies
)

 Called by the engine when level editing viewports need to be redrawn
Public function Virtual void Called by the engine when level editing viewports need to take a high res screenshot
Public function Virtual void  
Public function Virtual void Called to focus the level editor that has a play in editor viewport
Public function Virtual void Called to focus the level editor viewport
Public function Virtual TArray< FLevelEditorMenuExtender > &  
Public function Virtual TArray< TSharedPtr< FExtender > > &  
Public function Virtual TArray< FLevelEditorMenuExtender > &  
Public function Virtual TArray< TSharedPtr< FExtender > > &  
Public function Virtual TArray< FLevelEditorMenuExtender > &  
Public function Virtual TArray< FLevelEditorMenuExtender > &  
Public function Virtual TArray< FLevelEditorMenuExtender > &  
Public function Virtual TArray< FLevelEditorMenuExtender > &  
Public function Virtual TArray< FLevelEditorMenuExtender > &  
Public function Virtual TArray< FLevelViewportMenuExtender_SelectedActors > &  
Public function Virtual TArray< FLevelViewportMenuExtender_SelectedObjects > &  
Public function Virtual TArray< FLevelEditorMenuExtender > &  
Public function Virtual TArray< FLevelEditorMenuExtender > &  
Public function Virtual TSharedPtr< class SLevelViewport > Gets the first active viewport of all the viewports.
Public function Virtual TSharedPtr< class IAssetViewport > Gets the first active viewport of all the viewports.
Public function Virtual Const TSharedPtr< class ILevelEditor >  
Public function Virtual Const const TSharedRef< FUICommandList >  
Public function Virtual Const const FLevelEditorCommands & Method for getting level editor commands outside of this module
Public function Virtual Const TWeakPtr< class ILevelEditor >  
Public function Virtual Const TWeakPtr< class SDockTab >  
Public function Virtual Const const FLevelEditorModesCommands & Method for getting level editor modes commands outside of this module
Public function Const TSharedPtr< FLevelEditorOutlinerSettings > Return the settings (containing the outliner filters) used to create the level editor's outliners
Public function Virtual Const TSharedPtr< SDockTab >  
Public function Virtual Const TSharedPtr< FTabManager >  
Public function Virtual Const const FLevelViewportCommands & Method for getting level viewport commands outside of this module
Public function Virtual TSharedPtr< FExtensibilityManager >  
Public function Virtual Const TSharedPtr< FFilterCategory >

GetOutlinerFilterCategory ( const FName& CategoryName
)

 Get the FFilterCategory attached to the given category name.
Public function Const const TMap< FName, FTitleBarItem > &  
Public function Virtual void

GoImmersiveWithActiveLevelViewport ( const bool bForceGameView
)

 Takes the first active viewport and switches it to immersive mode.
Public function void Iterate all registered viewport types
Public function Virtual FActorSelectionChangedEvent &  
Public function Virtual FCaptureSingleFrameAnimSequence &  
Public function Virtual FComponentsEditedEvent &  
Public function Virtual FElementSelectionChangedEvent &  
Public function Virtual FOnLevelEditorCreated &  
Public function Virtual FMapChangedEvent &  
Public function Virtual FOverridePropertyEditorSelectionEvent &  
Public function Virtual FRedrawLevelEditingViewportsEvent &  
Public function FOnRegisterLayoutExtensions &  
Public function FOnRegisterTabs &  
Public function Virtual FTabContentChangedEvent &  
Public function Virtual FTabManagerChangedEvent &  
Public function Virtual FTakeHighResScreenShotsEvent &  
Public function Virtual FTitleBarMessagesChanged &  
Public function void

RegisterViewportType ( FName InLayoutName,
const FViewportTypeDefinition& InDefinition
)

 Register a viewport type for the level editor
Public function void Remove a delegate that was added via AddEditableObjectPredicate
Public function Virtual void

RemoveTitleBarItem ( FName InTitleBarIdentifier
)

  
Public function Virtual void

SetLevelEditorInstance ( TWeakPtr< class SLevelEditor > LevelEditor
)

 Set the pointer to the current level Editor instance
Public function Virtual void

SetLevelEditorInstanceTab ( TWeakPtr< class SDockTab > LevelEditorTab
)

 Set the pointer to the level editor tab
Public function Virtual void Create a tab manager for the level editor based on the given tab (or clears the tab manager if OwnerTab is null)
Public function Virtual void Starts a play in editor session using the active viewport
Public function Virtual void Spawns a new build and submit widget
Public function Virtual void Spawns a new property viewer Spawns a new property viewer
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void Toggles immersive mode on the currently active level viewport
Public function void

UnregisterViewportType ( FName InLayoutName
)

 Unregister a previously registered viewport type

Overridden from IModuleInterface

  Type Name Description
Public function Virtual void Called before the module is unloaded, right before the module object is destroyed.
Public function Virtual void Called right after the module DLL has been loaded and the module object has been created
Public function Virtual bool Override this to set whether your module is allowed to be unloaded on the fly

Overridden from IHasMenuExtensibility

  Type Name Description
Public function Virtual TSharedPtr< FExtensibilityManager > Gets the extensibility managers for outside entities to extend static mesh editor's menus and toolbars

Overridden from IHasToolBarExtensibility

  Type Name Description
Public function Virtual TSharedPtr< FExtensibilityManager >  

Classes

  Type Name Description
Public class FActorSelectionChangedEvent Called when actor selection changes  
Public class FComponentsEditedEvent Called when an edit command is executed on components in the world  
Public class FElementSelectionChangedEvent Called when element selection changes  
Public class FMapChangedEvent Called when a new map is loaded  
Public class FOnLevelEditorCreated Called when a level editor widget has been created  
Public class FOnRegisterLayoutExtensions    
Public class FOnRegisterTabs    
Public class FOverridePropertyEditorSelectionEvent Called to set property editors to show the given actors, even if those actors aren't in the current selection set  
Public class FRedrawLevelEditingViewportsEvent Called when level editor viewports should be redrawn  
Public class FTabContentChangedEvent Called when the tab content is changed  
Public class FTabManagerChangedEvent Called when the tab manager is changed  
Public class FTakeHighResScreenShotsEvent Called when a high res screenshot is requested.  
Public struct FTitleBarItem Add / Remove title bar item  
Public class 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

  Type Name Description
Public function Virtual void Use the AddCustomFilterToOutliner override that takes in a delegate instead so each Outliner can have a unique instance of the filter
Public function Const TSharedRef< ILevelViewportLayoutEntity >

FactoryViewport ( FName InTypeName,
const FAssetEditorViewportConstructionArgs& ConstructionArgs
)

 Use FactoryViewport from inside of a FLevelViewportTabContent.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page