1. Epic GamesDeveloper
  3. FBlueprintEditor

FBlueprintEditor

Main Kismet asset editor

API > API/Editor > API/Editor/Kismet

Inheritance Hierarchy

References

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

Syntax

class FBlueprintEditor :  
    public IBlueprintEditor,  
    public FGCObject,  
    public FNotifyHook,  
    public FTickableEditorObject,  
    public FEditorUndoClient,  
    public FNoncopyable

Remarks

Main Kismet asset editor

Variables

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function FBPEditorBookmarkNode *

AddBookmark ( const FText& DisplayName,
const FEditedDocumentInfo& BookmarkInfo,
bool bSharedBookmark
)

 Adds a new bookmark node to the Blueprint that's being edited.
Public function Const bool  
Public function Const void

AnalyticsTrackCompileEvent ( UBlueprint* Blueprint,
int32 NumErrors,
int32 NumWarnings
)

  
Public function Virtual Const bool Whether delegates are allowed to be displayed/created in a blueprint
Public function Virtual Const bool Whether event graphs are allowed to be displayed/created in a blueprint
Public function Virtual Const bool Whether macros are allowed to be displayed/created in a blueprint
Public function Const bool Returns whether the edited blueprint has components
Protected function Const bool  
Protected function Const bool  
Public function Virtual Const bool Checks if adding a local variable is allowed in the focused graph
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool

CanCollapseSelectionToFunction ( TSet< class UEdGraphNode* >& InSelection
)

 Called when a selection of nodes is being collapsed into a function
Protected function Const bool  
Protected function Const bool

CanCollapseSelectionToMacro ( TSet< class UEdGraphNode* >& InSelection
)

 Called when a selection of nodes is being collapsed into a macro
Protected function Const bool  
Protected function Const bool  
Protected function Const bool Callback function for the context menu on a node to determine if a function could possibly be converted to an event
Protected function Virtual Const bool  
Protected function Const bool  
Protected function Virtual Const bool  
Protected function Virtual Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool Navigating into/out of graphs.
Protected function Const bool Spawns a new blueprint debugger tab
Protected function Virtual Const bool Paste Variable Definition or Nodes
Protected function Const bool  
Protected function Const bool  
Protected function Const bool

CanPromoteToVariable ( bool bInToMemberVariable
)

  
Protected function Const bool  
Protected function Const bool Whether or not we can redo an undone action
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Virtual Const bool  
Protected function Virtual Const bool  
Protected function Const bool  
Protected function Const bool Whether or not we can perform an undo of the last transacted action
Protected function Const bool  
Protected function Const bool  
Protected function void Deletes all breakpoints for the blueprint being edited
Protected function void Unbinds all graph editor "quick jump" commands
Protected function void Clears all watches associated with the blueprint being edited
Protected function void

ClearGraphEditorQuickJump ( int32 BookmarkIndex
)

 Unbinds a graph editor "quick jump" from the command at the given index
Public function Virtual void

ClearSelectionStateFor ( FName SelectionOwner
)

  
Public function void

CloseDocumentTab ( const UObject* DocumentID
)

 Finds the tab associated with the specified asset, and closes if it is open
Public function void Closes the merge tool, rather than simply hiding it
Protected function void

CollapseNodes ( TSet< class UEdGraphNode* >& InCollapsableNodes
)

 Called when a selection of nodes are being collapsed into a sub-graph
Protected function void

CollapseNodesIntoGraph ( UEdGraphNode* InGatewayNode,
UK2Node_EditablePinBase* InEntryNode,
UK2Node_EditablePinBase* InResultNode,
UEdGraph* InSourceGraph,
UEdGraph* InDestinationGraph,
TSet< UEdGraphNode* >& InCollapsableNodes,
bool bCanDiscardEmptyReturnNode,
bool bCanHaveWeakObjPtrParam
)

 Collapses a selection of nodes into a graph for composite, function, or macro nodes.
Protected function UEdGraph *

CollapseSelectionToFunction ( TSharedPtr< SGraphEditor > InRootGraph,
TSet< class UEdGraphNode* >& InCollapsableNodes,
UEdGraphNode*& OutFunctionNode
)

 Called when a selection of nodes are being collapsed into a function
Protected function UEdGraph *

CollapseSelectionToMacro ( TSharedPtr< SGraphEditor > InRootGraph,
TSet< class UEdGraphNode* >& InCollapsableNodes,
UEdGraphNode*& OutMacroNode
)

 Called when a selection of nodes are being collapsed into a macro
Protected function void

CollectExecDownstreamNodes ( UEdGraphNode* CurrentNode,
TArray< UEdGraphNode* >& CollectedNodes
)

  
Protected function void

CollectExecUpstreamNodes ( UEdGraphNode* CurrentNode,
TArray< UEdGraphNode* >& CollectedNodes
)

  
Protected function void

CollectPureDownstreamNodes ( UEdGraphNode* CurrentNode,
TArray< UEdGraphNode* >& CollectedNodes
)

  
Protected function void

CollectPureUpstreamNodes ( UEdGraphNode* CurrentNode,
TArray< UEdGraphNode* >& CollectedNodes
)

  
Public function void

CommonInitialization ( const TArray< UBlueprint* >& InitBlueprints,
bool bShouldOpenInDefaultsMode
)

 Should be called when initializing any editor built off this foundation.
Public function Virtual void

Compile ()

 Called when Compile button is clicked
Public function Virtual FReply Calls the above function, but returns an FReply::Handled().
Public function bool Converts the given event node to a function graph on this blueprint if it passes validation
Protected function void

ConvertEventToFunction ( UK2Node_Event* SelectedEventNode
)

  
Public function bool Converts the given function entry node to an event if it passes validation
Protected function void

ConvertFunctionToEvent ( UK2Node_FunctionEntry* SelectedCallFunctionNode
)

 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.
Protected function Virtual void  
Protected function Virtual void Create Default Commands
Protected function Virtual void

CreateDefaultTabContents ( const TArray< UBlueprint* >& InBlueprints
)

 Creates the widgets that go into the tabs (note: does not create the tabs themselves)
Protected function Virtual TSharedRef< SGraphEditor >

CreateGraphEditorWidget ( TSharedRef< class FTabInfo > InTabInfo,
UEdGraph* InGraph
)

 Create new graph editor widget for the supplied document container.
Protected function TSharedRef< SWidget > Create a graph title bar widget
Public function void Forces the merge tool to be shown
Public function void

CreateMergeToolTab ( const UBlueprint* BaseBlueprint,
const UBlueprint* RemoteBlueprint,
const FOnMergeResolved& ResolutionCallback
)

 Forces the merge tool to be shown
Public function Const TSharedPtr< class ISCSEditorCustomization >

CustomizeSubobjectEditor ( const USceneComponent* InComponentToCustomize
)

 Check to see if we can customize the subobject editor for the passed-in scene component
Protected function Virtual void  
Protected function void  
Protected function Virtual void  
Protected function void Called when DeleteUnusedVariables button is clicked
Public function void Destroy the Blueprint preview.
Protected function void Disables all breakpoints for the blueprint being edited
Public function void

DoPromoteToVariable ( UBlueprint* InBlueprint,
UEdGraphPin* InTargetPin,
bool bInToMemberVariable,
const FVector2D* InOptionalLocation
)

 Perform the actual promote to variable action on the given pin in the given blueprint.
Public function void

DumpMessagesToCompilerLog ( const TArray< TSharedRef< class FTokenizedMessage >>& Messages,
bool bForceMessageDisplay
)

 Dumps messages to the compiler log, with an option to force it to display/come to front
Protected function void  
Protected function void Edit the class defaults
Protected function void Edit the class settings aka Blueprint global options
Protected function void Enables all breakpoints for the blueprint being edited
Public function void

EnableSubobjectPreview ( bool bEnable
)

 Enable/disable the subobject editor preview viewport
Public function void Ensures the blueprint is up to date.
Protected function Static void

ExpandNode ( UEdGraphNode* InNodeToExpand,
UEdGraph* InSourceGraph,
TSet< UEdGraphNode* >& OutExpandedNodes
)

 Expands passed in node
Protected function void

ExtractEventTemplateForFunction ( UK2Node_CustomEvent* InCustomEvent,
UEdGraphNode* InGatewayNode,
UK2Node_EditablePinBase* InEntryNode,
UK2Node_EditablePinBase* InResultNode,
TSet< UEdGraphNode* >& InCollapsableNodes
)

 Pulls out the pins to use as a template when collapsing a selection to a function with a custom event involved.
Public function Virtual TSharedPtr< FSubobjectEditorTreeNode >

FindAndSelectSubobjectEditorTreeNode ( const UActorComponent* InComponent,
bool IsCntrlDown
)

  
Protected function void Called to start a quick find (focus the search box in the explorer tab)
Protected function void Called when Find In Blueprints menu is opened is clicked
Public function bool

FindOpenTabsContainingDocument ( const UObject* DocumentID,
TArray< TSharedPtr< SDockTab > >& Results
)

 Finds any open tabs containing the specified document and adds them to the specified array; returns true if at least one is found.
Public function Virtual void

FocusInspectorOnGraphSelection ( const TSet< class UObject* >& NewSelection,
bool bForceRefresh
)

  
Protected function Const TArray< UEdGraphNode * > Get all connected nodes and add them to a set of out nodes
Public function Virtual Const UBlueprint * Returns a pointer to the Blueprint object we are currently editing, as long as we are editing exactly one
Public function Const TSharedRef< SBlueprintBookmarks >  
Public function Const void

GetBoundsForNode ( const UEdGraphNode* InNode,
FSlateRect& OutRect,
float InPadding
)

 Get the visible bounds of the given graph node
Public function Const TSharedRef< SWidget >  
Public function Static FName

GetContextFromBlueprintType ( EBlueprintType InType
)

 Get the context to use from the Blueprint type
Protected function Const FGraphAppearanceInfo Get the graph appearance of the currently focused graph
Protected function Const UEdGraphPin * Utility helper to get the currently hovered pin in the currently visible graph, or nullptr if there isn't one.
Public function Virtual Const FString

GetCustomDebugObjectLabel ( UObject* ObjectBeingDebugged
)

 Can be overloaded to customize the labels in the debug filter
Public function Virtual Const void Adds to a list of custom objects for debugging beyond what will automatically be found/used
Public function Const TSharedRef< SKismetInspector >  
Public function Const TSubclassOf< UEdGraphSchema > Gets the default schema for this editor
Protected function Virtual Const TSubclassOf< UEdGraphSchema > Whenever new graphs need to be created it will use this schema by default.
Protected function Const EVisibility Determines visibility of the edit parent class button on the menu bar overlay
Protected function Const EVisibility Determines visibility of the find parent class in content browser button on the menu bar overlay
Public function Const TSharedRef< SFindInBlueprints >  
Public function Static const FSlateBrush *

GetGlyphForGraph ( const UEdGraph* Graph,
bool bInLargeIcon
)

 Util for finding a glyph for a graphUtil for finding a glyph for a graph
Protected function Virtual Const FGraphAppearanceInfo Get the graph appearance of a specific graph, GetCurrentGraphAppearance() uses the currently focused graph.
Public function Virtual Const FText Called by a graph title bar to get any extra information the editor would like to display
Public function Static FText

GetGraphDisplayName ( const UEdGraph* Graph
)

 Gets the display name of a graph
Public function Const TSharedRef< SKismetInspector > Getters for the various Kismet2 widgets
Public function Const float Used to determine the visibility of the graph's instruction text.
Public function bool & Gets or sets the flag for context sensitivity in the graph action menu
Public function Const TSharedPtr< SMyBlueprint >  
Public function Const EVisibility Determines visibility of the native parent class manipulation buttons on the menu bar overlay
Public function TSharedRef< SBlueprintPalette >  
Protected function Const FText Returns the name of the Blueprint's parent class
Public function Const EVisibility Determines visibility of the standard parent class label on the menu bar overlay
Public function Const FText Returns our PIE Status - SIMULATING / SERVER / CLIENT
Public function Const bool  
Public function Const AActor * Provides access to the preview actor.
Public function FPreviewScene * Provides access to the preview scene.
Public function Const TSharedPtr< SReplaceNodeReferences >  
Protected function Const bool  
Public function Const FGraphPanelSelectionSet Get the currently selected set of nodes
Public function Const UEdGraphNode * 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)
Public function Const TSharedPtr< SSubobjectEditor >  
Public function Const UObject * Subobject Editor Callbacks.
Public function Const TSharedPtr< SSCSEditorViewport >  
Public function Const FText Returns: "(.h)"
Public function TSharedPtr< class FBlueprintEditorToolbar >  
Public function Const FName Gets the UI selection state of this editor
Public function Static FSlateBrush const *

GetVarIconAndColor ( const UStruct* VarScope,
FName VarName,
FSlateColor& IconColorOut,
FSlateBrush const*& SecondaryBrushOut,
FSlateColor& SecondaryColorOut
)

 Util for finding a glyph and color for a variable.
Public function Static FSlateBrush const *

GetVarIconAndColorFromPinType ( const FEdGraphPinType& PinType,
FSlateColor& IconColorOut,
FSlateBrush const*& SecondaryBrushOut,
FSlateColor& SecondaryColorOut
)

 Util for finding a glyph and color for a variable.
Public function Static FSlateBrush const *

GetVarIconAndColorFromProperty ( const FProperty* Property,
FSlateColor& IconColorOut,
FSlateBrush const*& SecondaryBrushOut,
FSlateColor& SecondaryColorOut
)

 Util for finding a glyph and color for a variable.
Public function void

GetViewBookmark ( FGuid& BookmarkId
)

 Gets the focused graph current view bookmark ID
Public function void

GetViewLocation ( FVector2D& Location,
float& ZoomAmount
)

 Gets the focused graph view location/zoom amount
Public function Virtual void Handle when the debug object is changed in the UI
Public function void  
Public function Const TOptional< float >  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  
Protected function void  
Public function void

ImportNamespace ( const FString& InNamespace
)

 Imports the given namespace into the editor.
Public function void Imports a set of namespace(s) into the editor.
Public function Const bool Returns true if in editing mode
Protected function Virtual void Called during initialization of the blueprint editor to register commands and extenders.
Public function void

InitBlueprintEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< class IToolkitHost >& InitToolkitHost,
const TArray< class UBlueprint* >& InBlueprints,
bool bShouldOpenInDefaultsMode
)

 Edits the specified blueprint
Public function Virtual Const bool Returns true if able to compile
Public function Const EVisibility  
Protected function Const bool Is the main details panel currently showing 'Class defaults' (Note: Has nothing to do with the standalone class defaults panel)?
Protected function Const bool Is the main details panel currently showing 'Global options' (e.g., class metadata)?
Public function Virtual Const bool

IsEditable ( UEdGraph* InGraph
)

 Returns whether a graph is editable or not
Public function Const bool Returns whether the editor is currently editing a single blueprint object
Public function Const bool Returns if we are currently closing the editor
Public function Const bool

IsGraphInCurrentBlueprint ( const UEdGraph* InGraph
)

 Checks to see if the provided graph is contained within the current blueprint
Public function Const 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
Public function Virtual Const bool Overridable function for determining if the current mode can script
Public function Virtual Const bool Returns true if the parent class is native and the link to it's header can be shown
Public function bool

IsNodeTitleVisible ( const UEdGraphNode* Node,
bool bRequestRename
)

 Check the Node Title is visible
Public function Const bool Returns true if the parent class of the Blueprint being edited is also a Blueprint
Public function Const bool Returns true if the parent class of the Blueprint being edited is an editable Blueprint
Public function Const bool Returns true if the parent class of the Blueprint being edited is native
Public function Const bool Returns true if PIE is active
Public function Const bool Helper functions used to construct/operate-on the "Save on Compile" command
Public function Virtual Const bool Called to see if the new document menu items is visible for this type.
Public function Const bool Make nodes which are unrelated to the selected nodes fade out
Public function void

JumpToNode ( const UEdGraphNode* Node,
bool bRequestRename
)

 Pan the view to center on a particular node
Public function Virtual void

JumpToPin ( const UEdGraphPin* Pin
)

  
Protected function void Load macro & function blueprint libraries from asset registry
Public function void

LogSimpleMessage ( const FText& MessageText
)

 Throw a simple message into the log
Public function void Called when a token in a log message is clicked
Public function TSharedRef< SWidget > Make a drop down menu to control the opacity of unrelated nodes
Protected function Const void

MoveNodesToAveragePos ( TSet< UEdGraphNode* >& AverageNodes,
FVector2D SourcePos,
bool bExpandedNodesNeedUniqueGuid
)

 Move the given set of nodes to an average spot near the Source position
Protected function Static void

MoveNodesToGraph ( TArray< UEdGraphNode* >& SourceNodes,
UEdGraph* DestinationGraph,
TSet< UEdGraphNode* >& OutExpandedNodes,
UEdGraphNode** OutEntry,
UEdGraphNode** OutResult,
const bool bIsCollapsedGraph
)

 Move every node from the source graph to the destination graph.
Protected function void  
Protected function void Navigating into/out of graphs.
Protected function void Navigating into/out of graphs.
Public function Const EVisibility  
Public function Virtual Const bool  
Public function FReply  
Public function Virtual void Called when New Function button is clicked
Public function Virtual Const bool

OnActionMatchesName ( FEdGraphSchemaAction* InAction,
const FName& InName
)

 Function used by the SMyBlueprint to determine if an action matches a name.
Public function Virtual void

OnActiveTabChanged ( TSharedPtr< SDockTab > PreviouslyActive,
TSharedPtr< SDockTab > NewlyActivated
)

  
Protected function void  
Protected function void  
Public function void Called when New Delegate button is clicked
Public function Virtual void Adds a new local variable to the focused function graph
Public function void Adds a new variable to this blueprint
Public function FReply  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void

OnBlueprintChanged ( UBlueprint* InBlueprint
)

 Called when the Blueprint we are editing has changed, forwards to impl
Protected function Virtual void

OnBlueprintChangedImpl ( UBlueprint* InBlueprint,
bool bIsJustBeingCompiled
)

 Called when the Blueprint we are editing has changed
Protected function void

OnBlueprintCompiled ( UBlueprint* InBlueprint
)

  
Protected function void

OnBlueprintUnloaded ( UBlueprint* InBlueprint
)

 Handles the unloading of Blueprints (by closing the editor, if it operating on the Blueprint being unloaded)
Protected function void  
Protected function void

OnChangePinTypeFinished ( const FEdGraphPinType& PinType,
UEdGraphPin* SelectedPin
)

  
Protected function void  
Protected function void  
Protected function void  
Public function Virtual void

OnComponentAddedToBlueprint ( const FSubobjectData& NewSubobjectData
)

 Delegate invoked when a new subobject is added in the subobject editor widget
Public function Virtual void Delegate invoked when an item is double clicked in the subobject editor widget
Protected function void  
Protected function void  
Protected function Virtual void Create comment node on graph
Protected function FActionMenuContent

OnCreateGraphActionMenu ( UEdGraph* InGraph,
const FVector2D& InNodePosition,
const TArray< UEdGraphPin* >& InDraggedPins,
bool bAutoExpand,
SGraphEditor::FActionMenuClosed InOnMenuClosed
)

 Called to create context menu when right-clicking on graph
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Public function void Dumps the currently-cached index data for the blueprint to a file for debugging
Protected function FReply Handler for "Edit parent class" button
Public function void Handles opening the header file of native parent class
Protected function Virtual void  
Protected function void  
Protected function void  
Protected function FReply Handler for "Find parent class in CB" button
Protected function Virtual void

OnFinishedChangingProperties ( const FPropertyChangedEvent& PropertyChangedEvent
)

 Callback when properties have finished being handled
Public function void Dumps the current blueprint search index to a JSON file for debugging purposes
Protected function Const FEdGraphPinType

OnGetPinType ( UEdGraphPin* SelectedPin
)

 Functions for handling the changing of the pin's type (PinCategory, PinSubCategory, etc)
Protected function void

OnGraphActionMenuClosed ( bool bActionExecuted,
bool bContextSensitiveChecked,
bool bGraphPinContext
)

 Called from graph context menus when they close to tell the editor why they closed
Public function Virtual void

OnGraphEditorBackgrounded ( const TSharedRef< SGraphEditor >& InGraphEditor
)

 Called when the graph editor tab is backgrounded
Protected function void

OnGraphEditorDropActor ( const TArray< TWeakObjectPtr< AActor > >& Actors,
UEdGraph* Graph,
const FVector2D& DropLocation
)

 Called when an actor is dropped onto the graph editor
Protected function void

OnGraphEditorDropStreamingLevel ( const TArray< TWeakObjectPtr< ULevelStreaming > >& Levels,
UEdGraph* Graph,
const FVector2D& DropLocation
)

 Called when a streaming level is dropped onto the graph editor
Public function Virtual void

OnGraphEditorFocused ( const TSharedRef< class SGraphEditor >& InGraphEditor
)

 Called when graph editor focus is changed
Protected function void

OnGraphEditorQuickJump ( int32 BookmarkIndex
)

 Handles activation of a graph editor "quick jump" command
Protected function void

OnInsertExecutionPin ( EPinInsertPosition Position
)

  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Public function void

OnLockNodeStateCheckStateChanged ( ECheckBoxState NewCheckedState
)

  
Public function Virtual Const bool If returns true only the custom debug list will be used
Public function FOnModeSet &  
Protected function void  
Public function void Called when node is spawned by keymap
Public function void

OnNodeTitleCommitted ( const FText& NewText,
ETextCommit::Type CommitInfo,
UEdGraphNode* NodeBeingChanged
)

 Called when a node's title is committed for a rename
Protected function 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
Public function Virtual void

OnPasteNewLocalVariable ( const FBPVariableDescription& VariableDescription
)

 Pastes a new local variable to the focused function graph
Protected function void

OnPostObjectPropertyChanged ( UObject* InObject,
FPropertyChangedEvent& PropertyChangedEvent
)

 Called after a property change has been propagated to instances of the Blueprint
Protected function void

OnPreObjectPropertyChanged ( UObject* InObject,
const FEditPropertyChain& EditPropertyChain
)

 Called when a property change is about to be propagated to instances of the Blueprint
Protected function void  
Protected function void  
Protected function void

OnPromoteToVariable ( bool bInToMemberVariable
)

 UI Action functionality.
Protected function void  
Public function FOnRefreshEvent &  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void On starting to rename node
Protected function void  
Protected function void  
Protected function void  
Protected function void

OnSelectedNodesChanged ( const TSet< class UObject* >& NewSelection
)

 Called when the selection changes in the GraphEditor
Protected function Virtual void

OnSelectedNodesChangedImpl ( const TSet< class UObject* >& NewSelection
)

 Called when the selection changes in the GraphEditor
Public function Virtual void

OnSelectionUpdated ( const TArray< TSharedPtr< class FSubobjectEditorTreeNode >>& SelectedNodes
)

 Delegate invoked when the selection is changed in the subobject editor widget
Protected function void  
Public function Virtual FReply

OnSpawnGraphNodeByShortcut ( FInputChord InChord,
const FVector2D& InPosition,
UEdGraph* InGraph
)

 Handles spawning a graph node in the current graph using the passed in chord
Protected function void  
Protected function void Start editing the defaults for this blueprint
Protected function Virtual void  
Protected function Virtual void  
Protected function void  
Protected function void  
Protected function void Spawns a new blueprint debugger tab
Public function TSharedPtr< SDockTab >  
Protected function Virtual void Paste Variable Definition or Nodes
Protected function Virtual void  
Public function void Should be called when initializing an editor that has a blueprint, after layout (tab spawning) is done.
Protected function void Given a node, make connections from anything connected to it's input pin to anything connected to it's "then" pins.
Protected function void Called to redo the last undone action
Public function void Called when the refresh all nodes button is clicked
Protected function void Updates the selected object used by the stand lone defaults editor widget.
Protected function Virtual void

RegisterApplicationModes ( const TArray< UBlueprint* >& InBlueprints,
bool bShouldOpenInDefaultsMode,
bool bNewlyCreated
)

 Called during initialization of the blueprint editor to register any application modes.
Protected function void Register Menus
Public function void

RegisterSCSEditorCustomization ( const FName& InComponentName,
TSharedPtr< class ISCSEditorCustomization > InCustomization
)

 Register a customization for interacting with the subobject editor
Public function void

RegisterToolbarTab ( const TSharedRef< class FTabManager >& TabManager
)

  
Public function void

RemoveBookmark ( const FGuid& BookmarkNodeId,
bool bRefreshUI
)

 Removes the bookmark node with the given ID.
Public function void

RemoveNamespace ( const FString& InNamespace
)

 Removes the given namespace from the editor's current import context.
Public function void

RenameBookmark ( const FGuid& BookmarkNodeId,
const FText& NewName
)

 Renames the bookmark node with the given ID.
Public function void

RenameNewlyAddedAction ( FName InActionName
)

 Utility function to handle all steps required to rename a newly added action
Public function void Reparent the current blueprint
Public function Virtual Const bool  
Public function void  
Public function void 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
Protected function void Focus nodes which are related to the selected nodes
Public function void Create new tab for each element of LastEditedObjects array
Public function void Save the current set of edited objects in the LastEditedObjects array so it will be opened next time we open K2
Protected function void  
Public function void Duplicates an EdGraphNode using selection and copy / paste functionality
Public function void

SelectGraphActionItemByName ( const FName& ItemName,
ESelectInfo::Type SelectInfo,
int32 SectionId,
bool bIsCategory
)

 Selects an item in "My Blueprint" by name.
Public function Virtual bool

SelectLocalVariable ( const UEdGraph* Graph,
const FName& VariableName
)

 Selects a local variable to load in the details panel.
Public function void

SetDetailsCustomization ( TSharedPtr< class FDetailsViewObjectFilter > DetailsObjectFilter,
TSharedPtr< class IDetailRootObjectCustomization > DetailsRootCustomization
)

 Sets customizations for the BP editor details panel.
Protected function void

SetGraphEditorQuickJump ( int32 BookmarkIndex
)

 Binds a graph editor "quick jump" to the command at the given index
Public function void Ensures the blueprint has keyboard focus.
Public function void Pin visibility accessors
Public function void Sets subobject editor UI customization
Public function void

SetUISelectionState ( FName SelectionOwner
)

  
Protected function Virtual void Setup all the events that the graph editor can handle
Public function void Called by the blueprint editing app mode to focus the appropriate tabs, etc...
Public function void

SetViewLocation ( const FVector2D& Location,
float ZoomAmount,
const FGuid& BookmarkId
)

 Sets the focused graph view location/zoom amount
Public function Virtual bool 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.
Public function Virtual void

StartEditingDefaults ( bool bAutoFocus,
bool bForceRefresh
)

 Virtual override point for editing defaults; allowing more derived editors to edit something else
Public function void Make nodes which are unrelated to the selected nodes fade out
Protected function void  
Public function Virtual bool

TransactionObjectAffectsBlueprint ( UObject* InTransactedObject
)

  
Protected function void

TryInvokingDetailsTab ( bool bFlash
)

 Attempts to invoke the details tab if it's currently possible to.
Protected function void Called to undo the last action
Public function void

UnregisterSCSEditorCustomization ( const FName& InComponentName
)

 Unregister a previously registered customization for interacting with the subobject editor
Public function void Update Node Creation mechanisms for analytics
Public function void Update all nodes' unrelated states when the graph has changed
Public function void

UpdatePreviewActor ( UBlueprint* InBlueprint,
bool bInForceFullUpdate
)

 Creates/updates the preview actor for the given blueprint.
Public function void

UpdateSubobjectPreview ( bool bUpdateNow
)

 Refresh the preview viewport to reflect changes in the subobject
Public function void Variable list window calls this after it is updated
Protected function void Zooming to fit the current selection.
Protected function void Zooming to fit the entire graph.

Overridden from IBlueprintEditor

  Type Name Description
Public function Virtual void  
Public function Virtual Const void

AnalyticsTrackNodeEvent ( UBlueprint* Blueprint,
UEdGraphNode* GraphNode,
bool bNodeDelete
)

 Used to track node create/delete events for Analytics
Protected function Virtual Const bool  
Protected function Virtual bool

GetBoundsForSelectedNodes ( FSlateRect& Rect,
float Padding
)

  
Public function Virtual Const UEdGraph * Returns the currently focused graph context, or NULL if no graph is available.
Public function Virtual Const TSharedPtr< class IClassViewerFilter > Return the class viewer filter associated with the current set of imported namespaces within this editor context.
Public function Virtual Const int32 Get number of currently selected nodes in the SCS editor tree
Public function Virtual Const void Get all the the pin type selector filters within this editor context.
Public function Virtual Const TArray< TSharedPtr< FSubobjectEditorTreeNode > > Util to get the currently selected Subobject editor tree Nodes
Public function Virtual Const 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.
Public function Virtual Const 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.
Public function Virtual void

JumpToHyperlink ( const UObject* ObjectReference,
bool bRequestRename
)

  
Public function Virtual TSharedPtr< SGraphEditor >

OpenGraphAndBringToFront ( UEdGraph* Graph,
bool bSetFocus
)

 Tries to open the specified graph and bring it's document to the front (note: this can return NULL)
Protected function Virtual void

PasteNodesHere ( UEdGraph* DestinationGraph,
const FVector2D& GraphLocation
)

 Paste on graph at specific location
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void Invokes the Find and Replace UI
Public function Virtual 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
Public function Virtual 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
Public function Virtual Const FString  
Public function Virtual void Add context objects for menus and toolbars
Public function Virtual void

OnClose ()

 Called when this toolkit is being closed
Public function Virtual bool

OnRequestClose ( EAssetEditorCloseReason InCloseReason
)

 Called when this toolkit is requested to close. Returns false if closing should be prevented.
Protected function Virtual void Recreates the overlay on the menu bar

Overridden from IToolkit

  Type Name Description
Public function Virtual Const FText Returns the localized name of this toolkit type (typically just " editor")
Public function Virtual Const FName Returns the invariant name of this toolkit type, used for establishing the context for help, documentation and tutorials
Public function Virtual Const FName Returns the invariant name of this toolkit type
Public function Virtual Const FText Returns the localized name of this toolkit
Public function Virtual Const FText Returns the localized tooltip text of this toolkit
Public function Virtual Const FLinearColor  
Public function Virtual Const FString Returns the localize prefix string to use for tab labels in world-centric mode.
Public function Virtual Const bool Returns if this is a IBlueprintEditor derivation
Public function Virtual void

RegisterTabSpawners ( const TSharedRef< class FTabManager >& TabManager
)

 IToolkit interface

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Overridden from FNotifyHook

  Type Name Description
Protected function Virtual void

NotifyPostChange ( const FPropertyChangedEvent& PropertyChangedEvent,
FProperty* PropertyThatChanged
)

  
Protected function Virtual void

NotifyPreChange ( FProperty* PropertyAboutToChange
)

  

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual Const ETickableTickType Virtual that can be overloaded by the inheriting class.
Public function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Overridden from FEditorUndoClient

  Type Name Description
Protected function Virtual void

PostRedo ( bool bSuccess
)

 Signal that client should run any PostRedo code
Protected function Virtual 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

Name Description
SelectionState_ClassDefaults  
SelectionState_ClassSettings  
SelectionState_Components  
SelectionState_Graph  
SelectionState_MyBlueprint  

Deprecated Functions

  Type Name Description
Public function Const TSharedPtr< class ISCSEditorCustomization >

CustomizeSCSEditor ( USceneComponent* InComponentToCustomize
)

 CustomizeSCSEditor has been deprecated. Use CustomizeSubobjectEditor instead.
Public function Virtual TSharedPtr< class FSCSEditorTreeNode >

FindAndSelectSCSEditorTreeNode ( const UActorComponent* InComponent,
bool IsCntrlDown
)

 FindAndSelectSCSEditorTreeNode has been deprecated. Use FindAndSelectSubobjectEditorTreeNode instead.
Public function Virtual Const TSharedPtr< class IPinTypeSelectorFilter > Please use GetPinTypeSelectorFilters
Public function Const TSharedPtr< SSCSEditor > GetSCSEditor has been deprecated. Use GetSubobjectEditor instead.
Public function Virtual Const TArray< TSharedPtr< class FSCSEditorTreeNode > > GetSelectedSCSEditorTreeNodes has been deprecated. Use GetSelectedSubobjectEditorTreeNodes instead.
Public function Virtual void OnComponentDoubleClicked(TSharedPtr) has been deprecated. Use OnComponentDoubleClicked(TSharedPtr) instead.
Public function Virtual void

OnSelectionUpdated ( const TArray< TSharedPtr< class FSCSEditorTreeNode >>& SelectedNodes
)

 OnSelectionUpdated(const TArray>&) has been deprecated. Use OnSelectionUpdated(const TArray>&) instead.
Public function void

SetSCSEditorUICustomization ( TSharedPtr< class ISCSEditorUICustomization > SCSEditorUICustomization
)

 SetSCSEditorUICustomization has been deprecated. Use SetSubobjectEditorUICustomization instead.
Public function Const bool 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

On this page