1. Epic GamesDeveloper
  3. UPCGComponent

UPCGComponent

API > API/Plugins > API/Plugins/PCG

   
Name UPCGComponent
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/PCGComponent.h
Include Path #include "PCGComponent.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural),  
       Meta=(BlueprintSpawnableComponent, prioritizeCategories="PCG"))  
class UPCGComponent :  
    public UActorComponent ,  
    public IPCGGraphExecutionSource

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPCGComponent ( const FObjectInitializer& InObjectInitializer
)

   PCGComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bActivated bool   PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(DisplayPriority=100)
bDirtyGenerated bool   PCGComponent.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Transient
  • Category=Debug
  • Meta=(NoResetToDefault)
bForceGenerateOnBPAddedToWorld bool Property that will automatically be set on BP templates, to allow for "Generate on add to world" in editor. PCGComponent.h  
bGenerated bool Flag to indicate whether this component has run in the editor. PCGComponent.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Category=Debug
  • NonTransactional
  • Meta=(NoResetToDefault)
bGenerateOnDropWhenTriggerOnDemand bool When Generation Trigger is OnDemand, we can still force the component to generate on drop. PCGComponent.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Settings|Advanced"
  • Meta=(EditCondition="GenerationTrigger == EPCGComponentGenerationTrigger::GenerateOnDemand")
bIgnoreLandscapeTracking bool Marks the component to be not refreshed automatically when the landscape changes, even if it is used. PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Editing Settings"
  • Meta=(DisplayPriority=451)
bIsComponentPartitioned bool Will partition the component in a grid, dispatching the generation to multiple local components. PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition="!bIsComponentLocal", DisplayName="Is Partitioned", DisplayPriority=500)
bOnlyTrackItself bool Even if the graph has external dependencies, the component won't react to them. PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Editing Settings"
  • Meta=(DisplayPriority=450)
bOverrideGenerationRadii bool Manual overrides for the graph generation radii and cleanup radius multiplier. PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=RuntimeGeneration
  • Meta=(EditCondition="GenerationTrigger == EPCGComponentGenerationTrigger::GenerateAtRuntime", EditConditionHides)
bParseActorComponents bool   PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Input Node Settings (Deprecated)"
  • Meta=(DisplayPriority=900)
bRegenerateInEditor bool   PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Editing Settings"
  • Meta=(DisplayName="Regenerate PCG Volume In Editor", DisplayPriority=400)
bRuntimeGenerated bool   PCGComponent.h
  • NonPIEDuplicateTransient
ExtraCapture PCGUtils::FExtraCapture   PCGComponent.h  
GenerationRadii FPCGRuntimeGenerationRadii   PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=RuntimeGeneration
  • Meta=(EditCondition="GenerationTrigger == EPCGComponentGenerationTrigger::GenerateAtRuntime && bOverrideGenerationRadii", EditConditionHides)
GenerationTrigger EPCGComponentGenerationTrigger   PCGComponent.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition="!bIsComponentLocal", EditConditionHides, DisplayPriority=200)
InputType EPCGComponentInput   PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Input Node Settings (Deprecated)"
  • Meta=(DisplayPriority=800)
OnPCGGraphCancelledDelegate FOnPCGGraphCancelled   PCGComponent.h  
OnPCGGraphCancelledExternal FOnPCGGraphCancelledExternal Event dispatched when a graph cancels generation on this component. PCGComponent.h
  • BlueprintAssignable
  • Meta=(DisplayName="On Graph Cancelled")
OnPCGGraphCleanedDelegate FOnPCGGraphCleaned   PCGComponent.h  
OnPCGGraphCleanedExternal FOnPCGGraphCleanedExternal Event dispatched when a graph cleans on this component. PCGComponent.h
  • BlueprintAssignable
  • Meta=(DisplayName="On Graph Cleaned")
OnPCGGraphGeneratedDelegate FOnPCGGraphGenerated   PCGComponent.h  
OnPCGGraphGeneratedExternal FOnPCGGraphGeneratedExternal Event dispatched when a graph completes its generation on this component. PCGComponent.h
  • BlueprintAssignable
  • Meta=(DisplayName="On Graph Generated")
OnPCGGraphStartGeneratingDelegate FOnPCGGraphStartGenerating   PCGComponent.h  
OnPCGGraphStartGeneratingExternal FOnPCGGraphStartGeneratingExternal Event dispatched when a graph begins generation on this component. PCGComponent.h
  • BlueprintAssignable
  • Meta=(DisplayName="On Graph Started Generating")
PostGenerateFunctionNames TArray< FName > Can specify a list of functions from the owner of this component to be called when generation is done, in order. PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(DisplayPriority=700)
SchedulingPolicy TObjectPtr< UPCGSchedulingPolicyBase > This is the instanced UPCGSchedulingPolicy object which holds scheduling parameters and calculates priorities. PCGComponent.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Instanced
  • Category=RuntimeGeneration
  • Meta=(EditCondition="GenerationTrigger == EPCGComponentGenerationTrigger::GenerateAtRuntime", EditConditionHides)
SchedulingPolicyClass TSubclassOf< UPCGSchedulingPolicyBase > A Scheduling Policy dictates the order in which instances of this component will be scheduled. PCGComponent.h
  • BlueprintReadOnly
  • EditAnywhere
  • NoClear
  • Category=RuntimeGeneration
  • Meta=(EditCondition="GenerationTrigger == EPCGComponentGenerationTrigger::GenerateAtRuntime", EditConditionHides)
Seed int   PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(DisplayPriority=600)
Timer PCGUtils::FCallTime   PCGComponent.h  
ToolDataContainer FPCGInteractiveToolDataContainer This stores working data of a tool; runtime property as the PCG Component will rely on the tool's working data to generate properly. PCGComponent.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Tool Data"
TrackingPriority double Tracking priority used to solve tracking dependencies between PCG Components. PCGComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Editing Settings"
  • Meta=(DisplayPriority=452, ClampMin="-10000.0", ClampMax="10000.0", UIMin="-10000.0", UIMax="10000.0", Delta="1")

Protected

Name Type Remarks Include Path Unreal Specifiers
bDisableIsComponentPartitionedOnLoad bool Track if component should disable 'bIsComponentPartitioned'. PCGComponent.h  
bGenerationInProgress bool   PCGComponent.h
  • Transient
  • VisibleInstanceOnly
  • Category=Debug
bIsComponentLocal bool   PCGComponent.h
  • VisibleAnywhere
  • Transient
  • Category=Debug
  • Meta=(EditCondition=false, EditConditionHides)
bProceduralInstancesInUse bool Whether procedural ISM components were used/generated in the last execution. PCGComponent.h  
bUnregisteredThroughLoading bool Track if component was unregistered while in a loading scope. PCGComponent.h  
bWasGeneratedThisSession bool   PCGComponent.h  
CachedActorData TObjectPtr< UPCGData >   PCGComponent.h
  • Transient
  • NonPIEDuplicateTransient
CachedInputData TObjectPtr< UPCGData >   PCGComponent.h
  • Transient
  • NonPIEDuplicateTransient
CachedLandscapeData TObjectPtr< UPCGData >   PCGComponent.h
  • Transient
  • NonPIEDuplicateTransient
CachedLandscapeHeightData TObjectPtr< UPCGData >   PCGComponent.h
  • Transient
  • NonPIEDuplicateTransient
CachedPCGData TObjectPtr< UPCGData >   PCGComponent.h
  • Transient
  • NonPIEDuplicateTransient
CurrentCleanupTask FPCGTaskId   PCGComponent.h  
CurrentExecutionDynamicTracking FPCGSelectionKeyToSettingsMap Temporary storage for dynamic tracking that will be filled during component execution. PCGComponent.h  
CurrentExecutionDynamicTrackingLock FTransactionallySafeCriticalSection   PCGComponent.h  
CurrentExecutionDynamicTrackingSettings TSet< const UPCGSettings * > Temporary storage for dynamic tracking that will keep all settings that could have dynamic tracking, in order to detect changes. PCGComponent.h  
CurrentGenerationTask FPCGTaskId   PCGComponent.h  
CurrentRefreshTask FPCGTaskId   PCGComponent.h  
DynamicallyTrackedKeysToSettings FPCGSelectionKeyToSettingsMap Need to keep a reference to all tracked settings to still react to changes after a map load (since the component won't have been executed). PCGComponent.h  
ExecutionInspection FPCGGraphExecutionInspection   PCGComponent.h  
ExecutionState FPCGComponentExecutionState   PCGComponent.h  
GeneratedGraphOutput FPCGDataCollection   PCGComponent.h
  • VisibleInstanceOnly
  • Category=Debug
GeneratedResources TArray< TObjectPtr< UPCGManagedResource > > NOTE: This should not be made visible or editable because it will change the way the BP actors are duplicated/setup and might trigger an ensure in the resources. PCGComponent.h  
GeneratedResourcesInaccessible bool When doing a cleanup, locking resource modification. Used as sentinel. PCGComponent.h  
GeneratedResourcesLock FTransactionallySafeCriticalSection   PCGComponent.h  
IgnoredChangeOriginsLock FTransactionallySafeRWLock   PCGComponent.h  
IgnoredChangeOriginsToCounters TMap< TObjectKey< UObject >, int32 > The tracking system will not trigger a generation on this component for these change origins. PCGComponent.h  
LastGeneratedBounds FBox   PCGComponent.h
  • VisibleInstanceOnly
  • Category=Debug
LastGeneratedBoundsPriorToUndo FBox   PCGComponent.h  
LoadedPreviewGeneratedGraphOutput FPCGDataCollection   PCGComponent.h
  • Transient
LoadedPreviewResources TArray< TObjectPtr< UPCGManagedResource > >   PCGComponent.h
  • Transient
PerPinGeneratedOutput TMap< FString, FPCGDataCollection > If any graph edges cross execution grid sizes, data on the edge is stored / retrieved from this map. PCGComponent.h
  • Transient
  • NonTransactional
  • VisibleAnywhere
  • Category=Debug
PerPinGeneratedOutputLock FTransactionallySafeRWLock   PCGComponent.h  
RuntimeGridDescriptorHash uint32   PCGComponent.h  
StaticallyTrackedKeysToSettings FPCGSelectionKeyToSettingsMap   PCGComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddActorsToManagedResources ( const TArray< AActor* >& InActors
)

 Creates a managed actors resource and adds it to the current component. PCGComponent.h
  • BlueprintCallable
  • Category=PCG

void AddComponentsToManagedResources ( const TArray< UActorComponent* >& InComponents
)

 Creates a managed component resource and adds it to the current component. PCGComponent.h
  • BlueprintCallable
  • Category=PCG

void AddToManagedResources ( UPCGManagedResource* InResource
)

 Registers some managed resource to the current component PCGComponent.h
  • BlueprintCallable
  • Category=PCG

bool AreManagedResourcesAccessible()

   PCGComponent.h  

bool AreProceduralInstancesInUse()

 Whether this component created one or more procedural ISM components when last generated. PCGComponent.h  

void CancelGeneration()

 Cancels in-progress generation PCGComponent.h  

bool CanPartition()

   PCGComponent.h  

void ChangeTransientState ( EPCGEditorDirtyMode NewEditingMode
)

 Changes the transient state (preview, normal, load on preview) - public only because it needs to be accessed by APCGPartitionActor PCGComponent.h  

void Cleanup ( bool bRemoveComponents
)

 Networked cleanup call PCGComponent.h
  • BlueprintCallable
  • NetMulticast
  • Reliable
  • Category=PCG

void Cleanup ()

   PCGComponent.h  

void CleanupLocal ( bool bRemoveComponents,
bool bSave,
const TArray< FPCGTaskId >& Dependencies
)

   PCGComponent.h  

void CleanupLocal ( bool bRemoveComponents,
bool bSave
)

   PCGComponent.h  

FPCGTaskId CleanupLocal ( bool bRemoveComponents,
const TArray< FPCGTaskId >& Dependencies
)

   PCGComponent.h  

void CleanupLocal ( bool bRemoveComponents
)

 Cleans up the generation from a local (vs. remote) standpoint. PCGComponent.h
  • BlueprintCallable
  • Category=PCG

void CleanupLocalDeleteAllGeneratedObjects ( const TArray< FPCGTaskId >& Dependencies
)

 Cleanup the generation while purging Actors and Components tagged as generated by PCG but are no longer managed by this or any other actor PCGComponent.h  

void CleanupLocalImmediate ( bool bRemoveComponents,
bool bCleanupLocalComponents
)

 Same as CleanupLocal, but without any delayed tasks. PCGComponent.h  

void ClearInspectionData ( bool bClearPerNodeExecutionData
)

   PCGComponent.h  

AActor * ClearPCGLink ( UClass* TemplateActor
)

 Move all generated resources under a new actor, following a template (AActor if not provided), clearing all link to this PCG component. PCGComponent.h
  • BlueprintCallable
  • Category=PCG

void ClearPerPinGeneratedOutput()

 Clear any data stored for any pins. PCGComponent.h  

void DirtyGenerated ( EPCGComponentDirtyFlag DataToDirtyFlag,
const bool bDispatchToLocalComponents
)

 Dirty generated data depending on the flag. PCGComponent.h  

void DisableInspection()

   PCGComponent.h  

bool DoesGridDependOnWorldStreaming ( uint32 InGridSize
) const

   PCGComponent.h  

void EnableInspection()

   PCGComponent.h  

void ForEachConstManagedResource ( TFunctionRef< void(const UPCGManagedResource*)> InFunction
) const

   PCGComponent.h  

void ForEachManagedResource ( TFunctionRef< void(UPCGManagedResource*)> InFunction
)

   PCGComponent.h  

void Generate ()

   PCGComponent.h  

void Generate ( bool bForce
)

 Networked generation call that also activates the component as needed PCGComponent.h
  • BlueprintCallable
  • NetMulticast
  • Reliable
  • Category=PCG

void GenerateLocal ( EPCGComponentGenerationTrigger RequestedGenerationTrigger,
bool bForce,
EPCGHiGenGrid Grid,
const TArray< FPCGTaskId >& Dependencies
)

 Requests the component to generate only on the specified grid level (all grid levels if EPCGHiGenGrid::Uninitialized). PCGComponent.h  

void GenerateLocal ( bool bForce
)

 Starts generation from a local (vs. remote) standpoint. Will not be replicated. Will be delayed. PCGComponent.h
  • BlueprintCallable
  • Category=PCG

FPCGTaskId GenerateLocalGetTaskId ( bool bForce
)

   PCGComponent.h  

FPCGTaskId GenerateLocalGetTaskId ( EPCGComponentGenerationTrigger RequestedGenerationTrigger,
bool bForce,
EPCGHiGenGrid Grid,
const TArray< FPCGTaskId >& Dependencies
)

   PCGComponent.h  

FPCGTaskId GenerateLocalGetTaskId ( EPCGComponentGenerationTrigger RequestedGenerationTrigger,
bool bForce,
EPCGHiGenGrid Grid
)

   PCGComponent.h  

UPCGData * GetActorPCGData()

   PCGComponent.h  

double GetCleanupRadiusFromGrid ( EPCGHiGenGrid Grid
) const

 Compute the runtime cleanup radius for the given grid size. PCGComponent.h  

const UPCGComponent * GetConstOriginalComponent()

   PCGComponent.h  

EPCGEditorDirtyMode GetEditingMode()

 Returns the current editing mode PCGComponent.h
  • BlueprintCallable
  • Category="PCG|Advanced"

PRAGMA_DISABLE_DEPRECATION_WARNINGSTMap< TObjectKey< const UPCGNode >, TSet< NodeExecutedNotificationData > > GetExecutedNodeStacks()

   PCGComponent.h  

const FPCGDataCollection & GetGeneratedGraphOutput()

 Retrieves generated data PCGComponent.h
  • BlueprintCallable
  • Category=PCG

EPCGHiGenGrid GetGenerationGrid()

   PCGComponent.h  

uint32 GetGenerationGridSize()

   PCGComponent.h  

const FPCGRuntimeGenerationRadii & GetGenerationRadii()

 Get the generation radii that are currently active for this component. PCGComponent.h  

double GetGenerationRadiusFromGrid ( EPCGHiGenGrid Grid
) const

 Get the runtime generation radius for the given grid size. PCGComponent.h  

FPCGTaskId GetGenerationTaskId()

 Returns task ids to do internal chaining PCGComponent.h  

UPCGGraph * GetGraph()

   PCGComponent.h  

UPCGGraphInstance * GetGraphInstance()

   PCGComponent.h  

FBox GetGridBounds ()

   PCGComponent.h  

FPCGGridDescriptor GetGridDescriptor ( uint32 GridSize
) const

 Returns a GridDescriptor based on this component for the specified grid size PCGComponent.h  

UPCGData * GetInputPCGData()

   PCGComponent.h  

const FPCGDataCollection * GetInspectionData ( const FPCGStack& InStack
) const

   PCGComponent.h  

UPCGData * GetLandscapeHeightPCGData()

   PCGComponent.h  

UPCGData * GetLandscapePCGData()

   PCGComponent.h  

FBox GetLastGeneratedBounds()

   PCGComponent.h  

FBox GetLocalSpaceBounds()

   PCGComponent.h  

uint64 GetNodeInactivePinMask ( const UPCGNode* InNode,
const FPCGStack& Stack
) const

 Retrieve the inactive pin bitmask for the given node and stack in the last execution. PCGComponent.h  

UPCGData * GetOriginalActorPCGData()

   PCGComponent.h  

UPCGComponent * GetOriginalComponent()

 If this is a local component returns the original component, otherwise returns self. PCGComponent.h  

FBox GetOriginalGridBounds()

   PCGComponent.h  

FBox GetOriginalLocalSpaceBounds()

   PCGComponent.h  

UPCGData * GetPCGData()

   PCGComponent.h  

UPCGSchedulingPolicyBase * GetRuntimeGenSchedulingPolicy()

   PCGComponent.h  

EPCGEditorDirtyMode GetSerializedEditingMode()

   PCGComponent.h
  • BlueprintCallable
  • Category="PCG|Advanced"

bool GetStackContext ( FPCGStackContext& OutStackContext
) const

 Get execution stack information. PCGComponent.h  

UPCGSubsystem * GetSubsystem()

   PCGComponent.h  

bool HasNodeProducedData ( const UPCGNode* InNode,
const FPCGStack& Stack
) const

 Did the given node produce one or more data items in the given stack during the last execution. PCGComponent.h  

void IgnoreChangeOriginDuringGenerationWithScope ( const UObject* InChangeOriginToIgnore,
Func InFunc
)

   PCGComponent.h  

void IgnoreChangeOriginsDuringGenerationWithScope ( const TArrayView< const UObject* > InChangeOriginsToIgnore,
Func InFunc
)

 Allow for the function to be defined outside of editor, so it's lighter at the calling site and will just call the InFunc. PCGComponent.h  

bool IsAnyObjectManagedByResource ( const TArrayView< const UObject* > InObjects
) const

 Will scan the managed resources to check if any resource manage one of the objects. PCGComponent.h  

bool IsCleaningUp()

   PCGComponent.h  

bool IsGenerating()

 Return if we are currently generating the graph for this component PCGComponent.h  

bool IsGenerationInProgress()

   PCGComponent.h  

bool IsIgnoringAnyChangeOrigins ( const TArrayView< const UObject* > InChangeOrigins,
const UObject*& OutFirstObjectFound
) const

   PCGComponent.h  

bool IsIgnoringChangeOrigin ( const UObject* InChangeOrigin
) const

   PCGComponent.h  

bool IsInPreviewMode()

 Returns whether the component (or resources) should be marked as dirty following interaction/refresh based on the current editing mode PCGComponent.h  

bool IsInspecting()

   PCGComponent.h  

bool IsLocalComponent()

   PCGComponent.h  
Returns true if the component is managed by the runtime generation system. PCGComponent.h  

bool IsObjectTracked ( const UObject* InObject,
bool& bOutIsCulled
) const

   PCGComponent.h  

bool IsPartitioned()

   PCGComponent.h  

bool IsRefreshInProgress()

 Returns current refresh task ID. PCGComponent.h  

void MarkAsLocalComponent()

 Responsibility of the PCG Partition Actor to mark is local PCGComponent.h  

void NotifyNodeDynamicInactivePins ( const UPCGNode* InNode,
const FPCGStack* InStack,
uint64 InactivePinBitmask
) const

 Whether the given node was culled by a dynamic branch in the given stack. PCGComponent.h  

void NotifyNodeExecuted ( const UPCGNode* InNode,
const FPCGStack* InStack,
const PCGUtils::FCallTime* InTimer,
bool bNodeUsedCache
)

   PCGComponent.h  

void NotifyProceduralInstancesInUse()

 Called during execution if one or more procedural ISM components are in use. PCGComponent.h  

void NotifyPropertiesChangedFromBlueprint()

 Notify properties changed, used in runtime cases, will dirty & trigger a regeneration if needed PCGComponent.h
  • BlueprintCallable
  • Category=PCG

void OnRefresh ( bool bForceRefresh
)

   PCGComponent.h  

void Refresh ( EPCGChangeType ChangeType,
bool bCancelExistingRefresh
)

 Schedules refresh of the component. PCGComponent.h  

void RegisterDynamicTracking ( const FPCGSelectionKeyToSettingsMap& InKeysToSettings
)

 To be called to notify the component that this list of keys have a dynamic dependency. PCGComponent.h  

void RegisterDynamicTracking ( const UPCGSettings* InSettings,
const TArrayView< TPair< FPCGSelectionKey, bool > >& InDynamicKeysAndCulling
)

 To be called by an element to notify the component that this settings have a dynamic dependency. PCGComponent.h  

void ResetIgnoredChangeOrigins ( bool bLogIfAnyPresent
)

   PCGComponent.h  

void ResetLastGeneratedBounds()

 Reset last generated bounds to force PCGPartitionActor creation on next refresh PCGComponent.h  

const FPCGDataCollection * RetrieveOutputDataForPin ( const FString& InResourceKey
)

 Lookup data using a resource key that identifies the pin. PCGComponent.h  

void SetEditingMode ( EPCGEditorDirtyMode InEditingMode,
EPCGEditorDirtyMode InSerializedEditingMode
)

   PCGComponent.h
  • BlueprintCallable
  • Category="PCG|Advanced"

void SetGenerationGridSize ( uint32 InGenerationGridSize
)

   PCGComponent.h  

void SetGraph ( UPCGGraphInterface* InGraph
)

   PCGComponent.h
  • BlueprintCallable
  • NetMulticast
  • Reliable
  • Category=PCG

void SetGraphLocal ( UPCGGraphInterface* InGraph
)

   PCGComponent.h  

void SetIsPartitioned ( bool bIsNowPartitioned
)

 Utility function (mostly for tests) to properly set the value of bIsComponentPartitioned. PCGComponent.h  

void SetPropertiesFromOriginal ( const UPCGComponent* Original
)

 Updates internal properties from other component, dirties as required but does not trigger Refresh PCGComponent.h  

void SetSchedulingPolicyClass ( TSubclassOf< UPCGSchedulingPolicyBase > InSchedulingPolicyClass
)

 Set the runtime generation scheduling policy type. PCGComponent.h  

bool ShouldGenerateBPPCGAddedToWorld()

 Know if we need to force a generation, in case of BP added to the world in editor PCGComponent.h  

void StartGenerationInProgress()

   PCGComponent.h  

void StartIgnoringChangeOriginDuringGeneration ( const UObject* InChangeOriginToIgnore
)

 For duration of the current/next generation, any change triggers from this change origin will be discarded. PCGComponent.h  

void StartIgnoringChangeOriginsDuringGeneration ( const TArrayView< const UObject* > InChangeOriginsToIgnore
)

   PCGComponent.h  

void StopGenerationInProgress()

   PCGComponent.h  

void StopIgnoringChangeOriginDuringGeneration ( const UObject* InChangeOriginToIgnore
)

   PCGComponent.h  

void StopIgnoringChangeOriginsDuringGeneration ( const TArrayView< const UObject* > InChangeOriginsToIgnore
)

   PCGComponent.h  

void StoreInspectionData ( const FPCGStack* InStack,
const UPCGNode* InNode,
const PCGUtils::FCallTime* InTimer,
const FPCGDataCollection& InInputData,
const FPCGDataCollection& InOutputData,
bool bUsedCache
)

   PCGComponent.h  

void StoreOutputDataForPin ( const FString& InResourceKey,
const FPCGDataCollection& InData
)

 Store data with a resource key that identifies the pin. PCGComponent.h  

bool Use2DGrid()

 Returns true if component should output on a 2D Grid PCGComponent.h  

bool WasGeneratedThisSession()

 Functions for managing the node inspection cache PCGComponent.h  

bool WasNodeExecuted ( const UPCGNode* InNode,
const FPCGStack& Stack
) const

   PCGComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

 ~End UObject interface PCGComponent.h  

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   PCGComponent.h  

virtual void OnComponentDestroyed ( bool bDestroyingHierarchy
)

   PCGComponent.h  

virtual void OnRegister()

   PCGComponent.h  

virtual void OnUnregister()

   PCGComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   PCGComponent.h  

virtual bool CanEditChange ( const FProperty* InProperty
) const

   PCGComponent.h  

virtual bool IsEditorOnly()

   PCGComponent.h  

virtual void PostEditImport()

   PCGComponent.h  

virtual void PostInitProperties()

   PCGComponent.h  

virtual void PostLoad()

   PCGComponent.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   PCGComponent.h  

virtual void Serialize ( FArchive& Ar
)

 ~End IPCGGraphExecutionSource interface ~Begin UObject interface PCGComponent.h  

Overridden from IPCGGraphExecutionSource

Name Remarks Include Path Unreal Specifiers
~Begin IPCGGraphExecutionSource interface PCGComponent.h  
  PCGComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

FPCGGridDescriptor GetGridDescriptorInternal ( uint32 GridSize,
bool bRuntimeHashUpdate
) const

   PCGComponent.h  

void MarkSubObjectsAsGarbage()

   PCGComponent.h  

void RefreshSchedulingPolicy()

   PCGComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual TStructOnScope< FActorComponentInstanceData > GetComponentInstanceData()

   PCGComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

   PCGComponent.h  

static UPCGData * CreateActorPCGData ( AActor* Actor,
const UPCGComponent* Component,
bool bParseActor
)

 Builds the canonical PCG data from a given actor and its PCG component if any. PCGComponent.h  

static FPCGDataCollection CreateActorPCGDataCollection ( AActor* Actor,
const UPCGComponent* Component,
EPCGDataType InDataFilter,
bool bParseActor,
bool* bOutOptionalSanitizedTagAttributeName
)

 Builds the PCG data from a given actor and its PCG component, and places it in a data collection with appropriate tags PCGComponent.h  

static TArray< TSoftObjectPtr< AActor > > GetManagedActorPaths ( AActor* InActor
)

   PCGComponent.h  

static void PurgeUnlinkedResources ( const AActor* InActor
)

 Purges Actors and Components generated by PCG but are no longer managed by any PCG Component PCGComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
Graph_DEPRECATED TObjectPtr< UPCGGraph >   PCGComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page