SceneTreeTimer

Inherits: Reference < 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:

  1. func some_function():
  2.     print("Timer started.")
  3.     yield(get_tree().create_timer(1.0), "timeout")
  4.     print("Timer ended.")

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.