unreal.NavigationPath

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

Bases: Object

UObject wrapper for FNavigationPath

C++ Source:

• Module: NavigationSystem

• File: NavigationPath.h

Editor Properties: (see get_editor_property/set_editor_property)

• path_points (Array[Vector]): [Read-Write]

• path_updated_notifier (OnNavigationPathUpdated): [Read-Write]

• recalculate_on_invalidation (NavigationOptionFlag): [Read-Write]

enable_debug_drawing(should_draw_debug_data, path_color=[1.000000, 1.000000, 1.000000, 1.000000]) → None

Enable Debug Drawing

Parameters:

• should_draw_debug_data (bool) –

• path_color (LinearColor) –

enable_recalculation_on_invalidation(do_recalculation) → None

if enabled path will request recalculation if it gets invalidated due to a change to underlying navigation

Parameters:

do_recalculation (NavigationOptionFlag) –

get_debug_string() → str

UObject end

Return type:

str

get_path_cost() → double

Get Path Cost

Return type:

double

get_path_lenght() → float

deprecated: ‘get_path_lenght’ was renamed to ‘get_path_length’.

get_path_length() → double

Get Path Length

Return type:

double

is_partial() → bool

Is Partial

Return type:

bool

is_string_pulled() → bool

Is String Pulled

Return type:

bool

is_valid() → bool

Is Valid

Return type:

bool

property path_points: None

[Read-Only]

Type:

(Array[Vector])

property path_updated_notifier: OnNavigationPathUpdated

[Read-Write]

Type:

(OnNavigationPathUpdated)

property recalculate_on_invalidation: NavigationOptionFlag

[Read-Only]

Type:

(NavigationOptionFlag)