From f072aa69a99a436b711afeb4b2b1c10b93883606 Mon Sep 17 00:00:00 2001
From: Ricardo Buring <ricardo.buring@gmail.com>
Date: Thu, 28 Apr 2022 22:44:09 +0200
Subject: Add motion parameter to toggle whether recovery is reported as a
 collision

This makes the intent explicit in each use case.
---
 doc/classes/PhysicsTestMotionParameters2D.xml | 4 ++++
 doc/classes/PhysicsTestMotionParameters3D.xml | 4 ++++
 2 files changed, 8 insertions(+)

(limited to 'doc/classes')

diff --git a/doc/classes/PhysicsTestMotionParameters2D.xml b/doc/classes/PhysicsTestMotionParameters2D.xml
index c22a49edf7..00f21a2058 100644
--- a/doc/classes/PhysicsTestMotionParameters2D.xml
+++ b/doc/classes/PhysicsTestMotionParameters2D.xml
@@ -28,5 +28,9 @@
 		<member name="motion" type="Vector2" setter="set_motion" getter="get_motion" default="Vector2(0, 0)">
 			Motion vector to define the length and direction of the motion to test.
 		</member>
+		<member name="recovery_as_collision" type="bool" setter="set_recovery_as_collision_enabled" getter="is_recovery_as_collision_enabled" default="false">
+			If set to [code]true[/code], any depenetration from the recovery phase is reported as a collision; this is used e.g. by [method CharacterBody2D.move_and_slide] for improving floor detection when floor snapping is disabled.
+			If set to [code]false[/code], only collisions resulting from the motion are reported; this is used e.g. by [method PhysicsBody2D.move_and_collide].
+		</member>
 	</members>
 </class>
diff --git a/doc/classes/PhysicsTestMotionParameters3D.xml b/doc/classes/PhysicsTestMotionParameters3D.xml
index 4ff07de7aa..5b07796a10 100644
--- a/doc/classes/PhysicsTestMotionParameters3D.xml
+++ b/doc/classes/PhysicsTestMotionParameters3D.xml
@@ -31,5 +31,9 @@
 		<member name="motion" type="Vector3" setter="set_motion" getter="get_motion" default="Vector3(0, 0, 0)">
 			Motion vector to define the length and direction of the motion to test.
 		</member>
+		<member name="recovery_as_collision" type="bool" setter="set_recovery_as_collision_enabled" getter="is_recovery_as_collision_enabled" default="false">
+			If set to [code]true[/code], any depenetration from the recovery phase is reported as a collision; this is used e.g. by [method CharacterBody3D.move_and_slide] for improving floor detection when floor snapping is disabled.
+			If set to [code]false[/code], only collisions resulting from the motion are detected; this is used e.g. by [method PhysicsBody3D.move_and_collide].
+		</member>
 	</members>
 </class>
-- 
cgit v1.2.3