1. Epic GamesDeveloper
  3. UPCGNode

UPCGNode

API > API/Plugins > API/Plugins/PCG

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

Syntax

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

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UPCGNode ( const FObjectInitializer& ObjectInitializer
)

   PCGNode.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCommentBubblePinned uint8   PCGNode.h
  • Meta=(PCGNoHash)
bCommentBubbleVisible uint8   PCGNode.h
  • Meta=(PCGNoHash)
NodeComment FString   PCGNode.h
  • Meta=(PCGNoHash)
NodeTitle FName   PCGNode.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Node
  • Meta=(PCGNoHash)
NodeTitleColor FLinearColor   PCGNode.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Node
  • Meta=(PCGNoHash)
OnNodeChangedDelegate FOnPCGNodeChanged   PCGNode.h  
PositionX int32   PCGNode.h
  • Meta=(PCGNoHash)
PositionY int32   PCGNode.h
  • Meta=(PCGNoHash)

Protected

Name Type Remarks Include Path Unreal Specifiers
bHidden uint8 Will be hidden in the Editor, but will still exist in the backend. PCGNode.h
  • Meta=(PCGNoHash)

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Adds an edge in the owning graph to the given "To" node. PCGNode.h
  • BlueprintCallable
  • Category=Node

void ApplyDeprecation()

 Used to be able to force deprecation when things need to be deprecated at the graph level. PCGNode.h  

void ApplyDeprecationBeforeUpdatePins()

 ~End UObject interface UpdatePins will kick off invalid edges, so this is useful for making pin changes graceful. PCGNode.h  

virtual void ApplyStructuralDeprecation()

 If a node does require structural changes, this will apply them PCGNode.h  

FText GetAuthoredTitleLine()

 Authored part of node title (like "Create Constant 1"). PCGNode.h  

FName GetAuthoredTitleName()

 Authored node title as raw name or none if no title authored. PCGNode.h  

FText GetDefaultTitle()

 Title to use if no title is authored. PCGNode.h  

const UPCGPin * GetFirstConnectedInputPin()

 Returns the first connected input pin on the node. PCGNode.h  

const UPCGPin * GetFirstConnectedOutputPin()

 Returns the first connected output pin on the node. PCGNode.h  

FText GetGeneratedTitleLine()

 Generated part of node title, not user editable (like "MyValue = 5.0"). PCGNode.h  

UPCGGraph * GetGraph()

 Returns the owning graph PCGNode.h
  • BlueprintCallable
  • Category=Node

int32 GetInboundEdgesNum()

   PCGNode.h  

const UPCGPin * GetInputPin ( const FName& Label
) const

   PCGNode.h  

UPCGPin * GetInputPin ( const FName& Label
)

   PCGNode.h  

const TArray< TObjectPtr< UPCGPin > > & GetInputPins()

   PCGNode.h  

void GetNodePosition ( int32& OutPositionX,
int32& OutPositionY
) const

   PCGNode.h
  • BlueprintCallable
  • Category=Node

FText GetNodeTitle ( EPCGNodeTitleType TitleType
) const

 Get title for node of specified type. PCGNode.h  

FText GetNodeTooltipText()

 Tooltip that describes node functionality and other information. PCGNode.h  

const UPCGPin * GetOutputPin ( const FName& Label
) const

   PCGNode.h  

UPCGPin * GetOutputPin ( const FName& Label
)

   PCGNode.h  

const TArray< TObjectPtr< UPCGPin > > & GetOutputPins()

   PCGNode.h  

virtual const UPCGPin * GetPassThroughInputPin()

 Pin from which data is passed through when this node is disabled. PCGNode.h  

virtual const UPCGPin * GetPassThroughOutputPin()

 Pin to which data is passed through when this node is disabled. PCGNode.h  

UPCGSettings * GetSettings()

 Returns the settings this node holds (either directly or through an instance) PCGNode.h
  • BlueprintCallable
  • Category=Node

UPCGSettingsInterface * GetSettingsInterface()

 Returns the settings interface (settings or instance of settings) on this node PCGNode.h  

bool HasAuthoredTitle()

 Whether user has renamed the node. PCGNode.h  

bool HasFlippedTitleLines()

 Whether to flip the order of the title lines - display generated title first and authored second. PCGNode.h  

bool HasInboundEdges()

   PCGNode.h  

TArray< FPCGPinProperties > InputPinProperties()

 Returns all the input pin properties PCGNode.h  

virtual bool IsEdgeUsedByNodeExecution ( const UPCGEdge* InEdge
) const

 True if the edge is being used by the node. UI will gray out unused pins. PCGNode.h  

bool IsHidden()

   PCGNode.h  

bool IsInputPinConnected ( const FName& Label
) const

 Returns true if the input pin is connected PCGNode.h  

virtual bool IsInputPinRequiredByExecution ( const UPCGPin* InPin
) const

 A node will be executed (not culled) if at least one required-pin is connected to at least one active upstream pin. PCGNode.h  

bool IsInstance()

 Returns true if the node has an instance of the settings (e.g. does not own the settings) PCGNode.h  

bool IsOutputPinConnected ( const FName& Label
) const

 Returns true if the output pin is connected PCGNode.h  

virtual bool IsPinUsedByNodeExecution ( const UPCGPin* InPin
) const

 True if the pin is being used by the node. UI will gray out unused pins. PCGNode.h  

TArray< FPCGPinProperties > OutputPinProperties()

 Returns all the output pin properties PCGNode.h  

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

 Recursively follow downstream edges and call UpdatePins on each node that has dynamic pins. PCGNode.h  

virtual void RebuildAfterPaste()

   PCGNode.h  

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

 Removes an edge originating from this node PCGNode.h
  • BlueprintCallable
  • Category=Node

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

 Allow to change the name of a pin, to keep edges connected. PCGNode.h  

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

   PCGNode.h  

void SetNodePosition ( int32 InPositionX,
int32 InPositionY
)

   PCGNode.h
  • BlueprintCallable
  • Category=Node

bool SetNodeTitle ( FName NewTitle,
bool bApplySanitization
)

 Set the node title. PCGNode.h  

void SetSettingsInterface ( UPCGSettingsInterface* InSettingsInterface,
bool bUpdatePins
)

 Changes the default settings in the node PCGNode.h  

void TransferEditorProperties ( UPCGNode* OtherNode
) const

 Transfer all editor only properties to the other node PCGNode.h  

void UpdateAfterSettingsChangeDuringCreation()

 Triggers some uppdates after creating a new node and changing its settings PCGNode.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   PCGNode.h  

virtual void PostEditUndo()

   PCGNode.h  

virtual void PostLoad()

 ~Begin UObject interface PCGNode.h  

virtual void PreEditUndo()

   PCGNode.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CreateDefaultPins ( TFunctionRef< UPCGPin*(UPCGNode*)> PinAllocator
)

 When we create a new graph, we initialize the input/output nodes as default, with default pins. PCGNode.h  

void OnSettingsChanged ( UPCGSettings* InSettings,
EPCGChangeType ChangeType
)

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   PCGNode.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DefaultSettings_DEPRECATED TObjectPtr< UPCGSettings >   PCGNode.h
  • Meta=(PCGNoHash)
InboundEdges_DEPRECATED TArray< TObjectPtr< UPCGEdge > >   PCGNode.h
  • TextExportTransient
  • Meta=(PCGNoHash)
OutboundEdges_DEPRECATED TArray< TObjectPtr< UPCGEdge > >   PCGNode.h
  • TextExportTransient
  • Meta=(PCGNoHash)
OutboundNodes_DEPRECATED TArray< TObjectPtr< UPCGNode > >   PCGNode.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