2014-02-10 09:10:30 +08:00
|
|
|
/*************************************************************************/
|
|
|
|
/* timer.cpp */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 20:16:55 +08:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 09:10:30 +08:00
|
|
|
/*************************************************************************/
|
2021-01-02 03:13:46 +08:00
|
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
2014-02-10 09:10:30 +08:00
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/*************************************************************************/
|
2018-01-05 07:50:27 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
#include "timer.h"
|
|
|
|
|
2020-11-08 06:33:38 +08:00
|
|
|
#include "core/config/engine.h"
|
2017-08-19 07:02:56 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
void Timer::_notification(int p_what) {
|
2017-03-05 23:44:50 +08:00
|
|
|
switch (p_what) {
|
2014-02-10 09:10:30 +08:00
|
|
|
case NOTIFICATION_READY: {
|
2014-10-12 13:13:22 +08:00
|
|
|
if (autostart) {
|
2014-10-14 12:01:25 +08:00
|
|
|
#ifdef TOOLS_ENABLED
|
2021-06-19 06:02:50 +08:00
|
|
|
if (Engine::get_singleton()->is_editor_hint() && get_tree()->get_edited_scene_root() && (get_tree()->get_edited_scene_root() == this || get_tree()->get_edited_scene_root()->is_ancestor_of(this))) {
|
2014-10-12 13:13:22 +08:00
|
|
|
break;
|
2020-05-14 22:41:43 +08:00
|
|
|
}
|
2014-12-07 13:04:20 +08:00
|
|
|
#endif
|
|
|
|
start();
|
2017-03-05 23:44:50 +08:00
|
|
|
autostart = false;
|
2014-10-12 13:13:22 +08:00
|
|
|
}
|
2014-02-10 09:10:30 +08:00
|
|
|
} break;
|
2017-01-11 05:02:19 +08:00
|
|
|
case NOTIFICATION_INTERNAL_PROCESS: {
|
2021-02-19 20:35:31 +08:00
|
|
|
if (!processing || timer_process_callback == TIMER_PROCESS_PHYSICS || !is_processing_internal()) {
|
2015-05-01 22:44:02 +08:00
|
|
|
return;
|
2020-05-14 22:41:43 +08:00
|
|
|
}
|
2014-02-10 09:10:30 +08:00
|
|
|
time_left -= get_process_delta_time();
|
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
if (time_left < 0) {
|
2020-05-14 22:41:43 +08:00
|
|
|
if (!one_shot) {
|
2017-04-05 14:22:41 +08:00
|
|
|
time_left += wait_time;
|
2020-05-14 22:41:43 +08:00
|
|
|
} else {
|
2014-02-10 09:10:30 +08:00
|
|
|
stop();
|
2020-05-14 22:41:43 +08:00
|
|
|
}
|
2014-02-10 09:10:30 +08:00
|
|
|
|
|
|
|
emit_signal("timeout");
|
|
|
|
}
|
|
|
|
|
|
|
|
} break;
|
2017-09-30 22:19:07 +08:00
|
|
|
case NOTIFICATION_INTERNAL_PHYSICS_PROCESS: {
|
2021-02-19 20:35:31 +08:00
|
|
|
if (!processing || timer_process_callback == TIMER_PROCESS_IDLE || !is_physics_processing_internal()) {
|
2015-05-10 22:00:26 +08:00
|
|
|
return;
|
2020-05-14 22:41:43 +08:00
|
|
|
}
|
2017-09-30 22:19:07 +08:00
|
|
|
time_left -= get_physics_process_delta_time();
|
2015-05-10 22:00:26 +08:00
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
if (time_left < 0) {
|
2020-05-14 22:41:43 +08:00
|
|
|
if (!one_shot) {
|
2017-04-05 14:22:41 +08:00
|
|
|
time_left += wait_time;
|
2020-05-14 22:41:43 +08:00
|
|
|
} else {
|
2015-05-10 22:00:26 +08:00
|
|
|
stop();
|
2020-05-14 22:41:43 +08:00
|
|
|
}
|
2015-05-10 22:00:26 +08:00
|
|
|
emit_signal("timeout");
|
|
|
|
}
|
|
|
|
|
|
|
|
} break;
|
2014-02-10 09:10:30 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void Timer::set_wait_time(float p_time) {
|
2019-08-09 04:11:48 +08:00
|
|
|
ERR_FAIL_COND_MSG(p_time <= 0, "Time should be greater than zero.");
|
2017-03-05 23:44:50 +08:00
|
|
|
wait_time = p_time;
|
2014-02-10 09:10:30 +08:00
|
|
|
}
|
2020-05-14 20:29:06 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
float Timer::get_wait_time() const {
|
|
|
|
return wait_time;
|
|
|
|
}
|
|
|
|
|
|
|
|
void Timer::set_one_shot(bool p_one_shot) {
|
2017-03-05 23:44:50 +08:00
|
|
|
one_shot = p_one_shot;
|
2014-02-10 09:10:30 +08:00
|
|
|
}
|
2020-05-14 20:29:06 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
bool Timer::is_one_shot() const {
|
|
|
|
return one_shot;
|
|
|
|
}
|
|
|
|
|
|
|
|
void Timer::set_autostart(bool p_start) {
|
2017-03-05 23:44:50 +08:00
|
|
|
autostart = p_start;
|
2014-02-10 09:10:30 +08:00
|
|
|
}
|
2020-05-14 20:29:06 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
bool Timer::has_autostart() const {
|
|
|
|
return autostart;
|
|
|
|
}
|
|
|
|
|
2018-04-27 03:42:50 +08:00
|
|
|
void Timer::start(float p_time) {
|
2019-11-27 23:34:54 +08:00
|
|
|
ERR_FAIL_COND_MSG(!is_inside_tree(), "Timer was not added to the SceneTree. Either add it or set autostart to true.");
|
2019-09-01 07:25:22 +08:00
|
|
|
|
2018-04-27 03:42:50 +08:00
|
|
|
if (p_time > 0) {
|
|
|
|
set_wait_time(p_time);
|
|
|
|
}
|
2017-03-05 23:44:50 +08:00
|
|
|
time_left = wait_time;
|
2015-05-10 22:00:26 +08:00
|
|
|
_set_process(true);
|
2014-02-10 09:10:30 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
void Timer::stop() {
|
2017-03-05 23:44:50 +08:00
|
|
|
time_left = -1;
|
2015-05-10 22:00:26 +08:00
|
|
|
_set_process(false);
|
2017-03-05 23:44:50 +08:00
|
|
|
autostart = false;
|
2014-02-10 09:10:30 +08:00
|
|
|
}
|
|
|
|
|
2017-03-12 01:10:01 +08:00
|
|
|
void Timer::set_paused(bool p_paused) {
|
2020-05-14 22:41:43 +08:00
|
|
|
if (paused == p_paused) {
|
2016-04-01 05:23:16 +08:00
|
|
|
return;
|
2020-05-14 22:41:43 +08:00
|
|
|
}
|
2016-04-01 05:23:16 +08:00
|
|
|
|
2017-03-12 01:10:01 +08:00
|
|
|
paused = p_paused;
|
2016-04-01 05:23:16 +08:00
|
|
|
_set_process(processing);
|
|
|
|
}
|
|
|
|
|
2017-03-12 01:10:01 +08:00
|
|
|
bool Timer::is_paused() const {
|
|
|
|
return paused;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool Timer::is_stopped() const {
|
|
|
|
return get_time_left() <= 0;
|
2016-04-01 05:23:16 +08:00
|
|
|
}
|
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
float Timer::get_time_left() const {
|
2017-03-05 23:44:50 +08:00
|
|
|
return time_left > 0 ? time_left : 0;
|
2014-02-10 09:10:30 +08:00
|
|
|
}
|
|
|
|
|
2021-02-19 20:35:31 +08:00
|
|
|
void Timer::set_timer_process_callback(TimerProcessCallback p_callback) {
|
|
|
|
if (timer_process_callback == p_callback) {
|
2015-05-10 22:00:26 +08:00
|
|
|
return;
|
2020-05-14 22:41:43 +08:00
|
|
|
}
|
2015-05-10 22:00:26 +08:00
|
|
|
|
2021-02-19 20:35:31 +08:00
|
|
|
switch (timer_process_callback) {
|
2017-09-30 22:19:07 +08:00
|
|
|
case TIMER_PROCESS_PHYSICS:
|
|
|
|
if (is_physics_processing_internal()) {
|
|
|
|
set_physics_process_internal(false);
|
2017-01-11 05:02:19 +08:00
|
|
|
set_process_internal(true);
|
2015-05-10 22:00:26 +08:00
|
|
|
}
|
2017-03-05 23:44:50 +08:00
|
|
|
break;
|
2015-05-10 22:00:26 +08:00
|
|
|
case TIMER_PROCESS_IDLE:
|
2017-01-11 05:02:19 +08:00
|
|
|
if (is_processing_internal()) {
|
|
|
|
set_process_internal(false);
|
2017-09-30 22:19:07 +08:00
|
|
|
set_physics_process_internal(true);
|
2015-05-10 22:00:26 +08:00
|
|
|
}
|
2017-03-05 23:44:50 +08:00
|
|
|
break;
|
2015-05-10 22:00:26 +08:00
|
|
|
}
|
2021-02-19 20:35:31 +08:00
|
|
|
timer_process_callback = p_callback;
|
2015-05-10 22:00:26 +08:00
|
|
|
}
|
|
|
|
|
2021-02-19 20:35:31 +08:00
|
|
|
Timer::TimerProcessCallback Timer::get_timer_process_callback() const {
|
|
|
|
return timer_process_callback;
|
2015-05-10 22:00:26 +08:00
|
|
|
}
|
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
void Timer::_set_process(bool p_process, bool p_force) {
|
2021-02-19 20:35:31 +08:00
|
|
|
switch (timer_process_callback) {
|
2020-05-10 19:00:47 +08:00
|
|
|
case TIMER_PROCESS_PHYSICS:
|
|
|
|
set_physics_process_internal(p_process && !paused);
|
|
|
|
break;
|
|
|
|
case TIMER_PROCESS_IDLE:
|
|
|
|
set_process_internal(p_process && !paused);
|
|
|
|
break;
|
2015-05-10 22:00:26 +08:00
|
|
|
}
|
2016-04-01 05:23:16 +08:00
|
|
|
processing = p_process;
|
2015-05-10 22:00:26 +08:00
|
|
|
}
|
2014-02-10 09:10:30 +08:00
|
|
|
|
|
|
|
void Timer::_bind_methods() {
|
2017-03-05 23:44:50 +08:00
|
|
|
ClassDB::bind_method(D_METHOD("set_wait_time", "time_sec"), &Timer::set_wait_time);
|
|
|
|
ClassDB::bind_method(D_METHOD("get_wait_time"), &Timer::get_wait_time);
|
2014-02-10 09:10:30 +08:00
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
ClassDB::bind_method(D_METHOD("set_one_shot", "enable"), &Timer::set_one_shot);
|
|
|
|
ClassDB::bind_method(D_METHOD("is_one_shot"), &Timer::is_one_shot);
|
2014-02-10 09:10:30 +08:00
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
ClassDB::bind_method(D_METHOD("set_autostart", "enable"), &Timer::set_autostart);
|
|
|
|
ClassDB::bind_method(D_METHOD("has_autostart"), &Timer::has_autostart);
|
2014-02-10 09:10:30 +08:00
|
|
|
|
2018-04-27 03:42:50 +08:00
|
|
|
ClassDB::bind_method(D_METHOD("start", "time_sec"), &Timer::start, DEFVAL(-1));
|
2017-03-05 23:44:50 +08:00
|
|
|
ClassDB::bind_method(D_METHOD("stop"), &Timer::stop);
|
2014-02-10 09:10:30 +08:00
|
|
|
|
2017-03-12 01:10:01 +08:00
|
|
|
ClassDB::bind_method(D_METHOD("set_paused", "paused"), &Timer::set_paused);
|
|
|
|
ClassDB::bind_method(D_METHOD("is_paused"), &Timer::is_paused);
|
|
|
|
|
|
|
|
ClassDB::bind_method(D_METHOD("is_stopped"), &Timer::is_stopped);
|
2016-04-01 05:23:16 +08:00
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
ClassDB::bind_method(D_METHOD("get_time_left"), &Timer::get_time_left);
|
2014-02-10 09:10:30 +08:00
|
|
|
|
2021-02-19 20:35:31 +08:00
|
|
|
ClassDB::bind_method(D_METHOD("set_timer_process_callback", "callback"), &Timer::set_timer_process_callback);
|
|
|
|
ClassDB::bind_method(D_METHOD("get_timer_process_callback"), &Timer::get_timer_process_callback);
|
2015-05-10 22:00:26 +08:00
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
ADD_SIGNAL(MethodInfo("timeout"));
|
2014-02-10 09:10:30 +08:00
|
|
|
|
2021-02-19 20:35:31 +08:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::INT, "process_callback", PROPERTY_HINT_ENUM, "Physics,Idle"), "set_timer_process_callback", "get_timer_process_callback");
|
Variant: Added 64-bit packed arrays, renamed Variant::REAL to FLOAT.
- Renames PackedIntArray to PackedInt32Array.
- Renames PackedFloatArray to PackedFloat32Array.
- Adds PackedInt64Array and PackedFloat64Array.
- Renames Variant::REAL to Variant::FLOAT for consistency.
Packed arrays are for storing large amount of data and creating stuff like
meshes, buffers. textures, etc. Forcing them to be 64 is a huge waste of
memory. That said, many users requested the ability to have 64 bits packed
arrays for their games, so this is just an optional added type.
For Variant, the float datatype is always 64 bits, and exposed as `float`.
We still have `real_t` which is the datatype that can change from 32 to 64
bits depending on a compile flag (not entirely working right now, but that's
the idea). It affects math related datatypes and code only.
Neither Variant nor PackedArray make use of real_t, which is only intended
for math precision, so the term is removed from there to keep only float.
2020-02-25 02:20:53 +08:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "wait_time", PROPERTY_HINT_EXP_RANGE, "0.001,4096,0.001,or_greater"), "set_wait_time", "get_wait_time");
|
2017-03-05 23:44:50 +08:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "one_shot"), "set_one_shot", "is_one_shot");
|
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "autostart"), "set_autostart", "has_autostart");
|
2021-06-18 07:10:18 +08:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "paused", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_paused", "is_paused");
|
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "time_left", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "", "get_time_left");
|
2015-09-26 02:45:00 +08:00
|
|
|
|
2017-09-30 22:19:07 +08:00
|
|
|
BIND_ENUM_CONSTANT(TIMER_PROCESS_PHYSICS);
|
2017-08-20 23:45:01 +08:00
|
|
|
BIND_ENUM_CONSTANT(TIMER_PROCESS_IDLE);
|
2014-02-10 09:10:30 +08:00
|
|
|
}
|
|
|
|
|
2021-02-10 01:24:36 +08:00
|
|
|
Timer::Timer() {}
|