UPCGLoopSettings | Unreal Engine 5.6 Documentation


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

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))  
class UPCGLoopSettings : public UPCGSubgraphSettings

Name	Type	Remarks	Include Path	Unreal Specifiers
bTokenizeOnWhiteSpace	bool	Enables deprecated behavior using spaces as separators.	Elements/PCGLoopElement.h	EditAnywhere Category=Settings Meta=(EditCondition="bTokenizeOnWhiteSpace", EditConditionHides, DeprecationMessage="bTokenizeOnWhiteSpace has been deprecated.")
bUseGraphDefaultPinUsage	bool	Controls whether the pin usage (normal, loop, feedback) will be taken from the subgraph to execute or from the manually provided list.	Elements/PCGLoopElement.h	BlueprintReadWrite EditAnywhere Category=Data
FeedbackPins	FString	Comma-separated list of pin names that will act as feedback pins, namely that in a given iteration it will receive the data from the output pin of the same name of the previous loop iteration.	Elements/PCGLoopElement.h	BlueprintReadWrite EditAnywhere Category=Data Meta=(EditCondition="!bUseGraphDefaultPinUsage")
LoopPins	FString	Comma-separated list of pin names on which we will loop by-element in a step-wise fashion; if more than one is provided, it is expected that they all have the same number of data.	Elements/PCGLoopElement.h	BlueprintReadWrite EditAnywhere Category=Data Meta=(EditCondition="!bUseGraphDefaultPinUsage")

Name	Remarks	Include Path	Unreal Specifiers
void GetLoopPinNames ( FPCGContext* Context, TArray< FName >& LoopPinNames, TArray< FName >& FeedbackPinNames, bool bQuiet ) const	This method is used to retrieve the loop & feedback pin names either from the graph (if using the default pin usage) or from the comma-separated list otherwise.	Elements/PCGLoopElement.h

Name	Remarks	Include Path	Unreal Specifiers
virtual bool IsDynamicGraph()	Returns true if the subgraphs nodes were not inlined into the parent graphs tasks during compilation.	Elements/PCGLoopElement.h

Name	Remarks	Include Path
virtual void ApplyDeprecation ( UPCGNode* InOutNode )	Any final migration/recovery that can be done after pins are finalized.	Elements/PCGLoopElement.h
virtual FName GetDefaultNodeName()		Elements/PCGLoopElement.h
virtual FText GetDefaultNodeTitle()		Elements/PCGLoopElement.h
virtual FText GetNodeTooltipText()		Elements/PCGLoopElement.h
virtual bool GetPinExtraIcon ( const UPCGPin* InPin, FName& OutExtraIcon, FText& OutTooltip ) const	Can override to add a custom icon next to the pin label (and an optional tooltip).	Elements/PCGLoopElement.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )		Elements/PCGLoopElement.h

Name	Remarks	Include Path	Unreal Specifiers
virtual FPCGElementPtr CreateElement()		Elements/PCGLoopElement.h
virtual EPCGChangeType GetChangeTypeForProperty ( const FName& InPropertyName ) const	Gets the change impact for a given property.	Elements/PCGLoopElement.h