1. Epic GamesDeveloper
  3. UPCGComponent

UPCGComponent

API > API/Plugins > API/Plugins/PCG

Inheritance Hierarchy

  • UActorComponent
  • UPCGComponent

References

   
Module PCG
Header /Engine/Plugins/PCG/Source/PCG/Public/PCGComponent.h
Include #include "PCGComponent.h"

Syntax

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bActivated  
Public variable UProperty Category, Meta BlueprintReadOnly Transient visibleanywhere bool bDirtyGenerated  
Public variable UProperty bool bForceGenerateOnBPAddedToWorld Property that will automatically be set on BP templates, to allow for "Generate on add to world" in editor.
Public variable UProperty Category, Meta BlueprintReadOnly nontransactional, visibleanywhere bool bGenerated Flag to indicate whether this component has run in the editor.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bGenerateOnDropWhenTriggerOnDemand When Generation Trigger is OnDemand, we can still force the component to generate on drop.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bIsComponentPartitioned Will partition the component in a grid, dispatching the generation to multiple local components.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bOnlyTrackItself Even if the graph has external dependencies, the component won't react to them.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bOverrideGenerationRadii Manual overrides for the graph generation radii and cleanup radius multiplier.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bParseActorComponents  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bRegenerateInEditor  
Public variable UProperty nonpieduplicatetransient bool bRuntimeGenerated  
Protected variable UProperty Category, EditAnywhere, Meta Transient EPCGEditorDirtyMode CurrentEditingMode Current editing mode that depends on the serialized editing mode and loading.
Public variable PCGUtils::FExtraCapture ExtraCapture  
Protected variable UProperty Category Transient visibleanywhere uint32 GenerationGridSize  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FPCGRuntimeGenerationRadii GenerationRadii  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly EPCGComponentGenerationTrigger GenerationTrigger  
Protected variable UProperty Category, Meta BlueprintReadOnly instanced, visibleanywhere TObjectPtr< UPCGGraphInstance > GraphInstance  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EPCGComponentInput InputType  
Public variable FOnPCGGraphCancelled OnPCGGraphCancelledDelegate  
Public variable UProperty Meta BlueprintAssignable FOnPCGGraphCancelledExternal OnPCGGraphCancelledExternal Event dispatched when a graph cancels generation on this component.
Public variable FOnPCGGraphCleaned OnPCGGraphCleanedDelegate  
Public variable UProperty Meta BlueprintAssignable FOnPCGGraphCleanedExternal OnPCGGraphCleanedExternal Event dispatched when a graph cleans on this component.
Public variable FOnPCGGraphGenerated OnPCGGraphGeneratedDelegate  
Public variable UProperty Meta BlueprintAssignable FOnPCGGraphGeneratedExternal OnPCGGraphGeneratedExternal Event dispatched when a graph completes its generation on this component.
Public variable FOnPCGGraphStartGenerating OnPCGGraphStartGeneratingDelegate  
Public variable UProperty Meta BlueprintAssignable FOnPCGGraphStartGeneratingExternal OnPCGGraphStartGeneratingExternal Event dispatched when a graph begins generation on this component.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TArray< FName > PostGenerateFunctionNames Can specify a list of functions from the owner of this component to be called when generation is done, in order.
Protected variable EPCGEditorDirtyMode PreviousEditingMode Used to store the CurrentEditingMode when it is forcefully changed by another system, such as runtime generation.
Public variable UProperty Category, Meta BlueprintReadOnly instanced, visibleanywhere TObjectPtr< UPCGSchedulingPolicyBase > SchedulingPolicy This is the instanced UPCGSchedulingPolicy object which holds scheduling parameters and calculates priorities.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly noclear TSubclassOf< UPCGSchedulingPolicyBase > SchedulingPolicyClass A Scheduling Policy dictates the order in which instances of this component will be scheduled.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int Seed  
Protected variable UProperty Category, Meta visibleanywhere EPCGEditorDirtyMode SerializedEditingMode  

Constructors

No constructors are accessible with public or protected access.

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void Registers some managed resource to the current component
Public function Virtual void  
Public function Virtual void ~End UObject interface
Public function void Cancels in-progress generation
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

  
Public function Const bool  
Public function void Changes the transient state (preview, normal, load on preview) - public only because it needs to be accessed by APCGPartitionActor
Public function void

Cleanup ()

  
Public function UFunction BlueprintCallable, Category Reliable, NetMulticast void

Cleanup ( bool bRemoveComponents,
bool bSave
)

 Networked cleanup call
Public function UFunction BlueprintCallable, Category void

CleanupLocal ( bool bRemoveComponents,
bool bSave
)

 Cleans up the generation from a local (vs. remote) standpoint.
Public function void

CleanupLocalImmediate ( bool bRemoveComponents,
bool bCleanupLocalComponents
)

 Same as CleanupLocal, but without any delayed tasks.
Public function void

ClearInspectionData ( bool bClearPerNodeExecutionData
)

  
Public function UFunction BlueprintCallable, Category 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.
Public function void Clear any data stored for any pins.
Public function 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.
Public function 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
Public function void
DirtyGenerated

( EPCGComponentDirtyFlag DataToDirtyFlag,
const bool bDispatchToLocalComponents
)

 Dirty generated data depending on the flag.
Public function void  
Public function void  
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

  
Public function void  
Public function void Transactionable methods to be called from details UI
Public function UFunction BlueprintCallable, Category Reliable, NetMulticast void

Generate ( bool bForce
)

 Networked generation call that also activates the component as needed
Public function 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).
Public function UFunction BlueprintCallable, Category void

GenerateLocal ( bool bForce
)

 Starts generation from a local (vs. remote) standpoint. Will not be replicated. Will be delayed.
Public function FPCGTaskId

GenerateLocalGetTaskId ( bool bForce
)

  
Public function FPCGTaskId

GenerateLocalGetTaskId ( EPCGComponentGenerationTrigger RequestedGenerationTrigger,
bool bForce,
EPCGHiGenGrid Grid
)

  
Public function UPCGData *  
Public function Const double Compute the runtime cleanup radius for the given grid size.
Protected function Virtual Const TStructOnScope< FActorComponentInstanceData >  
Public function Const UFunction BlueprintCallable, Category EPCGEditorDirtyMode Returns the current editing mode
Public function Const TMap< TObjectKey< const UPCGNode >, TSet< FPCGStack > > Retrieves the executed nodes information
Public function Const UFunction BlueprintCallable, Category const FPCGDataCollection & Retrieves generated data
Public function Const EPCGHiGenGrid  
Public function Const uint32  
Public function Const double Get the runtime generation radius for the given grid size.
Public function Const FPCGTaskId Returns task ids to do internal chaining
Public function Const UPCGGraph *  
Public function Const UPCGGraphInstance *  
Public function Const FBox  
Public function UPCGData *  
Public function Const const FPCGDataCollection *

GetInspectionData ( const FPCGStack& InStack
)

  
Public function UPCGData *  
Public function UPCGData *  
Public function Const FBox  
Public function Const uint64

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

 Retrieve the inactive pin bitmask for the given node and stack in the last execution.
Public function UPCGData *  
Public function UPCGComponent * If this is a local component returns self, otherwise returns the original component.
Public function UPCGData *  
Public function Const UPCGSchedulingPolicyBase *  
Public function Const UFunction BlueprintCallable, Category EPCGEditorDirtyMode  
Public function Const bool

GetStackContext ( FPCGStackContext& OutStackContext
)

 Get execution stack information.
Public function Const UPCGSubsystem *  
Public function Const bool

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

 Did the given node produce one or more data items in the given stack during the last execution.
Public function Const bool  
Public function Virtual Const bool  
Public function Const bool Return if we are currently generating the graph for this component
Public function bool  
Public function bool

IsIgnoringChangeOrigin ( UObject* InChangeOrigin
)

  
Public function Const bool Returns whether the component (or resources) should be marked as dirty following interaction/refresh based on the current editing mode
Public function Const bool Functions for managing the node inspection cache
Public function Const bool  
Public function Const bool Returns true if the component is managed by the runtime generation system.
Public function Const bool

IsObjectTracked ( const UObject* InObject,
bool& bOutIsCulled
)

  
Public function Const bool  
Public function Const bool Returns current refresh task ID.
Public function void Responsibility of the PCG Partition Actor to mark is local
Public function Const void

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

 Whether the given node was culled by a dynamic branch in the given stack.
Public function void

NotifyNodeExecuted ( const UPCGNode* InNode,
const FPCGStack* InStack,
bool bNodeUsedCache
)

 Called at execution time each time a node has been executed.
Public function UFunction BlueprintCallable, Category void Notify properties changed, used in runtime cases, will dirty & trigger a regeneration if needed
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

  
Public function void

OnRefresh ( bool bForceRefresh
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function void

Refresh ( EPCGChangeType ChangeType,
bool bCancelExistingRefresh
)

 Schedules refresh of the component.
Protected function void  
Public function 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.
Public function void

ResetIgnoredChangeOrigins ( bool bLogIfAnyPresent
)

  
Public function void Reset last generated bounds to force PCGPartitionActor creation on next refresh
Public function const FPCGDataCollection *

RetrieveOutputDataForPin ( const FString& InResourceKey
)

 Lookup data using a resource key that identifies the pin.
Public function Virtual void

Serialize ( FArchive& Ar
)

 ~Begin UObject interface
Public function UFunction BlueprintCallable, Category void

SetEditingMode ( EPCGEditorDirtyMode InEditingMode,
EPCGEditorDirtyMode InSerializedEditingMode
)

  
Public function void

SetGenerationGridSize ( uint32 InGenerationGridSize
)

  
Public function UFunction BlueprintCallable, Category Reliable, NetMulticast void  
Public function void  
Public function void

SetIsPartitioned ( bool bIsNowPartitioned
)

 Utility function (mostly for tests) to properly set the value of bIsComponentPartitioned.
Public function void Updates internal properties from other component, dirties as required but does not trigger Refresh
Public function void Set the runtime generation scheduling policy type.
Public function Const bool Know if we need to force a generation, in case of BP added to the world in editor
Public function void  
Public function void

StartIgnoringChangeOriginDuringGeneration ( UObject* InChangeOriginToIgnore
)

 For duration of the current/next generation, any change triggers from this change origin will be discarded.
Public function void  
Public function void

StopIgnoringChangeOriginDuringGeneration ( UObject* InChangeOriginToIgnore
)

  
Public function void

StoreInspectionData ( const FPCGStack* InStack,
const UPCGNode* InNode,
const FPCGDataCollection& InInputData,
const FPCGDataCollection& InOutputData,
bool bUsedCache
)

  
Public function void

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

 Store data with a resource key that identifies the pin.
Public function Const bool

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

 Whether a task for the given node and stack was executed during the last execution.

Deprecated Variables

  Type Name Description
Protected variable UProperty TObjectPtr< UPCGGraph > Graph_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page