2017-09-12 22:42:36 +02:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
2019-04-25 14:00:31 +02:00
|
|
|
<class name="SceneTreeTimer" inherits="Reference" category="Core" version="3.1.1">
|
2017-09-12 22:42:36 +02:00
|
|
|
<brief_description>
|
2019-02-24 03:56:10 +01:00
|
|
|
One-shot timer.
|
2017-09-12 22:42:36 +02:00
|
|
|
</brief_description>
|
|
|
|
<description>
|
2019-02-24 03:56:10 +01:00
|
|
|
A one-shot timer managed by the scene tree, which emits [signal timeout] on completion. See also [method SceneTree.create_timer].
|
2019-02-25 11:17:56 +01:00
|
|
|
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:
|
2019-02-24 03:56:10 +01:00
|
|
|
[codeblock]
|
|
|
|
func some_function():
|
|
|
|
print("start")
|
|
|
|
yield(get_tree().create_timer(1.0), "timeout")
|
|
|
|
print("end")
|
|
|
|
[/codeblock]
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
<tutorials>
|
|
|
|
</tutorials>
|
|
|
|
<methods>
|
|
|
|
</methods>
|
2018-01-11 23:38:35 +01:00
|
|
|
<members>
|
|
|
|
<member name="time_left" type="float" setter="set_time_left" getter="get_time_left">
|
2019-02-24 03:56:10 +01:00
|
|
|
The time remaining.
|
2018-01-11 23:38:35 +01:00
|
|
|
</member>
|
|
|
|
</members>
|
2017-09-12 22:42:36 +02:00
|
|
|
<signals>
|
|
|
|
<signal name="timeout">
|
|
|
|
<description>
|
2019-02-24 03:56:10 +01:00
|
|
|
Emitted when the timer reaches 0.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</signal>
|
|
|
|
</signals>
|
|
|
|
<constants>
|
|
|
|
</constants>
|
|
|
|
</class>
|