1. Epic GamesDeveloper
  3. UEdGraphPin

UEdGraphPin

Unreal Engine C++ API Reference > Runtime > Engine > EdGraph

References

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

Syntax

class UEdGraphPin

Variables

  Type Name Description
Public variable FString AutogeneratedDefaultValue Initial default value (the autogenerated value, to identify if the user has modified the value), stored as a string
Public variable uint8: 1 bAdvancedView If true, the pin may be hidden by user.
Public variable uint8: 1 bAllowFriendlyName If true, the pin's name will be allowed to be made friendly by the editor.
Public variable uint8: 1 bDefaultValueIsIgnored If true, the default value on this pin is ignored and should not be set.
Public variable uint8: 1 bDefaultValueIsReadOnly If true, the default value of this connector is fixed and cannot be modified by the user (it's visible for reference only).
Public variable uint8: 1 bDisplayAsMutableRef If true, the pin is displayed as ref. This is transient.
Public variable uint8: 1 bHidden ONLY PUT BITFIELD PROPERTIES AFTER THIS TO ENSURE GOOD MEMORY ALIGNMENT.
Public variable uint8: 1 bNotConnectable If true, this connector is unconnectable, and present only to allow the editing of the default text.
Public variable uint8: 1 bOrphanedPin If true, this pin existed on an older version of the owning node, but when the node was reconstructed a matching pin was not found.
Public variable uint8: 1 bUseBackwardsCompatForEmptyAutogeneratedValue Older content sometimes had an empty autogenerated default value string in cases where that does not mean the property default value (0, none, false, etc.)
Public variable uint8: 1 bWasTrashed True when InvalidateAndTrash was called. This pin is intended to be discarded and destroyed.
Public variable TObjectPtr< class UObject > DefaultObject If the default value for this pin should be an object, we store a pointer to it
Public variable FText DefaultTextValue If the default value for this pin should be an FText, it is stored here.
Public variable FString DefaultValue Default value for this pin (used if the pin has no connections), stored as a string
Public variable TEnumAsByte< enum EEdGraphPinDirection > Direction Direction of flow of this pin (input or output)
Public variable TArray< UEdGraphPin * > LinkedTo Set of pins that we are linked to
Public variable UEdGraphPin * ParentPin The pin that was split and generated this pin
Public variable FGuid PersistentGuid Pin name could be changed, so whenever possible it's good to have a persistent GUID identifying Pin to reconstruct Node seamlessly
Public variable FText PinFriendlyName Used as the display name if set.
Public variable FGuid PinId The pin's unique ID.
Public variable FName PinName Name of this pin.
Public variable FString PinToolTip The tool-tip describing this pin's purpose
Public variable FEdGraphPinType PinType The type of information carried on this pin
Public variable UEdGraphPin * ReferencePassThroughConnection Pin that this pin uses for passing through reference connection
Public variable int32 SourceIndex Index of the pin in the source data structure represented by the graph, INDEX_NONE if not used
Public variable TArray< UEdGraphPin * > SubPins The pins created when a pin is split and hidden

Constructors

No constructors are accessible with public or protected access.

Destructors

  Type Name Description
Public function   Destructor

Functions

  Type Name Description
Public function void Provides a reference collector with all object references this pin has.
Public function Static bool  
Public function void Connects the two pins as by-ref pass-through, allowing the input to auto-forward to the output pin
Public function void

BreakAllPinLinks ( bool bNotifyNodes
)

 Break all links from this pin
Public function void Break a link to the specified pin (if present)
Public function void Copies the persistent data (across a node refresh) from the SourcePin.
Public function Static UEdGraphPin *

CreatePin ( UEdGraphNode* InOwningNode
)

 Creates a new pin.
Public function Static UEdGraphPin * Transition support for UEdGraphPins
Public function Static void  
Public function Const bool Returns true if the current default value matches the autogenerated default value
Public function Const bool

ExportTextItem ( FString& ValueStr,
int32 PortFlags
)

 ExportText/ImportText
Public function Static UEdGraphPin *  
Public function Static EEdGraphPinDirection

GetComplementaryDirection ( EEdGraphPinDirection InDirection
)

 Direction flipping utility; returns the complementary direction
Public function Const FString Returns an internal string representation of the string/object/text default value, that is compatible with AutogeneratedDefaultValue and ImportText
Public function Const FText Returns a human readable FText representation of the string/object/text default value
Public function Const FText Returns how the name of the pin should be displayed in the UI
Public function Const const FName  
Public function Const const FString

GetLinkInfoString ( const FString& InFunctionName,
const FString& InInfoData,
const UEdGraphPin* InToPin
)

 Generate a string detailing the link this pin has to another pin.
Public function Const const FString

GetName ()

  
Public function Const UEdGraphNode *  
Public function Const UEdGraphNode * Returns the node that owns this pin
Public function Const UEdGraphNode *  
Public function Const FEdGraphTerminalType  
Public function Const const UEdGraphSchema * Shorthand way to access the schema of the graph that owns the node that owns this pin
Public function Const bool Returns true if there are entries in the pin's LinkedTo array, or if it has SubPins, one of their SubPins arrays:
Public function bool

ImportTextItem ( const TCHAR*& Buffer,
int32 PortFlags,
UObject* Parent,
FOutputDevice* ErrorText
)

  
Public function Const bool Returns true if GetDefaultAsString will return an empty string.
Public function Const bool  
Public function void

MakeLinkTo ( UEdGraphPin* ToPin
)

 Create a link.
Public function void Marks the pin as 'trashed'. Does not remove the pin from the Owning Node's Pins list
Public function bool

Modify ( bool bAlwaysMarkDirty
)

 Marks the owning node as modified.
Public function void Moves the persistent data (across a node refresh) from the SourcePin.
Public function Static void

Purge ()

  
Public function void Reset default values to empty.
Public function void Resets node to default constructor state
Public function Static void This needs to be called if you want to use pin data within PostEditUndo
Public function void

SafeSetHidden ( bool bIsHidden
)

 Helper to safely set a pin's bHidden property only if it has no sub-pins that are influencing it to be hidden
Public function Static void  
Public function Static void Serializes an array of pins as the owner. Only the OwningNode should call this function.
Public function void

SetOwningNode ( UEdGraphNode* NewOwningNode
)

 Changes the owning node.
Public function void

SetSavePinIfOrphaned ( bool bShouldSave
)

  
Public function Const bool  
Public function Static void Verification that all pins have been destroyed after shutting down
Public function Const bool Returns true if InvalidateAndTrash was ever called on this pin.

Deprecated Variables

  Type Name Description
Public variable uint32: 1 bIsDiffing bIsDiffing is deprecated. Please use SGraphPanel::DiffResults and SGraphPanel::FocusedDiffResult instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page