diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-02-19 16:53:36 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-19 16:53:36 +0100 |
| commit | 3c65550816b1f9ca0d4a12411a4d596ae8e7726b (patch) | |
| tree | 1390e225e85359c8b8f7945edf80a9026d52efad /doc/classes/SceneTree.xml | |
| parent | 6d0c502ee48e9724cd71a8f602694e7bccb5d49d (diff) | |
| parent | 78de8a762b4517bedd63d6756227e9989e062b26 (diff) | |
Merge pull request #39606 from aaronfranke/pause
Update documentation for the new ProcessMode
Diffstat (limited to 'doc/classes/SceneTree.xml')
| -rw-r--r-- | doc/classes/SceneTree.xml | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 830fe6ef4d..f65d013bfc 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -64,10 +64,10 @@ </return> <argument index="0" name="time_sec" type="float"> </argument> - <argument index="1" name="pause_mode_process" type="bool" default="true"> + <argument index="1" name="process_always" type="bool" default="true"> </argument> <description> - Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this [SceneTree]. If [code]pause_mode_process[/code] is set to [code]false[/code], pausing the [SceneTree] will also pause the timer. + Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this [SceneTree]. If [code]process_always[/code] is set to [code]false[/code], pausing the [SceneTree] will also pause the timer. Commonly used to create a one-shot delay timer as in the following example: [codeblock] func some_function(): @@ -363,6 +363,7 @@ </signal> <signal name="tree_process_mode_changed"> <description> + This signal is only emitted in the editor, it allows the editor to update the visibility of disabled nodes. Emitted whenever any node's [member Node.process_mode] is changed. </description> </signal> </signals> |