Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add time scale property to Timer node #34544

Closed
wants to merge 1 commit into from
Closed

Add time scale property to Timer node #34544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/classes/Timer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@
The timer's remaining time in seconds. Returns 0 if the timer is inactive.
[b]Note:[/b] You cannot set this value. To change the timer's remaining time, use [method start].
</member>
<member name="time_scale" type="float" setter="set_time_scale" getter="get_time_scale">
Controls how fast or slow the timer ticks. Defaults to 1.0. A value of 2.0 means the timer ticks twice as fast, whilst a value of 0.5 means the timer ticks half the regular speed.
</member>
<member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time" default="1.0">
Wait time in seconds.
</member>
Expand Down
17 changes: 15 additions & 2 deletions scene/main/timer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ void Timer::_notification(int p_what) {
if (!processing || timer_process_callback == TIMER_PROCESS_PHYSICS || !is_processing_internal()) {
return;
}
time_left -= get_process_delta_time();
time_left -= get_process_delta_time() * time_scale;

if (time_left < 0) {
if (!one_shot) {
Expand All @@ -66,7 +66,7 @@ void Timer::_notification(int p_what) {
if (!processing || timer_process_callback == TIMER_PROCESS_IDLE || !is_physics_processing_internal()) {
return;
}
time_left -= get_physics_process_delta_time();
time_left -= get_physics_process_delta_time() * time_scale;

if (time_left < 0) {
if (!one_shot) {
Expand Down Expand Up @@ -135,6 +135,15 @@ bool Timer::is_paused() const {
return paused;
}

void Timer::set_time_scale(float p_time_scale) {
ERR_FAIL_COND_MSG(p_time_scale < 0, "Time scale should be greater than or equal to zero.");
time_scale = p_time_scale;
}

float Timer::get_time_scale() const {
return time_scale;
}

bool Timer::is_stopped() const {
return get_time_left() <= 0;
}
Expand Down Expand Up @@ -197,6 +206,9 @@ void Timer::_bind_methods() {
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("set_time_scale", "time_scale"), &Timer::set_time_scale);
ClassDB::bind_method(D_METHOD("get_time_scale"), &Timer::get_time_scale);

ClassDB::bind_method(D_METHOD("is_stopped"), &Timer::is_stopped);

ClassDB::bind_method(D_METHOD("get_time_left"), &Timer::get_time_left);
Expand All @@ -211,6 +223,7 @@ void Timer::_bind_methods() {
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "one_shot"), "set_one_shot", "is_one_shot");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "autostart"), "set_autostart", "has_autostart");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "paused", PROPERTY_HINT_NONE, "", 0), "set_paused", "is_paused");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "time_scale", PROPERTY_HINT_EXP_RANGE, "0, 100, 0.001, or_greater"), "set_time_scale", "get_time_scale");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "time_left", PROPERTY_HINT_NONE, "", 0), "", "get_time_left");

BIND_ENUM_CONSTANT(TIMER_PROCESS_PHYSICS);
Expand Down
4 changes: 4 additions & 0 deletions scene/main/timer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ class Timer : public Node {
bool autostart = false;
bool processing = false;
bool paused = false;
float time_scale = 1.0;

double time_left = -1.0;

Expand Down Expand Up @@ -69,6 +70,9 @@ class Timer : public Node {
void set_paused(bool p_paused);
bool is_paused() const;

void set_time_scale(float p_time_scale);
float get_time_scale() const;

bool is_stopped() const;

float get_time_left() const;
Expand Down