diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-06-09 13:34:35 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-09 13:34:35 +0200 |
| commit | 532942c019c8fcfa565093a77a8cffc572be8e9c (patch) | |
| tree | 9ed163854b26deab7e9c7fd50b9b9d5f5ef53ede /doc/classes/RigidBody2D.xml | |
| parent | a1c7669bef5905c4905bcc095d92facbe879f124 (diff) | |
| parent | 1b738a77c15cf3a462ffc8bc509f511d994fc488 (diff) | |
Merge pull request #39411 from madmiraal/update-rigidbody-sleep-docs
Update Rigidbody 2D and 3D sleep documentation.
Diffstat (limited to 'doc/classes/RigidBody2D.xml')
| -rw-r--r-- | doc/classes/RigidBody2D.xml | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 8379fc5b58..a3fd2e81fd 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -127,7 +127,7 @@ The body's total applied torque. </member> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true"> - 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]. </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]. @@ -165,7 +165,7 @@ If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one. </member> <member name="sleeping" type="bool" setter="set_sleeping" getter="is_sleeping" default="false"> - 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. </member> <member name="weight" type="float" setter="set_weight" getter="get_weight" default="9.8"> The body's weight based on its mass and the [b]Default Gravity[/b] value in [b]Project > Project Settings > Physics > 2d[/b]. @@ -214,7 +214,8 @@ </signal> <signal name="sleeping_state_changed"> <description> - 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. </description> </signal> </signals> |