Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Timer

Inherits: Node < Object

A countdown timer.

Description

Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one-shot" mode.

Note: Timers are affected by Engine.time_scale, a higher scale means quicker timeouts, and vice versa.

Note: To create a one-shot timer without instantiating a node, use SceneTree.create_timer.

Tutorials

Properties

bool

autostart

false

bool

one_shot

false

bool

paused

TimerProcessCallback

process_callback

1

float

time_left

float

wait_time

1.0

Methods

bool

is_stopped ( ) const

void

start ( float time_sec=-1 )

void

stop ( )


Signals

timeout ( )

Emitted when the timer reaches 0.


Enumerations

enum TimerProcessCallback:

TimerProcessCallback TIMER_PROCESS_PHYSICS = 0

Update the timer during physics frames (see Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS).

TimerProcessCallback TIMER_PROCESS_IDLE = 1

Update the timer during process frames (see Node.NOTIFICATION_INTERNAL_PROCESS).