123456789101112131415161718192021222324252627282930313233343536 |
- <?xml version="1.0" encoding="UTF-8" ?>
- <class name="SceneTreeTimer" inherits="Reference" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
- <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>
|