AStar2D

_computeCost double _computeCost(long from_id, long to_id): Called when computing the cost between two connected points. Note that this function is hidden in the default AStar2D class.
_estimateCost double _estimateCost(long from_id, long to_id): Called when estimating the cost between a point and the path's ending point. Note that this function is hidden in the default AStar2D class.
addPoint void addPoint(long id, Vector2 position, double weight_scale): Adds a new point at the given position with the given identifier. The id must be 0 or larger, and the weight_scale must be 1 or larger. The weight_scale is multiplied by the result of _computeCost when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower weight_scales to form a path.
arePointsConnected bool arePointsConnected(long id, long to_id): Returns whether there is a connection/segment between the given points.
clear void clear(): Clears all the points and segments.
connectPoints void connectPoints(long id, long to_id, bool bidirectional): Creates a segment between the given points. If bidirectional is false, only movement from id to to_id is allowed, not the reverse direction.
disconnectPoints void disconnectPoints(long id, long to_id): Deletes the segment between the given points.
getAvailablePointId long getAvailablePointId(): Returns the next available point ID with no point associated to it.
getClosestPoint long getClosestPoint(Vector2 to_position, bool include_disabled): Returns the ID of the closest point to to_position, optionally taking disabled points into account. Returns -1 if there are no points in the points pool. Note: If several points are the closest to to_position, the one with the smallest ID will be returned, ensuring a deterministic result.
getClosestPositionInSegment Vector2 getClosestPositionInSegment(Vector2 to_position): Returns the closest position to to_position that resides inside a segment between two connected points.
getIdPath PoolIntArray getIdPath(long from_id, long to_id): Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path.
getPointCapacity long getPointCapacity(): Returns the capacity of the structure backing the points, useful in conjunction with reserve_space.
getPointConnections PoolIntArray getPointConnections(long id): Returns an array with the IDs of the points that form the connection with the given point.
getPointCount long getPointCount(): Returns the number of points currently in the points pool.
getPointPath PoolVector2Array getPointPath(long from_id, long to_id): Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. Note: This method is not thread-safe. If called from a Thread, it will return an empty PoolVector2Array and will print an error message.
getPointPosition Vector2 getPointPosition(long id): Returns the position of the point associated with the given id.
getPointWeightScale double getPointWeightScale(long id): Returns the weight scale of the point associated with the given id.
getPoints Array getPoints(): Returns an array of all points.
hasPoint bool hasPoint(long id): Returns whether a point associated with the given id exists.
isPointDisabled bool isPointDisabled(long id): Returns whether a point is disabled or not for pathfinding. By default, all points are enabled.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(AStar2D other)
opEquals bool opEquals(typeof(null) n)
removePoint void removePoint(long id): Removes the point associated with the given id from the points pool.
reserveSpace void reserveSpace(long num_nodes): Reserves space internally for num_nodes points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity.
setPointDisabled void setPointDisabled(long id, bool disabled): Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle.
setPointPosition void setPointPosition(long id, Vector2 position): Sets the position for the point with the given id.
setPointWeightScale void setPointWeightScale(long id, double weight_scale): Sets the weight_scale for the point with the given id. The weight_scale is multiplied by the result of _computeCost when determining the overall cost of traveling across a segment from a neighboring point to this point.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new AStar2D _new(): Construct a new instance of AStar2D. Note: use memnew!AStar2D 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.

AStar2D

Members

Aliases

Functions

Mixins

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

AStar2D

From mixin baseCasts

From `mixin baseCasts`