Skip to content
Download
API reference

SceneTreeTimer

Inherits: Shared < Object

One-shot timer.

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 an actor. Commonly used to create a one-shot delay timer as in the following example:

async fn some_function() void {
print("Timer started.")
await get_tree().create_timer(1.0).timeout
print("Timer ended.")
}

The timer will be dereferenced after its time elapses. To preserve the timer, you can keep a reference to it. See Shared.

Note: The timer is processed after all of the actors in the current frame, i.e. actor’s Actor._process() method would be called before the timer (or Actor._physics_process() if process_in_physics in SceneTree.create_timer() has been set to true).

TypeNameDefault
floattime_left

timeout()

Emitted when the timer reaches 0.

float time_left

Setter/getter: set_time_left(), get_time_left()

The time remaining (in seconds).