Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > Kismet > FBlueprintEditor

Light Theme

Dark Theme

FBlueprintEditor

Main Kismet asset editor

Windows

MacOS

Linux

Inheritance Hierarchy

IBlueprintEditor

FGCObject

FNotifyHook

FTickableEditorObject

FEditorUndoClient

FBlueprintEditor

	FGameplayAbilitiesEditor
	FWidgetBlueprintEditor
	IAnimationBlueprintEditor
	IControlRigEditor
	IDisplayClusterConfiguratorBlueprintEditor

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

Remarks

Main Kismet asset editor

Variables

	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
TSharedPtr< cla...	CompilerResults	Compiler results log, with the log listing that it reflects
TSharedPtr< cla...	CompilerResultsListing
FName	CurrentUISelection	The current UI selection state of this editor
TSharedPtr< cla...	DebuggingView	Debugging window (watches, breakpoints, etc...)
TSharedPtr< cla...	DefaultEditor	Defaults inspector widget
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...	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
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
TSharedPtr< cla...	SCSEditor	SCS editor
TSharedPtr< cla...	SCSViewport	Viewport widget
TArray< UBluepr...	StandardLibraries	Macro/function libraries to keep loaded
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

	Name	Description
	FBlueprintEditor()

Destructors

	Name	Description
	~FBlueprintEditor()

Functions

	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	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	CanAddPosePin()
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()
bool	CanCollapseSelectionToMacro ( TSet< class UEdGraphNode* >& ... )	Called when a selection of nodes is being collapsed into a macro
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	CanGenerateNativeCode()	Can generate native code for current blueprint
bool	CanInsertExecutionPin()
bool	CanMergeAnimStateTransitions()
bool	CanNavigateToChildGraph()
bool	CanNavigateToParentGraph()
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	CanRemovePosePin()
bool	CanRemoveThisStructVarPin()
bool	CanRenameNodes()
bool	CanResetPinToDefaultValue()
bool	CanRestoreAllStructVarPins()
bool	CanSelectAllNodes()
bool	CanSelectBone()
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 ( does not create the tabs themselves)
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< ...	CustomizeSCSEditor ( USceneComponent* InComponentTo... )	Check to see if we can customize the SCS 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 )	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	EnableSCSPreview ( bool bEnable )	Enable/disable the SCS 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< ...	FindAndSelectSCSEditorTreeNode ( 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 NULL 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< ...	GetDebuggingView()
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()
UEdGraph ...	GetFocusedGraph()	Returns the currently focused graph in the Blueprint editor
const FSlate...	GetGlyphForGraph ( const UEdGraph* Graph, bool bInLargeIcon )	Util for finding a glyph for a graph Util 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
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()
TSharedPtr< ...	GetSCSEditor()	Getters for the various optional Kismet2 widgets
AActor *	GetSCSEditorActorContext()	Delegate invoked when the SCS editor needs to obtain the Actor context for editing
TSharedPtr< ...	GetSCSViewport()
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)
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 ...	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()
bool	InDebuggingMode()	Returns true if in debugging mode
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' (.
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	IsGraphInCurrentBlueprint ( 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	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_Clicked()
void	NavigateToParentGraph_Clicked()	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
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	OnAddPosePin()
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	OnComponentDoubleClicked ( TSharedPtr< class FSCSEditorTreeNod... )	Delegate invoked when an item is double clicked in the SCS editor widget
void	OnConvertEventToFunction()
void	OnConvertFunctionToEvent()
void	OnConvertToAimOffsetLookAt()
void	OnConvertToAimOffsetSimple()
void	OnConvertToBlendSpaceEvaluator()
void	OnConvertToBlendSpacePlayer()
void	OnConvertToPoseBlender()
void	OnConvertToPoseByName()
void	OnConvertToSequenceEvaluator()	Convert functions between evaluator and player
void	OnConvertToSequencePlayer()
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
void	OnMergeAnimStateTransitions()
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	OnOpenRelatedAsset()	Opens the associated asset of the selected nodes.
void	OnPromoteSelectionToFunction()
void	OnPromoteSelectionToMacro()
void	OnPromoteToVariable ( bool bInToMemberVariable )	UI Action functionality.
void	OnRecombineStructPin()
FOnRefreshEv...	OnRefresh()
void	OnRemoveBreakpoint()
void	OnRemoveExecutionPin()
void	OnRemoveOptionPin()
void	OnRemoveOtherStructVarPins()
void	OnRemovePosePin()
void	OnRemoveThisStructVarPin()
void	OnRenameNode()	On starting to rename node
void	OnRepairCorruptedBlueprint()
void	OnResetPinToDefaultValue()
void	OnRestoreAllStructVarPins()
void	OnSelectBone()	BEGIN PERSONA related callback functions
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 FSC... )	Delegate invoked when the selection is changed in the SCS 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()
TSharedPtr< ...	OpenDocument ( const UObject* DocumentID, FDocumentTracker::EOpenDocumentCaus... )
void	OpenNativeCodeGenerationTool()	Opens a native code generation modal window
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 SCS editor
void	RegisterToolbarTab ( const TSharedRef< class FTabManager... )
void	RemoveBookmark ( const FGuid& BookmarkNodeId, bool bRefreshUI )	Removes the bookmark node with the given ID.
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	SelectGraphActionItemByName ( const FName& ItemName, ESelectInfo::Type SelectInfo, int32 SectionId, bool bIsCategory )	Selects an item in "My Blueprint" by name.
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	SetPinVisibility ( SGraphEditor::EPinVisibility Visibi... )	Pin visibility accessors
void	SetSCSEditorUICustomization ( TSharedPtr< class ISCSEditorUICusto... )	Sets SCS 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	ShouldShowToggleHideUnrelatedNodes ( bool bIsToolbar )	Make nodes which are unrelated to the selected nodes fade out
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()	END PERSONA related callback functions
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 SCS 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	UpdateSCSPreview ( bool bUpdateNow )	Refresh the preview viewport to reflect changes in the SCS
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

	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 )
int32	GetNumberOfSelectedNodes()	Get number of currently selected nodes in the SCS editor tree
TArray< TSha...	GetSelectedSCSEditorTreeNodes()	Util to get the currently selected SCS editor tree Nodes
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 ( 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

		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

	Name	Description
FString	GetDocumentationLink()
void	InitToolMenuContext ( FToolMenuContext& MenuContext )	Add context objects for menus and toolbars
bool	OnRequestClose()	Called when this toolkit would close
void	PostRegenerateMenusAndToolbars()	Recreates the overlay on the menu bar

Overridden from IToolkit

	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

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

Overridden from FNotifyHook

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

Overridden from FTickableObjectBase

	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

		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

	Name	Description
	FOnRefreshEvent	Broadcasts a notification whenever the editor needs associated controls to refresh

Enums

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

Typedefs

Name	Description
FOnModeSet
FOnSetPinVisibility

Constants

Name	Description
SelectionState_ClassDefaults
SelectionState_ClassSettings
SelectionState_Components
SelectionState_Graph
SelectionState_MyBlueprint

Deprecated Functions

		Name	Description
	void	AppendExtraCompilerResults ( TSharedPtr< class IMessageLogListin... )	Please do any validation inside the UBlueprint class during compilation, extra errors during compiling only supplied by the designer can lead to design time only errors being reported and being missed during cooks/content validation.
	bool	IsParentClassOfObjectABlueprint ( const UBlueprint* Blueprint )	Please use FBlueprintEditorUtils::IsParentClassABlueprint instead

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

Take our survey

Dismiss