From 7200a0eac59bed4b974b2d2011b7299531c3dfbe Mon Sep 17 00:00:00 2001 From: Marcel Admiraal Date: Tue, 9 Jun 2020 10:40:45 +0100 Subject: [PATCH] Update Rigidbody 2D and 3D sleep documentation. (cherry picked from commit 1b738a77c15cf3a462ffc8bc509f511d994fc488) --- doc/classes/RigidBody.xml | 7 ++++--- doc/classes/RigidBody2D.xml | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index b05291e51a7..2ae6ec1a553 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -151,7 +151,7 @@ Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override]. - If [code]true[/code], the RigidBody will not calculate forces and will act as a static body while there is no movement. It will wake up when forces are applied through other collisions or when the [code]apply_impulse[/code] method is used. + If [code]true[/code], the body can enter sleep mode when there is no movement. See [member sleeping]. If [code]true[/code], the RigidBody will emit signals when it collides with another RigidBody. @@ -190,7 +190,7 @@ If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one. - If [code]true[/code], the body is sleeping and will not calculate forces until woken up by a collision or the [code]apply_impulse[/code] method. + If [code]true[/code], the body will not move and will not calculate forces until woken up by another body through, for example, a collision, or by using the [method apply_impulse] or [method add_force] methods. The body's weight based on its mass and the global 3D gravity. Global values are set in [b]Project > Project Settings > Physics > 3d[/b]. @@ -241,7 +241,8 @@ - Emitted when the body changes its sleeping state. Either by sleeping or waking up. + Emitted when the physics engine changes the body's sleeping state. + [b]Note:[/b] Changing the value [member sleeping] will not trigger this signal. It is only emitted if the sleeping state is changed by the physics engine or [code]emit_signal("sleeping_state_changed")[/code] is used. diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 6751b840afd..60f1e151da5 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -131,7 +131,7 @@ Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override]. - If [code]true[/code], the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using [method apply_impulse] or [method add_force]. + If [code]true[/code], the body can enter sleep mode when there is no movement. See [member sleeping]. If [code]true[/code], the body will emit signals when it collides with another RigidBody2D. See also [member contacts_reported]. @@ -173,7 +173,7 @@ If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one. - If [code]true[/code], the body is sleeping and will not calculate forces until woken up by a collision or by using [method apply_impulse] or [method add_force]. + If [code]true[/code], the body will not move and will not calculate forces until woken up by another body through, for example, a collision, or by using the [method apply_impulse] or [method add_force] methods. The body's weight based on its mass and the [b]Default Gravity[/b] value in [b]Project > Project Settings > Physics > 2d[/b]. @@ -222,7 +222,8 @@ - Emitted when [member sleeping] changes. + Emitted when the physics engine changes the body's sleeping state. + [b]Note:[/b] Changing the value [member sleeping] will not trigger this signal. It is only emitted if the sleeping state is changed by the physics engine or [code]emit_signal("sleeping_state_changed")[/code] is used.