1. Epic GamesDeveloper
  3. APCGPartitionActor

APCGPartitionActor

The [APCGPartitionActor](API\Plugins\PCG\Grid\APCGPartitionActor) actor is used to store grid cell data and its size will be a multiple of the grid size.

API > API/Plugins > API/Plugins/PCG > API/Plugins/PCG/Grid

Inheritance Hierarchy

  • APartitionActor
  • APCGPartitionActor

References

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

Syntax

UCLASS (NotBlueprintable, NotPlaceable)  
class APCGPartitionActor : public APartitionActor

Remarks

The APCGPartitionActor actor is used to store grid cell data and its size will be a multiple of the grid size.

Variables

  Type Name Description
Public variable UProperty FGuid PCGGuid  

Constructors

  Type Name Description
Public function  

APCGPartitionActor ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddGraphInstance ( UPCGComponent* OriginalComponent
)

  
Public function Virtual void  
Public function Virtual void  
Public function bool

ChangeTransientState ( UPCGComponent* OriginalComponent,
EPCGEditorDirtyMode EditingMode
)

 Changes transient state for the local component matching the given original component.
Public function void

CleanupDeadGraphInstances ( bool bRemoveNonNullOnly
)

  
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

  
Public function Virtual Const void

GetActorBounds ( bool bOnlyCollidingComponents,
FVector& Origin,
FVector& BoxExtent,
bool bIncludeFromChildActors
)

  
Public function Const TSet< TObjectPtr< UPCGComponent > > Return an array of all the PCGComponents on this actor
Public function Const TSet< TObjectPtr< UPCGComponent > > Return a set of all the PCGComponents linked to this actor
Public function Virtual Const uint32

GetDefaultGridSize ( UWorld* InWorld
)

  
Public function Const FBox  
Public function Const FIntVector  
Public function Virtual Const FGuid  
Public function Const UFunction BlueprintCallable, Category UPCGComponent *

GetLocalComponent ( const UPCGComponent* OriginalComponent
)

 TODO: Make this in-editor only; during runtime, we should keep a map of component to bounds/volume only and preferably precompute the intersection, so this would make it easier/possible to not have the original actor in game version.
Public function Const UFunction BlueprintCallable, Category UPCGComponent *

GetOriginalComponent ( const UPCGComponent* LocalComponent
)

  
Public function Const uint32  
Public function Static FString

GetPCGPartitionActorName ( uint32 GridSize,
const FIntVector& GridCoords,
bool bRuntimeGenerated
)

 Gets the name this partition actor should have.
Public function Virtual Const AActor *  
Public function Const bool Return true if this PA has any graph instances.
Public function Const bool  
Public function Const bool [Game thread only] Return if the actor is safe for deletion, meaning no generation is currently running on all original components.
Public function Const bool  
Public function void

PostCreation ( const FGuid& InGridGUID,
uint32 InGridSize
)

 To be called after the creation of a new actor to set the grid guid and size.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function void Register with the PCG Subsystem.
Public function void

RemapGraphInstance ( const UPCGComponent* OldOriginalComponent,
UPCGComponent* NewOriginalComponent
)

  
Public function bool

RemoveGraphInstance ( UPCGComponent* OriginalComponent
)

  
Public function void

RemoveLocalComponent ( UPCGComponent* LocalComponent
)

 When a local component is destroyed. It calls this function. We make sure we don't keep mappings that are dead.
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function void Marks this PartitionActor as managed by the runtime generation system.
Public function Virtual Const bool  
Public function bool

Teleport ( const FVector& NewLocation
)

 Forces the actor location to change even if its mobility is static.
Public function void Unregister with the PCG Subsystem.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page