unreal.PCGPathfindingSettings

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

Bases: PCGSettings

Finds the optimal path across the points of a given point cloud–should one exist–when provided a start and goal location, and a maximum jump distance between points. Can return a partial path.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGPathfindingElement.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accept_partial_path (bool): [Read-Write] Even if the path is not complete, return a viable partial path to the point closest to the goal. Output data will be tagged with “CompletePath” or “PartialPath”, depending on the result, if enabled.

  • break_debugger (bool): [Read-Write] If a debugger is attached, a breakpoint will be triggered in the execution code to enable debugging. Only applies when inspecting a debug object. Transient and Editor-only.

  • category (Text): [Read-Write]

  • copy_originating_points (bool): [Read-Write] Copy the properties and attributes from the originating point input to the output points.

  • cost_attribute (PCGAttributePropertyInputSelector): [Read-Write] Attribute to use as part of the cost function - it’s meaning will depend on the cost function mode (fitness value, scalar multiplier, or else).

  • cost_function_mode (PCGPathfindingCostFunctionMode): [Read-Write] Controls whether the cost function will use a given attribute as a scalar wrt to the distance.

  • debug (bool): [Read-Write]

  • debug_buffer_size (int32): [Read-Write] Size (in number of floats) of the shader debug print buffer.

  • debug_settings (PCGDebugVisualizationSettings): [Read-Write]

  • description (Text): [Read-Write]

  • determinism_settings (PCGDeterminismSettings): [Read-Write]

  • dump_cooked_hlsl (bool): [Read-Write] Dump the cooked HLSL into the log after it is generated.

  • dump_data_descriptions (bool): [Read-Write] Dump the data descriptions of input/output pins to the log.

  • enabled (bool): [Read-Write]

  • execute_on_gpu (bool): [Read-Write] Whether this node should be executed on the GPU.

  • execution_dependency_required (bool): [Read-Write] If enabled, the execution dependency pin will require to be connected for execution (as any other required pin) and will be used for culling.

  • expose_to_library (bool): [Read-Write]

  • goal (Vector): [Read-Write] The location the pathfinding should attempt to reach. Not used when using goal locations from an input.

  • goal_location_attribute (PCGAttributePropertyInputSelector): [Read-Write]

  • goal_locations_as_input (bool): [Read-Write]

  • goal_mapping_mode (PCGPathfindingGoalMappingMode): [Read-Write] How each goal location correlates to each start location. Only relevant when using multiple start and goal locations as input.

  • heuristic_weight (double): [Read-Write] The heuristic estimates a faster path to speed up processing. A higher than 1 heuristic weight can be faster, but it may cease being the optimal path. A weight of 0 is essentially flood fill.

  • maximum_fitness_penalty_factor (double): [Read-Write] Fitness penalty scalar (maximum penalty applied when fitness is zero.)

  • output_as_spline (bool): [Read-Write] The final path will be a spline. If false, the final path will be an ordered point data.

  • path_trace_params (PCGWorldRaycastQueryParams): [Read-Write]

  • print_shader_debug_values (bool): [Read-Write] Enable use of ‘WriteDebugValue(uint Index, float Value)’ function in your kernel. Allows you to write float values to a buffer for logging on the CPU.

  • profile_kernel_index (int32): [Read-Write] Index of kernel emitted by this node to repeatedly dispatch every frame to enable profiling. Set to -1 to disable profiling. PCG_GPU_KERNEL_PROFILING must be defined in PCG.Build.cs.

  • search_distance (double): [Read-Write] The max distance from each point to search for the next viable point in the path.

  • seed (int32): [Read-Write]

  • spline_mode (PCGPathfindingSplineMode): [Read-Write] Determines how the output spline’s curves will be calculated.

  • start (Vector): [Read-Write] The location the pathfinding should attempt to reach. Not used when using start locations from an input.

  • start_location_attribute (PCGAttributePropertyInputSelector): [Read-Write]

  • start_locations_as_input (bool): [Read-Write]

  • trigger_render_capture (bool): [Read-Write] Will trigger a render capture when this node executes and a debug object is selected in the graph editor. Transient and Editor-only. Render captures must be enabled (e.g. -AttachRenderDoc or -AttachPIX).

  • use_path_traces (bool): [Read-Write] Controls whether raycasts will be used to test for collisions along the path (hit results will be considered obstacles for the pathfinding).

  • use_seed (bool): [Read-Write] deprecated: Implement the PCGSettings virtual UseSeed() override.

property accept_partial_path: bool

[Read-Write] Even if the path is not complete, return a viable partial path to the point closest to the goal. Output data will be tagged with “CompletePath” or “PartialPath”, depending on the result, if enabled.

Type:

(bool)

property copy_originating_points: bool

[Read-Write] Copy the properties and attributes from the originating point input to the output points.

Type:

(bool)

property cost_attribute: PCGAttributePropertyInputSelector

[Read-Write] Attribute to use as part of the cost function - it’s meaning will depend on the cost function mode (fitness value, scalar multiplier, or else).

Type:

(PCGAttributePropertyInputSelector)

property cost_function_mode: PCGPathfindingCostFunctionMode

[Read-Write] Controls whether the cost function will use a given attribute as a scalar wrt to the distance.

Type:

(PCGPathfindingCostFunctionMode)

property goal: Vector

[Read-Write] The location the pathfinding should attempt to reach. Not used when using goal locations from an input.

Type:

(Vector)

property goal_location_attribute: PCGAttributePropertyInputSelector

[Read-Write]

Type:

(PCGAttributePropertyInputSelector)

property goal_locations_as_input: bool

[Read-Write]

Type:

(bool)

property goal_mapping_mode: PCGPathfindingGoalMappingMode

[Read-Write] How each goal location correlates to each start location. Only relevant when using multiple start and goal locations as input.

Type:

(PCGPathfindingGoalMappingMode)

property heuristic_weight: float

[Read-Write] The heuristic estimates a faster path to speed up processing. A higher than 1 heuristic weight can be faster, but it may cease being the optimal path. A weight of 0 is essentially flood fill.

Type:

(double)

property maximum_fitness_penalty_factor: float

[Read-Write] Fitness penalty scalar (maximum penalty applied when fitness is zero.)

Type:

(double)

property output_as_spline: bool

[Read-Write] The final path will be a spline. If false, the final path will be an ordered point data.

Type:

(bool)

property path_trace_params: PCGWorldRaycastQueryParams

[Read-Write]

Type:

(PCGWorldRaycastQueryParams)

property search_distance: float

[Read-Write] The max distance from each point to search for the next viable point in the path.

Type:

(double)

property spline_mode: PCGPathfindingSplineMode

[Read-Write] Determines how the output spline’s curves will be calculated.

Type:

(PCGPathfindingSplineMode)

property start: Vector

[Read-Write] The location the pathfinding should attempt to reach. Not used when using start locations from an input.

Type:

(Vector)

property start_location_attribute: PCGAttributePropertyInputSelector

[Read-Write]

Type:

(PCGAttributePropertyInputSelector)

property start_locations_as_input: bool

[Read-Write]

Type:

(bool)

property use_path_traces: bool

[Read-Write] Controls whether raycasts will be used to test for collisions along the path (hit results will be considered obstacles for the pathfinding).

Type:

(bool)