unreal.PCGSchedulingPolicyDistanceAndDirection

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

Bases: PCGSchedulingPolicyBase

SchedulingPolicyDistanceAndDirection uses distance from the generating volume and alignment with view direction to choose the most important volumes to generate.

Distance and Direction are calculated with respect to the Generation Source.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGSchedulingPolicyDistanceAndDirection.h

Editor Properties: (see get_editor_property/set_editor_property)

  • cleanup_bounds_modifier (float): [Read-Write] Multiplier to scale bounds by when comparing against the view frustum for clean up.

  • direction_weight (float): [Read-Write] Scalar value used to increase/decrease the impact of direction in the scheduling priority.

  • distance_weight (float): [Read-Write] deprecated: Property ‘DistanceWeight’ is deprecated.

  • generate_bounds_modifier (float): [Read-Write] Multiplier to scale bounds by when comparing against the view frustum for generation. Can help if components on the edge of the frustum are not generating as soon as you would like.

  • grid_streaming_dependency_mode (PCGGridStreamingDependencyMode): [Read-Write] 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] Grids that depend on world streaming.

  • network_mode (PCGSchedulingPolicyNetworkMode): [Read-Write] Client/Server policy mode will determine which generation sources to consider.

  • use_direction (bool): [Read-Write] Toggle whether or not direction is used to calculate the scheduling priority.

  • use_distance (bool): [Read-Write] Toggle whether or not distance is used to calculate the scheduling priority.

  • use_frustum_culling (bool): [Read-Write] With frustum culling enabled, only components whose bounds overlap the view frustum will be generated.

property cleanup_bounds_modifier: float

[Read-Write] Multiplier to scale bounds by when comparing against the view frustum for clean up.

Type:

(float)

property direction_weight: float

[Read-Write] Scalar value used to increase/decrease the impact of direction in the scheduling priority.

Type:

(float)

property distance_weight: float

[Read-Write] deprecated: Property ‘DistanceWeight’ is deprecated.

Type:

(float)

property generate_bounds_modifier: float

[Read-Write] Multiplier to scale bounds by when comparing against the view frustum for generation. Can help if components on the edge of the frustum are not generating as soon as you would like.

Type:

(float)

get_distance_weight_deprecated() → float

Get Distance Weight DEPRECATED deprecated: Use Direction Weight instead.

Return type:

float

property network_mode: PCGSchedulingPolicyNetworkMode

[Read-Write] Client/Server policy mode will determine which generation sources to consider.

Type:

(PCGSchedulingPolicyNetworkMode)

set_distance_weight_deprecated(value) → None

Set Distance Weight DEPRECATED deprecated: Use Direction Weight instead.

Parameters:

value (float)

property use_direction: bool

[Read-Write] Toggle whether or not direction is used to calculate the scheduling priority.

Type:

(bool)

property use_distance: bool

[Read-Write] Toggle whether or not distance is used to calculate the scheduling priority.

Type:

(bool)

property use_frustum_culling: bool

[Read-Write] With frustum culling enabled, only components whose bounds overlap the view frustum will be generated.

Type:

(bool)