SceneTreeTimer

Inherits: RefCounted < Object

One-shot timer.

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("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 RefCounted.

Properties

float

time_left

Signals

  • timeout ( )

Emitted when the timer reaches 0.

Property Descriptions

Setter

set_time_left(value)

Getter

get_time_left()

The time remaining (in seconds).