AStar class representation that uses 2D vectors as edges.

## Description

This is a wrapper for the AStar class which uses 2D vectors instead of 3D vectors.

## Methods

## Method Descriptions

Adds a new point at the given position with the given identifier. The algorithm prefers points with lower `weight_scale`

to form a path. The `id`

must be 0 or larger, and the `weight_scale`

must be 1 or larger.

```
var astar = AStar2D.new()
astar.add_point(1, Vector2(1, 0), 4) # Adds the point (1, 0) with weight_scale 4 and id 1
```

If there already exists a point for the given `id`

, its position and weight scale are updated to the given values.

Returns whether there is a connection/segment between the given points.

- void
**clear****(****)**

Clears all the points and segments.

Creates a segment between the given points. If `bidirectional`

is `false`

, only movement from `id`

to `to_id`

is allowed, not the reverse direction.

```
var astar = AStar2D.new()
astar.add_point(1, Vector2(1, 1))
astar.add_point(2, Vector2(0, 5))
astar.connect_points(1, 2, false)
```

Deletes the segment between the given points.

- int
**get_available_point_id****(****)**const

Returns the next available point ID with no point associated to it.

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.

Returns the closest position to `to_position`

that resides inside a segment between two connected points.

```
var astar = AStar2D.new()
astar.add_point(1, Vector2(0, 0))
astar.add_point(2, Vector2(0, 5))
astar.connect_points(1, 2)
var res = astar.get_closest_position_in_segment(Vector2(3, 3)) # Returns (0, 3)
```

The result is in the segment that goes from `y = 0`

to `y = 5`

. It’s the closest position in the segment to the given point.

- PoolIntArray
**get_id_path****(**int from_id, int 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.

```
var astar = AStar2D.new()
astar.add_point(1, Vector2(0, 0))
astar.add_point(2, Vector2(0, 1), 1) # Default weight is 1
astar.add_point(3, Vector2(1, 1))
astar.add_point(4, Vector2(2, 0))
astar.connect_points(1, 2, false)
astar.connect_points(2, 3, false)
astar.connect_points(4, 3, false)
astar.connect_points(1, 4, false)
var res = astar.get_id_path(1, 3) # Returns [1, 2, 3]
```

If you change the 2nd point’s weight to 3, then the result will be `[1, 4, 3]`

instead, because now even though the distance is longer, it’s “easier” to get through point 4 than through point 2.

- int
**get_point_capacity****(****)**const

Returns the capacity of the structure backing the points, useful in conjunction with `reserve_space`

.

- PoolIntArray
**get_point_connections****(**int id**)**

Returns an array with the IDs of the points that form the connection with the given point.

```
var astar = AStar2D.new()
astar.add_point(1, Vector2(0, 0))
astar.add_point(2, Vector2(0, 1))
astar.add_point(3, Vector2(1, 1))
astar.add_point(4, Vector2(2, 0))
astar.connect_points(1, 2, true)
astar.connect_points(1, 3, true)
var neighbors = astar.get_point_connections(1) # Returns [2, 3]
```

- int
**get_point_count****(****)**const

Returns the number of points currently in the points pool.

- PoolVector2Array
**get_point_path****(**int from_id, int 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.

Returns the position of the point associated with the given `id`

.

Returns the weight scale of the point associated with the given `id`

.

- Array
**get_points****(****)**

Returns an array of all points.

Returns whether a point associated with the given `id`

exists.

Returns whether a point is disabled or not for pathfinding. By default, all points are enabled.

- void
**remove_point****(**int id**)**

Removes the point associated with the given `id`

from the points pool.

- void
**reserve_space****(**int 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.

Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle.

Sets the `position`

for the point with the given `id`

.

Sets the `weight_scale`

for the point with the given `id`

.

## Leave a Reply