FBlueprintEditorModule

The blueprint editor module provides the blueprint editor application.

Unreal Engine C++ API Reference > Editor > Kismet

Inheritance Hierarchy

References

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

Syntax

class FBlueprintEditorModule :  
    public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface),  
    public [IHasMenuExtensibility](API\Editor\UnrealEd\Toolkits\IHasMenuExtensibility)  

Remarks

The blueprint editor module provides the blueprint editor application.

Functions

Type 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

Type 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

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

Classes

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

Deprecated Functions

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library