浏览代码

Merge pull request #82724 from AThousandShips/grid_doc

Clarify `AStarGrid2D.is_in_bounds` functionality
Rémi Verschelde 2 年之前
父节点
当前提交
954a3b337d
共有 1 个文件被更改,包括 2 次插入2 次删除
  1. 2 2
      doc/classes/AStarGrid2D.xml

+ 2 - 2
doc/classes/AStarGrid2D.xml

@@ -113,14 +113,14 @@
 			<param index="0" name="x" type="int" />
 			<param index="1" name="y" type="int" />
 			<description>
-				Returns [code]true[/code] if the [param x] and [param y] is a valid grid coordinate (id).
+				Returns [code]true[/code] if the [param x] and [param y] is a valid grid coordinate (id), i.e. if it is inside [member region]. Equivalent to [code]region.has_point(Vector2i(x, y))[/code].
 			</description>
 		</method>
 		<method name="is_in_boundsv" qualifiers="const">
 			<return type="bool" />
 			<param index="0" name="id" type="Vector2i" />
 			<description>
-				Returns [code]true[/code] if the [param id] vector is a valid grid coordinate.
+				Returns [code]true[/code] if the [param id] vector is a valid grid coordinate, i.e. if it is inside [member region]. Equivalent to [code]region.has_point(id)[/code].
 			</description>
 		</method>
 		<method name="is_point_solid" qualifiers="const">