Table of Contents

Class NavigationPathQueryParameters2D

Namespace
Godot
Assembly
GodotSharp.dll

By changing various properties of this object, such as the start and target position, you can configure path queries to the NavigationServer2D.

public class NavigationPathQueryParameters2D : RefCounted, IDisposable
Inheritance
NavigationPathQueryParameters2D
Implements
Inherited Members

Constructors

NavigationPathQueryParameters2D()

public NavigationPathQueryParameters2D()

Properties

Map

The navigation map Rid used in the path query.

public Rid Map { get; set; }

Property Value

Rid

MetadataFlags

Additional information to include with the navigation path.

public NavigationPathQueryParameters2D.PathMetadataFlags MetadataFlags { get; set; }

Property Value

NavigationPathQueryParameters2D.PathMetadataFlags

NavigationLayers

The navigation layers the query will use (as a bitmask).

public uint NavigationLayers { get; set; }

Property Value

uint

PathPostprocessing

The path postprocessing applied to the raw path corridor found by the PathfindingAlgorithm.

public NavigationPathQueryParameters2D.PathPostProcessing PathPostprocessing { get; set; }

Property Value

NavigationPathQueryParameters2D.PathPostProcessing

PathfindingAlgorithm

The pathfinding algorithm used in the path query.

public NavigationPathQueryParameters2D.PathfindingAlgorithmEnum PathfindingAlgorithm { get; set; }

Property Value

NavigationPathQueryParameters2D.PathfindingAlgorithmEnum

StartPosition

The pathfinding start position in global coordinates.

public Vector2 StartPosition { get; set; }

Property Value

Vector2

TargetPosition

The pathfinding target position in global coordinates.

public Vector2 TargetPosition { get; set; }

Property Value

Vector2

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool