1. Epic GamesDeveloper
  3. UPCGComponent

UPCGComponent

API > API/Plugins > API/Plugins/PCG

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, ClassGroup&61;&40;Procedural&41;,  
       Meta&61;&40;BlueprintSpawnableComponent, prioritizeCategories&61;"PCG"&41;&41;  
class UPCGComponent : public UActorComponent

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bActivated  
Public variable UProperty Category, AdvancedDisplay 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, AdvancedDisplay BlueprintReadOnly visibleanywhere bool bGenerated Flag to indicate whether this component has run in the editor.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite bool bIsComponentPartitioned In World Partition map, will partition the component in a grid, according to PCGWorldActor settings, dispatching the generation to multiple local components.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bParseActorComponents  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite bool bRegenerateInEditor  
Public variable UProperty nonpieduplicatetransient bool bRuntimeGenerated  
Public variable PCGUtils::FExtraCapture ExtraCapture  
Protected variable UProperty Category, AdvancedDisplay Transient visibleanywhere uint32 GenerationGridSize  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly EPCGComponentGenerationTrigger GenerationTrigger  
Protected variable UProperty Category, Meta BlueprintReadOnly instanced, visibleanywhere TObjectPtr< UPCGGraphInstance > GraphInstance  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EPCGComponentInput InputType  
Public variable FOnPCGGraphCleaned OnPCGGraphCleanedDelegate  
Public variable FOnPCGGraphGenerated OnPCGGraphGeneratedDelegate  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay 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.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite int Seed  

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors 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 void Cancels in-progress generation
Public function Const bool  
Public function UFunction BlueprintCallable, Category Reliable, NetMulticast void

Cleanup ( bool bRemoveComponents,
bool bSave
)

 Networked cleanup call
Public function void

Cleanup ()

  
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
)

 Same as CleanupLocal, but without any delayed tasks. All is done immediately.
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
)

 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 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 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 UPCGData *  
Public function Const UFunction BlueprintCallable, Category const FPCGDataCollection & Retrieves generated data
Public function Const EPCGHiGenGrid  
Public function Const uint32  
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 UPCGData *  
Public function UPCGComponent * If this is a local component returns self, otherwise returns the original component.
Public function UPCGData *  
Public function Const UPCGSubsystem *  
Public function Const bool

IsActorTracked ( AActor* InActor,
bool& bOutIsCulled
)

  
Public function Const bool  
Public function Const bool Return if we are currently generating the graph for this component
Public function bool  
Public function Const bool Functions for managing the node inspection cache
Public function Const bool  
Public function Const bool  
Public function void Responsibility of the PCG Partition Actor to mark is local
Public function UFunction BlueprintCallable, Category void Notify properties changed, used in runtime cases, will dirty & trigger a regeneration if needed
Public function void

OnRefresh ( bool bForceRefresh
)

  
Public function void

Refresh ( bool bStructural
)

  
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 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 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  
Public function void

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

  
Public function void

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

 Store data with a resource key that identifies the pin.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void ~End UObject interface
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component.
Protected function Virtual Const TStructOnScope< FActorComponentInstanceData > Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

 Called when a component is destroyed
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void ~Begin UObject interface

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