Added pause, resume and exists to control tweens #6

stevencodeuk · 2025-01-31T13:56:45Z

No description provided.

Insality

Wrote some thoughts, let's discuss!

Insality · 2025-02-01T11:35:24Z

tweener/tweener.lua

@@ -12,6 +12,7 @@ local M = {}
 local TYPE_TABLE = "table"
 local TYPE_USERDATA = "userdata"

+local current_tweens = {}


I thinking about two solutions, one is a a module state as you did to keep all tweens locally. Other one is to create a table state and return it instead of timer_id now. Like the first one, but I see next cases

The problem what in some scenarios the tween state inside this table will be not deleted

game object can be deleted and our cancel will be not invoked

user can cancel tween by timer.cancel()

Game rebooted in the middle of running tween

For tweener state feels more safety in this cases, wdyt about this?
The cons of state is it requires a table per tween (+memory) and a breaking API for timer.cancel, so need to migrate for tweener.cancel in this cases

The third way also can be a good feature request for Defold and timer.set_pause itself :)

I think I was very much thinking outside the scope of Tweener and thinking of my own needs here by using a module state.
I only use tweens to control UI, and it's very limited usage, so a table state would be ideal for my usage. It would also allow usage of string ids for the tweens, so I could not cancel through timer.cancel() only via the module, and to store start, current, end, time elapsed values in this table.
I don't think Tweener needs that (a side project for myself!) and it doesn't solve the issues of game object deletion and game reboots, so a tweener state is safer, and allows the user to check if the timer handle exists.

I think if you have some requirements for the library what you need, probably other users want this too!

I still thinking about the better approach, but in case of return table in tweener.tween instead of module state, I can't ask you to implement the solution in other way :)

Can you explain why you want to use strings as an ID and also for which scenarios do you use the start/current/end time?

That's me inventing values off the top of my head! I don't think I have any use of start, current or end time!

I'm currently writing a quiz game, so I'll start a question timer, which I will pause for a little while if the player wants to reveal a hint.

So, in my usage, I would write something like tween.start("timer", start_value, end_value, duration) and then if I want to pause it call tween.pause("timer). I would also tween.get_current_value("timer") even after the tween is stopped/cancelled to get the bonus points achieved. Likely tween.is_finished(id) to control flow routines.

I think all outside the scope of Tweener, but I'm very happy to implement/contribute to Tweener as it's a great learning tool for me. I hope to contribute more to the Defold community in future and give something back for all the help I've received.

So you using tweener to track the in-game time? Seems a little bit complex honestly, can a just timer counter solve all this requirements? like

function update(dt) if self.is_running then self.timer = self.timer + dt end -- do actions end

And score mapping will be just tweener.ease() at result/display

In case to share this value with other modules is the special lua module will be more solid than tweener

But anyways the tween pause sounds as a good feature to do! Let's re-make to stateless module (without inner list of tweeners) and return a custom table as a tweener state?

Like this

{ timer_id = hash[], paused = nil, }

Also the tweener.cancel|set_pause|is_paused will use this new table as argument

Insality · 2025-02-01T11:37:30Z

tweener/tweener.lua

@@ -37,28 +38,39 @@ function M.tween(easing_function, from, to, time, callback, update_delta_time)
 	end

 	local time_elapsed = 0
+


Found a few of new unintended new lines, better to remove it to keep code style & make changes only for the issue it solving, thanks!

Me and the Enter key! Forgot it would create changes!

Insality · 2025-02-01T11:38:13Z

tweener/tweener.lua

 		if time <= 0 then
 			timer.cancel(handle)
+            current_tweens[handle] = nil


timer.cancel(handle) current_tweens[handle] = nil

We call it twice and we can replace it with already defined function M.cancel(handle)

Makes complete sense

Insality · 2025-02-01T11:39:27Z

tweener/tweener.lua

 			callback(to, true)
 			return
 		end

 		local current_time = socket.gettime()
-		time_elapsed = time_elapsed + (current_time - latest_time)
+
+        if current_tweens[handle]["paused"] == false then


We can check the current state early and make a early return

Currently we do a checks twice for pause state, can be like

local is_paused = M.TWEENS[timer_id] == false if is_paused then latest_time = socket.gettime() return end

Hopefully my lua skills improve as we go on :)

Insality · 2025-02-01T11:41:52Z

tweener/tweener.lua

+---Pause a running tween.
+---@param tween_id hash the tween handle returned by `tween` function
+---@return boolean true if the tween was active and could be paused, false if the tween doesn't exist or already paused
+function M.pause(tween_id)


pause and resume can be united into one function set_pause(handler, pause)
function can be just one liner

M.TWEENS[easing_id] = not is_paused

If we set a tweens table as a boolean map, <handle_id: is_active>, so we can check in one index about tween state, instead of two and checks for nil

so if M.TWEENS[handle_id]
nil - no running tween
false - tween paused
true - tween active

seems more convinient, wdyt?

Entirely makes sense. Like I've done with other code in my project, I was creating the table to store more information - which really would be beyond the scope of Tweener.

Insality · 2025-02-01T11:42:19Z

tweener/tweener.lua

 ---Cancel a previous running tween.
 ---@param tween_id hash the tween handle returned by `tween` function
 ---@return boolean true if the tween was active, false if the tween is already cancelled / complete
 function M.cancel(tween_id)
+    if current_tweens[tween_id] ~= false then
+        current_tweens[tween_id] = nil


Just current_tweens[tween_id] = nil will be better, no need to check if

Insality · 2025-02-01T11:43:32Z

tweener/tweener.lua

+---Check if a tween exists and is running.
+---@param tween_id hash the tween handle returned by `tween` function
+---@return boolean true if the tween is active, false if the tween doesn't exist
+function M.exists(tween_id)


I think also we can add a function is_paused for the API, like for this is_exists function

Insality · 2025-02-01T11:44:39Z

tweener/tweener.lua

 	end)

+    current_tweens[timer_id] = { ["paused"] = false }


We can use here a boolean state instead a lua table per easing to reduce memory

Yes. (sorry I've been commenting on every comment, maybe I should have been clicking Resolve Conversation - first time and thank you for your patience with this complete newbie - your skills far exceed mine and I know you could do this yourself quicker than helping me!)

Usually "Resolve Conversation" clicked when you push additional changes after a review or resolve the comment in other way. Commenting each comment is also good, no need to excuse

It also kind of fun to make and discuss something together, so don't worry about this also, just have fun with this! You also put your free time into that :)

Added pause, resume and exists to control tweens

19be386

Insality changed the base branch from main to develop January 31, 2025 14:14

Insality changed the base branch from develop to main January 31, 2025 14:14

Insality changed the base branch from main to pause_tween February 1, 2025 11:19

Insality requested changes Feb 1, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added pause, resume and exists to control tweens #6

Added pause, resume and exists to control tweens #6

stevencodeuk commented Jan 31, 2025

Insality left a comment

Insality Feb 1, 2025

stevencodeuk Feb 2, 2025

Insality Feb 2, 2025

stevencodeuk Feb 2, 2025

Insality Feb 2, 2025

Insality Feb 1, 2025

stevencodeuk Feb 2, 2025

Insality Feb 1, 2025

stevencodeuk Feb 2, 2025

Insality Feb 1, 2025

stevencodeuk Feb 2, 2025

Insality Feb 1, 2025

stevencodeuk Feb 2, 2025

Insality Feb 1, 2025

stevencodeuk Feb 2, 2025

Insality Feb 1, 2025

stevencodeuk Feb 2, 2025

Insality Feb 1, 2025

stevencodeuk Feb 2, 2025

Insality Feb 2, 2025

		@@ -37,28 +38,39 @@ function M.tween(easing_function, from, to, time, callback, update_delta_time)
		end

		local time_elapsed = 0

Added pause, resume and exists to control tweens #6

Are you sure you want to change the base?

Added pause, resume and exists to control tweens #6

Conversation

stevencodeuk commented Jan 31, 2025

Insality left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment