diff options
| author | Nick Huelin <62965063+SirQuartz@users.noreply.github.com> | 2021-07-06 11:17:14 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-06 11:17:14 -0400 |
| commit | d62175e0099aee42d671b7629c0ad294d7b9e812 (patch) | |
| tree | 3a72ea044b9effdf311a6033e45b68021912548b | |
| parent | 053198a5f34b7ce680e2fd1a3287a559cc2afc94 (diff) | |
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
| -rw-r--r-- | doc/classes/SceneTree.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index d327e8cbca..3973e8f230 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -306,7 +306,7 @@ </member> <member name="paused" type="bool" setter="set_pause" getter="is_paused" default="false"> 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. </member> <member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections" default="false"> |