diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-09-01 19:48:42 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-01 19:48:42 +0200 |
| commit | 52013cdee382aa99c97d68ca95dad3f3a645bdf0 (patch) | |
| tree | b1fe7a5c914c2d77fdb1986f4706971f25a644eb | |
| parent | cb5db91cf0af0bfc257abe4f80e13d7382948415 (diff) | |
| parent | 5fbf709ca22e0d8b7db885d96cd059e7c39528fa (diff) | |
Merge pull request #41677 from Calinou/doc-rigidbody-sleeping
Document RigidBodies in character mode never sleeping automatically
| -rw-r--r-- | doc/classes/RigidBody2D.xml | 1 | ||||
| -rw-r--r-- | doc/classes/RigidBody3D.xml | 1 |
2 files changed, 2 insertions, 0 deletions
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 @@ </member> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true"> 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]. </member> <member name="contact_monitor" type="bool" setter="set_contact_monitor" getter="is_contact_monitor_enabled" default="false"> 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 @@ </member> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true"> 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]. </member> <member name="contact_monitor" type="bool" setter="set_contact_monitor" getter="is_contact_monitor_enabled" default="false"> If [code]true[/code], the RigidBody3D will emit signals when it collides with another RigidBody3D. See also [member contacts_reported]. |