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 > Runtime > Engine > EdGraph > UEdGraphPin

Light Theme

Dark Theme

UEdGraphPin

References

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

Syntax

class UEdGraphPin

Variables

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

Constructors

No constructors are accessible with public or protected access.

Destructors

	Name	Description
	~UEdGraphPin()	Destructor

Functions

	Name	Description
void	AddStructReferencedObjects ( FReferenceCollector& Collector )	Provides a reference collector with all object references this pin has.
bool	AreOrphanPinsEnabled()
void	AssignByRefPassThroughConnection ( UEdGraphPin* InTargetPin )	Connects the two pins as by-ref pass-through, allowing the input to auto-forward to the output pin
void	BreakAllPinLinks ( bool bNotifyNodes )	Break all links from this pin
void	BreakLinkTo ( UEdGraphPin* ToPin )	Break a link to the specified pin (if present)
void	CopyPersistentDataFromOldPin ( const UEdGraphPin& SourcePin )	Copies the persistent data (across a node refresh) from the SourcePin.
UEdGraphPin ...	CreatePin ( UEdGraphNode* InOwningNode )	Creates a new pin.
UEdGraphPin ...	CreatePinFromDeprecatedPin ( UEdGraphPin_Deprecated* Deprec... )	Transition support for UEdGraphPins
void	DeclarePinCustomVersions ( FArchive& Ar )
bool	DoesDefaultValueMatchAutogenerated()	Returns true if the current default value matches the autogenerated default value
bool	ExportTextItem ( FString& ValueStr, int32 PortFlags )	ExportText/ImportText
UEdGraphPin ...	FindPinCreatedFromDeprecatedPin ( UEdGraphPin_Deprecated* Deprec... )
EEdGraphPinD...	GetComplementaryDirection ( EEdGraphPinDirection InDirection )	Direction flipping utility; returns the complementary direction
FString	GetDefaultAsString()	Returns an internal string representation of the string/object/text default value, that is compatible with AutogeneratedDefaultValue and ImportText
FText	GetDefaultAsText()	Returns a human readable FText representation of the string/object/text default value
FText	GetDisplayName()	Returns how the name of the pin should be displayed in the UI
const FName	GetFName()
const FStrin...	GetLinkInfoString ( const FString& InFunctionName, const FString& InInfoData, const UEdGraphPin* InToPin )	Generate a string detailing the link this pin has to another pin.
const FStrin...	GetName()
UEdGraphNode...	GetOuter()
UEdGraphNode...	GetOwningNode()	Returns the node that owns this pin
UEdGraphNode...	GetOwningNodeUnchecked()
FEdGraphTerm...	GetPrimaryTerminalType()
const UEdGra...	GetSchema()	Shorthand way to access the schema of the graph that owns the node that owns this pin
bool	HasAnyConnections()	Returns true if there are entries in the pin's LinkedTo array, or if it has SubPins, one of their SubPins arrays:
bool	ImportTextItem ( const TCHAR& Buffer, int32 PortFlags, UObject Parent, FOutputDevice* ErrorText )
bool	IsDefaultAsStringEmpty()	Returns true if GetDefaultAsString will return an empty string.
bool	IsPendingKill()
void	MakeLinkTo ( UEdGraphPin* ToPin )	Create a link.
void	MarkAsGarbage()	Marks the pin as 'trashed'. Does not remove the pin from the Owning Node's Pins list
bool	Modify ( bool bAlwaysMarkDirty )	Marks the owning node as modified.
void	MovePersistentDataFromOldPin ( UEdGraphPin& SourcePin )	Moves the persistent data (across a node refresh) from the SourcePin.
void	Purge()
void	ResetDefaultValue()	Reset default values to empty.
void	ResetToDefaults()	Resets node to default constructor state
void	ResolveAllPinReferences()	This needs to be called if you want to use pin data within PostEditUndo
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
void	SanitizePinsPostUndoRedo()
void	SerializeAsOwningNode ( FArchive& Ar, TArray< UEdGraphPin* >& Array... )	Serializes an array of pins as the owner. Only the OwningNode should call this function.
void	SetOwningNode ( UEdGraphNode* NewOwningNode )	Changes the owning node.
void	SetSavePinIfOrphaned ( bool bShouldSave )
bool	ShouldSavePinIfOrphaned()
void	ShutdownVerification()	Verification that all pins have been destroyed after shutting down
bool	WasTrashed()	Returns true if InvalidateAndTrash was ever called on this pin.

Deprecated Variables

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

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

Take our survey

Cancel