1/**************************************************************************/
2/* timer.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef TIMER_H
32#define TIMER_H
33
34#include "scene/main/node.h"
35
36class Timer : public Node {
37 GDCLASS(Timer, Node);
38
39 double wait_time = 1.0;
40 bool one_shot = false;
41 bool autostart = false;
42 bool processing = false;
43 bool paused = false;
44
45 double time_left = -1.0;
46
47protected:
48 void _notification(int p_what);
49 static void _bind_methods();
50
51public:
52 enum TimerProcessCallback {
53 TIMER_PROCESS_PHYSICS,
54 TIMER_PROCESS_IDLE,
55 };
56
57 void set_wait_time(double p_time);
58 double get_wait_time() const;
59
60 void set_one_shot(bool p_one_shot);
61 bool is_one_shot() const;
62
63 void set_autostart(bool p_start);
64 bool has_autostart() const;
65
66 void start(double p_time = -1);
67 void stop();
68
69 void set_paused(bool p_paused);
70 bool is_paused() const;
71
72 bool is_stopped() const;
73
74 double get_time_left() const;
75
76 PackedStringArray get_configuration_warnings() const override;
77
78 void set_timer_process_callback(TimerProcessCallback p_callback);
79 TimerProcessCallback get_timer_process_callback() const;
80 Timer();
81
82private:
83 TimerProcessCallback timer_process_callback = TIMER_PROCESS_IDLE;
84 void _set_process(bool p_process, bool p_force = false);
85};
86
87VARIANT_ENUM_CAST(Timer::TimerProcessCallback);
88
89#endif // TIMER_H
90