unreal.PCGSchedulingPolicyBase

class unreal.PCGSchedulingPolicyBase(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Scheduling Policies provide custom logic to efficiently schedule work for the Runtime Generation Scheduling system. A higher priority value means the work will be scheduled sooner, and larger grid sizes will always have a higher priority than lower grid sizes.

If multiple Generation Sources overlap a component, the highest priority value will be used for scheduling.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGSchedulingPolicyBase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • grid_streaming_dependency_mode (PCGGridStreamingDependencyMode): [Read-Write] Hi-Gen grids with a streaming dependency will only generate if the world within the generation volume is fully streamed. Enable this if the graph depends on actors in the world such as a landscape or a set of streamable actors.

  • grids_dependent_on_world_streaming (Array[PCGHiGenGrid]): [Read-Write] Hi-Gen grids that depend on world streaming.

  • world_partition_target_grids (Set[Name]): [Read-Write] Optional World Partition grid names to scope streaming queries. If empty, all WP grids are considered. When set, only the listed grids participate in the streaming-complete check that gates runtime generation.