1. Epic GamesDeveloper
  3. UEdGraphSchema

UEdGraphSchema

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/EdGraph

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/EdGraph/EdGraphSchema.h
Include #include "EdGraph/EdGraphSchema.h"

Syntax

class UEdGraphSchema : public UObject

Constructors

  Type Name Description
Public function  

UEdGraphSchema ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const bool

ArePinsCompatible ( const UEdGraphPin* PinA,
const UEdGraphPin* PinB,
const UClass* CallingContext,
bool bIgnoreArray
)

 Returns true if the types and directions of two pins are schema compatible.
Public function Virtual Const bool Returns true if the types are schema Equivalent.
Public function Virtual Const void

BackwardCompatibilityNodeConversion ( UEdGraph* Graph,
bool bOnlySafeChanges
)

  
Public function Virtual Const FReply Begins a drag and drop action to drag a graph action into another graph
Public function Virtual Const void

BreakNodeLinks ( UEdGraphNode& TargetNode
)

 Breaks all links from/to a single node
Public function Virtual Const void

BreakPinLinks ( UEdGraphPin& TargetPin,
bool bSendsNodeNotifcation
)

 Breaks all links from/to a single pin
Public function Virtual Const void

BreakSinglePinLink ( UEdGraphPin* SourcePin,
UEdGraphPin* TargetPin
)

 Breaks the link between two nodes.
Public function Virtual Const const FPinConnectionResponse Determine if a connection can be created between two pins.
Public function Virtual Const FPinConnectionResponse

CanCreateNewNodes ( UEdGraphPin* InSourcePin
)

 Check whether new nodes can be user-created (by dragging off pins etc.)
Public function Virtual Const bool

CanDuplicateGraph ( UEdGraph* InSourceGraph
)

 Can this graph type be duplicated?
Public function Virtual Const bool

CanEncapuslateNode ( UEdGraphNode const& TestNode
)

 Can TestNode be encapsulated into a child graph?
Public function Virtual Const bool Can the function graph be dropped into another graph
Public function Virtual Const const FPinConnectionResponse

CanMergeNodes ( const UEdGraphNode* A,
const UEdGraphNode* B
)

 Determine if two nodes can be merged
Public function Virtual Const const FPinConnectionResponse

CanRelinkConnectionToPin ( const UEdGraphPin* OldSourcePin,
const UEdGraphPin* TargetPinCandidate
)

 Determine if a connection can be relinked to the given pin.
Public function Virtual Const bool Checks to see if a pin supports Pin Value Inspection Tooltips
Public function Virtual Const bool

CanVariableBeDropped ( UEdGraph* InGraph,
FProperty* InVariableToDrop
)

 Check whether variables can be dropped onto the graph
Public function Static bool

CategorizePinsByDirection ( PinType* PinA,
PinType* PinB,
PinType*& InputPin,
PinType*& OutputPin
)

 Categorizes two pins into an input pin and an output pin. Returns true if successful or false if they don't make sense as such (two inputs or two outputs)
Public function Virtual Const void

ClearPinWatch ( UEdGraphPin const* Pin
)

 If the specified pin is currently being watched, then this will clear the watch from the graph's debug system.
Protected function Const int32 Build an array containing all search types, return the index of the first non-localized entry.
Public function Virtual Const void

ConstructBasicPinTooltip ( UEdGraphPin const& Pin,
FText const& PinDescription,
FString& TooltipOut
)

 Takes the PinDescription and tacks on any other data important to the schema (things like the pin's type, etc.).
Public function Virtual Const FPinConnectionResponse

CopyPinLinks ( UEdGraphPin& CopyFromPin,
UEdGraphPin& CopyToPin,
bool bIsIntermediateCopy
)

 Copies pin links from one pin to another without breaking the original links
Public function Virtual Const bool Try to create an automatic cast or other conversion node node to facilitate a connection between two pins.
Public function Virtual Const FConnectionDrawingPolicy *

CreateConnectionDrawingPolicy ( int32 InBackLayerID,
int32 InFrontLayerID,
float InZoomFactor,
const FSlateRect& InClippingRect,
FSlateWindowElementList& InDrawElements,
UEdGraph* InGraphObj
)

 Returns new FConnectionDrawingPolicy from this schema
Public function Virtual Const void Populate new graph with any default nodes
Public function Virtual Const bool Try to create a promotion from one type to another in order to make a connection between two pins.
Public function Virtual Const UEdGraphNode *

CreateSubstituteNode ( UEdGraphNode* Node,
const UEdGraph* Graph,
FObjectInstancingGraph* InstanceGraph,
TSet< FName >& InOutExtraNames
)

 Attempts to construct a substitute node that is unique within its graph.
Public function Virtual Const bool

DoesDefaultValueMatch ( const UEdGraphPin& InPin,
const FString& InValue
)

 Returns if the pin's value matches the given value
Public function Virtual Const bool Returns if the pin's value matches what the true (autogenerated) default value for that pin would be
Public function Virtual Const bool An easy way to check to see if the current graph system supports pin watching.
Public function Virtual Const void

DroppedAssetsOnGraph ( const TArray< struct FAssetData >& Assets,
const FVector2D& GraphPosition,
UEdGraph* Graph
)

 Called when asset(s) are dropped onto a graph background.
Public function Virtual Const void

DroppedAssetsOnNode ( const TArray< struct FAssetData >& Assets,
const FVector2D& GraphPosition,
UEdGraphNode* Node
)

 Called when asset(s) are dropped onto the specified node
Public function Virtual Const void

DroppedAssetsOnPin ( const TArray< struct FAssetData >& Assets,
const FVector2D& GraphPosition,
UEdGraphPin* Pin
)

 Called when asset(s) are dropped onto the specified pin
Public function Virtual Const UEdGraphPin *

DropPinOnNode ( UEdGraphNode* InTargetNode,
const FName& InSourcePinName,
const FEdGraphPinType& InSourcePinType,
EEdGraphPinDirection InSourcePinDirection
)

 Some schemas have nodes that support the user dynamically adding pins when dropping a connection on the node
Public function Virtual Const UEdGraph *

DuplicateGraph ( UEdGraph* GraphToDuplicate
)

 Duplicate a given graph return the duplicate graph
Public function Virtual Const bool When dragging off a pin, we want to duck the alpha of some nodes
Public function Virtual Const void Forces cached visualization data to refresh
Public function Virtual Const float

GetActionFilteredWeight ( const FGraphActionListBuilderBase::ActionGroup& InCurrentAction,
const TArray< FString >& InFilterTerms,
const TArray< FString >& InSanitizedFilterTerms,
const TArray< UEdGraphPin* >& DraggedFromPins
)

 Calculate the weight priority of a given action for the context menu.
Public function Virtual Const void

GetAssetsGraphHoverMessage ( const TArray< FAssetData >& Assets,
const UEdGraph* HoverGraph,
FString& OutTooltipText,
bool& OutOkIcon
)

 Allows schema to generate a tooltip (icon & message) when the specified asset(s) are dragged over the specified graph
Public function Virtual Const void

GetAssetsNodeHoverMessage ( const TArray< struct FAssetData >& Assets,
const UEdGraphNode* HoverNode,
FString& OutTooltipText,
bool& OutOkIcon
)

 Allows schema to generate a tooltip (icon & message) when the specified asset(s) are dragged over the specified node
Public function Virtual Const void

GetAssetsPinHoverMessage ( const TArray< struct FAssetData >& Assets,
const UEdGraphPin* HoverPin,
FString& OutTooltipText,
bool& OutOkIcon
)

 Allows schema to generate a tooltip (icon & message) when the specified asset(s) are dragged over the specified pin
Public function Virtual Const void Gets actions that should be added to the right-click context menu for a node or pin
Public function Const FName Returns context menu name
Public function Static FName

GetContextMenuName ( UClass* InClass
)

 Returns context menu name for a given class
Public function Virtual Const TSharedPtr< FEdGraphSchemaAction > Returns schema action to create comment from implemention
Public function Virtual Const int32 Returns the current cache title refresh ID that is appropriate for the passed node
Public function Virtual Const FString Returns a custom reference string for searching within the blueprint based on a given action
Public function Virtual Const FText

GetGraphCategory ( const UEdGraph* InGraph
)

 Returns an optional category for a graph
Public function Virtual Const void Get all actions that can be performed when right clicking on a graph or drag-releasing on a graph from a pin
Public function Virtual Const void

GetGraphDisplayInformation ( const UEdGraph& Graph,
FGraphDisplayInfo& DisplayInfo
)

 Gets display information for a graph
Public function Virtual Const EGraphType

GetGraphType ( const UEdGraph* TestEdGraph
)

  
Public function Virtual Const bool

GetLocalVariables ( const UEdGraph* InGraph,
TArray< FBPVariableDescription >& OutLocalVariables
)

 Returns the local variables related to the graph.
Public function Virtual Const TSharedPtr< INameValidatorInterface >

GetNameValidator ( const UBlueprint* InBlueprintObj,
const FName& InOriginalName,
const UStruct* InValidationScope,
const FName& InActionTypeId
)

 Returns a name validator appropiate for the schema and object that is being named
Public function Virtual Const int32

GetNodeSelectionCount ( const UEdGraph* Graph
)

 Returns the currently selected graph node count
Public function Virtual Const FName Returns parent context menu name
Public function Virtual Const FText Get the name to show in the editor
Public function Virtual Const FLinearColor

GetPinTypeColor ( const FEdGraphPinType& PinType
)

 Gets the draw color of a pin based on it's type.
Public function Virtual Const FGraphSchemaSearchWeightModifiers Get the weight modifiers from the console variable settings
Public function Virtual Const FLinearColor  
Public function Virtual Const void

HandleGraphBeingDeleted ( UEdGraph& GraphBeingRemoved
)

 Handle a graph being removed by the user (potentially removing associated bound nodes, etc...)
Public function Virtual Const void

InsertAdditionalActions ( TArray< UBlueprint* > InBlueprints,
TArray< UEdGraph* > InGraphs,
TArray< UEdGraphPin* > InPins,
FGraphActionListBuilderBase& OutAllActions
)

 Insert additional actions into the blueprint action menu
Public function Virtual Const bool

IsCacheVisualizationOutOfDate ( int32 InVisualizationCacheID
)

 Checks if a CacheRefreshID is out of date
Public function Virtual Const bool Is this schema supporting connection relinking for the given pin?
Public function Const FString Determine whether the current pin default values are valid
Public function Virtual Const bool

IsDelegateCategory ( const FName Category
)

 Is given string a delegate category name ?
Public function Virtual Const bool Checks to see if the specified pin is being watched by the graph's debug system.
Public function Virtual Const FString

IsPinDefaultValid ( const UEdGraphPin* Pin,
const FString& NewDefaultValue,
TObjectPtr< UObject > NewDefaultObject,
const FText& InNewDefaultText
)

 Determine if the supplied pin default values would be valid.
Public function Virtual Const bool

IsSelfPin ( const UEdGraphPin& Pin
)

 Is self pin type?
Public function Virtual Const bool

IsTitleBarPin ( const UEdGraphPin& Pin
)

 Query if the passed in pin is a title bar pin.
Public function Virtual Const TSharedPtr< FEdGraphSchemaAction >

MakeActionFromVariableDescription ( const UEdGraph* InEdGraph,
const FBPVariableDescription& VariableDescription
)

 Generates a graph schema action from a graph and a variable description.
Public function Virtual Const bool

MarkBlueprintDirtyFromNewNode ( UBlueprint* InBlueprint,
UEdGraphNode* InEdGraphNode
)

 Returns true if the schema wants to overdrive the behaviour of dirtying the blueprint on new node creation.
Public function Virtual Const FPinConnectionResponse

MovePinLinks ( UEdGraphPin& MoveFromPin,
UEdGraphPin& MoveToPin,
bool bIsIntermediateMove,
bool bNotifyLinkedNodes
)

 Break links on this pin and create links instead on MoveToPin
Public function Virtual Const void

OnPinConnectionDoubleCicked ( UEdGraphPin* PinA,
UEdGraphPin* PinB,
const FVector2D& GraphPosition
)

 Handles double-clicking on a pin<->pin connection
Protected function Const void

PrintSearchTextDebugInfo ( const TArray< FString >& InFilterTerms,
const FGraphActionListBuilderBase::ActionGroup& InCurrentAction,
const FGraphSchemaSearchTextDebugInfo* InDebugInfo
)

  
Public function Virtual Const void Collapses a pin and its siblings back in to the original pin
Public function Virtual Const void

ReconstructNode ( UEdGraphNode& TargetNode,
bool bIsBatchRequest
)

 Reconstructs a node
Public function Virtual bool

RequestVariableDropOnNode ( UEdGraph* InGraph,
FProperty* InVariableToDrop,
UEdGraphNode* InNode,
const FVector2D& InDropPosition,
const FVector2D& InScreenPosition
)

 Request to drop a variable on a node
Public function Virtual bool

RequestVariableDropOnPanel ( UEdGraph* InGraph,
FProperty* InVariableToDrop,
const FVector2D& InDropPosition,
const FVector2D& InScreenPosition
)

 Request to drop a variable on a panel
Public function Virtual bool

RequestVariableDropOnPin ( UEdGraph* InGraph,
FProperty* InVariableToDrop,
UEdGraphPin* InPin,
const FVector2D& InDropPosition,
const FVector2D& InScreenPosition
)

 Request to drop a variable on a pin
Public function Virtual Const void

ResetPinToAutogeneratedDefaultValue ( UEdGraphPin* Pin,
bool bCallModifyCallbacks
)

 Resets a pin back to it's autogenerated default value, optionally calling the default value change callbacks
Public function Virtual Const bool Perform any logic necessary to safely remove this node from the graph.
Public function Static bool

SetNodeMetaData ( UEdGraphNode* Node,
FName const& KeyValue
)

  
Public function Virtual Const void

SetNodePosition ( UEdGraphNode* Node,
const FVector2D& Position
)

 Sets a node's position.
Public function Virtual Const void Let's the schema know about the next pin being dropped
Public function Virtual Const bool When a node is removed, this method determines whether we should remove it immediately or use the old (slower) code path that results in all node being recreated:
Public function Virtual Const bool If we should disallow viewing and editing of the supplied pin
Public function Virtual Const bool Should the Pin in question display an asset picker
Public function Virtual Const void

SplitPin ( UEdGraphPin* Pin,
bool bNotify
)

 Split a pin in to subelements
Public function Virtual Const bool

SupportsDropPinOnNode ( UEdGraphNode* InTargetNode,
const FEdGraphPinType& InSourcePinType,
EEdGraphPinDirection InSourcePinDirection,
FText& OutErrorMessage
)

 Checks if the node supports dropping a pin on it
Public function Virtual Const bool

SupportsPinType ( TWeakPtr< const FEdGraphSchemaAction > SchemaAction,
const FEdGraphPinType& PinType
)

 Returns true if the schema supports the pin type through the schema action
Public function Virtual Const bool

SupportsPinTypeContainer ( TWeakPtr< const FEdGraphSchemaAction > SchemaAction,
const FEdGraphPinType& PinType,
const EPinContainerType& ContainerType
)

 Returns true if the schema supports the pin type through the schema action
Public function Virtual Const bool Try to make a connection between two pins.
Public function Virtual Const bool

TryDeleteGraph ( UEdGraph* GraphToDelete
)

 Try to delete the graph through the schema, return true if successful
Public function Virtual Const bool

TryRelinkConnectionTarget ( UEdGraphPin* SourcePin,
UEdGraphPin* OldTargetPin,
UEdGraphPin* NewTargetPin,
const TArray< UEdGraphNode* >& InSelectedGraphNodes
)

 Try relinking the connection starting at the old source and target pins and relink it to the new target pin.
Public function Virtual Const bool

TryRenameGraph ( UEdGraph* GraphToRename,
const FName& InNewName
)

 Try to rename a graph through the schema, return true if successful
Public function Virtual Const void

TrySetDefaultObject ( UEdGraphPin& Pin,
UObject* NewDefaultObject,
bool bMarkAsModified
)

 Sets the object to the specified pin
Public function Virtual Const void

TrySetDefaultText ( UEdGraphPin& InPin,
const FText& InNewDefaultText,
bool bMarkAsModified
)

 Sets the text to the specified pin
Public function Virtual Const void

TrySetDefaultValue ( UEdGraphPin& Pin,
const FString& NewDefaultValue,
bool bMarkAsModified
)

 Sets the string to the specified pin; even if it is invalid it is still set.
Public function Virtual FReply

TrySetGraphCategory ( const UEdGraph* InGraph,
const FText& InCategory
)

 Tentatively sets the category for a given graph
Public function Virtual Const bool

TryToGetChildEvents ( const UEdGraph* Graph,
const int32 SectionId,
TArray< TSharedPtr< FEdGraphSchemaAction >>& Actions,
const FText& ParentCategory
)

 Try to retrieve the event child actions for a given graph

Deprecated Functions

  Type Name Description
Public function Virtual Const FReply Use version that takes FPointerEvent instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page