SceneTreeTimer

Inherits: Reference < Object

Category: Core

Brief Description

One-shot timer.

Properties

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

The time remaining.