W3cubDocs

/Godot 3.1

SceneTreeTimer

Inherits: Reference < Object

Category: Core

Brief Description

One-shot timer.

Properties

float time_left

Signals

timeout ( )

Emitted when the timer reaches 0.

Description

A one-shot timer managed by the scene tree, which emits timeout on completion. See also 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:

func some_function():
print("start")
yield(get_tree().create_timer(1.0), "timeout")
print("end")

Property Descriptions

float time_left

Setter set_time_left(value)
Getter get_time_left()

The time remaining.

© 2014–2019 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.1/classes/class_scenetreetimer.html