FBlueprintEditor

Main Kismet asset editor

Unreal Engine C++ API Reference > Editor > Kismet

Inheritance Hierarchy

References

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

Syntax

class FBlueprintEditor :  
    public [IBlueprintEditor](API\Editor\Kismet\IBlueprintEditor),  
    public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject),  
    public [FNotifyHook](API\Runtime\CoreUObject\Misc\FNotifyHook),  
    public [FTickableEditorObject](API\Editor\UnrealEd\FTickableEditorObject),  
    public [FEditorUndoClient](API\Editor\UnrealEd\FEditorUndoClient),  
    public [FNoncopyable](API\Runtime\Core\Templates\FNoncopyable)  

Remarks

Main Kismet asset editor

Variables

Type Name Description
bool bBlueprintModifiedOnOpen Did we update the blueprint when it opened
bool bEditorMarkedAsClosed Whether we are already in the process of closing this editor
bool bHideUnrelatedNodes If true, fade out nodes which are unrelated to the selected nodes automatically.
bool bIsActionMenuContextSensitive Whether the graph action menu should be sensitive to the pins dragged off of
bool bIsReparentingBlueprint True if the current blueprint is in the process of being reparented
bool bLockNodeFadeState Lock the current fade state of each node
TSharedPtr< cla... BookmarksWidget Blueprint bookmark editing widget
bool bPendingDeferredClose Flags if this blueprint editor should close on its next tick.
bool bRequestedSavingOpenDocumentState Has someone requested a deferred update of the saved document state?
bool bSaveIntermediateBuildProducts Should intermediate build products be saved when recompiling?
bool bSelectRegularNode If a regular node (not a comment node) has been selected
int32 CachedNumErrors  
int32 CachedNumWarnings Limited cache of last compile results
TSharedPtr< cla... CompilerResults Compiler results log, with the log listing that it reflects
TSharedPtr< cla... CompilerResultsListing  
TSharedPtr< cla... CompositePinTypeSelectorFilter Filter used to compose multiple pin type filters together
FName CurrentUISelection The current UI selection state of this editor
TSharedPtr< cla... DefaultEditor Defaults inspector widget
TSet< FString > DeferredNamespaceImports Pending set of namespaces to be auto-imported on the next tick
TSharedPtr< FDo... DocumentManager  
TSharedPtr< cla... FindResults Find results log as well as the search filter
TWeakPtr< class... FocusedGraphEdPtr Currently focused graph editor
TWeakPtr< FDocu... GraphEditorTabFactoryPtr Factory that spawns graph editors; used to look up all tabs spawned by it.
TSharedPtr< cla... ImportedClassViewerFilter Filter used to restrict class viewer widgets in the editor context to imported namespaces only
TSharedPtr< FBl... ImportedNamespaceHelper Imported namespace helper utility object
TSharedPtr< cla... ImportedPinTypeSelectorFilter Filter used to restrict pin type selector widgets in the editor context to imported namespaces only
TSharedPtr< cla... Inspector Node inspector widget
TWeakPtr< class... MergeTool Merge tool - WeakPtr because it's owned by the GlobalTabManager
TSharedPtr< cla... MyBlueprintWidget All of this blueprints' functions and variables
TWeakPtr< class... NameEntryPopupWindow Reference to owner of the current popup
TSharedPtr< cla... NameEntryValidator Reference to helper object to validate names in popup
FOnMergeResolve... OnMergeResolved Merge tool - Delegate to call when the merge tool is closed.
FOnSetPinVisibi... OnSetPinVisibility  
TSharedPtr< cla... Palette Palette of all classes with funcs/vars
TSharedPtr< cla... PermissionsPinTypeSelectorFilter Filter used to restrict pin type selector widgets to those which permissions allow
TWeakPtr< class... PinTypeChangeMenu Reference to owner of the pin type change popup
SGraphEditor::E... PinVisibility Whether to hide unused pins or not
TWeakObjectPtr<... PreviewActorPtr The preview actor representing the current preview
FPreviewScene PreviewScene Blueprint preview scene
TSharedPtr< cla... ReplaceReferencesWidget Widget for replacing node references
TArray< TObject... StandardLibraries Macro/function libraries to keep loaded
TSharedPtr< SSu... SubobjectEditor Subobject Editor
TSharedPtr< SSC... SubobjectViewport Viewport widget
TSharedPtr< cla... Toolbar The toolbar builder class
TSet< TWeakObje... UserDefinedEnumerators User-defined enumerators to keep loaded
TSet< TWeakObje... UserDefinedStructures User-defined structures to keep loaded

Constructors

Type Name Description
  FBlueprintEditor ()  

Destructors

Type Name Description
  ~FBlueprintEditor ()  

Functions

Type Name Description
FBPEditorBoo... AddBookmark ( const FText& DisplayName, const FEditedDocumentInfo& Bookmar..., bool bSharedBookmark ) Adds a new bookmark node to the Blueprint that's being edited.
bool AddNewDelegateIsVisible ()  
void AnalyticsTrackCompileEvent ( UBlueprint* Blueprint, int32 NumErrors, int32 NumWarnings )  
bool AreDelegatesAllowed () Whether delegates are allowed to be displayed/created in a blueprint
bool AreEventGraphsAllowed () Whether event graphs are allowed to be displayed/created in a blueprint
bool AreMacrosAllowed () Whether macros are allowed to be displayed/created in a blueprint
bool CanAccessComponentsMode () Returns whether the edited blueprint has components
bool CanAddBreakpoint ()  
bool CanAddExecutionPin ()  
bool CanAddNewLocalVariable () Checks if adding a local variable is allowed in the focused graph
bool CanAddOptionPin ()  
bool CanAddParentNode ()  
bool CanAssignReferencedActor ()  
bool CanChangePinType ()  
bool CanCollapseNodes ()  
bool CanCollapseSelectionToFunction ( TSet< class UEdGraphNode* >& ... ) Called when a selection of nodes is being collapsed into a function
bool CanCollapseSelectionToFunction ()  
bool CanCollapseSelectionToMacro ( TSet< class UEdGraphNode* >& ... ) Called when a selection of nodes is being collapsed into a macro
bool CanCollapseSelectionToMacro ()  
bool CanConvertEventToFunction ()  
bool CanConvertFunctionToEvent () Callback function for the context menu on a node to determine if a function could possibly be converted to an event
bool CanCopyNodes ()  
bool CanCreateMatchingFunction ()  
bool CanCutNodes ()  
bool CanDeleteNodes ()  
bool CanDisableBreakpoint ()  
bool CanDuplicateNodes ()  
bool CanEnableBreakpoint ()  
bool CanExpandNodes ()  
bool CanInsertExecutionPin ()  
bool CanNavigateToChildGraph ()  
bool CanNavigateToParentGraph () Navigating into/out of graphs.
bool CanOpenBlueprintDebugger () Spawns a new blueprint debugger tab
bool CanPasteGeneric () Paste Variable Definition or Nodes
bool CanPromoteSelectionToFunction ()  
bool CanPromoteSelectionToMacro ()  
bool CanPromoteToVariable ( bool bInToMemberVariable )  
bool CanRecombineStructPin ()  
bool CanRedoGraphAction () Whether or not we can redo an undone action
bool CanRemoveBreakpoint ()  
bool CanRemoveExecutionPin ()  
bool CanRemoveOptionPin ()  
bool CanRemoveOtherStructVarPins ()  
bool CanRemoveThisStructVarPin ()  
bool CanRenameNodes ()  
bool CanResetPinToDefaultValue ()  
bool CanRestoreAllStructVarPins ()  
bool CanSelectAllNodes ()  
bool CanSelectReferenceInLevel ()  
bool CanSplitStructPin ()  
bool CanStartWatchingPin ()  
bool CanStopWatchingPin ()  
bool CanToggleBreakpoint ()  
bool CanUndoGraphAction () Whether or not we can perform an undo of the last transacted action
bool CanZoomToSelection ()  
bool CanZoomToWindow ()  
void ClearAllBreakpoints () Deletes all breakpoints for the blueprint being edited
void ClearAllGraphEditorQuickJumps () Unbinds all graph editor "quick jump" commands
void ClearAllWatches () Clears all watches associated with the blueprint being edited
void ClearGraphEditorQuickJump ( int32 BookmarkIndex ) Unbinds a graph editor "quick jump" from the command at the given index
void ClearSelectionStateFor ( FName SelectionOwner )  
void CloseDocumentTab ( const UObject* DocumentID ) Finds the tab associated with the specified asset, and closes if it is open
void CloseMergeTool () Closes the merge tool, rather than simply hiding it
void CollapseNodes ( TSet< class UEdGraphNode* >& ... ) Called when a selection of nodes are being collapsed into a sub-graph
void CollapseNodesIntoGraph ( UEdGraphNode* InGatewayNode, UK2Node_EditablePinBase* InEnt..., UK2Node_EditablePinBase* InRes..., UEdGraph* InSourceGraph, UEdGraph* InDestinationGraph, TSet< UEdGraphNode* >& InColl..., bool bCanDiscardEmptyReturnNode, bool bCanHaveWeakObjPtrParam ) Collapses a selection of nodes into a graph for composite, function, or macro nodes.
UEdGraph ... CollapseSelectionToFunction ( TSharedPtr< SGraphEditor > InRootGr..., TSet< class UEdGraphNode* >& ..., UEdGraphNode*& OutFunctionNode ) Called when a selection of nodes are being collapsed into a function
UEdGraph ... CollapseSelectionToMacro ( TSharedPtr< SGraphEditor > InRootGr..., TSet< class UEdGraphNode* >& ..., UEdGraphNode*& OutMacroNode ) Called when a selection of nodes are being collapsed into a macro
void CollectExecDownstreamNodes ( UEdGraphNode* CurrentNode, TArray< UEdGraphNode* >& Coll... )  
void CollectExecUpstreamNodes ( UEdGraphNode* CurrentNode, TArray< UEdGraphNode* >& Coll... )  
void CollectPureDownstreamNodes ( UEdGraphNode* CurrentNode, TArray< UEdGraphNode* >& Coll... )  
void CollectPureUpstreamNodes ( UEdGraphNode* CurrentNode, TArray< UEdGraphNode* >& Coll... )  
void CommonInitialization ( const TArray< UBlueprint* >& ..., bool bShouldOpenInDefaultsMode ) Should be called when initializing any editor built off this foundation.
void Compile () Called when Compile button is clicked
FReply Compile_OnClickWithReply () Calls the above function, but returns an FReply::Handled().
bool ConvertEventIfValid ( UK2Node_Event* EventToConv ) Converts the given event node to a function graph on this blueprint if it passes validation
void ConvertEventToFunction ( UK2Node_Event* SelectedEventNo... )  
bool ConvertFunctionIfValid ( UK2Node_FunctionEntry* FuncEnt... ) Converts the given function entry node to an event if it passes validation
void ConvertFunctionToEvent ( UK2Node_FunctionEntry* Selecte... ) Given a function node, move all nodes from the function out of the function graph, create an event with the same function name, and connect nodes to that event.
void CopySelectedNodes ()  
void CreateDefaultCommands () Create Default Commands
void CreateDefaultTabContents ( const TArray< UBlueprint* >& ... ) Creates the widgets that go into the tabs (note: does not create the tabs themselves)
TSharedRef< ... CreateGraphEditorWidget ( TSharedRef< class FTabInfo > InTabI..., UEdGraph* InGraph ) Create new graph editor widget for the supplied document container.
TSharedRef< ... CreateGraphTitleBarWidget ( TSharedRef< FTabInfo > InTabInfo, UEdGraph* InGraph ) Create a graph title bar widget
void CreateMergeToolTab () Forces the merge tool to be shown
void CreateMergeToolTab ( const UBlueprint* BaseBlueprin..., const UBlueprint* RemoteBluepr..., const FOnMergeResolved& Resolution... ) Forces the merge tool to be shown
TSharedPtr< ... CustomizeSubobjectEditor ( const USceneComponent* InCompo... ) Check to see if we can customize the subobject editor for the passed-in scene component
void CutSelectedNodes ()  
void DeleteSelectedDuplicatableNodes ()  
void DeleteSelectedNodes ()  
void DeleteUnusedVariables_OnClicked () Called when DeleteUnusedVariables button is clicked
void DestroyPreview () Destroy the Blueprint preview.
void DisableAllBreakpoints () Disables all breakpoints for the blueprint being edited
void DoPromoteToVariable ( UBlueprint* InBlueprint, UEdGraphPin* InTargetPin, bool bInToMemberVariable, const FVector2D* InOptionalLoc... ) Perform the actual promote to variable action on the given pin in the given blueprint.
void DumpMessagesToCompilerLog ( const TArray< TSharedRef< class FTo..., bool bForceMessageDisplay ) Dumps messages to the compiler log, with an option to force it to display/come to front
void DuplicateNodes ()  
void EditClassDefaults_Clicked () Edit the class defaults
void EditGlobalOptions_Clicked () Edit the class settings aka Blueprint global options
void EnableAllBreakpoints () Enables all breakpoints for the blueprint being edited
void EnableSubobjectPreview ( bool bEnable ) Enable/disable the subobject editor preview viewport
void EnsureBlueprintIsUpToDate ( UBlueprint* BlueprintObj ) Ensures the blueprint is up to date.
void ExpandNode ( UEdGraphNode* InNodeToExpand, UEdGraph* InSourceGraph, TSet< UEdGraphNode* >& OutExp... ) Expands passed in node
void ExtractEventTemplateForFunction ( UK2Node_CustomEvent* InCustomE..., UEdGraphNode* InGatewayNode, UK2Node_EditablePinBase* InEnt..., UK2Node_EditablePinBase* InRes..., TSet< UEdGraphNode* >& InColl... ) Pulls out the pins to use as a template when collapsing a selection to a function with a custom event involved.
TSharedPtr< ... FindAndSelectSubobjectEditorTreeNode ( const UActorComponent* InCompo..., bool IsCntrlDown )  
void FindInBlueprint_Clicked () Called to start a quick find (focus the search box in the explorer tab)
void FindInBlueprints_OnClicked () Called when Find In Blueprints menu is opened is clicked
bool FindOpenTabsContainingDocument ( const UObject* DocumentID, TArray< TSharedPtr< SDockTab > >& ... ) Finds any open tabs containing the specified document and adds them to the specified array; returns true if at least one is found.
void FocusInspectorOnGraphSelection ( const TSet< class UObject* >&..., bool bForceRefresh )  
TArray< UEdG... GetAllConnectedNodes ( UEdGraphNode*const Node ) Get all connected nodes and add them to a set of out nodes
UBlueprint &... GetBlueprintObj () Returns a pointer to the Blueprint object we are currently editing, as long as we are editing exactly one
TSharedRef< ... GetBookmarksWidget ()  
void GetBoundsForNode ( const UEdGraphNode* InNode, FSlateRect& OutRect, float InPadding ) Get the visible bounds of the given graph node
TSharedRef< ... GetCompilerResults ()  
FName GetContextFromBlueprintType ( EBlueprintType InType ) Get the context to use from the Blueprint type
FGraphAppear... GetCurrentGraphAppearance () Get the graph appearance of the currently focused graph
UEdGraphPin ... GetCurrentlySelectedPin () Utility helper to get the currently hovered pin in the currently visible graph, or nullptr if there isn't one.
FString GetCustomDebugObjectLabel ( UObject* ObjectBeingDebugged ) Can be overloaded to customize the labels in the debug filter
void GetCustomDebugObjects ( TArray< FCustomDebugObject >& Debu... ) Adds to a list of custom objects for debugging beyond what will automatically be found/used
TSharedRef< ... GetDefaultEditor ()  
TSubclassOf<... GetDefaultSchema () Gets the default schema for this editor
TSubclassOf<... GetDefaultSchemaClass () Whenever new graphs need to be created it will use this schema by default.
EVisibility GetEditParentClassVisibility () Determines visibility of the edit parent class button on the menu bar overlay
EVisibility GetFindParentClassVisibility () Determines visibility of the find parent class in content browser button on the menu bar overlay
TSharedRef< ... GetFindResults ()  
const FSlate... GetGlyphForGraph ( const UEdGraph* Graph, bool bInLargeIcon ) Util for finding a glyph for a graphUtil for finding a glyph for a graph
FGraphAppear... GetGraphAppearance ( UEdGraph* InGraph ) Get the graph appearance of a specific graph, GetCurrentGraphAppearance() uses the currently focused graph.
FText GetGraphDecorationString ( UEdGraph* InGraph ) Called by a graph title bar to get any extra information the editor would like to display
FText GetGraphDisplayName ( const UEdGraph* Graph ) Gets the display name of a graph
TSharedRef< ... GetInspector () Getters for the various Kismet2 widgets
float GetInstructionTextOpacity ( UEdGraph* InGraph ) Used to determine the visibility of the graph's instruction text.
bool & GetIsContextSensitive () Gets or sets the flag for context sensitivity in the graph action menu
TSharedPtr< ... GetMyBlueprintWidget ()  
EVisibility GetNativeParentClassButtonsVisibility () Determines visibility of the native parent class manipulation buttons on the menu bar overlay
TSharedRef< ... GetPalette ()  
FText GetParentClassNameText () Returns the name of the Blueprint's parent class
EVisibility GetParentClassNameVisibility () Determines visibility of the standard parent class label on the menu bar overlay
FText GetPIEStatus () Returns our PIE Status - SIMULATING / SERVER / CLIENT
bool GetPinVisibility ( SGraphEditor::EPinVisibility Visibi... )  
AActor * GetPreviewActor () Provides access to the preview actor.
FPreviewScen... GetPreviewScene () Provides access to the preview scene.
TSharedPtr< ... GetReplaceReferencesWidget ()  
bool GetSaveIntermediateBuildProducts ()  
FGraphPanelS... GetSelectedNodes () Get the currently selected set of nodes
UEdGraphNode... GetSingleSelectedNode () Returns the currently selected node if there is a single node selected (if there are multiple nodes selected or none selected, it will return nullptr)
TSharedPtr< ... GetSubobjectEditor ()  
UObject *... GetSubobjectEditorObjectContext () Subobject Editor Callbacks.
TSharedPtr< ... GetSubobjectViewport ()  
FText GetTextForNativeParentClassHeaderLink () Returns: "(.h)"
TSharedPtr< ... GetToolbarBuilder ()  
FName GetUISelectionState () Gets the UI selection state of this editor
FSlateBrush ... GetVarIconAndColor ( const UStruct* VarScope, FName VarName, FSlateColor& IconColorOut, FSlateBrush const*& SecondaryB..., FSlateColor& SecondaryColorOut ) Util for finding a glyph and color for a variable.
FSlateBrush ... GetVarIconAndColorFromPinType ( const FEdGraphPinType& PinType, FSlateColor& IconColorOut, FSlateBrush const*& SecondaryB..., FSlateColor& SecondaryColorOut ) Util for finding a glyph and color for a variable.
FSlateBrush ... GetVarIconAndColorFromProperty ( const FProperty* Property, FSlateColor& IconColorOut, FSlateBrush const*& SecondaryB..., FSlateColor& SecondaryColorOut ) Util for finding a glyph and color for a variable.
void GetViewBookmark ( FGuid& BookmarkId ) Gets the focused graph current view bookmark ID
void GetViewLocation ( FVector2D& Location, float& ZoomAmount ) Gets the focused graph view location/zoom amount
void HandleSetObjectBeingDebugged ( UObject* InObject ) Handle when the debug object is changed in the UI
void HandleUnrelatedNodesOpacityBoxChanged ( float NewOpacity )  
TOptional< f... HandleUnrelatedNodesOpacityBoxValue ()  
bool HasAnyBreakpoints ()  
bool HasAnyDisabledBreakpoints ()  
bool HasAnyEnabledBreakpoints ()  
bool HasAnyWatches ()  
void HideUnrelatedNodes ()  
void ImportNamespace ( const FString& InNamespace ) Imports the given namespace into the editor.
void ImportNamespaceEx ( const FImportNamespaceExParameters ... ) Imports a set of namespace(s) into the editor.
bool InEditingMode () Returns true if in editing mode
void InitalizeExtenders () Called during initialization of the blueprint editor to register commands and extenders.
void InitBlueprintEditor ( const EToolkitMode::Type Mode, const TSharedPtr< class IToolkitHos..., const TArray< class UBlueprint*..., bool bShouldOpenInDefaultsMode ) Edits the specified blueprint
bool IsCompilingEnabled () Returns true if able to compile
EVisibility IsDebuggerVisible ()  
bool IsDetailsPanelEditingClassDefaults () Is the main details panel currently showing 'Class defaults' (Note: Has nothing to do with the standalone class defaults panel)?
bool IsDetailsPanelEditingGlobalOptions () Is the main details panel currently showing 'Global options' (e.g., class metadata)?
bool IsEditable ( UEdGraph* InGraph ) Returns whether a graph is editable or not
bool IsEditingSingleBlueprint () Returns whether the editor is currently editing a single blueprint object
bool IsEditorClosing () Returns if we are currently closing the editor
bool IsGraphInCurrentBlueprint ( const UEdGraph* InGraph ) Checks to see if the provided graph is contained within the current blueprint
bool IsGraphReadOnly ( UEdGraph* InGraph ) Determines if the graph is ReadOnly, this differs from editable in that it is never expected to be edited and is in a read-only state
bool IsInAScriptingMode () Overridable function for determining if the current mode can script
bool IsNativeParentClassCodeLinkEnabled () Returns true if the parent class is native and the link to it's header can be shown
bool IsNodeTitleVisible ( const UEdGraphNode* Node, bool bRequestRename ) Check the Node Title is visible
bool IsParentClassABlueprint () Returns true if the parent class of the Blueprint being edited is also a Blueprint
bool IsParentClassAnEditableBlueprint () Returns true if the parent class of the Blueprint being edited is an editable Blueprint
bool IsParentClassNative () Returns true if the parent class of the Blueprint being edited is native
bool IsPlayInEditorActive () Returns true if PIE is active
bool IsSaveOnCompileEnabled () Helper functions used to construct/operate-on the "Save on Compile" command
bool IsSectionVisible ( NodeSectionID::Type InSectionID ) Called to see if the new document menu items is visible for this type.
bool IsToggleHideUnrelatedNodesChecked () Make nodes which are unrelated to the selected nodes fade out
void JumpToNode ( const UEdGraphNode* Node, bool bRequestRename ) Pan the view to center on a particular node
void JumpToPin ( const UEdGraphPin* Pin )  
void LoadLibrariesFromAssetRegistry () Load macro & function blueprint libraries from asset registry
void LogSimpleMessage ( const FText& MessageText ) Throw a simple message into the log
void LogToken_OnClicked ( const IMessageToken& Token ) Called when a token in a log message is clicked
TSharedRef< ... MakeHideUnrelatedNodesOptionsMenu () Make a drop down menu to control the opacity of unrelated nodes
void MoveNodesToAveragePos ( TSet< UEdGraphNode* >& Averag..., FVector2D SourcePos, bool bExpandedNodesNeedUniqueGuid ) Move the given set of nodes to an average spot near the Source position
void MoveNodesToGraph ( TArray< UEdGraphNode* >& Sour..., UEdGraph* DestinationGraph, TSet< UEdGraphNode* >& OutExp..., UEdGraphNode** OutEntry, UEdGraphNode** OutResult, const bool bIsCollapsedGraph ) Move every node from the source graph to the destination graph.
void NavigateToChildGraph ()  
void NavigateToParentGraph () Navigating into/out of graphs.
void NavigateToParentGraphByDoubleClick () Navigating into/out of graphs.
EVisibility NewDocument_GetVisibilityForType ( ECreatedDocumentType GraphType )  
bool NewDocument_IsVisibleForType ( ECreatedDocumentType GraphType )  
FReply NewDocument_OnClick ( ECreatedDocumentType GraphType )  
void NewDocument_OnClicked ( ECreatedDocumentType GraphType ) Called when New Function button is clicked
bool OnActionMatchesName ( FEdGraphSchemaAction* InAction, const FName& InName ) Function used by the SMyBlueprint to determine if an action matches a name.
void OnActiveTabChanged ( TSharedPtr< SDockTab > PreviouslyAc..., TSharedPtr< SDockTab > NewlyActivat... )  
void OnAddBreakpoint ()  
void OnAddExecutionPin ()  
void OnAddNewDelegate () Called when New Delegate button is clicked
void OnAddNewLocalVariable () Adds a new local variable to the focused function graph
void OnAddNewVariable () Adds a new variable to this blueprint
FReply OnAddNewVariable_OnClick ()  
void OnAddOptionPin ()  
void OnAddParentNode ()  
void OnAlignBottom ()  
void OnAlignCenter ()  
void OnAlignLeft ()  
void OnAlignMiddle ()  
void OnAlignRight ()  
void OnAlignTop ()  
void OnAssignReferencedActor ()  
void OnBlueprintChanged ( UBlueprint* InBlueprint ) Called when the Blueprint we are editing has changed, forwards to impl
void OnBlueprintChangedImpl ( UBlueprint* InBlueprint, bool bIsJustBeingCompiled ) Called when the Blueprint we are editing has changed
void OnBlueprintCompiled ( UBlueprint* InBlueprint )  
void OnBlueprintUnloaded ( UBlueprint* InBlueprint ) Handles the unloading of Blueprints (by closing the editor, if it operating on the Blueprint being unloaded)
void OnChangePinType ()  
void OnChangePinTypeFinished ( const FEdGraphPinType& PinType, UEdGraphPin* SelectedPin )  
void OnCollapseNodes ()  
void OnCollapseSelectionToFunction ()  
void OnCollapseSelectionToMacro ()  
void OnComponentAddedToBlueprint ( const FSubobjectData& NewSubobject... ) Delegate invoked when a new subobject is added in the subobject editor widget
void OnComponentDoubleClicked ( TSharedPtr< class FSubobjectEditorT... ) Delegate invoked when an item is double clicked in the subobject editor widget
void OnConvertEventToFunction ()  
void OnConvertFunctionToEvent ()  
void OnCreateComment () Create comment node on graph
FActionMenuC... OnCreateGraphActionMenu ( UEdGraph* InGraph, const FVector2D& InNodePosition, const TArray< UEdGraphPin* >&..., bool bAutoExpand, SGraphEditor::FActionMenuClosed InO... ) Called to create context menu when right-clicking on graph
void OnCreateMatchingFunction ()  
void OnDisableBreakpoint ()  
void OnDistributeNodesH ()  
void OnDistributeNodesV ()  
void OnDumpCachedIndexDataForBlueprint () Dumps the currently-cached index data for the blueprint to a file for debugging
FReply OnEditParentClassClicked () Handler for "Edit parent class" button
void OnEditParentClassNativeCodeClicked () Handles opening the header file of native parent class
void OnEditTabClosed ( TSharedRef< SDockTab > Tab )  
void OnEnableBreakpoint ()  
void OnExpandNodes ()  
FReply OnFindParentClassInContentBrowserClicked () Handler for "Find parent class in CB" button
void OnFinishedChangingProperties ( const FPropertyChangedEvent& Prope... ) Callback when properties have finished being handled
void OnGenerateSearchIndexForDebugging () Dumps the current blueprint search index to a JSON file for debugging purposes
FEdGraphPinT... OnGetPinType ( UEdGraphPin* SelectedPin ) Functions for handling the changing of the pin's type (PinCategory, PinSubCategory, etc)
void OnGraphActionMenuClosed ( bool bActionExecuted, bool bContextSensitiveChecked, bool bGraphPinContext ) Called from graph context menus when they close to tell the editor why they closed
void OnGraphEditorBackgrounded ( const TSharedRef< SGraphEditor >& ... ) Called when the graph editor tab is backgrounded
void OnGraphEditorDropActor ( const TArray< TWeakObjectPtr< AActo..., UEdGraph* Graph, const FVector2D& DropLocation ) Called when an actor is dropped onto the graph editor
void OnGraphEditorDropStreamingLevel ( const TArray< TWeakObjectPtr< ULeve..., UEdGraph* Graph, const FVector2D& DropLocation ) Called when a streaming level is dropped onto the graph editor
void OnGraphEditorFocused ( const TSharedRef< class SGraphEdito... ) Called when graph editor focus is changed
void OnGraphEditorQuickJump ( int32 BookmarkIndex ) Handles activation of a graph editor "quick jump" command
void OnInsertExecutionPin ( EPinInsertPosition Position )  
void OnInsertExecutionPinAfter ()  
void OnInsertExecutionPinBefore ()  
void OnListObjectsReferencedByBlueprint ()  
void OnListObjectsReferencedByClass ()  
void OnLockNodeStateCheckStateChanged ( ECheckBoxState NewCheckedState )  
bool OnlyShowCustomDebugObjects () If returns true only the custom debug list will be used
FOnModeSet & OnModeSet ()  
void OnNodeDoubleClicked ( UEdGraphNode* Node )  
void OnNodeSpawnedByKeymap () Called when node is spawned by keymap
void OnNodeTitleCommitted ( const FText& NewText, ETextCommit::Type CommitInfo, UEdGraphNode* NodeBeingChanged ) Called when a node's title is committed for a rename
bool OnNodeVerifyTitleCommit ( const FText& NewText, UEdGraphNode* NodeBeingChanged, FText& OutErrorMessage ) Called when a node's title is being committed for a rename so it can be verified
void OnPasteNewLocalVariable ( const FBPVariableDescription& Vari... ) Pastes a new local variable to the focused function graph
void OnPostObjectPropertyChanged ( UObject* InObject, FPropertyChangedEvent& PropertyCha... ) Called after a property change has been propagated to instances of the Blueprint
void OnPreObjectPropertyChanged ( UObject* InObject, const FEditPropertyChain& EditProp... ) Called when a property change is about to be propagated to instances of the Blueprint
void OnPromoteSelectionToFunction ()  
void OnPromoteSelectionToMacro ()  
void OnPromoteToVariable ( bool bInToMemberVariable ) UI Action functionality.
void OnRecombineStructPin ()  
FOnRefreshEv... OnRefresh ()  
void OnRemoveBreakpoint ()  
void OnRemoveExecutionPin ()  
void OnRemoveOptionPin ()  
void OnRemoveOtherStructVarPins ()  
void OnRemoveThisStructVarPin ()  
void OnRenameNode () On starting to rename node
void OnRepairCorruptedBlueprint ()  
void OnResetPinToDefaultValue ()  
void OnRestoreAllStructVarPins ()  
void OnSelectedNodesChanged ( const TSet< class UObject* >&... ) Called when the selection changes in the GraphEditor
void OnSelectedNodesChangedImpl ( const TSet< class UObject* >&... ) Called when the selection changes in the GraphEditor
void OnSelectionUpdated ( const TArray< TSharedPtr< class FSu... ) Delegate invoked when the selection is changed in the subobject editor widget
void OnSelectReferenceInLevel ()  
FReply OnSpawnGraphNodeByShortcut ( FInputChord InChord, const FVector2D& InPosition, UEdGraph* InGraph ) Handles spawning a graph node in the current graph using the passed in chord
void OnSplitStructPin ()  
void OnStartEditingDefaultsClicked () Start editing the defaults for this blueprint
void OnStartWatchingPin ()  
void OnStopWatchingPin ()  
void OnStraightenConnections ()  
void OnToggleBreakpoint ()  
void OpenBlueprintDebugger () Spawns a new blueprint debugger tab
TSharedPtr< ... OpenDocument ( const UObject* DocumentID, FDocumentTracker::EOpenDocumentCaus... )  
void PasteGeneric () Paste Variable Definition or Nodes
void PasteNodes ()  
void PostLayoutBlueprintEditorInitialization () Should be called when initializing an editor that has a blueprint, after layout (tab spawning) is done.
void ReconnectExecPins ( UK2Node* Node ) Given a node, make connections from anything connected to it's input pin to anything connected to it's "then" pins.
void RedoGraphAction () Called to redo the last undone action
void RefreshAllNodes_OnClicked () Called when the refresh all nodes button is clicked
void RefreshStandAloneDefaultsEditor () Updates the selected object used by the stand lone defaults editor widget.
void RegisterApplicationModes ( const TArray< UBlueprint* >& ..., bool bShouldOpenInDefaultsMode, bool bNewlyCreated ) Called during initialization of the blueprint editor to register any application modes.
void RegisterMenus () Register Menus
void RegisterSCSEditorCustomization ( const FName& InComponentName, TSharedPtr< class ISCSEditorCustomi... ) Register a customization for interacting with the subobject editor
void RegisterToolbarTab ( const TSharedRef< class FTabManager... )  
void RemoveBookmark ( const FGuid& BookmarkNodeId, bool bRefreshUI ) Removes the bookmark node with the given ID.
void RemoveNamespace ( const FString& InNamespace ) Removes the given namespace from the editor's current import context.
void RenameBookmark ( const FGuid& BookmarkNodeId, const FText& NewName ) Renames the bookmark node with the given ID.
void RenameNewlyAddedAction ( FName InActionName ) Utility function to handle all steps required to rename a newly added action
void ReparentBlueprint_Clicked () Reparent the current blueprint
bool ReparentBlueprint_IsVisible ()  
void ReparentBlueprint_NewParentChosen ( UClass* ChosenClass )  
void RequestSaveEditedObjectState () Request a save of the edited object state This is used to delay it by one frame when triggered by a tab being closed, so it can finish closing before remembering the new state
void ResetAllNodesUnrelatedStates () Focus nodes which are related to the selected nodes
void RestoreEditedObjectState () Create new tab for each element of LastEditedObjects array
void SaveEditedObjectState () Save the current set of edited objects in the LastEditedObjects array so it will be opened next time we open K2
void SelectAllNodes ()  
void SelectAndDuplicateNode ( UEdGraphNode* InNode ) Duplicates an EdGraphNode using selection and copy / paste functionality
void SelectGraphActionItemByName ( const FName& ItemName, ESelectInfo::Type SelectInfo, int32 SectionId, bool bIsCategory ) Selects an item in "My Blueprint" by name.
bool SelectLocalVariable ( const UEdGraph* Graph, const FName& VariableName ) Selects a local variable to load in the details panel.
void SetDetailsCustomization ( TSharedPtr< class FDetailsViewObjec..., TSharedPtr< class IDetailRootObject... ) Sets customizations for the BP editor details panel.
void SetGraphEditorQuickJump ( int32 BookmarkIndex ) Binds a graph editor "quick jump" to the command at the given index
void SetKeyboardFocus () Ensures the blueprint has keyboard focus.
void SetPinVisibility ( SGraphEditor::EPinVisibility Visibi... ) Pin visibility accessors
void SetSubobjectEditorUICustomization ( TSharedPtr< class ISCSEditorUICusto... ) Sets subobject editor UI customization
void SetUISelectionState ( FName SelectionOwner )  
void SetupGraphEditorEvents ( UEdGraph* InGraph, SGraphEditor::FGraphEditorEvents& ... ) Setup all the events that the graph editor can handle
void SetupViewForBlueprintEditingMode () Called by the blueprint editing app mode to focus the appropriate tabs, etc...
void SetViewLocation ( const FVector2D& Location, float ZoomAmount, const FGuid& BookmarkId ) Sets the focused graph view location/zoom amount
bool ShouldLoadBPLibrariesFromAssetRegistry () Other types of BP editors that don't use BP VM/function libs can choose to not load BP function libraries, for example: Control Rig Blueprints.
void StartEditingDefaults ( bool bAutoFocus, bool bForceRefresh ) Virtual override point for editing defaults; allowing more derived editors to edit something else
void ToggleHideUnrelatedNodes () Make nodes which are unrelated to the selected nodes fade out
void ToggleSaveIntermediateBuildProducts ()  
bool TransactionObjectAffectsBlueprint ( UObject* InTransactedObject )  
void TryInvokingDetailsTab ( bool bFlash ) Attempts to invoke the details tab if it's currently possible to.
void UndoGraphAction () Called to undo the last action
void UnregisterSCSEditorCustomization ( const FName& InComponentName ) Unregister a previously registered customization for interacting with the subobject editor
void UpdateNodeCreationStats ( const ENodeCreateAction::Type Creat... ) Update Node Creation mechanisms for analytics
void UpdateNodesUnrelatedStatesAfterGraphChange () Update all nodes' unrelated states when the graph has changed
void UpdatePreviewActor ( UBlueprint* InBlueprint, bool bInForceFullUpdate ) Creates/updates the preview actor for the given blueprint.
void UpdateSubobjectPreview ( bool bUpdateNow ) Refresh the preview viewport to reflect changes in the subobject
void VariableListWasUpdated () Variable list window calls this after it is updated
void ZoomToSelection_Clicked () Zooming to fit the current selection.
void ZoomToWindow_Clicked () Zooming to fit the entire graph.

Overridden from IBlueprintEditor

Type Name Description
void AddToSelection ( UEdGraphNode* InNode )  
void AnalyticsTrackNodeEvent ( UBlueprint* Blueprint, UEdGraphNode* GraphNode, bool bNodeDelete ) Used to track node create/delete events for Analytics
bool CanPasteNodes ()  
bool GetBoundsForSelectedNodes ( FSlateRect& Rect, float Padding )  
UEdGraph ... GetFocusedGraph () Returns the currently focused graph context, or NULL if no graph is available.
TSharedPtr< ... GetImportedClassViewerFilter () Return the class viewer filter associated with the current set of imported namespaces within this editor context.
int32 GetNumberOfSelectedNodes () Get number of currently selected nodes in the SCS editor tree
void GetPinTypeSelectorFilters ( TArray< TSharedPtr< class IPinTypeS... ) Get all the the pin type selector filters within this editor context.
TArray< TSha... GetSelectedSubobjectEditorTreeNodes () Util to get the currently selected Subobject editor tree Nodes
bool IsNonImportedObject ( const UObject* InObject ) Return whether the given object falls outside the scope of the current set of imported namespaces within this editor context.
bool IsNonImportedObject ( const FSoftObjectPath& InObject ) Return whether the given object falls outside the scope of the current set of imported namespaces within this editor context.
void JumpToHyperlink ( const UObject* ObjectReference, bool bRequestRename )  
TSharedPtr< ... OpenGraphAndBringToFront ( UEdGraph* Graph, bool bSetFocus ) Tries to open the specified graph and bring it's document to the front (note: this can return NULL)
void PasteNodesHere ( UEdGraph* DestinationGraph, const FVector2D& GraphLocation ) Paste on graph at specific location
void RefreshEditors ( ERefreshBlueprintEditorReason::Type... )  
void RefreshInspector ()  
void RefreshMyBlueprint ()  
void SummonFindAndReplaceUI () Invokes the Find and Replace UI
void SummonSearchUI ( bool bSetFindWithinBlueprint, FString NewSearchTerms, bool bSelectFirstResult ) Invokes the search UI and sets the mode and search terms optionally

Overridden from FWorkflowCentricApplication

Type Name Description
void SetCurrentMode ( FName NewMode ) Attempt to set the current mode. If this mode is illegal or unknown, the mode will remain unchanged.

Overridden from FAssetEditorToolkit

Type Name Description
FString GetDocumentationLink ()  
void InitToolMenuContext ( FToolMenuContext& MenuContext ) Add context objects for menus and toolbars
void OnClose () Called when this toolkit is being closed
bool OnRequestClose ( EAssetEditorCloseReason InCloseReas... ) Called when this toolkit is requested to close. Returns false if closing should be prevented.
void PostRegenerateMenusAndToolbars () Recreates the overlay on the menu bar

Overridden from IToolkit

Type Name Description
FText GetBaseToolkitName () Returns the localized name of this toolkit type (typically just " editor")
FName GetToolkitContextFName () Returns the invariant name of this toolkit type, used for establishing the context for help, documentation and tutorials
FName GetToolkitFName () Returns the invariant name of this toolkit type
FText GetToolkitName () Returns the localized name of this toolkit
FText GetToolkitToolTipText () Returns the localized tooltip text of this toolkit
FLinearColor GetWorldCentricTabColorScale ()  
FString GetWorldCentricTabPrefix () Returns the localize prefix string to use for tab labels in world-centric mode.
bool IsBlueprintEditor () Returns if this is a IBlueprintEditor derivation
void RegisterTabSpawners ( const TSharedRef< class FTabManager... ) IToolkit interface

Overridden from FGCObject

Type Name Description
void AddReferencedObjects ( FReferenceCollector& Collector ) Pure virtual that must be overloaded by the inheriting class.
FString GetReferencerName () Overload this method to report a name for your referencer

Overridden from FNotifyHook

Type Name Description
void NotifyPostChange ( const FPropertyChangedEvent& Prope..., FProperty* PropertyThatChanged )  
void NotifyPreChange ( FProperty* PropertyAboutToChan... )  

Overridden from FTickableObjectBase

Type Name Description
TStatId GetStatId () Return the stat id to use for this tickable
ETickableTic... GetTickableTickType () Virtual that can be overloaded by the inheriting class.
void Tick ( float DeltaTime ) Pure virtual that must be overloaded by the inheriting class.

Overridden from FEditorUndoClient

Type Name Description
void PostRedo ( bool bSuccess ) Signal that client should run any PostRedo code
void PostUndo ( bool bSuccess ) Signal that client should run any PostUndo code

Classes

Type Name Description
Public struct FImportNamespaceExParameters Parameters for the extended ImportNamespaceEx() method
Public class FOnRefreshEvent Broadcasts a notification whenever the editor needs associated controls to refresh

Enums

Type Name Description
Public enum ECreatedDocumentType Type of new document/graph being created by a menu item.
Private enum ESafeToModifyDuringPIEStatus  

Typedefs

Name Description
FOnModeSet  
FOnSetPinVisibility  

Constants

Deprecated Functions

Type Name Description
TSharedPtr< ... CustomizeSCSEditor ( USceneComponent* InComponentTo... ) CustomizeSCSEditor has been deprecated. Use CustomizeSubobjectEditor instead.
TSharedPtr< ... FindAndSelectSCSEditorTreeNode ( const UActorComponent* InCompo..., bool IsCntrlDown ) FindAndSelectSCSEditorTreeNode has been deprecated. Use FindAndSelectSubobjectEditorTreeNode instead.
TSharedPtr< ... GetImportedPinTypeSelectorFilter () Please use GetPinTypeSelectorFilters
TSharedPtr< ... GetSCSEditor () GetSCSEditor has been deprecated. Use GetSubobjectEditor instead.
TArray< TSha... GetSelectedSCSEditorTreeNodes () GetSelectedSCSEditorTreeNodes has been deprecated. Use GetSelectedSubobjectEditorTreeNodes instead.
void OnComponentDoubleClicked ( TSharedPtr< class FSCSEditorTreeNod... ) OnComponentDoubleClicked(TSharedPtr) has been deprecated. Use OnComponentDoubleClicked(TSharedPtr) instead.
void OnSelectionUpdated ( const TArray< TSharedPtr< class FSC... ) OnSelectionUpdated(const TArray>&) has been deprecated. Use OnSelectionUpdated(const TArray>&) instead.
void SetSCSEditorUICustomization ( TSharedPtr< class ISCSEditorUICusto... ) SetSCSEditorUICustomization has been deprecated. Use SetSubobjectEditorUICustomization instead.
bool ShouldShowToggleHideUnrelatedNodes ( bool bIsToolbar ) The Toggle Hide Unrelated Nodes button is always shown now

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library