FBlueprintEditorModule

The blueprint editor module provides the blueprint editor application.

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

IHasMenuExtensibility

FBlueprintEditorModule

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

Public function Virtual

TSharedRef< ...

 

CreateBlueprintEditor

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

Creates an instance of a Kismet editor object.

Public function Virtual

TSharedRef< ...

 

CreateBlueprintEditor

(
    const EToolkitMode::Type Mode,
    const TSharedPtr< IToolkitHost >& ...,
    const TArray< UBlueprint* >& ...
)

Creates an instance of a Kismet editor object.

Public function Virtual

TSharedRef< ...

 

CreateUserDefinedEnumEditor

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

Creates an instance of a Enum editor object.

Public function Virtual

TSharedRef< ...

 

CreateUserDefinedStructEditor

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

Creates an instance of a Structure editor object.

Public function Virtual

TArray< TSha...

 

CustomizeGraph

(
    const UEdGraphSchema* InGraphS...,
    TSharedPtr< IBlueprintEditor > InBl...
)

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

Public function Virtual

TArray< TSha...

 

CustomizeVariable

(
    FFieldClass* InFieldClass,
    TSharedPtr< IBlueprintEditor > InBl...
)

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

Public function Virtual Const

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).

Public function

FBlueprintEd...

 

OnBlueprintEditorOpened()

Public function

FBlueprintMe...

 

OnGatherBlueprintMenuExtensions()

Public function

FOnRegisterL...

 

OnRegisterLayoutExtensions()

Public function

FOnRegisterT...

 

OnRegisterTabsForEditor()

Public function Virtual

void

 

RegisterGraphCustomization

(
    const UEdGraphSchema* InGraphS...,
    FOnGetGraphCustomizationInstance In...
)

Register a customization for for Blueprint graphs

Public function Virtual

void

 

RegisterSCSEditorCustomization

(
    const FName& InComponentName,
    FSCSEditorCustomizationBuilder InCu...
)

Register a customization for interacting with the SCS editor

Public function Virtual

void

 

RegisterVariableCustomization

(
    FFieldClass* InFieldClass,
    FOnGetVariableCustomizationInstance...
)

Register a customization for for Blueprint variables

Public function Virtual

void

 

UnregisterGraphCustomization

(
    const UEdGraphSchema* InGraphS...
)

Unregister a previously registered customization for BP graphs

Public function Virtual

void

 

UnregisterSCSEditorCustomization

(
    const FName& InComponentName
)

Unregister a previously registered customization for interacting with the SCS editor

Public function Virtual

void

 

UnregisterVariableCustomization

(
    FFieldClass* InFieldClass
)

Unregister a previously registered customization for BP variables

Overridden from IModuleInterface

Name Description

Public function Virtual

void

 

ShutdownModule()

Called before the module is unloaded, right before the module object is destroyed.

Public function Virtual

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

Public function Virtual

TSharedPtr< ...

 

GetMenuExtensibilityManager()

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

Classes

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

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