1. Epic GamesDeveloper
  3. FBlueprintEditorModule

FBlueprintEditorModule

The blueprint editor module provides the blueprint editor application.

API > API/Editor > API/Editor/Kismet

Inheritance Hierarchy

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

  Type Name Description
Public function Virtual TSharedRef< IBlueprintEditor >

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

 Creates an instance of a Kismet editor object.
Public function Virtual TSharedRef< IBlueprintEditor >

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

 Creates an instance of a Kismet editor object.
Public function Virtual TSharedRef< IUserDefinedEnumEditor >

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

 Creates an instance of a Enum editor object.
Public function Virtual TSharedRef< IUserDefinedStructureEditor >

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

 Creates an instance of a Structure editor object.
Public function Virtual TArray< TSharedPtr< IDetailCustomization > > Build a set of details customizations for function with the passed-in type, if possible.
Public function 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.
Public function Virtual TArray< TSharedPtr< IDetailCustomization > >

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

 Build a set of details customizations for the passed-in type, if possible.
Public function Const const TUniquePtr< FBlueprintDebugger > & Returns a reference to the Blueprint Debugger state object
Public function Virtual Const TArray< TSharedRef< IBlueprintEditor > > Get all blueprint editor instances
Public function Virtual Const const TSharedRef< FUICommandList > 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).
Public function FBlueprintEditorOpenedEvent &  
Public function FBlueprintMenuExtensionEvent &  
Public function FOnRegisterLayoutExtensions &  
Public function FOnRegisterTabs &  
Public function Virtual FDelegateHandle

RegisterFunctionCustomization ( TSubclassOf< UK2Node_EditablePinBase > InFieldClass,
FOnGetFunctionCustomizationInstance InOnGetFunctionCustomization
)

 Register a customization for for Blueprint functions
Public function Virtual void

RegisterGraphCustomization ( const UEdGraphSchema* InGraphSchema,
FOnGetGraphCustomizationInstance InOnGetGraphCustomization
)

 Register a customization for for Blueprint graphs
Public function Virtual FDelegateHandle

RegisterLocalVariableCustomization ( FFieldClass* InFieldClass,
FOnGetLocalVariableCustomizationInstance InOnGetLocalVariableCustomization
)

 Register a customization for for Blueprint local variables
Public function Virtual void

RegisterSCSEditorCustomization ( const FName& InComponentName,
FSCSEditorCustomizationBuilder InCustomizationBuilder
)

 Register a customization for interacting with the SCS editor
Public function Virtual FDelegateHandle

RegisterVariableCustomization ( FFieldClass* InFieldClass,
FOnGetVariableCustomizationInstance InOnGetVariableCustomization
)

 Register a customization for for Blueprint variables
Public function Virtual void

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

 Sets customizations for the BP editor details panel.
Public function Virtual void Sets SCS editor UI customization
Public function Virtual void Unregister a previously registered customization for BP functions
Public function Virtual void

UnregisterGraphCustomization ( const UEdGraphSchema* InGraphSchema
)

 Unregister a previously registered customization for BP graphs
Public function Virtual void Unregister a previously registered customization for BP local variables
Public function Virtual void

UnregisterSCSEditorCustomization ( const FName& InComponentName
)

 Unregister a previously registered customization for interacting with the SCS editor
Public function Virtual void Unregister a previously registered customization for BP variables

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

Overridden from IHasMenuExtensibility

  Type Name Description
Public function Virtual TSharedPtr< FExtensibilityManager > 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
Public function Virtual void UnregisterLocalVariableCustomization without a delegate handle is deprecated.
Public function Virtual void 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

On this page