1. Epic GamesDeveloper
  3. UPCGPin

UPCGPin

API > API/Plugins > API/Plugins/PCG

   
Name UPCGPin
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/PCGPin.h
Include Path #include "PCGPin.h"

Syntax

UCLASS (MinimalAPI, ClassGroup=(Procedural))  
class UPCGPin : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UPCGPin ( const FObjectInitializer& ObjectInitializer
)

   PCGPin.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Edges TArray< TObjectPtr< UPCGEdge > >   PCGPin.h
  • BlueprintReadOnly
  • TextExportTransient
  • Category=Properties
Node TObjectPtr< UPCGNode >   PCGPin.h
  • BlueprintReadOnly
  • Category=Properties
Properties FPCGPinProperties   PCGPin.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category=Settings
  • Meta=(ShowOnlyInnerProperties)

Protected

Name Type Remarks Include Path Unreal Specifiers
bPropertiesHaveChangedOnDeprecation bool Keep track if a pin had their properties changed while loading, so UpdatePins will try to break incompatible edges. PCGPin.h  
UPCGNode friend   PCGPin.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddEdgeTo ( UPCGPin* OtherPin,
TSet< UPCGNode* >* InTouchedNodes
)

 Adds edge to pin if edge does not exist. PCGPin.h  

bool AllowsMultipleConnections()

   PCGPin.h  

bool AllowsMultipleData()

   PCGPin.h  

bool BreakAllEdges ( TSet< UPCGNode* >* InTouchedNodes
)

 Breaks all connected edges. Optionally returns list of affected nodes (including the pin owner). PCGPin.h  

bool BreakAllIncompatibleEdges ( TSet< UPCGNode* >* InTouchedNodes
)

 Break all edges the connect pins of invalid type. PCGPin.h  

bool BreakEdgeTo ( UPCGPin* OtherPin,
TSet< UPCGNode* >* InTouchedNodes
)

 Breaks edge to pin if edge exists. PCGPin.h  

bool CanConnect ( const UPCGPin* OtherPin
) const

   PCGPin.h  

int32 EdgeCount()

   PCGPin.h  

EPCGDataTypeCompatibilityResult GetCompatibilityWithOtherPin ( const UPCGPin* OtherPin,
FText* OptionalOutCompatibilityMessage
) const

 Query the data type registry to check if this pin is compatible with the other pin. PCGPin.h  

EPCGDataType GetCurrentTypes()

   PCGPin.h  

FPCGDataTypeIdentifier GetCurrentTypesID()

 Returns the current pin types, which can either be the static types from the pin properties, or a dynamic type based on connected edges. PCGPin.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS EPCGTypeConversion GetRequiredTypeConversion ( const UPCGPin* InOtherPin
) const

   PCGPin.h  

FText GetTooltip()

   PCGPin.h
  • BlueprintCallable
  • Category=Settings

bool IsCompatible ( const UPCGPin* OtherPin
) const

   PCGPin.h  

bool IsConnected()

   PCGPin.h
  • BlueprintCallable
  • Category=Settings

bool IsDownstreamPinTypeCompatible ( EPCGDataType UpstreamTypes
) const

 For checking when the new node doesn't exist yet. PCGPin.h  

bool IsOutputPin()

   PCGPin.h
  • BlueprintCallable
  • Category=Settings

void SetTooltip ( const FText& InTooltip
)

   PCGPin.h
  • BlueprintCallable
  • Category=Settings

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   PCGPin.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
Label_DEPRECATED FName   PCGPin.h
  • Meta=(PCGNoHash)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page