pandemonium_engine/doc/classes/SceneTreeTimer.xml

36 lines
1.1 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2024-02-25 10:26:26 +01:00
<class name="SceneTreeTimer" inherits="Reference" version="4.3">
<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 dereferenced after its time elapses. To preserve the timer, you can keep a reference to it. See [Reference].
</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>