AStar class representation that uses 2d-vectors as edges.
    public class AStar2D : Reference

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

Inheritance Chain

Constructors

    public AStar2D()

Methods

    public void AddPoint(int id, Vector2 position, float weightScale = 1f)

Adds a new point at the given position with the given identifier. The algorithm prefers points with lower weightScale to form a path. The id must be 0 or larger, and the weightScale must be 1 or larger.

[codeblock]

var astar = AStar2D.new()

astar.add_point(1, Vector2(1, 0), 4) # Adds the point (1, 0) with weight_scale 4 and id 1

[/codeblock]

If there already exists a point for the given id, its position and weight scale are updated to the given values.

    public bool ArePointsConnected(int id, int toId)

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

    public void Clear()

Clears all the points and segments.

    public void ConnectPoints(int id, int toId, bool bidirectional = true)

Creates a segment between the given points. If bidirectional is false, only movement from id to toId is allowed, not the reverse direction.

[codeblock]

var astar = AStar2D.new()

astar.add_point(1, Vector2(1, 1))

astar.add_point(2, Vector2(0, 5))

astar.connect_points(1, 2, false)

[/codeblock]

    public void DisconnectPoints(int id, int toId)

Deletes the segment between the given points.

    public int GetAvailablePointId()

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

    public int GetClosestPoint(Vector2 toPosition, bool includeDisabled = false)

Returns the ID of the closest point to toPosition, optionally taking disabled points into account. Returns -1 if there are no points in the points pool.

    public Vector2 GetClosestPositionInSegment(Vector2 toPosition)

Returns the closest position to toPosition that resides inside a segment between two connected points.

[codeblock]

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)

[/codeblock]

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.

    public int[] GetIdPath(int fromId, int toId)

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.

[codeblock]

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]

[/codeblock]

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.

    public int GetPointCapacity()

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

    public int[] GetPointConnections(int id)

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

[codeblock]

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]

[/codeblock]

    public int GetPointCount()

Returns the number of points currently in the points pool.

    public Vector2[] GetPointPath(int fromId, int toId)

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.

    public Vector2 GetPointPosition(int id)

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

    public Godot.Collections.Array GetPoints()

Returns an array of all points.

    public float GetPointWeightScale(int id)

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

    public bool HasPoint(int id)

Returns whether a point associated with the given id exists.

    public bool IsPointDisabled(int id)

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

    public void RemovePoint(int id)

Removes the point associated with the given id from the points pool.

    public void ReserveSpace(int numNodes)

Reserves space internally for numNodes 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.

    public void SetPointDisabled(int id, bool disabled = true)

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

    public void SetPointPosition(int id, Vector2 position)

Sets the position for the point with the given id.

    public void SetPointWeightScale(int id, float weightScale)

Sets the weightScale for the point with the given id.

Tags: