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