noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Update documentation for the new ProcessMode

Browse Source
This commit is contained in:
Aaron Franke
2021-02-19 07:57:41 -05:00
parent 6d0c502ee4
commit 78de8a762b
6 changed files with 27 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/SceneTree.xml
+3 -2
View File
@@ -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>