An implementation of A* for finding the shortest path between two vertices on a connected graph in 2D space.
If true enables the filtering of neighbors via _filter_neighbor().
Called when computing the cost between two connected points.
Note that this function is hidden in the default AStar2D class.
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.
Called when neighboring enters processing and if neighbor_filter_enabled is true. If true is returned the point will not be processed.
Note that this function is hidden in the default AStar2D class.
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 0.0 or greater.
The weight_scale is multiplied by the result of _compute_cost() 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.
var astar = AStar2D.new()
astar.add_point(1, Vector2(1, 0), 4) # Adds the point (1, 0) with weight_scale 4 and id 1If 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. If bidirectional is false, returns whether movement from id to to_id is possible through this segment.
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. If bidirectional is false, only movement from id to to_id is prevented, and a unidirectional segment possibly remains.
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.
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.
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.
If from_id point is disabled, returns an empty array (even if from_id == to_id).
If from_id point is not disabled, there is no valid path to the target, and allow_partial_path is true, returns a path to the point closest to the target that can be reached.
Note: When allow_partial_path is true and to_id is disabled the search may take an unusually long time to finish.
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.
Returns the capacity of the structure backing the points, useful in conjunction with reserve_space().
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]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.
If from_id point is disabled, returns an empty array (even if from_id == to_id).
If from_id point is not disabled, there is no valid path to the target, and allow_partial_path is true, returns a path to the point closest to the target that can be reached.
Note: This method is not thread-safe; it can only be used from a single Thread at a given time. Consider using Mutex to ensure exclusive access to one thread to avoid race conditions.
Additionally, when allow_partial_path is true and to_id is disabled the search may take an unusually long time to finish.
Reserves space internally for num_nodes points. Useful if you're adding a known large number of points at once, such as points on a grid.
Sets the weight_scale for the point with the given id. The weight_scale is multiplied by the result of _compute_cost() when determining the overall cost of traveling across a segment from a neighboring point to this point.