From 5fbf709ca22e0d8b7db885d96cd059e7c39528fa Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Tue, 1 Sep 2020 18:54:13 +0200 Subject: Document RigidBodies in character mode never sleeping automatically See #7996. --- doc/classes/RigidBody2D.xml | 1 + doc/classes/RigidBody3D.xml | 1 + 2 files changed, 2 insertions(+) diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 1fbcccdbb5..f3d43b193e 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -129,6 +129,7 @@ If [code]true[/code], the body can enter sleep mode when there is no movement. See [member sleeping]. + [b]Note:[/b] A RigidBody2D will never enter sleep mode automatically if its [member mode] is [constant MODE_CHARACTER]. It can still be put to sleep manually by setting its [member sleeping] property to [code]true[/code]. If [code]true[/code], the body will emit signals when it collides with another RigidBody2D. See also [member contacts_reported]. diff --git a/doc/classes/RigidBody3D.xml b/doc/classes/RigidBody3D.xml index 1f6f3ad371..e9ebf33aa7 100644 --- a/doc/classes/RigidBody3D.xml +++ b/doc/classes/RigidBody3D.xml @@ -156,6 +156,7 @@ If [code]true[/code], the body can enter sleep mode when there is no movement. See [member sleeping]. + [b]Note:[/b] A RigidBody3D will never enter sleep mode automatically if its [member mode] is [constant MODE_CHARACTER]. It can still be put to sleep manually by setting its [member sleeping] property to [code]true[/code]. If [code]true[/code], the RigidBody3D will emit signals when it collides with another RigidBody3D. See also [member contacts_reported]. -- cgit v1.2.3