1. Epic GamesDeveloper
  3. UPCGBlueprintElement

UPCGBlueprintElement

API > API/Plugins > API/Plugins/PCG > API/Plugins/PCG/Elements

Inheritance Hierarchy

  • UObject
  • UPCGBlueprintElement

References

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

Syntax

UCLASS (Abstract, BlueprintType, Blueprintable, HideCategories=(Object))  
class UPCGBlueprintElement : public UObject

Variables

  Type Name Description
Public variable UProperty Category, EditDefaultsOnly, AdvancedDisplay BlueprintReadWrite bool bComputeFullDataCrc In cases where your node is non-cacheable but is likely to yield the same results on subsequent executions, this controls whether we will do a deep & computationally intensive CRC computation (true), which will allow cache usage in downstream nodes in your graph, or, by default (false), a shallow but quick crc computation which will not be cache-friendly.
Public variable UProperty Category, EditDefaultsOnly BlueprintReadWrite assetregistrysearchable bool bEnablePreconfiguredSettings  
Public variable UProperty Category, EditDefaultsOnly BlueprintReadWrite assetregistrysearchable bool bExposeToLibrary  
Public variable UProperty Category, EditDefaultsOnly BlueprintReadWrite bool bHasDefaultInPin  
Public variable UProperty Category, EditDefaultsOnly BlueprintReadWrite bool bHasDefaultOutPin  
Public variable UProperty Category, EditDefaultsOnly, AdvancedDisplay BlueprintReadWrite bool bIsCacheable Controls whether results can be cached so we can bypass execution if the inputs & settings are the same in a subsequent execution.
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadWrite assetregistrysearchable bool bOnlyExposePreconfiguredSettings  
Public variable UProperty Category, EditDefaultsOnly BlueprintReadWrite bool bRequiresGameThread Controls whether this node execution can be run from a non-game thread.
Public variable UProperty Category, EditDefaultsOnly BlueprintReadWrite assetregistrysearchable FText Category  
Protected variable FPCGContext * CurrentContext Since we duplicate the blueprint elements prior to execution, they will be unique and have a 1:1 match with their context, which allows us to store it here
Public variable UProperty Category, EditDefaultsOnly BlueprintReadWrite TArray< FPCGPinProperties > CustomInputPins  
Public variable UProperty Category, EditDefaultsOnly BlueprintReadWrite TArray< FPCGPinProperties > CustomOutputPins  
Protected variable TSet< TObjectPtr< UObject > > DataDependencies  
Public variable UProperty Category, EditDefaultsOnly, AdvancedDisplay BlueprintReadWrite int32 DependencyParsingDepth  
Public variable UProperty Category, EditDefaultsOnly BlueprintReadWrite assetregistrysearchable FText Description  
Public variable FOnPCGBlueprintChanged OnBlueprintChangedDelegate  
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadWrite TArray< FPCGPreConfiguredSettingsInfo > PreconfiguredInfo  

Functions

  Type Name Description
Public function UFunction Category, Meta, BlueprintImplementableEvent void

ApplyPreconfiguredSettings ( UPARAM(ref) const FPCGPreConfiguredSettingsInfo& InPreconfigureInfo
)

 Apply the preconfigured settings specified in the class default.
Public function Virtual void  
Public function Const UFunction BlueprintCallable, Category TSet< FName > Returns the labels of custom input pins only.
Public function Const UFunction BlueprintCallable, Category TSet< FName > Returns the labels of custom output pins only.
Public function UFunction BlueprintCallable, Category, BlueprintImplementableEvent void

Execute ( const FPCGDataCollection& Input,
FPCGDataCollection& Output
)

 Main execution function that will contain the logic for this PCG Element.
Public function UFunction Category blueprintnativeevent void

ExecuteWithContext ( UPARAM(ref) FPCGContext& InContext,
const FPCGDataCollection& Input,
FPCGDataCollection& Output
)

 Main execution function that will contain the logic for this PCG Element, with the context as parameter.
Public function Const UFunction BlueprintCallable, Category, Meta FPCGContext & Retrieves the execution context - note that this will not be valid outside of the Execute functions
Public function Const UFunction BlueprintCallable, Category, Meta bool

GetInputPinByLabel ( FName InPinLabel,
FPCGPinProperties& OutFoundPin
)

 Returns true if there is an input pin with the matching label.
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FPCGPinProperties >  
Public function Const UFunction BlueprintCallable, Category, Meta bool

GetOutputPinByLabel ( FName InPinLabel,
FPCGPinProperties& OutFoundPin
)

 Returns true if there is an output pin with the matching label.
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FPCGPinProperties >  
Public function Static FString Used for filtering
Public function Const UFunction BlueprintCallable, BlueprintPure, Category FRandomStream

GetRandomStream ( UPARAM(ref) FPCGContext& InContext
)

 Creates a random stream from the settings & source component
Public function Const UFunction BlueprintCallable, Category int

GetSeed ( UPARAM(ref) FPCGContext& InContext
)

 Gets the seed from the associated settings & source component
Public function Virtual Const UWorld * Needed to be able to call certain blueprint functions
Public function void Called after object creation to setup the object callbacks
Public function Const UFunction Category blueprintnativeevent bool Override for the IsCacheable node property when it depends on the settings in your node.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

IterationLoop ( UPARAM(ref) FPCGContext& InContext,
int64 NumIterations,
UPCGPointData*& OutData,
const UPCGSpatialData* OptionalA,
const UPCGSpatialData* OptionalB,
UPCGPointData* OptionalOutData
)

 Calls the IterationLoopBody a fixed number of times, optional parameters are used to potentially initialized the Out Data, but otherwise are used to remove the need to have variables
Public function Const UFunction Category, BlueprintImplementableEvent bool

IterationLoopBody ( const FPCGContext& InContext,
int64 Iteration,
const UPCGSpatialData* InA,
const UPCGSpatialData* InB,
FPCGPoint& OutPoint,
UPCGMetadata* OutMetadata
)

 Multi-threaded loop that will be called N number of times (defined by Iteration Loop parameter NumIterations).
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

NestedLoop ( UPARAM(ref) FPCGContext& InContext,
const UPCGPointData* InOuterData,
const UPCGPointData* InInnerData,
UPCGPointData*& OutData,
UPCGPointData* OptionalOutData
)

 Calls the NestedLoopBody function on all nested loop pairs (e.g. (o, i) for all o in Outer, i in Inner)
Public function Const UFunction Category, BlueprintImplementableEvent bool

NestedLoopBody ( const FPCGContext& InContext,
const UPCGPointData* InOuterData,
const UPCGPointData* InInnerData,
const FPCGPoint& InOuterPoint,
const FPCGPoint& InInnerPoint,
FPCGPoint& OutPoint,
UPCGMetadata* OutMetadata,
int64 OuterIteration,
int64 InnerIteration
)

 Multi-threaded loop that will iterate on all nested loop pairs (e.g. (o, i) for all o in Outer, i in Inner).
Public function Const UFunction Category blueprintnativeevent FLinearColor Override for the default node color.
Public function Const UFunction Category blueprintnativeevent FName Override for the default node name
Public function Const UFunction Category blueprintnativeevent EPCGSettingsType Override to change the node type.
Protected function void

OnDependencyChanged ( UObject* Object,
FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

PointLoop ( UPARAM(ref) FPCGContext& InContext,
const UPCGPointData* InData,
UPCGPointData*& OutData,
UPCGPointData* OptionalOutData
)

 Calls the PointLoopBody function on all points
Public function Const UFunction Category, BlueprintImplementableEvent bool

PointLoopBody ( const FPCGContext& InContext,
const UPCGPointData* InData,
const FPCGPoint& InPoint,
FPCGPoint& OutPoint,
UPCGMetadata* OutMetadata,
int64 Iteration
)

 Multi-threaded loop that will iterate on all points in InData.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function void

SetCurrentContext ( FPCGContext* InCurrentContext
)

 Called after the element duplication during execution to be able to get the context easily - internal call only
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

VariableLoop ( UPARAM(ref) FPCGContext& InContext,
const UPCGPointData* InData,
UPCGPointData*& OutData,
UPCGPointData* OptionalOutData
)

 Calls the VariableLoopBody function on all points, each call can return a variable number of points
Public function Const UFunction Category, BlueprintImplementableEvent TArray< FPCGPoint >

VariableLoopBody ( const FPCGContext& InContext,
const UPCGPointData* InData,
const FPCGPoint& InPoint,
UPCGMetadata* OutMetadata,
int64 Iteration
)

 Multi-threaded loop that will be called on all points in InData.

Deprecated Variables

  Type Name Description
Public variable UProperty bool bCanBeMultithreaded_DEPRECATED This property is deprecated, please use 'Requires Game Thread' instead.
Public variable UProperty Category, Meta blueprintgetter TSet< FName > InputPinLabels_DEPRECATED  
Public variable UProperty Category blueprintgetter TSet< FName > OutputPinLabels_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page