AStar2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AStar2D" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		An implementation of A* for finding the shortest path between two vertices on a connected graph in 2D space.
	</brief_description>
	<description>
		An implementation of the A* algorithm, used to find the shortest path between two vertices on a connected graph in 2D space.
		See [AStar3D] for a more thorough explanation on how to use this class. [AStar2D] is a wrapper for [AStar3D] that enforces 2D coordinates.
	</description>
	<tutorials>
		<link title="Grid-based Navigation with AStarGrid2D Demo">https://godotengine.org/asset-library/asset/2723</link>
	</tutorials>
	<methods>
		<method name="_compute_cost" qualifiers="virtual const">
			<return type="float" />
			<param index="0" name="from_id" type="int" />
			<param index="1" name="to_id" type="int" />
			<description>
				Called when computing the cost between two connected points.
				Note that this function is hidden in the default [AStar2D] class.
			</description>
		</method>
		<method name="_estimate_cost" qualifiers="virtual const">
			<return type="float" />
			<param index="0" name="from_id" type="int" />
			<param index="1" name="end_id" type="int" />
			<description>
				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.
			</description>
		</method>
		<method name="_filter_neighbor" qualifiers="virtual const">
			<return type="bool" />
			<param index="0" name="from_id" type="int" />
			<param index="1" name="neighbor_id" type="int" />
			<description>
				Called when neighboring enters processing and if [member neighbor_filter_enabled] is [code]true[/code]. If [code]true[/code] is returned the point will not be processed.
				Note that this function is hidden in the default [AStar2D] class.
			</description>
		</method>
		<method name="add_point">
			<return type="void" />
			<param index="0" name="id" type="int" />
			<param index="1" name="position" type="Vector2" />
			<param index="2" name="weight_scale" type="float" default="1.0" />
			<description>
				Adds a new point at the given position with the given identifier. The [param id] must be 0 or larger, and the [param weight_scale] must be 0.0 or greater.
				The [param weight_scale] is multiplied by the result of [method _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 [param weight_scale]s to form a path.
				[codeblocks]
				[gdscript]
				var astar = AStar2D.new()
				astar.add_point(1, Vector2(1, 0), 4) # Adds the point (1, 0) with weight_scale 4 and id 1
				[/gdscript]
				[csharp]
				var astar = new AStar2D();
				astar.AddPoint(1, new Vector2(1, 0), 4); // Adds the point (1, 0) with weight_scale 4 and id 1
				[/csharp]
				[/codeblocks]
				If there already exists a point for the given [param id], its position and weight scale are updated to the given values.
			</description>
		</method>
		<method name="are_points_connected" qualifiers="const">
			<return type="bool" />
			<param index="0" name="id" type="int" />
			<param index="1" name="to_id" type="int" />
			<param index="2" name="bidirectional" type="bool" default="true" />
			<description>
				Returns whether there is a connection/segment between the given points. If [param bidirectional] is [code]false[/code], returns whether movement from [param id] to [param to_id] is possible through this segment.
			</description>
		</method>
		<method name="clear">
			<return type="void" />
			<description>
				Clears all the points and segments.
			</description>
		</method>
		<method name="connect_points">
			<return type="void" />
			<param index="0" name="id" type="int" />
			<param index="1" name="to_id" type="int" />
			<param index="2" name="bidirectional" type="bool" default="true" />
			<description>
				Creates a segment between the given points. If [param bidirectional] is [code]false[/code], only movement from [param id] to [param to_id] is allowed, not the reverse direction.
				[codeblocks]
				[gdscript]
				var astar = AStar2D.new()
				astar.add_point(1, Vector2(1, 1))
				astar.add_point(2, Vector2(0, 5))
				astar.connect_points(1, 2, false)
				[/gdscript]
				[csharp]
				var astar = new AStar2D();
				astar.AddPoint(1, new Vector2(1, 1));
				astar.AddPoint(2, new Vector2(0, 5));
				astar.ConnectPoints(1, 2, false);
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="disconnect_points">
			<return type="void" />
			<param index="0" name="id" type="int" />
			<param index="1" name="to_id" type="int" />
			<param index="2" name="bidirectional" type="bool" default="true" />
			<description>
				Deletes the segment between the given points. If [param bidirectional] is [code]false[/code], only movement from [param id] to [param to_id] is prevented, and a unidirectional segment possibly remains.
			</description>
		</method>
		<method name="get_available_point_id" qualifiers="const">
			<return type="int" />
			<description>
				Returns the next available point ID with no point associated to it.
			</description>
		</method>
		<method name="get_closest_point" qualifiers="const">
			<return type="int" />
			<param index="0" name="to_position" type="Vector2" />
			<param index="1" name="include_disabled" type="bool" default="false" />
			<description>
				Returns the ID of the closest point to [param to_position], optionally taking disabled points into account. Returns [code]-1[/code] if there are no points in the points pool.
				[b]Note:[/b] If several points are the closest to [param to_position], the one with the smallest ID will be returned, ensuring a deterministic result.
			</description>
		</method>
		<method name="get_closest_position_in_segment" qualifiers="const">
			<return type="Vector2" />
			<param index="0" name="to_position" type="Vector2" />
			<description>
				Returns the closest position to [param to_position] that resides inside a segment between two connected points.
				[codeblocks]
				[gdscript]
				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)
				[/gdscript]
				[csharp]
				var astar = new AStar2D();
				astar.AddPoint(1, new Vector2(0, 0));
				astar.AddPoint(2, new Vector2(0, 5));
				astar.ConnectPoints(1, 2);
				Vector2 res = astar.GetClosestPositionInSegment(new Vector2(3, 3)); // Returns (0, 3)
				[/csharp]
				[/codeblocks]
				The result is in the segment that goes from [code]y = 0[/code] to [code]y = 5[/code]. It's the closest position in the segment to the given point.
			</description>
		</method>
		<method name="get_id_path">
			<return type="PackedInt64Array" />
			<param index="0" name="from_id" type="int" />
			<param index="1" name="to_id" type="int" />
			<param index="2" name="allow_partial_path" type="bool" default="false" />
			<description>
				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 [param from_id] point is disabled, returns an empty array (even if [code]from_id == to_id[/code]).
				If [param from_id] point is not disabled, there is no valid path to the target, and [param allow_partial_path] is [code]true[/code], returns a path to the point closest to the target that can be reached.
				[b]Note:[/b] When [param allow_partial_path] is [code]true[/code] and [param to_id] is disabled the search may take an unusually long time to finish.
				[codeblocks]
				[gdscript]
				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]
				[/gdscript]
				[csharp]
				var astar = new AStar2D();
				astar.AddPoint(1, new Vector2(0, 0));
				astar.AddPoint(2, new Vector2(0, 1), 1); // Default weight is 1
				astar.AddPoint(3, new Vector2(1, 1));
				astar.AddPoint(4, new Vector2(2, 0));

				astar.ConnectPoints(1, 2, false);
				astar.ConnectPoints(2, 3, false);
				astar.ConnectPoints(4, 3, false);
				astar.ConnectPoints(1, 4, false);
				long[] res = astar.GetIdPath(1, 3); // Returns [1, 2, 3]
				[/csharp]
				[/codeblocks]
				If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2.
			</description>
		</method>
		<method name="get_point_capacity" qualifiers="const">
			<return type="int" />
			<description>
				Returns the capacity of the structure backing the points, useful in conjunction with [method reserve_space].
			</description>
		</method>
		<method name="get_point_connections">
			<return type="PackedInt64Array" />
			<param index="0" name="id" type="int" />
			<description>
				Returns an array with the IDs of the points that form the connection with the given point.
				[codeblocks]
				[gdscript]
				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]
				[/gdscript]
				[csharp]
				var astar = new AStar2D();
				astar.AddPoint(1, new Vector2(0, 0));
				astar.AddPoint(2, new Vector2(0, 1));
				astar.AddPoint(3, new Vector2(1, 1));
				astar.AddPoint(4, new Vector2(2, 0));

				astar.ConnectPoints(1, 2, true);
				astar.ConnectPoints(1, 3, true);

				long[] neighbors = astar.GetPointConnections(1); // Returns [2, 3]
				[/csharp]
				[/codeblocks]
			</description>
		</method>
		<method name="get_point_count" qualifiers="const">
			<return type="int" />
			<description>
				Returns the number of points currently in the points pool.
			</description>
		</method>
		<method name="get_point_ids">
			<return type="PackedInt64Array" />
			<description>
				Returns an array of all point IDs.
			</description>
		</method>
		<method name="get_point_path">
			<return type="PackedVector2Array" />
			<param index="0" name="from_id" type="int" />
			<param index="1" name="to_id" type="int" />
			<param index="2" name="allow_partial_path" type="bool" default="false" />
			<description>
				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 [param from_id] point is disabled, returns an empty array (even if [code]from_id == to_id[/code]).
				If [param from_id] point is not disabled, there is no valid path to the target, and [param allow_partial_path] is [code]true[/code], returns a path to the point closest to the target that can be reached.
				[b]Note:[/b] 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 [param allow_partial_path] is [code]true[/code] and [param to_id] is disabled the search may take an unusually long time to finish.
			</description>
		</method>
		<method name="get_point_position" qualifiers="const">
			<return type="Vector2" />
			<param index="0" name="id" type="int" />
			<description>
				Returns the position of the point associated with the given [param id].
			</description>
		</method>
		<method name="get_point_weight_scale" qualifiers="const">
			<return type="float" />
			<param index="0" name="id" type="int" />
			<description>
				Returns the weight scale of the point associated with the given [param id].
			</description>
		</method>
		<method name="has_point" qualifiers="const">
			<return type="bool" />
			<param index="0" name="id" type="int" />
			<description>
				Returns whether a point associated with the given [param id] exists.
			</description>
		</method>
		<method name="is_point_disabled" qualifiers="const">
			<return type="bool" />
			<param index="0" name="id" type="int" />
			<description>
				Returns whether a point is disabled or not for pathfinding. By default, all points are enabled.
			</description>
		</method>
		<method name="remove_point">
			<return type="void" />
			<param index="0" name="id" type="int" />
			<description>
				Removes the point associated with the given [param id] from the points pool.
			</description>
		</method>
		<method name="reserve_space">
			<return type="void" />
			<param index="0" name="num_nodes" type="int" />
			<description>
				Reserves space internally for [param num_nodes] points. Useful if you're adding a known large number of points at once, such as points on a grid.
			</description>
		</method>
		<method name="set_point_disabled">
			<return type="void" />
			<param index="0" name="id" type="int" />
			<param index="1" name="disabled" type="bool" default="true" />
			<description>
				Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle.
			</description>
		</method>
		<method name="set_point_position">
			<return type="void" />
			<param index="0" name="id" type="int" />
			<param index="1" name="position" type="Vector2" />
			<description>
				Sets the [param position] for the point with the given [param id].
			</description>
		</method>
		<method name="set_point_weight_scale">
			<return type="void" />
			<param index="0" name="id" type="int" />
			<param index="1" name="weight_scale" type="float" />
			<description>
				Sets the [param weight_scale] for the point with the given [param id]. The [param weight_scale] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point.
			</description>
		</method>
	</methods>
	<members>
		<member name="neighbor_filter_enabled" type="bool" setter="set_neighbor_filter_enabled" getter="is_neighbor_filter_enabled" default="false">
			If [code]true[/code] enables the filtering of neighbors via [method _filter_neighbor].
		</member>
	</members>
</class>