1. Epic GamesDeveloper
  3. Helpers

Helpers

API > API/Plugins > API/Plugins/PCG

Filters

Classes

  Type Name Description
Public struct FExtractorParameters    
Public struct FPCGAsyncState Helper class to gather information about asynchronus execution. Will be held in the PCGContext.  
Public struct FPCGCopyAttributeParams    
Public class FPCGDataPartitionBase Convenience class to do data partitioning, i.e. building a TMap> Uses CRTP to remove the need for virtual calls.  
Public struct FPCGDynamicTrackingHelper Simple helper class to factorize the logic for gathering dynamic tracking keys and pushing them to the component.  
Public struct FPCGGetAllOverridableParamsConfig    
Public class FPCGGraphParameterExtension Extension helper class to allow templatization without dirtying the PCGGraph.h file  
Public struct FPCGISMCBuilderParameters    
Public class FPCGSubgraphHelpers    
Public class TFunction    
Public class UClass BlueprintType UPCGActorHelpers    
Public class UClass UPCGBlueprintHelpers    
Public class UClass MinimalAPI UPCGFunctionPrototypes Holds function prototypes used to match against actor function signatures.  
Public class UClass UPCGGraphParametersHelpers Blueprint Library to get or set graph parameters on graphs and graph instances  

Functions

  Type Name Description
Public function bool

FPCGAsync::AsyncProcessing ( FPCGAsyncState* AsyncState,
int32 NumIterations,
TArray< OutputType >& OutData,
Func&& InFunc,
const bool bEnableTimeSlicing,
const int32 ChunkSize
)

 Helper for generic parallel loops, with support for timeslicing.
Public function bool

FPCGAsync::AsyncProcessingEx ( FPCGAsyncState* AsyncState,
int32 NumIterations,
InitializeFunc&& Initialize,
ProcessElementFunc&& ProcessElement,
MoveFunc&& MoveData,
FinishedFunc&& Finished,
const bool bEnableTimeSlicing,
const int32 ChunkSize
)

 A Helper for generic parallel loops, with support for timeslicing.
Public function bool

FPCGAsync::AsyncProcessingOneToOneEx ( FPCGAsyncState* AsyncState,
int32 NumIterations,
InitializeFunc&& Initialize,
ProcessElementFunc&& ProcessElement,
const bool bEnableTimeSlicing,
const int32 ChunkSize
)

 A Helper for generic parallel loops, with support for timeslicing.
Public function bool

FPCGAsync::AsyncProcessingRangeEx ( FPCGAsyncState* AsyncState,
int32 NumIterations,
InitializeFunc&& Initialize,
ProcessRangeFunc&& ProcessRange,
MoveDataRangeFunc&& MoveDataRange,
FinishedFunc&& Finished,
const bool bEnableTimeSlicing,
const int32 ChunkSize
)

 A Helper for generic parallel loops, with support for timeslicing, specialized to work on ranges.
Public function bool

FPCGAsync::Private::AsyncProcessing ( FPCGAsyncState& AsyncState,
int32 NumIterations,
InitializeFunc&& Initialize,
InnerLoopFunc&& IterationInnerLoop,
MoveDataRangeFunc&& MoveDataRange,
FinishedFunc&& Finished,
const bool bInEnableTimeSlicing,
const int32 InChunkSize
)

  
Public function UPCGParamData *

PCGPropertyHelpers::ExtractPropertyAsAttributeSet ( const FExtractorParameters& Parameters,
FPCGContext* OptionalContext,
TSet< FSoftObjectPath >* OptionalObjectTraversed
)

 Extract a given property in an Attribute Set.
Public function EPCGMetadataTypes

PCGPropertyHelpers::GetMetadataTypeFromProperty ( const FProperty* InProperty
)

 Conversion between property type and PCG type.
Public function decltype(auto)

PCGPropertyHelpers::GetPropertyValueWithCallback ( const ObjectType* InObject,
const FProperty* InProperty,
Func InFunc
)

 PCGPropertiesHelpers Implementation.
Public function bool

PCGPropertyHelpers::SetPropertyValueFromCallback ( ObjectType* InObject,
const FProperty* InProperty,
Func InFunc
)

 Set a property value given by a callback function.
Public function int

PCGSettingsHelpers::ComputeSeedWithOverride ( const UPCGSettings* InSettings,
TWeakObjectPtr< UPCGComponent > InComponent,
UPCGParamData* InParams
)

  
Public function bool

PCGSettingsHelpers::GetOverrideValue ( const FPCGDataCollection& InInputData,
const UPCGSettings* InSettings,
const FName InPropertyName,
const T& InDefaultValue,
T& OutValue
)

 Advanced method to gather override params when you don't have access to FPCGContext (and therefore don't have access to automatic param override).
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS T

PCGSettingsHelpers::GetValue ( const FName& InName,
const T& InValue,
const UPCGParamData* InParams
)

  
Public function T

PCGSettingsHelpers::GetValue ( const FName& InName,
const T& InValue,
const UPCGParamData* InParams
)

  
Public function FName

PCGSettingsHelpers::GetValue ( const FName& InName,
const FName& InValue,
const UPCGParamData* InParams
)

  
Public function T

PCGSettingsHelpers::GetValue ( const FName& InName,
const T& InValue,
const UPCGParamData* InParams,
PCGMetadataEntryKey InKey
)

 Utility function to get the value of type T from a param data or a default value
Public function T

PCGSettingsHelpers::GetValue ( const FName& InName,
const T& InValue,
const UPCGParamData* InParams,
const FName& InParamName
)

  
Public function FName

PCGSettingsHelpers::GetValue ( const FName& InName,
const FName& InValue,
const UPCGParamData* InParams,
PCGMetadataEntryKey InKey
)

 Specialized version for names
Public function FName

PCGSettingsHelpers::GetValue ( const FName& InName,
const FName& InValue,
const UPCGParamData* InParams,
const FName& InParamName
)

  

Variables

  Type Name Description
Public variable TAutoConsoleVariable< int32 > CVarAsyncOverrideChunkSize  
Public variable TAutoConsoleVariable< bool > CVarDisableAsyncTimeSlicing  
Public variable const FName DefaultPCGActorTag  
Public variable const FName DefaultPCGDebugTag  
Public variable const FName DefaultPCGTag Tag that will be added on every component generated through the PCG system
Public variable const FName MarkedForCleanupPCGTag  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page