Navigation
API > API/Plugins > API/Plugins/PCG
Inheritance Hierarchy
- FPCGContext
- FPCGAttributeNoiseContext
- FPCGBlueprintExecutionContext
- FPCGDataFromActorContext
- FPCGDataTableRowToParamDataContext
- FPCGExternalDataContext
- FPCGGetPropertyFromObjectPathContext
- FPCGIndirectionContext
- FPCGLoadDataAssetContext
- FPCGMeshSamplerContext
- FPCGPointFromMeshContext
- FPCGStaticMeshSpawnerContext
- FPCGSubgraphContext
- FPCGTextureSamplerContext
- TPCGTimeSlicedContext
References
| Module | PCG |
| Header | /Engine/Plugins/PCG/Source/PCG/Public/PCGContext.h |
| Include | #include "PCGContext.h" |
Syntax
USTRUCT (BlueprintType )
struct FPCGContext
Variables
| Type | Name | Description | |
|---|---|---|---|
| FPCGAsyncState | AsyncState | ||
| bool | bIsPaused | ||
| int32 | BypassedOutputCount | ||
| FPCGTaskId | CompiledTaskId | ||
| EPCGExecutionPhase | CurrentPhase | ||
| FPCGCrc | DependenciesCrc | ||
| FPCGDataCollection | InputData | ||
| const UPCGNode * | Node | TODO: replace this by a better identification mechanism. | |
| FPCGDataCollection | OutputData | ||
| TWeakObjectPtr< UPCGComponent > | SourceComponent | ||
| const FPCGStack * | Stack | The current call stack. | |
| FPCGTaskId | TaskId |
Destructors
| Type | Name | Description | |
|---|---|---|---|
~FPCGContext () |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddExtraStructReferencedObjects
(
FReferenceCollector& Collector |
||
| void | AddStructReferencedObjects
(
FReferenceCollector& Collector |
Gathers references to objects to prevent them from being garbage collected. | |
| FString | |||
| UObject * | GetExternalContainerForOverridableParam
(
const FPCGSettingsOverridableParam& InParam |
||
| const SettingsType * | Return the settings casted in the wanted type. | ||
| const UPCGSettingsInterface * | |||
| const SettingsType * | Caution: most use cases should use GetInputSettings, because they contain the overridden values. | ||
| int | GetSeed () |
Return the seed, possibly overriden by params, and combined with the source component (if any). | |
| AActor * | GetTargetActor
(
const UPCGSpatialData* InSpatialData |
||
| FString | GetTaskName () |
||
| void * | GetUnsafeExternalContainerForOverridableParam
(
const FPCGSettingsOverridableParam& InParam |
||
| bool | True if any issues were logged during last execution. | ||
| void | After initializing the context, we can call this method to prepare for parameter override It will create a copy of the original settings if there is indeed a possible override. | ||
| bool | IsValueOverriden
(
const FName PropertyName |
Returns true if the given property has been overriden. | |
| void | LogVisual
(
ELogVerbosity::Type InVerbosity, |
Log warnings and errors to be displayed on node in graph editor. | |
| void | If we any any parameter override, it will read from the params and override matching values in the settings copy. | ||
| bool | ShouldStop () |
||
| bool | Time slicing is not enabled by default. |