Skip to content

Commit

Permalink
Clarify AStarGrid2D.is_in_bounds functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
AThousandShips committed Oct 3, 2023
1 parent a2f90d5 commit 55a3d14
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/classes/AStarGrid2D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down

0 comments on commit 55a3d14

Please sign in to comment.