1. Epic GamesDeveloper
  3. UPCGNode

UPCGNode

API > API/Plugins > API/Plugins/PCG

Inheritance Hierarchy

References

   
Module PCG
Header /Engine/Plugins/PCG/Source/PCG/Public/PCGNode.h
Include #include "PCGNode.h"

Syntax

UCLASS (ClassGroup=(Procedural))  
class UPCGNode : public UObject

Variables

  Type Name Description
Public variable UProperty uint8: 1 bCommentBubblePinned  
Public variable UProperty uint8: 1 bCommentBubbleVisible  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TArray< TObjectPtr< UPCGPin > > InputPins  
Public variable UProperty FString NodeComment  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FName NodeTitle  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FLinearColor NodeTitleColor  
Public variable FOnPCGNodeChanged OnNodeChangedDelegate  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TArray< TObjectPtr< UPCGPin > > OutputPins  
Public variable UProperty int32 PositionX  
Public variable UProperty int32 PositionY  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere TObjectPtr< UPCGSettingsInterface > SettingsInterface Note: do not set this property directly from code, use SetSettingsInterface instead

Constructors

  Type Name Description
Public function  

UPCGNode ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category UPCGNode *

AddEdgeTo ( FName FromPinLabel,
UPCGNode* To,
FName ToPinLabel
)

 Adds an edge in the owning graph to the given "To" node.
Public function void Used to be able to force deprecation when things need to be deprecated at the graph level.
Public function void ~End UObject interface UpdatePins will kick off invalid edges, so this is useful for making pin changes graceful.
Public function Virtual void If a node does require structural changes, this will apply them
Public function Virtual void  
Protected function void When we create a new graph, we initialize the input/output nodes as default, with default pins.
Public function Const FText Authored part of node title (like "Create Attribute 1").
Public function Const FText Title to use if no title is authored.
Public function Const const UPCGPin * Returns the first connected input pin on the node.
Public function Const const UPCGPin * Returns the first connected output pin on the node.
Public function Const FText Generated part of node title, not user editable (like "MyValue = 5.0").
Public function Const UFunction BlueprintCallable, Category UPCGGraph * Returns the owning graph
Public function Const int32  
Public function Const const UPCGPin *

GetInputPin ( const FName& Label
)

  
Public function UPCGPin *

GetInputPin ( const FName& Label
)

  
Public function Const const TArray< TObjectPtr< UPCGPin > > &  
Public function Const UFunction BlueprintCallable, Category void

GetNodePosition ( int32& OutPositionX,
int32& OutPositionY
)

  
Public function Const FText Get title for node of specified type.
Public function Const FText Tooltip that describes node functionality and other information.
Public function Const const UPCGPin *

GetOutputPin ( const FName& Label
)

  
Public function UPCGPin *

GetOutputPin ( const FName& Label
)

  
Public function Const const TArray< TObjectPtr< UPCGPin > > &  
Public function Virtual Const const UPCGPin * Pin from which data is passed through when this node is disabled.
Public function Virtual Const const UPCGPin * Pin to which data is passed through when this node is disabled.
Public function Const UFunction BlueprintCallable, Category UPCGSettings * Returns the settings this node holds (either directly or through an instance)
Public function Const UPCGSettingsInterface * Returns the settings interface (settings or instance of settings) on this node
Public function Const bool Whether user has renamed the node.
Public function Const bool Whether to flip the order of the title lines - display generated title first and authored second.
Public function Const bool  
Public function Const TArray< FPCGPinProperties > Returns all the input pin properties
Public function Virtual Const bool True if the edge is being used by the node. UI will gray out unused pins.
Public function Const bool

IsInputPinConnected ( const FName& Label
)

 Returns true if the input pin is connected
Public function Virtual Const bool A node will be executed (not culled) if at least one required-pin is connected to at least one active upstream pin.
Public function Const bool Returns true if the node has an instance of the settings (e.g. does not own the settings)
Public function Const bool

IsOutputPinConnected ( const FName& Label
)

 Returns true if the output pin is connected
Public function Virtual Const bool True if the pin is being used by the node. UI will gray out unused pins.
Protected function void

OnSettingsChanged ( UPCGSettings* InSettings,
EPCGChangeType ChangeType
)

  
Public function Const TArray< FPCGPinProperties > Returns all the output pin properties
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void ~Begin UObject interface
Public function Virtual void  
Public function EPCGChangeType

PropagateDynamicPinTypes ( TSet< UPCGNode* >& TouchedNodes,
const UPCGNode* FromNode
)

 Recursively follow downstream edges and call UpdatePins on each node that has dynamic pins.
Public function Virtual void  
Public function UFunction BlueprintCallable, Category bool

RemoveEdgeTo ( FName FromPinLable,
UPCGNode* To,
FName ToPinLabel
)

 Removes an edge originating from this node
Public function void

RenameInputPin ( const FName& InOldLabel,
const FName& InNewLabel,
bool bInBroadcastUpdate
)

 Allow to change the name of a pin, to keep edges connected.
Public function void

RenameOutputPin ( const FName& InOldLabel,
const FName& InNewLabel,
bool bInBroadcastUpdate
)

  
Public function UFunction BlueprintCallable, Category void

SetNodePosition ( int32 InPositionX,
int32 InPositionY
)

  
Public function void

SetSettingsInterface ( UPCGSettingsInterface* InSettingsInterface,
bool bUpdatePins
)

 Changes the default settings in the node
Public function Const void Transfer all editor only properties to the other node
Public function void Triggers some uppdates after creating a new node and changing its settings
Protected function EPCGChangeType Updates pins based on node settings.
Protected function EPCGChangeType

UpdatePins ( TFunctionRef< UPCGPin*(UPCGNode*)> PinAllocator
)

 Updates pins based on node settings PinAllocator creates new pin objects.

Deprecated Variables

  Type Name Description
Public variable UProperty TObjectPtr< UPCGSettings > DefaultSettings_DEPRECATED  
Protected variable UProperty textexporttransient TArray< TObjectPtr< UPCGEdge > > InboundEdges_DEPRECATED  
Protected variable UProperty textexporttransient TArray< TObjectPtr< UPCGEdge > > OutboundEdges_DEPRECATED  
Protected variable UProperty TArray< TObjectPtr< UPCGNode > > OutboundNodes_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page