unreal.NavigationPath

class unreal.NavigationPath(outer=None, name='None')

Bases: unreal.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 Points

• path_updated_notifier (OnNavigationPathUpdated): [Read-Write] Path Updated Notifier

• recalculate_on_invalidation (NavigationOptionFlag): [Read-Write] Recalculate on Invalidation

enable_debug_drawing(should_draw_debug_data, path_color=[0.0, 0.0, 0.0, 0.0]) → 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

Returns

Return type

str

get_path_cost() → float

Get Path Cost

Returns

Return type

float

get_path_lenght()

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

get_path_length() → float

Get Path Length

Returns

Return type

float

is_partial() → bool

Is Partial

Returns

Return type

bool

is_string_pulled() → bool

Is String Pulled

Returns

Return type

bool

is_valid() → bool

Is Valid

Returns

Return type

bool

property path_points

[Read-Only] Path Points

Type

(Array(Vector))

property path_updated_notifier

[Read-Write] Path Updated Notifier

Type

(OnNavigationPathUpdated)

property recalculate_on_invalidation

[Read-Only] Recalculate on Invalidation

Type

(NavigationOptionFlag)