1. Epic GamesDeveloper
  3. FPCGRuntimeGenScheduler

FPCGRuntimeGenScheduler

The Runtime Generation Scheduler system handles the scheduling of PCG Components marked as GenerateAtRuntime.

API > API/Plugins > API/Plugins/PCG > API/Plugins/PCG/RuntimeGen

References

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

Syntax

class FPCGRuntimeGenScheduler

Remarks

The Runtime Generation Scheduler system handles the scheduling of PCG Components marked as GenerateAtRuntime. It searches the level for Partitioned and Non-Partitioned components in range of the currently active UPCGGenSources in the level, and schedules them efficiently based on their UPCGSchedulingPolicy, creating APCGPartitionActors as necessary to support hierarchical generation.

APCGPartitionActors can be created/destroyed on demand or provided by a dynamically growing pool of actors. If enabled, the pool will double in capacity anytime the number of available PAs reaches zero.

Components and PartitionActors created by the Runtime Generation Scheduler should be managed exclusively by the runtime gen scheduling system.

Constructors

  Type Name Description
Public function    
Public function    
Public function  

FPCGRuntimeGenScheduler ( UWorld* InWorld,
FPCGActorAndComponentMapping* InActorAndComponentMapping
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void Adds Count new RuntimeGen PAs to the Runtime PA pool.
Protected function void

CleanupComponent ( const FGridGenerationKey& GenerationKey,
UPCGComponent* GeneratedComponent
)

 Cleanup a component and remove it from the GeneratedComponents set.
Protected function void Remove components from the GeneratedComponents set that have been marked for delayed refresh.
Protected function void

CleanupLocalComponents ( const APCGWorldActor* InPCGWorldActor
)

 Cleanup all local components in the GeneratedComponents set.
Public function void Destroy all runtime gen partition actors (both generated and pooled). Executed in next tick.
Protected function APCGPartitionActor *

GetPartitionActorFromPool ( const FPCGGridDescriptor& GridDescriptor,
const FIntVector& GridCoords
)

 Grabs an empty RuntimeGen PA from the PartitionActorPool and initializes it at the given GridSize and GridCoords.
Public function void

OnOriginalComponentRegistered ( UPCGComponent* InOriginalComponent
)

  
Public function void  
Protected function void

RefreshComponent ( UPCGComponent* InComponent,
bool bRemovePartitionActors
)

 Refresh a generated component.
Protected function void Destroy all pooled partition actors and rebuild with the NewPoolSize.
Protected function bool Returns true if the scheduler should tick this frame.
Public function void

Tick ( APCGWorldActor* InPCGWorldActor
)

  
Protected function void

TickCleanup ( const TSet< IPCGGenSourceBase* >& GenSources,
const APCGWorldActor* InPCGWorldActor
)

 Perform immediate cleanup on components that become out of range.
Protected function void

TickCVars ( const APCGWorldActor* InPCGWorldActor
)

 Detects changes in RuntimeGen CVars to keep the PA pool in a valid state.
Protected function void

TickQueueComponentsForGeneration ( const TSet< IPCGGenSourceBase* >& GenSources,
APCGWorldActor* InPCGWorldActor,
TMap< FGridGenerationKey, double >& OutComponentsToGenerate
)

 Queue nearby components for generation.
Protected function void

TickScheduleGeneration ( TMap< FGridGenerationKey, double >& ComponentsToGenerate
)

 Schedule generation on components in priority order.

Operators

  Type Name Description
Public function FPCGRuntimeGenScheduler &  
Public function FPCGRuntimeGenScheduler &  

Classes

  Type Name Description
Protected struct FGridGenerationKey    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page