Skip to content

Commit

Permalink
Add note to SceneTree about pausing
Browse files Browse the repository at this point in the history
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: godotengine#47326

(cherry picked from commit d62175e)
  • Loading branch information
SirQuartz authored and lekoder committed Dec 18, 2021
1 parent 81f4dab commit 08c25f5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/classes/SceneTree.xml
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,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">
Expand Down

0 comments on commit 08c25f5

Please sign in to comment.