1. Epic GamesDeveloper
  3. UEdGraphPin

UEdGraphPin

API > API/Runtime > API/Runtime/Engine

   
Name UEdGraphPin
Type class
Header File /Engine/Source/Runtime/Engine/Classes/EdGraph/EdGraphPin.h
Include Path #include "EdGraph/EdGraphPin.h"

Syntax

class UEdGraphPin

Constructors

Name Remarks Include Path Unreal Specifiers

UEdGraphPin ( UEdGraphNode* InOwningNode,
const FGuid& PinGuid
)

 Private Constructor. EdGraph/EdGraphPin.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UEdGraphPin()

 Destructor EdGraph/EdGraphPin.h  

Variables

Public

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

Protected

Name Type Remarks Include Path Unreal Specifiers
bSavePinIfOrphaned uint8 If true, this pin will be retained when reconstructing a node if there is no matching pin on the new version of the pin. EdGraph/EdGraphPin.h  
OwningNode UEdGraphNode * The node that owns this pin. EdGraph/EdGraphPin.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Provides a reference collector with all object references this pin has. EdGraph/EdGraphPin.h  

void AssignByRefPassThroughConnection ( UEdGraphPin* InTargetPin
)

 Connects the two pins as by-ref pass-through, allowing the input to auto-forward to the output pin EdGraph/EdGraphPin.h  

void BreakAllPinLinks ( bool bNotifyNodes,
bool bAlwaysMarkDirty
)

 Break all links from this pin EdGraph/EdGraphPin.h  

void BreakLinkTo ( UEdGraphPin* ToPin,
bool bAlwaysMarkDirty
)

 Break a link to the specified pin (if present) EdGraph/EdGraphPin.h  

void CopyPersistentDataFromOldPin ( const UEdGraphPin& SourcePin
)

 Copies the persistent data (across a node refresh) from the SourcePin. EdGraph/EdGraphPin.h  

bool DoesDefaultValueMatchAutogenerated()

 Returns true if the current default value matches the autogenerated default value EdGraph/EdGraphPin.h  

bool ExportTextItem ( FString& ValueStr,
int32 PortFlags
) const

 ExportText/ImportText EdGraph/EdGraphPin.h  

FString GetDefaultAsString ()

 Returns an internal string representation of the string/object/text default value, that is compatible with AutogeneratedDefaultValue and ImportText EdGraph/EdGraphPin.h  

FText GetDefaultAsText()

 Returns a human readable FText representation of the string/object/text default value EdGraph/EdGraphPin.h  

FText GetDisplayName()

 Returns how the name of the pin should be displayed in the UI EdGraph/EdGraphPin.h  

const FName GetFName()

   EdGraph/EdGraphPin.h  

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

 Generate a string detailing the link this pin has to another pin. EdGraph/EdGraphPin.h  

const FString GetName()

   EdGraph/EdGraphPin.h  

UEdGraphNode * GetOuter()

   EdGraph/EdGraphPin.h  

UEdGraphNode * GetOwningNode()

 Returns the node that owns this pin EdGraph/EdGraphPin.h  

UEdGraphNode * GetOwningNodeUnchecked()

   EdGraph/EdGraphPin.h  

FEdGraphTerminalType GetPrimaryTerminalType()

   EdGraph/EdGraphPin.h  

const UEdGraphSchema * GetSchema()

 Shorthand way to access the schema of the graph that owns the node that owns this pin EdGraph/EdGraphPin.h  

bool HasAnyConnections()

 Returns true if there are entries in the pin's LinkedTo array, or if it has SubPins, one of their SubPins arrays: EdGraph/EdGraphPin.h  

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

   EdGraph/EdGraphPin.h  

bool IsDefaultAsStringEmpty()

 Returns true if GetDefaultAsString will return an empty string. EdGraph/EdGraphPin.h  

bool IsPendingKill()

   EdGraph/EdGraphPin.h  

void MakeLinkTo ( UEdGraphPin* ToPin,
bool bAlwaysMarkDirty
)

 Create a link. EdGraph/EdGraphPin.h  

void MarkAsGarbage()

 Marks the pin as 'trashed'. Does not remove the pin from the Owning Node's Pins list EdGraph/EdGraphPin.h  

bool Modify ( bool bAlwaysMarkDirty
)

 Marks the owning node as modified. EdGraph/EdGraphPin.h  

void MovePersistentDataFromOldPin ( UEdGraphPin& SourcePin
)

 Moves the persistent data (across a node refresh) from the SourcePin. EdGraph/EdGraphPin.h  
Reset default values to empty. EdGraph/EdGraphPin.h  

void ResetToDefaults()

 Resets node to default constructor state EdGraph/EdGraphPin.h  

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 EdGraph/EdGraphPin.h  

void SetOwningNode ( UEdGraphNode* NewOwningNode
)

 Changes the owning node. EdGraph/EdGraphPin.h  

void SetSavePinIfOrphaned ( bool bShouldSave
)

   EdGraph/EdGraphPin.h  

bool ShouldSavePinIfOrphaned()

   EdGraph/EdGraphPin.h  

bool WasTrashed()

 Returns true if InvalidateAndTrash was ever called on this pin. EdGraph/EdGraphPin.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool AreOrphanPinsEnabled()

   EdGraph/EdGraphPin.h  

static void ConvertConnectedGhostNodesToRealNodes ( UEdGraphNode* InNode,
bool bAlwaysMarkDirty
)

 Helper functions. EdGraph/EdGraphPin.h  

static UEdGraphPin * CreatePin ( UEdGraphNode* InOwningNode
)

 Creates a new pin. EdGraph/EdGraphPin.h  

static UEdGraphPin * CreatePinFromDeprecatedPin ( UEdGraphPin_Deprecated* DeprecatedPin
)

 Transition support for UEdGraphPins EdGraph/EdGraphPin.h  

static void DeclarePinCustomVersions ( FArchive& Ar
)

   EdGraph/EdGraphPin.h  

static FString ExportText_PinArray ( const TArray< UEdGraphPin* >& PinArray
)

   EdGraph/EdGraphPin.h  

static FString ExportText_PinReference ( const UEdGraphPin* Pin
)

   EdGraph/EdGraphPin.h  

static UEdGraphPin * FindPinCreatedFromDeprecatedPin ( UEdGraphPin_Deprecated* DeprecatedPin
)

   EdGraph/EdGraphPin.h  

static EEdGraphPinDirection GetComplementaryDirection ( EEdGraphPinDirection InDirection
)

 Direction flipping utility; returns the complementary direction EdGraph/EdGraphPin.h  

static bool ImportText_PinArray ( const TCHAR*& Buffer,
TArray< UEdGraphPin* >& ArrayRef,
UEdGraphPin* RequestingPin,
EPinResolveType ResolveType
)

   EdGraph/EdGraphPin.h  

static void Purge()

   EdGraph/EdGraphPin.h  

static void ResolveAllPinReferences()

 This needs to be called if you want to use pin data within PostEditUndo EdGraph/EdGraphPin.h  

static void ResolveReferencesToPin ( UEdGraphPin* Pin,
bool bStrictValidation
)

   EdGraph/EdGraphPin.h  

static void SanitizePinsPostUndoRedo()

   EdGraph/EdGraphPin.h  

static void SerializeAsOwningNode ( FArchive& Ar,
TArray< UEdGraphPin* >& ArrayRef
)

 Serializes an array of pins as the owner. Only the OwningNode should call this function. EdGraph/EdGraphPin.h  

static bool SerializePin ( FArchive& Ar,
UEdGraphPin*& PinRef,
int32 ArrayIdx,
UEdGraphPin* RequestingPin,
EPinResolveType ResolveType,
TArray< UEdGraphPin* >& OldPins
)

   EdGraph/EdGraphPin.h  

static void SerializePinArray ( FArchive& Ar,
TArray< UEdGraphPin* >& ArrayRef,
UEdGraphPin* RequestingPin,
EPinResolveType ResolveType
)

   EdGraph/EdGraphPin.h  

static void ShutdownVerification()

 Verification that all pins have been destroyed after shutting down EdGraph/EdGraphPin.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page