Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-21 19:42:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Created tutorial_pause (markdown)

reduz 2014-11-02 14:56:13 -08:00
parent c99536691a
commit 9489976c91
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
tutorial_pause.md Normal file

@ -0,0 +1,41 @@
# Pausing a Game
### Pause?
In most games, it is always desirable to, at some point, interrupt the game to do something else. Be it taking a break, to changing options. However this is not as simple s it seems. The game might be stopped, but it might be desirable that some menus and animations continue working.
Implementing a fine-grained control for what can be paused (and what not) is a lot of work, so a simple framework for pausing is provided in Godot.
### How Pausing Works
To set pause mode, the pause state must be set. This is done by calling [SceneTree.set_pause](class_scenetree#set_pause) with a "true" argument:
```python
get_tree().set_pause(true)
```
Doing so will have the following behavior:
* 2D and 3D Physics will be stopped.
* _process and _fixed_process will not be called anymore in nodes.
* _input and _input_event will not be called anymore either.
This effectively stops the whole game. Calling this function from a script, by default, will result in an unrecoverable state (nothing will work anymore!).
### White-Listing Nodes
Before enabling pause, make sure that nodes that must keep working during pause are white-listed. This is done by editing the "Pause Mode" property in a node:
By default all nodes have this property in the "Inherit" state. This means, that they will only process (or not) depending on what this same property is set on the parent node. If the parent is set to "Inherit" , then the grandparent will be checked and so on. Ultimately, if a state can't be found in any of the grandparents, the pause state in SceneTree is used. This means that, by default, when the game is paused every node will be paused.
So the three possible states for a node are:
* **Inherit**: Process depending on the state of the parent, grandparent, etc. The first parent that has a non-Inherit state.
* **Stop**: Stop the node no matter what (and children in Inherit mode). Paused or not this node will not process.
* **Process**: Process the node no matter what (and children in Inherit mode). Paused or not this node will process.