mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-11-24 01:47:20 +01:00
36 lines
1.1 KiB
XML
36 lines
1.1 KiB
XML
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||
|
|
<class name="SceneTreeTimer" inherits="Reference" version="3.5">
|
||
|
|
<brief_description>
|
||
|
|
One-shot timer.
|
||
|
|
</brief_description>
|
||
|
|
<description>
|
||
|
|
A one-shot timer managed by the scene tree, which emits [signal timeout] on completion. See also [method SceneTree.create_timer].
|
||
|
|
As opposed to [Timer], it does not require the instantiation of a node. Commonly used to create a one-shot delay timer as in the following example:
|
||
|
|
[codeblock]
|
||
|
|
func some_function():
|
||
|
|
print("Timer started.")
|
||
|
|
yield(get_tree().create_timer(1.0), "timeout")
|
||
|
|
print("Timer ended.")
|
||
|
|
[/codeblock]
|
||
|
|
The timer will be automatically freed after its time elapses.
|
||
|
|
</description>
|
||
|
|
<tutorials>
|
||
|
|
</tutorials>
|
||
|
|
<methods>
|
||
|
|
</methods>
|
||
|
|
<members>
|
||
|
|
<member name="time_left" type="float" setter="set_time_left" getter="get_time_left">
|
||
|
|
The time remaining (in seconds).
|
||
|
|
</member>
|
||
|
|
</members>
|
||
|
|
<signals>
|
||
|
|
<signal name="timeout">
|
||
|
|
<description>
|
||
|
|
Emitted when the timer reaches 0.
|
||
|
|
</description>
|
||
|
|
</signal>
|
||
|
|
</signals>
|
||
|
|
<constants>
|
||
|
|
</constants>
|
||
|
|
</class>
|