1. Epic GamesDeveloper
  3. UEdGraphNode

UEdGraphNode

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

Inheritance Hierarchy

References

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

Syntax

class UEdGraphNode : public UObject

Variables

  Type Name Description
Public variable TEnumAsByte< ENodeAdvancedPins::Type > AdvancedPinDisplay Enum to indicate if a node has advanced-display-pins, and if they are shown
Public variable uint8: 1 bCanRenameNode If true, this node can be renamed in the editor
Public variable uint8: 1 bCanResizeNode If true, this node can be resized and should be drawn with a resize handle
Public variable uint8: 1 bCommentBubbleMakeVisible Make comment bubble visible
Public variable uint8: 1 bCommentBubblePinned Comment bubble pinned state
Public variable uint8: 1 bCommentBubbleVisible Comment bubble visibility
Public variable uint8: 1 bDisableOrphanPinSaving When true, overrides whatever OrphanedPinSaveMode specifies and behaves as if it were SaveNone.
Public variable uint8: 1 bHasCompilerMessage Flag to check for compile error/warning
Public variable TWeakPtr< SGraphNode > DEPRECATED_NodeWidget Widget representing this node if it exists; Note: This is not safe to use in general and will be removed in the future, as there is no guarantee that only one graph editor/panel is viewing a given graph
Public variable TArray< TObjectPtr< class UEdGraphPin_Deprecated > > DeprecatedPins List of connector pins
Public variable FString ErrorMsg Error/Warning description
Public variable int32 ErrorType Flag to store node specific compile error/warning
Public variable FString NodeComment Comment string that is drawn on the node
Public variable FGuid NodeGuid GUID to uniquely identify this node, to facilitate diffing versions of this graph
Public variable int32 NodeHeight Height of node in the editor; only used when the node can be resized
Public variable int32 NodePosX X position of node in the editor
Public variable int32 NodePosY Y position of node in the editor
Public variable FText NodeUpgradeMessage Note for a node that lingers until saved
Public variable int32 NodeWidth Width of node in the editor; only used when the node can be resized
Protected variable ESaveOrphanPinMode OrphanedPinSaveMode When reconstructing a node should the orphaned pins be retained and transfered to the new pin list.
Public variable TArray< UEdGraphPin * > Pins  

Constructors

  Type Name Description
Public function  

UEdGraphNode ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddNodeUpgradeNote ( FText InUpgradeNote
)

 Adds an upgrade note to this node
Public function Virtual Const void

AddPinSearchMetaDataInfo ( const UEdGraphPin* Pin,
TArray< struct FSearchTagDataPair >& OutTaggedMetaData
)

 Adds node pin data to the search metadata, override to collect more data that may be desirable to search for
Public function Static void  
Public function Virtual Const void

AddSearchMetaDataInfo ( TArray< struct FSearchTagDataPair >& OutTaggedMetaData
)

 Add's node data to the search metadata, override to collect more data that may be desirable to search for
Public function Virtual void Allocate default pins for a given node, based only the NodeType, which should already be filled in.
Public function Virtual void Autowire a newly created node.
Public function void Break all links on this node
Public function Virtual Const bool Determine if this node can be created under the specified schema
Public function Virtual Const bool Whether or not this node can be safely duplicated (via copy/paste, etc...) in the graph
Public function Virtual Const bool Returns true if it is possible to jump to the definition of this node (e.g., if it's a variable get or a function call)
Public function Virtual Const bool

CanPasteHere ( const UEdGraph* TargetGraph
)

 Determine if this node can live in the specified graph
Public function Virtual Const bool

CanSplitPin ( const UEdGraphPin* Pin
)

 Whether or not struct pins belonging to this node should be allowed to be split or not.
Public function Virtual Const bool Whether or not this node can be deleted by user action
Public function Virtual Const bool Whether or not this node allows users to edit the advanced view flag of pins (actually edit the property, not the same as show/hide advanced pins).
Public function void Clear error flag
Public function void Create a new unique Guid for this node
Public function Virtual Const TSharedPtr< SWidget > Create the background image for the widget representing this node
Public function UEdGraphPin *

CreatePin ( EEdGraphPinDirection Dir,
const FName PinCategory,
const FName PinSubCategory,
const FName PinName,
const FCreatePinParams& PinParams
)

  
Public function UEdGraphPin *

CreatePin ( EEdGraphPinDirection Dir,
const FName PinCategory,
UObject* PinSubCategoryObject,
const FName PinName,
const FCreatePinParams& PinParams
)

  
Public function UEdGraphPin *

CreatePin ( EEdGraphPinDirection Dir,
const FName PinCategory,
const FName PinSubCategory,
UObject* PinSubCategoryObject,
const FName PinName,
const FCreatePinParams& PinParams
)

  
Public function UEdGraphPin *

CreatePin ( EEdGraphPinDirection Dir,
const FEdGraphPinType& InPinType,
const FName PinName,
int32 Index
)

 Create a new pin on this node using the supplied pin type, and return the new pin
Public function UEdGraphPin *

CreatePin ( EEdGraphPinDirection Dir,
const FName PinCategory,
const FName PinName,
const FCreatePinParams& PinParams
)

 Create a new pin on this node using the supplied info, and return the new pin
Public function Virtual Const FName

CreateUniquePinName ( FName SourcePinName
)

 Generate a unique pin name, trying to stick close to a passed in name
Public function Virtual TSharedPtr< SGraphNode > Create a visual widget to represent this node in a graph editor or graph panel.
Public function Static void

DeclareCustomVersions ( FArchive& Ar,
const UClass* SpecificSubclass
)

  
Public function Virtual void Destroy the specified node
Public function Static void Destroys the specified pin, does not modify its owning pin's Pins list
Protected function Virtual Const void

DiffProperties ( UClass* StructA,
UClass* StructB,
UObject* DataA,
UObject* DataB,
FDiffResults& Results,
FDiffSingleResult& Diff
)

 Finds the difference in properties of node instance, for subobjects
Protected function Virtual Const void

DiffProperties ( UStruct* StructA,
UStruct* StructB,
uint8* DataA,
uint8* DataB,
FDiffResults& Results,
FDiffSingleResult& Diff
)

 Finds the difference in properties of node instance, for arbitrary UStructs
Public function Virtual void

FindDiffs ( UEdGraphNode* OtherNode,
FDiffResults& Results
)

 Gives the node the option to customize how diffs are discovered within it.
Public function Const UEdGraphPin *

FindPin ( const TCHAR* PinName,
const EEdGraphPinDirection Direction
)

 Find a pin on this node with the supplied name and optional direction
Public function Const UEdGraphPin *

FindPin ( const FString& PinName,
const EEdGraphPinDirection Direction
)

 Find a pin on this node with the supplied name and optional direction
Public function Const UEdGraphPin *

FindPin ( const FName PinName,
const EEdGraphPinDirection Direction
)

 Find a pin on this node with the supplied name and optional direction
Public function Const UEdGraphPin *

FindPinById ( const FGuid PinId
)

 Find the pin on this node with the supplied guid
Public function Const UEdGraphPin *

FindPinByIdChecked ( const FGuid PinId
)

 Find the pin on this node with the supplied guid and assert if it is not present
Public function Const UEdGraphPin *

FindPinByPredicate ( TFunctionRef< bool(UEdGraphPin*InPin)> InFunction
)

 Find a pin using a user-defined predicate
Public function Const UEdGraphPin *

FindPinChecked ( const FName PinName,
const EEdGraphPinDirection Direction
)

 Find a pin on this node with the supplied name and optional direction and assert if it is not present
Public function Const UEdGraphPin *

FindPinChecked ( const FString& PinName,
const EEdGraphPinDirection Direction
)

 Find a pin on this node with the supplied name and optional direction and assert if it is not present
Public function Const UEdGraphPin *

FindPinChecked ( const TCHAR* PinName,
const EEdGraphPinDirection Direction
)

 Find a pin on this node with the supplied name and optional direction and assert if it is not present
Public function void Execute a provided function once for each node that is directly connected to this node, will not include the node itself
Public function void Often we are only interested in a subset of our connections (e.g. only output pins, or only output pins except our exec pin) This function provides the ability to execute a provided function once for each node that is directly connected to this node, but first filters out which of this node's pins to consider:
Public function void Execute a provided function once for each node that is directly connected to this node's input pins, will not include the node itself Implementation provides an example usage of ForEachNodeDirectlyConnectedIf.
Public function void Execute a provided function once for each node that is directly connected to this node's output pins, will not include the node itself Implementation provides an example usage of ForEachNodeDirectlyConnectedIf.
Protected function Virtual Const void

GatherForLocalization ( FPropertyLocalizationDataGatherer& PropertyLocalizationDataGatherer,
const EPropertyLocalizationGathererTextFlags GatherTextFlags
)

  
Public function Const const TArray< UEdGraphPin * > & Get all pins this node owns
Public function Virtual Const bool If true, this node can be renamed in the editor
Public function Virtual Const FEdGraphNodeDeprecationResponse

GetDeprecationResponse ( EEdGraphNodeDeprecationType DeprecationType
)

 Returns the response to use when reporting a deprecation.
Public function Virtual Const FString Tries to come up with a descriptive name for the compiled output
Public function Const ENodeEnabledState Returns the specific sort of enable state this node wants
Public function Virtual Const FString Returns the name of the excerpt to display from the specified external documentation link for the graph node Default behavior is to return the class name (including prefix)
Public function Virtual Const FString Returns the link used for external documentation for the graph node
Public function Virtual Const FString Gets the search string to find references to this node
Public function Const UEdGraph * Returns the graph that contains this node
Public function Virtual Const FSlateIcon  
Public function Virtual Const UObject * Returns the object that should be focused when double-clicking on this node (the object can be an actor, which selects it in the world, or a node/graph/pin)
Public function Virtual Const FText Returns the keywords that should be used when searching for this node
Public function Virtual Const void

GetMenuEntries ( FGraphContextMenuBuilder& ContextMenuBuilder
)

 This function gets menu items that can be created using this node given the specified context.
Public function Virtual Const FLinearColor Gets the draw color of a node's body tine
Public function Virtual Const FLinearColor Get the draw color for a node's comment popup
Public function Virtual Const void Gets a list of actions that can be done to this particular node
Public function Virtual Const FText Gets the name of this node, shown in title bar
Public function Virtual Const FLinearColor Gets the draw color of a node's title bar
Public function Virtual Const UEdGraphPin *

GetPassThroughPin ( const UEdGraphPin* FromPin
)

 Return the matching "pass-through" pin for the given pin (if supported by this node)
Public function Const UEdGraphPin *

GetPinAt ( int32 Index
)

 Gets the pin at a given index
Public function Virtual Const FText Gets the display name for a pin
Public function Virtual Const void

GetPinHoverText ( const UEdGraphPin& Pin,
FString& HoverTextOut
)

 Fetch the hover text for a pin when the graph is being edited.
Public function Const int32 Gets the index for a pin
Public function Virtual FString

GetPinMetaData ( FName InPinName,
FName InKey
)

 Return the requested metadata for the pin if there is any
Public function Virtual Const FText Gets the overridden name for the specified pin, if any
Public function Const UEdGraphPin *

GetPinWithDirectionAt ( int32 Index,
EEdGraphPinDirection PinDirection
)

 Gets the pin with the given direction, at the given index.
Protected function Virtual Const FString

GetPropertyNameAndValueForDiff ( const FProperty* Prop,
const uint8* PropertyAddr
)

 Returns a human-friendly description of the property in the form "PropertyName: Value".
Public function Const const UEdGraphSchema * Shorthand way to access the schema of the graph that owns this node
Public function Virtual Const TArray< UEdGraph * >  
Public function Virtual Const FText Gets the tooltip to display when over the node
Public function Virtual Const FText Visual Warning tooltip message to show
Public function Virtual Const bool Returns true if this node references a deprecated type or member.
Public function Virtual Const bool

HasExternalDependencies ( TArray< class UStruct* >* OptionalOutput
)

 Returns whether or not this node has dependencies on an external structure If OptionalOutput isn't null, it should be filled with the known dependencies objects (Classes, Structures, Functions, etc).
Public function Const bool Has the user set the enabled state or is it still using the automatic settings?
Public function Virtual Const bool Does the node context menu inherit parent class's menu
Public function Const bool Returns true if this is a disabled automatically placed ghost node (see the DefaultEventNodes ini section)
Public function Virtual Const bool

IsCompatibleWithGraph ( UEdGraph const* Graph
)

 Determine if a node of this type can be created for the specified graph.
Public function Virtual Const bool Return false if the node and any expansion will isolate itself during compile
Public function Virtual Const bool Returns true if this node is deprecated.
Public function Const bool  
Public function Virtual Const bool Determines whether or not the node will compile in development mode.
Public function Const bool Returns whether the node was created by UEdGraph::CreateIntermediateNode.
Public function Const bool Is the node actually enabled
Public function Const bool Determines whether this node is unrelated to the selected nodes or not.
Public function Virtual Const void Jump to the definition of this node (should only be called if CanJumpToDefinition() return true)
Public function void Marks this node as an automatically placed ghost node (see the DefaultEventNodes ini section)
Public function Virtual Const TSharedPtr< class INameValidatorInterface > Create a name validator for this node
Public function Virtual void Called when something external to this node has changed the connection list of any of the pins in the node
Public function Virtual void

OnCommentBubbleToggled ( bool bInCommentBubbleVisible
)

 Called when the node's comment bubble is toggled
Public function Virtual void

OnPinRemoved ( UEdGraphPin* InRemovedPin
)

 Called when a pin is removed
Public function Virtual void

OnRenameNode ( const FString& NewName
)

 Called when this node is being renamed after a successful name validation
Public function Virtual void

OnUpdateCommentText ( const FString& NewComment
)

 Called to replace this nodes comment text
Public function Virtual void Called when the connection list of one of the pins of this node is changed in the editor
Public function Virtual void Called when the DefaultValue of one of the pins of this node is changed in the editor
Public function Virtual void Called when one of the pins of this node has had its' pin type changed from an external source (like the SPinTypeSelector in the case of kismet)
Public function Virtual void Perform any fixups (deep copies of associated data, etc...) necessary after a node has been pasted in the editor
Public function Virtual void A chance to initialize a new node; called just once when a new node is created, before AutowireNewNode or AllocateDefaultPins is called.
Public function Virtual void Perform any steps necessary prior to copying a node into the paste buffer
Public function Virtual void Refresh the connectors on a node, preserving as many connections as it can.
Public function bool Find a pin on this node with the supplied name and remove it, returns TRUE if successful
Public function Virtual void

RemovePinAt ( const int32 PinIndex,
const EEdGraphPinDirection PinDirection
)

 Removes the specified pin from the node, preserving remaining pin ordering.
Public function Virtual void

ResizeNode ( const FVector2D& NewSize
)

 Update node size to new value
Public function void

SetEnabledState ( ENodeEnabledState NewState,
bool bUserAction
)

 Set the enabled state of the node to a new value
Public function void

SetForceDisplayAsDisabled ( const bool bInNewDisplayState
)

 Set whether or not this node should be forced to display as disabled
Public function void

SetMakeCommentBubbleVisible ( bool MakeVisible
)

 Sets a flag if the comment bubble needs to be made visible immediately
Public function void

SetNodeUnrelated ( bool bNodeUnrelated
)

 Set this node unrelated or not.
Public function Virtual Const bool

ShouldDrawNodeAsControlPointOnly ( int32& OutInputPinIndex,
int32& OutOutputPinIndex
)

 Returns whether to draw this node as a control point only (knot/reroute node).
Public function Const bool If the comment bubble needs to be made visible immediately
Public function Virtual Const bool If the node has a subgraph, should they be merged into the main graph?
Public function Virtual Const bool Whether or not this node should be given the chance to override pin names.
Public function Virtual Const bool Should we show the Palette Icon for this node on the node title
Public function Virtual Const bool If true, this node whill show the Visual Warning message
Public function void

SnapToGrid ( uint32 GridSnapSize
)

 Snap this node to a specified grid size
Public function Virtual Const bool Returns true if this node supports comment bubbles
Public function Virtual Const void Gives each visual node a chance to do final validation before it's node is harvested for use at runtime.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

ExportCustomProperties ( FOutputDevice& Out,
uint32 Indent
)

 Exports the property values for the specified object as text to the output device.
Public function Virtual void

ImportCustomProperties ( const TCHAR* SourceText,
FFeedbackContext* Warn
)

 Exports the property values for the specified object as text to the output device.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public struct FCreatePinParams Parameter struct of less common options for CreatePin  
Public struct FNameParameterHelper    

Constants

Name Description
PooledPins  

Deprecated Functions

  Type Name Description
Public function UEdGraphPin *

CreatePin ( EEdGraphPinDirection Dir,
const FEdGraphPinType& InPinType,
const TCHAR* PinName,
int32 Index
)

 Remove when removing FString version. Exists just to resolve ambiguity
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

PreSave ( const ITargetPlatform* TargetPlatform
)

 Use version that takes FObjectPreSaveContext instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page