Timer¶

Inherits: Node < Object

Category: Core

Brief Description¶

A simple Timer node.

float	get_time_left ( ) const
int	get_timer_process_mode ( ) const
float	get_wait_time ( ) const
bool	has_autostart ( ) const
bool	is_one_shot ( ) const
bool	is_paused ( ) const
bool	is_stopped ( ) const
void	set_autostart ( bool enable )
void	set_one_shot ( bool enable )
void	set_paused ( bool paused )
void	set_timer_process_mode ( int mode )
void	set_wait_time ( float time_sec )
void	start ( )
void	stop ( )

Emitted when the time runs out.

TIMER_PROCESS_FIXED = 0 — Update the timer at fixed intervals (framerate processing).
TIMER_PROCESS_IDLE = 1 — Update the timer during the idle time at each frame.

Timer node. This is a simple node that will emit a timeout callback when the timer runs out. It can optionally be set to loop.

Return the time left for timeout in seconds if the timer is active, 0 otherwise.

Return the timer’s processing mode.

Return the wait time in seconds.

Return true if set to automatically start when entering the scene.

Return true if configured as one-shot.

Return if the timer is paused or not.

Set to automatically start when entering the scene.

Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart.

Set whether the timer is paused or not. A paused timer will be inactive until it is unpaused again.

Set the timer’s processing mode (fixed or idle, use TIMER_PROCESS_* constants as argument).

Set wait time in seconds. When the time is over, it will emit the timeout signal.

Start the timer.

Stop (cancel) the timer.