Navigation2D

2D navigation and pathfinding node.

Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of NavigationPolygon resources. By default, these are automatically collected from child NavigationPolygonInstance nodes, but they can also be added on the fly with navpolyAdd. Note: The current navigation system has many known issues and will not always return optimal paths as expected. These issues will be fixed in Godot 4.0.

@GodotBaseClass

struct Navigation2D {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(Navigation2D other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static Navigation2D _new();

Vector2 getClosestPoint(Vector2 to_point);

GodotObject getClosestPointOwner(Vector2 to_point);

PoolVector2Array getSimplePath(Vector2 start, Vector2 end, bool optimize);

long navpolyAdd(NavigationPolygon mesh, Transform2D xform, GodotObject owner);

void navpolyRemove(long id);

void navpolySetTransform(long id, Transform2D xform);

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

getClosestPoint Vector2 getClosestPoint(Vector2 to_point): Returns the navigation point closest to the point given. Points are in local coordinate space.
getClosestPointOwner GodotObject getClosestPointOwner(Vector2 to_point): Returns the owner of the NavigationPolygon which contains the navigation point closest to the point given. This is usually a NavigationPolygonInstance. For polygons added via navpolyAdd, returns the owner that was given (or null if the owner parameter was omitted).
getSimplePath PoolVector2Array getSimplePath(Vector2 start, Vector2 end, bool optimize): Returns the path between two given points. Points are in local coordinate space. If optimize is true (the default), the path is smoothed by merging path segments where possible. Note: This method has known issues and will often return non-optimal paths. These issues will be fixed in Godot 4.0.
navpolyAdd long navpolyAdd(NavigationPolygon mesh, Transform2D xform, GodotObject owner): Adds a NavigationPolygon. Returns an ID for use with navpolyRemove or navpolySetTransform. If given, a Transform2D is applied to the polygon. The optional owner is used as return value for getClosestPointOwner.
navpolyRemove void navpolyRemove(long id): Removes the NavigationPolygon with the given ID.
navpolySetTransform void navpolySetTransform(long id, Transform2D xform): Sets the transform applied to the NavigationPolygon with the given ID.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(Navigation2D other)
opEquals bool opEquals(typeof(null) n)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new Navigation2D _new(): Construct a new instance of Navigation2D. Note: use memnew!Navigation2D instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Navigation2D

Members

Aliases

Functions

Mixins

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

Navigation2D

From mixin baseCasts

From `mixin baseCasts`