1. Epic GamesDeveloper
  3. Helpers

Helpers

API > API/Plugins > API/Plugins/PCG

Classes

  Type Name Description
Public struct FPCGAsyncState Helper class to gather information about asynchronus execution. Will be held in the PCGContext.  
Public struct FPCGGetAllOverridableParamsConfig    
Public struct FPCGISMCBuilderParameters    
Public class FPCGPointDataPartitionBase Convenience class to do point data partitioning, i.e. building a TMapTArray> Uses CRTP to remove the need for virtual calls.  
Public class UClass BlueprintType UPCGActorHelpers    
Public class UClass UPCGBlueprintHelpers    
Public class UClass UPCGGraphParametersHelpers Helpers to dynamically set parameters on 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::Private::AsyncProcessing ( FPCGAsyncState& AsyncState,
int32 NumIterations,
InitializeFunc&& Initialize,
InnerLoopFunc&& IterationInnerLoop,
MoveDataFunc&& MoveData,
FinishedFunc&& Finished,
const bool bInEnableTimeSlicing,
const int32 InChunkSize
)

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

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

 Get a property value and pass it as a parameter to a callback function.
Public function bool

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

 Set a property value given by a callback function.
Public function int ComputeSeedWithOverride is deprecated as overrides are now automatically applied on the settings. You should just query the settings value.
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
)

 GetValue is deprecated as overrides are now automatically applied on the settings. You should just query the settings value.
Public function T

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

 GetValue is deprecated as overrides are now automatically applied on the settings. You should just query the settings value.
Public function FName

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

 GetValue is deprecated as overrides are now automatically applied on the settings. You should just query the settings value.
Public function T

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

 GetValue is deprecated as overrides are now automatically applied on the settings. You should just query the settings value.
Public function T

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

 GetValue is deprecated as overrides are now automatically applied on the settings. You should just query the settings value.
Public function FName

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

 GetValue is deprecated as overrides are now automatically applied on the settings. You should just query the settings value.
Public function FName

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

 GetValue is deprecated as overrides are now automatically applied on the settings. You should just query the settings value.

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