1. Epic GamesDeveloper
  3. UPCGBlueprintElement

UPCGBlueprintElement

API > API/Plugins > API/Plugins/PCG

   
Name UPCGBlueprintElement
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGExecuteBlueprint.h
Include Path #include "Elements/PCGExecuteBlueprint.h"

Syntax

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

Inheritance Hierarchy

Derived Classes

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bComputeFullDataCrc bool 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. Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • AdvancedDisplay
  • Category=Settings
bEnablePreconfiguredSettings bool   Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category="AssetInfo|Preconfigured Settings"
  • AssetRegistrySearchable
bExposeToLibrary bool   Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category=AssetInfo
  • AssetRegistrySearchable
bHasDefaultInPin bool   Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category="Settings|Input & Output"
bHasDefaultOutPin bool   Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category="Settings|Input & Output"
bHasDynamicPins bool If enabled, by default, the Out pin type will have the union of In pin types. Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category="Settings|Input & Output"
bIsCacheable bool Controls whether results can be cached so we can bypass execution if the inputs & settings are the same in a subsequent execution. Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • AdvancedDisplay
  • Category=Settings
bOnlyExposePreconfiguredSettings bool   Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category="AssetInfo|Preconfigured Settings"
  • AssetRegistrySearchable
  • Meta=(EditCondition=bEnablePreconfiguredSettings, EditConditionHides)
bRequiresGameThread bool Controls whether this node execution can be run from a non-game thread. Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category=Settings
Category FText   Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category=AssetInfo
  • AssetRegistrySearchable
CustomInputPins TArray< FPCGPinProperties >   Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category="Settings|Input & Output"
CustomOutputPins TArray< FPCGPinProperties >   Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category="Settings|Input & Output"
DependencyParsingDepth int32   Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • AdvancedDisplay
  • Category="Settings"
Description FText   Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category=AssetInfo
  • AssetRegistrySearchable
OnBlueprintChangedDelegate FOnPCGBlueprintChanged   Elements/PCGExecuteBlueprint.h  
PreconfiguredInfo TArray< FPCGPreConfiguredSettingsInfo >   Elements/PCGExecuteBlueprint.h
  • BlueprintReadWrite
  • EditDefaultsOnly
  • Category="AssetInfo|Preconfigured Settings"
  • Meta=(EditCondition=bEnablePreconfiguredSettings, EditConditionHides)

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyPreconfiguredSettings ( const FPCGPreConfiguredSettingsInfo& InPreconfigureInfo
)

 Apply the preconfigured settings specified in the class default. Elements/PCGExecuteBlueprint.h
  • BlueprintImplementableEvent
  • Category="PCG|Preconfigure Settings"
  • Meta=(ForceAsFunction)

TSet< FName > CustomInputLabels()

 Returns the labels of custom input pins only. Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • Category="PCG|Input & Output"

TSet< FName > CustomOutputLabels()

 Returns the labels of custom output pins only. Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • Category="PCG|Input & Output"

int32 DynamicPinTypesOverride ( const UPCGSettings* InSettings,
const UPCGPin* InPin
) const

 If Dynamic Pins is enabled in the BP settings, override this function to provide the type for the given pin. Elements/PCGExecuteBlueprint.h
  • BlueprintNativeEvent
  • Category="PCG|Node Customization"

void Execute ( const FPCGDataCollection& Input,
FPCGDataCollection& Output
)

 Main execution function that will contain the logic for this PCG Element. Elements/PCGExecuteBlueprint.h
  • BlueprintImplementableEvent
  • BlueprintCallable
  • Category="PCG|Execution"

void ExecuteWithContext ( FPCGContext& InContext,
const FPCGDataCollection& Input,
FPCGDataCollection& Output
)

 Main execution function that will contain the logic for this PCG Element, with the context as parameter. Elements/PCGExecuteBlueprint.h
  • BlueprintNativeEvent
  • Category="PCG|Execution"

FPCGContext & GetContext()

 Retrieves the execution context - note that this will not be valid outside of the Execute functions Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • Category="PCG|Advanced"
  • Meta=(HideSelfPin="true")

bool GetInputPinByLabel ( FName InPinLabel,
FPCGPinProperties& OutFoundPin
) const

 Returns true if there is an input pin with the matching label. Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • Category="PCG|Input & Output"
  • Meta=(HideSelfPin="true")

TArray< FPCGPinProperties > GetInputPins()

   Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • Category="PCG|Input & Output"
  • Meta=(HideSelfPin="true")

bool GetOutputPinByLabel ( FName InPinLabel,
FPCGPinProperties& OutFoundPin
) const

 Returns true if there is an output pin with the matching label. Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • Category="PCG|Input & Output"
  • Meta=(HideSelfPin="true")

TArray< FPCGPinProperties > GetOutputPins()

   Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • Category="PCG|Input & Output"
  • Meta=(HideSelfPin="true")

FRandomStream GetRandomStream ( FPCGContext& InContext
) const

 Creates a random stream from the settings & source component Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="PCG|Random"

int GetSeed ( FPCGContext& InContext
) const

 Gets the seed from the associated settings & source component Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • Category="PCG|Random"

virtual UWorld * GetWorld()

 Needed to be able to call certain blueprint functions Elements/PCGExecuteBlueprint.h  

void Initialize()

 Called after object creation to setup the object callbacks Elements/PCGExecuteBlueprint.h  
Override for the IsCacheable node property when it depends on the settings in your node. Elements/PCGExecuteBlueprint.h
  • BlueprintNativeEvent
  • Category="PCG|Execution"

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

 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 Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="PCG|Flow Control"
  • Meta=(HideSelfPin="true")

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

 Multi-threaded loop that will be called N number of times (defined by Iteration Loop parameter NumIterations). Elements/PCGExecuteBlueprint.h
  • BlueprintImplementableEvent
  • Category="PCG|Flow Control"

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

 Calls the NestedLoopBody function on all nested loop pairs (e.g. (o, i) for all o in Outer, i in Inner) Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="PCG|FLow Control"
  • Meta=(HideSelfPin="true")

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
) const

 Multi-threaded loop that will iterate on all nested loop pairs (e.g. (o, i) for all o in Outer, i in Inner). Elements/PCGExecuteBlueprint.h
  • BlueprintImplementableEvent
  • Category="PCG|Flow Control"

FLinearColor NodeColorOverride()

 Override for the default node color. Elements/PCGExecuteBlueprint.h
  • BlueprintNativeEvent
  • Category="PCG|Node Customization"

FName NodeTitleOverride()

 Override for the default node name Elements/PCGExecuteBlueprint.h
  • BlueprintNativeEvent
  • Category="PCG|Node Customization"

EPCGSettingsType NodeTypeOverride()

 Override to change the node type. Elements/PCGExecuteBlueprint.h
  • BlueprintNativeEvent
  • Category="PCG|Node Customization"

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

 Calls the PointLoopBody function on all points Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="PCG|Flow Control"
  • Meta=(HideSelfPin="true")

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

 Multi-threaded loop that will iterate on all points in InData. Elements/PCGExecuteBlueprint.h
  • BlueprintImplementableEvent
  • Category="PCG|Flow Control"

void SetCurrentContext ( FPCGContext* InCurrentContext
)

 Called after the element duplication during execution to be able to get the context easily - internal call only Elements/PCGExecuteBlueprint.h  

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

 Calls the VariableLoopBody function on all points, each call can return a variable number of points Elements/PCGExecuteBlueprint.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="PCG|Flow Control"
  • Meta=(HideSelfPin="true")

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

 Multi-threaded loop that will be called on all points in InData. Elements/PCGExecuteBlueprint.h
  • BlueprintImplementableEvent
  • Category="PCG|Flow Control"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Elements/PCGExecuteBlueprint.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Elements/PCGExecuteBlueprint.h  

virtual void PostLoad()

   Elements/PCGExecuteBlueprint.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnDependencyChanged ( UObject* Object,
FPropertyChangedEvent& PropertyChangedEvent
)

   Elements/PCGExecuteBlueprint.h  

void UpdateDependencies()

   Elements/PCGExecuteBlueprint.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString GetParentClassName()

 Used for filtering Elements/PCGExecuteBlueprint.h  

static FPCGContext * ResolveContext()

 Tries to resolve current Context from thread local BP stack Elements/PCGExecuteBlueprint.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bCanBeMultithreaded_DEPRECATED bool This property is deprecated, please use 'Requires Game Thread' instead. Elements/PCGExecuteBlueprint.h  
InputPinLabels_DEPRECATED TSet< FName >   Elements/PCGExecuteBlueprint.h
  • BlueprintGetter=CustomInputLabels
  • Category="Settings|Input & Output"
  • Meta=(DeprecatedProperty, DeprecatedMessage="Input Pin Labels are deprecated - use Input Labels instead.")
OutputPinLabels_DEPRECATED TSet< FName >   Elements/PCGExecuteBlueprint.h
  • BlueprintGetter=CustomOutputLabels
  • Category="Settings|Input & Output"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page