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 > Kismet > FBlueprintEditorModule

Light Theme

Dark Theme

FBlueprintEditorModule

The blueprint editor module provides the blueprint editor application.

Inheritance Hierarchy

IModuleInterface

IHasMenuExtensibility

References

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

Syntax

class FBlueprintEditorModule :
public IModuleInterface,
public IHasMenuExtensibility

Remarks

The blueprint editor module provides the blueprint editor application.

Functions

	Name	Description
TSharedRef< ...	CreateBlueprintEditor ( const EToolkitMode::Type Mode, const TSharedPtr< IToolkitHost >& ..., UBlueprint* Blueprint, bool bShouldOpenInDefaultsMode )	Creates an instance of a Kismet editor object.
TSharedRef< ...	CreateBlueprintEditor ( const EToolkitMode::Type Mode, const TSharedPtr< IToolkitHost >& ..., const TArray< UBlueprint* >& ..., bool bShouldOpenInDefaultsMode )	Creates an instance of a Kismet editor object.
TSharedRef< ...	CreateUserDefinedEnumEditor ( const EToolkitMode::Type Mode, const TSharedPtr< IToolkitHost >& ..., UUserDefinedEnum* UDEnum )	Creates an instance of a Enum editor object.
TSharedRef< ...	CreateUserDefinedStructEditor ( const EToolkitMode::Type Mode, const TSharedPtr< IToolkitHost >& ..., UUserDefinedStruct* UDStruct )	Creates an instance of a Structure editor object.
TArray< TSha...	CustomizeFunction ( TSubclassOf< UK2Node_EditablePinBas..., TSharedPtr< IBlueprintEditor > InBl... )	Build a set of details customizations for function with the passed-in type, if possible.
TArray< TSha...	CustomizeGraph ( const UEdGraphSchema* InGraphS..., TSharedPtr< IBlueprintEditor > InBl... )	Build a set of details customizations for graphs with the passed-in schema, if possible.
TArray< TSha...	CustomizeVariable ( FFieldClass* InFieldClass, TSharedPtr< IBlueprintEditor > InBl... )	Build a set of details customizations for the passed-in type, if possible.
const TUniqu...	GetBlueprintDebugger()	Returns a reference to the Blueprint Debugger state object
TArray< TSha...	GetBlueprintEditors()	Get all blueprint editor instances
const TShare...	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).
FBlueprintEd...	OnBlueprintEditorOpened()
FBlueprintMe...	OnGatherBlueprintMenuExtensions()
FOnRegisterL...	OnRegisterLayoutExtensions()
FOnRegisterT...	OnRegisterTabsForEditor()
FDelegateHan...	RegisterFunctionCustomization ( TSubclassOf< UK2Node_EditablePinBas..., FOnGetFunctionCustomizationInstance... )	Register a customization for for Blueprint functions
void	RegisterGraphCustomization ( const UEdGraphSchema* InGraphS..., FOnGetGraphCustomizationInstance In... )	Register a customization for for Blueprint graphs
FDelegateHan...	RegisterLocalVariableCustomization ( FFieldClass* InFieldClass, FOnGetLocalVariableCustomizationIns... )	Register a customization for for Blueprint local variables
void	RegisterSCSEditorCustomization ( const FName& InComponentName, FSCSEditorCustomizationBuilder InCu... )	Register a customization for interacting with the SCS editor
FDelegateHan...	RegisterVariableCustomization ( FFieldClass* InFieldClass, FOnGetVariableCustomizationInstance... )	Register a customization for for Blueprint variables
void	SetDetailsCustomization ( TSharedPtr< class FDetailsViewObjec..., TSharedPtr< class IDetailRootObject... )	Sets customizations for the BP editor details panel.
void	SetSubobjectEditorUICustomization ( TSharedPtr< class ISCSEditorUICusto... )	Sets SCS editor UI customization
void	UnregisterFunctionCustomization ( TSubclassOf< UK2Node_EditablePinBas..., FDelegateHandle InHandle )	Unregister a previously registered customization for BP functions
void	UnregisterGraphCustomization ( const UEdGraphSchema* InGraphS... )	Unregister a previously registered customization for BP graphs
void	UnregisterLocalVariableCustomization ( FFieldClass* InFieldClass, FDelegateHandle InHandle )	Unregister a previously registered customization for BP local variables
void	UnregisterSCSEditorCustomization ( const FName& InComponentName )	Unregister a previously registered customization for interacting with the SCS editor
void	UnregisterVariableCustomization ( FFieldClass* InFieldClass, FDelegateHandle InHandle )	Unregister a previously registered customization for BP variables

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 Load dependent modules here, and they will be guaranteed to be available during ShutdownModule.

Overridden from IHasMenuExtensibility

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

Classes

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

Deprecated Functions

		Name	Description
	void	UnregisterLocalVariableCustomization ( FFieldClass* InFieldClass )	UnregisterLocalVariableCustomization without a delegate handle is deprecated.
	void	UnregisterVariableCustomization ( FFieldClass* InFieldClass )	UnregisterVariableCustomization without a delegate handle is deprecated.

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

Take our survey

Cancel