From c939ef15fa295ea2d6952af75f47088c928824e7 Mon Sep 17 00:00:00 2001
From: Nick Huelin <62965063+SirQuartz@users.noreply.github.com>
Date: Tue, 6 Jul 2021 11:17:14 -0400
Subject: [PATCH] Add note to `SceneTree` about pausing
This pull request adds a small amendment to `SceneTree` describing the behavior `_physics_process()` when pausing the scene.
`_physics_process` will completely stop processing collisions and signals whenever the scene is paused, however, the function will still receive calls.
This addresses: #47326
(cherry picked from commit d62175e0099aee42d671b7629c0ad294d7b9e812)
---
doc/classes/SceneTree.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml
index 060a82d9d94..971f941e1a6 100644
--- a/doc/classes/SceneTree.xml
+++ b/doc/classes/SceneTree.xml
@@ -246,7 +246,7 @@
If [code]true[/code], the [SceneTree] is paused. Doing so will have the following behavior:
- - 2D and 3D physics will be stopped.
+ - 2D and 3D physics will be stopped. This includes signals and collision detection.
- [method Node._process], [method Node._physics_process] and [method Node._input] will not be called anymore in nodes.