summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMax Hilbrunner <mhilbrunner@users.noreply.github.com>2021-10-29 18:02:46 +0200
committerGitHub <noreply@github.com>2021-10-29 18:02:46 +0200
commitd046817536a21358f9c51bf5b932d0a6615ee76a (patch)
treeb5d8d55208b0c7f9d1d37467825640381b79d07d /doc
parentbc171971dde52d503b894d8880a32d9029e3296d (diff)
parent5f69a29143c9c1dc5f487bede1e74d8822f2a722 (diff)
Merge pull request #54390 from Anutrix/collide-shape-doc
Added collide_shape return type info to PhysicsDirectSpaceState2D docs
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/PhysicsDirectSpaceState2D.xml1
-rw-r--r--doc/classes/PhysicsDirectSpaceState3D.xml1
2 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/PhysicsDirectSpaceState2D.xml b/doc/classes/PhysicsDirectSpaceState2D.xml
index 9aa00022cd..887b382267 100644
--- a/doc/classes/PhysicsDirectSpaceState2D.xml
+++ b/doc/classes/PhysicsDirectSpaceState2D.xml
@@ -26,6 +26,7 @@
<argument index="1" name="max_results" type="int" default="32" />
<description>
Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time.
+ Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in [PhysicsShapeQueryParameters2D] object, second one is in the collided shape from the physics space.
</description>
</method>
<method name="get_rest_info">
diff --git a/doc/classes/PhysicsDirectSpaceState3D.xml b/doc/classes/PhysicsDirectSpaceState3D.xml
index 137e7bbf39..8c37072f29 100644
--- a/doc/classes/PhysicsDirectSpaceState3D.xml
+++ b/doc/classes/PhysicsDirectSpaceState3D.xml
@@ -27,6 +27,7 @@
<argument index="1" name="max_results" type="int" default="32" />
<description>
Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time.
+ Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in [PhysicsShapeQueryParameters3D] object, second one is in the collided shape from the physics space.
</description>
</method>
<method name="get_rest_info">