Timer

A countdown timer.

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

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

Tutorials

• https://godotengine.org/asset-library/asset/515

Methods

• timeout ( )

Emitted when the timer reaches 0.

Enumerations

enum TimerProcessMode:

• TIMER_PROCESS_PHYSICS = 0 —- Update the timer during the physics step at each frame (fixed framerate processing).
• TIMER_PROCESS_IDLE = 1 —- Update the timer during the idle time at each frame.

• bool autostart

Note: This property is automatically set to after the timer enters the scene tree and starts.

If true, the timer will stop when reaching 0. If false, it will restart.

• paused

If true, the timer is paused and will not process until it is unpaused again, even if start is called.

• process_mode

Processing mode. See TimerProcessMode.

• time_left

The timer’s remaining time in seconds. Returns 0 if the timer is inactive.

• float wait_time

Wait time in seconds.

Method Descriptions

• is_stopped ( ) const

Returns true if the timer is stopped.

• void start ( float time_sec=-1 )

Starts the timer. Sets wait_time to time_sec if time_sec > 0. This also resets the remaining time to wait_time.

Note: this method will not resume a paused timer. See .

Stops the timer.