deftask

An async/await wrapper for Lua in Defold

Web example! -> HTML5

Setup

In your game.project add the following line to the dependencies field under the project section:

https://github.com/Magnatales/deftask/archive/refs/tags/1.0.3.zip

After that, click Project -> Fetch Libraries

General

local task = require("deftask.task")
local cancellation = require("deftask.cancellation")

function init(_)
	local ct = cancellation.new("task_cancellation")
	run_async(function ()

	-- Waits for a amount of seconds
	await(task.delay(5, ct))

	-- Waits until the predicate is met
	await(task.wait_until(function () return true end, ct))

	-- Waits until any task is completed
	await(task.when_any(task1(ct), task2(ct)))

	-- Waits until all tasks are completed
	await(task.when_all(task1(ct), task2(ct)))

	-- Waits for a certain amount of frames
	await(task.wait_frames(5, ct))

	-- Waits for a gui animation
	await(task.gui_animate(...))

	-- Waits for a go animation
	await(task.go_animate(...))
	end)
end

Creation

Create your task like this:

local example_task = async(function(...)
    
end)

So then you can use it like so:

run_async(function()
    await(example_task(...))
end)

Return type

Tasks may have a return type

local my_task_with_value = async(function(ct)
    await(task.delay(4, ct))
    return 5
end)

run_async(function()
    local value = await(my_task_with_value(ct))
    print(value) -- prints 5 after 4 seconds
end)

CancellationToken

local cancellation = require("deftask.cancellation")
ct = cancellation.new("id") -- create a new instance
local cuid = ct:register(...) -- register callbacks and returns a counter unique identifier
ct:unregister(cuid) -- unregister the callbacks for this cuid
ct:cancel() -- cancels the token and calls all the callbacks

Debug

If you want to debug the creation, completion, or cancellation of tasks, modify the settings inside async_config.lua

return {
    enabled = true, -- Set this to false to disable logging
    log_available =
    {
        [AsyncLogType.CREATED] = true,
        [AsyncLogType.COMPLETED] = true,
        [AsyncLogType.CANCELLED] = true,
        [AsyncLogType.WASCANCELLED] = true,
    }
}