From 9b2f387c36799e2881c7f8c9e22b4e500b1152c1 Mon Sep 17 00:00:00 2001 From: Ralph Minderhoud Date: Mon, 14 Aug 2017 20:31:29 -0500 Subject: [PATCH] Added note about sleeping rigid bodies --- learning/features/physics/physics_introduction.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/learning/features/physics/physics_introduction.rst b/learning/features/physics/physics_introduction.rst index 5e373274..2d1f4f7d 100644 --- a/learning/features/physics/physics_introduction.rst +++ b/learning/features/physics/physics_introduction.rst @@ -293,6 +293,16 @@ synchronizes state with the scene and allows full modification of the object's parameters. Since physics may run in its own thread, parameter changes outside that callback will not take place until the next frame. +.. note:: + + When a RigidBody goes to sleep then the :ref:`_integrate_forces() ` + method will not be called (I.E. they act like a static body until a + collision or a force is applied to them). To override this behavior you will + need to keep the rigid body "awake" by creating a collision, applying a force to it + (e.g. :ref:`set_linear_velocity `) + or by disabling the `can_sleep` property (see :ref:`set_can_sleep `). + Be aware that this can have an effect on performance. + Contact reporting -----------------