1. Epic GamesDeveloper
  3. FBlueprintEditorModule

FBlueprintEditorModule

The blueprint editor module provides the blueprint editor application.

API > API/Editor > API/Editor/Kismet

The blueprint editor module provides the blueprint editor application.

   
Name FBlueprintEditorModule
Type class
Header File /Engine/Source/Editor/Kismet/Public/BlueprintEditorModule.h
Include Path #include "BlueprintEditorModule.h"

Syntax

class FBlueprintEditorModule :  
    public IModuleInterface,  
    public IHasMenuExtensibility

Implements Interfaces

Classes

Name Remarks
FBlueprintEditorOpenedEvent Delegate for binding functions to be called when the blueprint editor finishes getting created
FBlueprintMenuExtensionEvent  
FOnRegisterLayoutExtensions  
FOnRegisterTabs  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BlueprintDebugger TUniquePtr< FBlueprintDebugger > Blueprint debugger state - refactor into SBlueprintDebugger if needed BlueprintEditorModule.h  
BlueprintEditorOpened FBlueprintEditorOpenedEvent Event to be called when the blueprint editor is opened. BlueprintEditorModule.h  
BlueprintEditors TArray< TWeakPtr< FBlueprintEditor > > List of all blueprint editors that were created. BlueprintEditorModule.h  
ConfigurationPanel TSharedPtr< SWidget > Reference to keep our custom configuration panel alive BlueprintEditorModule.h  
DetailsObjectFilter TSharedPtr< class FDetailsViewObjectFilter > Filter used to determine the set of objects shown in the BP editor details panel. BlueprintEditorModule.h  
DetailsRootCustomization TSharedPtr< class IDetailRootObjectCustomization > Root customization for the BP editor details panel. BlueprintEditorModule.h  
FunctionCustomizations TMultiMap< TSubclassOf< UK2Node_EditablePinBase >, FOnGetFunctionCustomizationInstance > Customizations for Blueprint functions BlueprintEditorModule.h  
GatherBlueprintMenuExtensions FBlueprintMenuExtensionEvent   BlueprintEditorModule.h  
GraphCustomizations TMap< const UEdGraphSchema *, FOnGetGraphCustomizationInstance > Customizations for Blueprint graphs BlueprintEditorModule.h  
LevelViewportContextMenuBlueprintExtenderDelegateHandle FDelegateHandle Handle to a registered LevelViewportContextMenuBlueprintExtender delegate BlueprintEditorModule.h  
LocalVariableCustomizations TMultiMap< FFieldClass *, FOnGetLocalVariableCustomizationInstance > Customizations for Blueprint local variables BlueprintEditorModule.h  
MenuExtensibilityManager TSharedPtr< FExtensibilityManager >   BlueprintEditorModule.h  
RegisterLayoutExtensions FOnRegisterLayoutExtensions   BlueprintEditorModule.h  
RegisterTabsForEditor FOnRegisterTabs Event called to allow external clients to register additional tabs for the specified editor BlueprintEditorModule.h  
SCSEditorCustomizations TMap< FName, FSCSEditorCustomizationBuilder > Customizations for the SCS editor BlueprintEditorModule.h  
SCSEditorUICustomization TSharedPtr< class ISCSEditorUICustomization > UI customizations for the SCS editor inside the blueprint editor BlueprintEditorModule.h  
SharedBlueprintEditorCommands TSharedPtr< FUICommandList > A command list that can be passed around and isn't bound to an instance of the blueprint editor. BlueprintEditorModule.h  
VariableCustomizations TMultiMap< FFieldClass *, FOnGetVariableCustomizationInstance > Customizations for Blueprint variables BlueprintEditorModule.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< IBlueprintEditor > CreateBlueprintEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
UBlueprint* Blueprint,
bool bShouldOpenInDefaultsMode
)

 Creates an instance of a Kismet editor object. BlueprintEditorModule.h  

virtual TSharedRef< IBlueprintEditor > CreateBlueprintEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
const TArray< UBlueprint* >& BlueprintsToEdit,
bool bShouldOpenInDefaultsMode
)

   BlueprintEditorModule.h  

virtual TSharedRef< IUserDefinedEnumEditor > CreateUserDefinedEnumEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
UUserDefinedEnum* UDEnum
)

 Creates an instance of a Enum editor object. BlueprintEditorModule.h  

virtual TSharedRef< IUserDefinedStructureEditor > CreateUserDefinedStructEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
UUserDefinedStruct* UDStruct
)

 Creates an instance of a Structure editor object. BlueprintEditorModule.h  

virtual TArray< TSharedPtr< IDetailCustomization > > CustomizeFunction ( TSubclassOf< UK2Node_EditablePinBase > InFunctionClass,
TSharedPtr< IBlueprintEditor > InBlueprintEditor
)

 Build a set of details customizations for function with the passed-in type, if possible. BlueprintEditorModule.h  

virtual TArray< TSharedPtr< IDetailCustomization > > CustomizeGraph ( const UEdGraphSchema* InGraphSchema,
TSharedPtr< IBlueprintEditor > InBlueprintEditor
)

 Build a set of details customizations for graphs with the passed-in schema, if possible. BlueprintEditorModule.h  

virtual TArray< TSharedPtr< IDetailCustomization > > CustomizeVariable ( FFieldClass* InFieldClass,
TSharedPtr< IBlueprintEditor > InBlueprintEditor
)

 Build a set of details customizations for the passed-in type, if possible. BlueprintEditorModule.h  

const TUniquePtr< FBlueprintDebugger > & GetBlueprintDebugger()

 Returns a reference to the Blueprint Debugger state object BlueprintEditorModule.h  

virtual TArray< TSharedRef< IBlueprintEditor > > GetBlueprintEditors()

 Get all blueprint editor instances BlueprintEditorModule.h  

virtual TSharedPtr< FExtensibilityManager > GetMenuExtensibilityManager()

 Gets the extensibility managers for outside entities to extend blueprint editor's menus and toolbars BlueprintEditorModule.h  

virtual const TSharedRef< FUICommandList > GetsSharedBlueprintEditorCommands()

 Exposes a way for other modules to fold in their own Blueprint editor commands (folded in with other BP editor commands, when the editor is first opened). BlueprintEditorModule.h  

FBlueprintEditorOpenedEvent & OnBlueprintEditorOpened()

   BlueprintEditorModule.h  

FBlueprintMenuExtensionEvent & OnGatherBlueprintMenuExtensions()

   BlueprintEditorModule.h  

FOnRegisterLayoutExtensions & OnRegisterLayoutExtensions()

   BlueprintEditorModule.h  

FOnRegisterTabs & OnRegisterTabsForEditor()

   BlueprintEditorModule.h  

virtual FDelegateHandle RegisterFunctionCustomization ( TSubclassOf< UK2Node_EditablePinBase > InFieldClass,
FOnGetFunctionCustomizationInstance InOnGetFunctionCustomization
)

 Register a customization for for Blueprint functions BlueprintEditorModule.h  

virtual void RegisterGraphCustomization ( const UEdGraphSchema* InGraphSchema,
FOnGetGraphCustomizationInstance InOnGetGraphCustomization
)

 Register a customization for for Blueprint graphs BlueprintEditorModule.h  

virtual FDelegateHandle RegisterLocalVariableCustomization ( FFieldClass* InFieldClass,
FOnGetLocalVariableCustomizationInstance InOnGetLocalVariableCustomization
)

 Register a customization for for Blueprint local variables BlueprintEditorModule.h  

virtual void RegisterSCSEditorCustomization ( const FName& InComponentName,
FSCSEditorCustomizationBuilder InCustomizationBuilder
)

 Register a customization for interacting with the SCS editor BlueprintEditorModule.h  

virtual FDelegateHandle RegisterVariableCustomization ( FFieldClass* InFieldClass,
FOnGetVariableCustomizationInstance InOnGetVariableCustomization
)

 Register a customization for for Blueprint variables BlueprintEditorModule.h  

virtual void SetDetailsCustomization ( TSharedPtr< class FDetailsViewObjectFilter > InDetailsObjectFilter,
TSharedPtr< class IDetailRootObjectCustomization > InDetailsRootCustomization
)

 Sets customizations for the BP editor details panel. BlueprintEditorModule.h  

virtual void SetSubobjectEditorUICustomization ( TSharedPtr< class ISCSEditorUICustomization > InSCSEditorUICustomization
)

 Sets SCS editor UI customization BlueprintEditorModule.h  

virtual void ShutdownModule()

   BlueprintEditorModule.h  

virtual void StartupModule()

   BlueprintEditorModule.h  

virtual void UnregisterFunctionCustomization ( TSubclassOf< UK2Node_EditablePinBase > InFieldClass,
FDelegateHandle InHandle
)

 Unregister a previously registered customization for BP functions BlueprintEditorModule.h  

virtual void UnregisterGraphCustomization ( const UEdGraphSchema* InGraphSchema
)

 Unregister a previously registered customization for BP graphs BlueprintEditorModule.h  

virtual void UnregisterLocalVariableCustomization ( FFieldClass* InFieldClass
)

 Unregister a previously registered customization for BP local variables BlueprintEditorModule.h  

virtual void UnregisterLocalVariableCustomization ( FFieldClass* InFieldClass,
FDelegateHandle InHandle
)

 Unregister a previously registered customization for BP local variables BlueprintEditorModule.h  

virtual void UnregisterSCSEditorCustomization ( const FName& InComponentName
)

 Unregister a previously registered customization for interacting with the SCS editor BlueprintEditorModule.h  

virtual void UnregisterVariableCustomization ( FFieldClass* InFieldClass
)

 Unregister a previously registered customization for BP variables BlueprintEditorModule.h  

virtual void UnregisterVariableCustomization ( FFieldClass* InFieldClass,
FDelegateHandle InHandle
)

 Unregister a previously registered customization for BP variables BlueprintEditorModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page