summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-06-27 01:03:51 +0200
committerGitHub <noreply@github.com>2019-06-27 01:03:51 +0200
commitd8c96461183f0dc3208c3d624674fa4544212ea5 (patch)
treea6c61caee9e9cfb19f1a05b5560a6b6d90b86a30 /doc/classes
parent65a7eba91ce8976bdb5e509a2211744f2023b9c8 (diff)
parent6f2233d13a1524ea184c30af066fd65278dcc610 (diff)
Merge pull request #30105 from Xrayez/bind-pip-geometry
Bind is_point_in_polygon in Geometry singleton
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Geometry.xml11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml
index e2ba3fb7b0..6fb4341b3c 100644
--- a/doc/classes/Geometry.xml
+++ b/doc/classes/Geometry.xml
@@ -216,6 +216,17 @@
Intersects [code]polyline[/code] with [code]polygon[/code] and returns an array of intersected polylines. This performs [code]OPERATION_INTERSECTION[/code] between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape.
</description>
</method>
+ <method name="is_point_in_polygon">
+ <return type="bool">
+ </return>
+ <argument index="0" name="point" type="Vector2">
+ </argument>
+ <argument index="1" name="polygon" type="PoolVector2Array">
+ </argument>
+ <description>
+ Returns [code]true[/code] if [code]point[/code] is inside [code]polygon[/code] or if it's located exactly [i]on[/i] polygon's boundary, otherwise returns [code]false[/code].
+ </description>
+ </method>
<method name="is_polygon_clockwise">
<return type="bool">
</return>