跳到主要内容

AStar2D

继承

Reference

简要描述

使用2D向量作为边缘的AStar类表示。

描述

这是AStar类的包装,该类使用2D向量而不是3D向量。

方法

返回值类型方法名称
voidadd_point(id: int, position: Vector2, weight_scale: float = 1.0)
boolare_points_connected(id: int, to_id: int) const
voidclear()
voidconnect_points(id: int, to_id: int, bidirectional: bool = true)
voiddisconnect_points(id: int, to_id: int)
intget_available_point_id() const
intget_closest_point(to_position: Vector2, include_disabled: bool = false) const
Vector2get_closest_position_in_segment(to_position: Vector2) const
PoolIntArrayget_id_path(from_id: int, to_id: int)
intget_point_capacity() const
PoolIntArrayget_point_connections(id: int)
intget_point_count() const
PoolVector2Arrayget_point_path(from_id: int, to_id: int)
Vector2get_point_position(id: int) const
floatget_point_weight_scale(id: int) const
Arrayget_points()
boolhas_point(id: int) const
boolis_point_disabled(id: int) const
voidremove_point(id: int)
voidreserve_space(num_nodes: int)
voidset_point_disabled(id: int, disabled: bool = true)
voidset_point_position(id: int, position: Vector2)
voidset_point_weight_scale(id: int, weight_scale: float)

方法说明

  • add_point add_point(id: int, position: Vector2, weight_scale: float = 1.0)

在具有给定标识符的给定位置添加新点。

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

如果给定的id已经存在一个点,则将其位置和权重更新为给定的值。


  • are_points_connected are_points_connected(id: int, to_id: int) const

返回给定点之间是否存在连接/段。


  • clear clear()

清除所有点和线段。


  • connect_points connect_points(id: int, to_id: int, bidirectional: bool = true)

在给定点之间创建线段。

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

  • disconnect_points disconnect_points(id: int, to_id: int)

删除给定点之间的线段。


  • get_available_point_id get_available_point_id() const

返回下一个可用的点ID,该点没有关联的点。


  • get_closest_point get_closest_point(to_position: Vector2, include_disabled: bool = false) const

返回最接近to_position的点的ID,可以选择考虑禁用点。


  • get_closest_position_in_segment get_closest_position_in_segment(to_position: Vector2) const

返回最接近to_position的位置,该位置位于两个连接点之间的线段内。

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)

结果位于从y = 0y = 5的段中。


  • get_id_path get_id_path(from_id: int, to_id: int)

返回一个数组,其中包含点的ID,这些点构成AStar2D在给定点之间找到的路径。

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 [2,]

如果将第二点的权重更改为3,则结果将改为[1、4、3],因为现在即使距离更长,也比通过点4更容易


  • get_point_capacity get_point_capacity() const

返回支持这些点的结构的容量,可与reserve_space结合使用。


  • get_point_connections get_point_connections(id: int)

返回一个数组,该数组具有与给定点形成连接的点的ID。

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 [3]

  • get_point_count get_point_count() const

返回数组中当前的定点数。


  • get_point_path get_point_path(from_id: int, to_id: int)

返回一个数组,其中的点位于AStar2D在给定点之间找到的路径中。


  • get_point_position get_point_position(id: int) const

返回与给定id关联的点的位置。


  • get_point_weight_scale get_point_weight_scale(id: int) const

返回与给定id关联的点的权重。


  • get_points get_points()

返回所有点的数组。


  • has_point has_point(id: int) const

返回与给定id关联的点。


  • is_point_disabled is_point_disabled(id: int) const

返回是否禁用点以进行寻路。


  • remove_point remove_point(id: int)

从数组中删​​除与给定id关联的积分。


  • reserve_space reserve_space(num_nodes: int)

在内部为num_nodes点保留空间,如果您要一次添加一个已知的大量点(例如对于网格),则很有用。


  • set_point_disabled set_point_disabled(id: int, disabled: bool = true)

禁用或启用指定点进行寻路。


  • set_point_position set_point_position(id: int, position: Vector2)

为具有给定id的点设置position


  • set_point_weight_scale set_point_weight_scale(id: int, weight_scale: float)

为具有给定id的点设置weight_scale