task

Allows for seamless scheduling with multithreading and the server

Overview:

Functions:
task.spawn(function) ⇒ taskId
task.main(function) ⇒ taskId
task.entitySchedule(entity, function) ⇒ taskId
task.thread(pluginName) ⇒ taskId
task.delay(delay, function) ⇒ taskId
task.repeat(delay, period, function) ⇒ taskId
task.cancel(taskId)
task.bindToUnload(function)
task.wait(time) ⇒ boolean & yields
task.waitForScript(scriptName) ⇒ yields
task.waitForPlugin(pluginName) ⇒ yields

API Reference

spawn()

Runs a function asynchronously.

• Bukkit: Uses async scheduler

• Folia: Runs on a separate thread

task.spawn(function() {
    log.info("Async execution")
})

Parameters:

• function (Function) Function to execute.

Returns:

• taskId (Number) Identifier used to cancel the task.

---

main()

Executes a function safely on the server main thread. (If on Folia use task.entitySchedule(..) instead)

task.main(function() {
    log.info("Main thread execution")
})

Parameters:

• function (Function) Function to execute.

Returns:

• taskId (Number)

---

entitySchedule()

Schedules a task bound to a specific entity. (Folia alternative to task.main(..))

task.entitySchedule(player, function() {
    player.sendMessage("Hello")
})

Parameters:

• entity (Entity) The entity to bind the task to.

• function (Function) Function to execute.

Returns:

• taskId (Number)

---

thread()

Executes a function parallel on a thread.

task.thread(function() {
    log.info("External thread execution")
})

Parameters:

• function (Function) Function to execute.

Returns:

• taskId (Number)

---

delay()

Executes a function after a delay asynchronously.

task.delay(10, function() {
    log.info("Executed after 10 seconds")
})

Parameters:

• delay (Number) Delay in seconds.

• function (Function) Function to execute.

Returns:

• taskId (Number)

---

repeat()

Runs a repeating task asynchronously .

task.repeat(5, 20, function() {
    log.info("Repeating")
})

Parameters:

• delay (Number) Initial delay in seconds.

• period (Number) Repeat interval in ticks.

• function (Function) Function to run.

Returns:

• taskId (Number)

---

cancel()

Cancels a scheduled task.

task.cancel(taskId)

Parameters:

• taskId (Number) The task identifier.

---

bindToUnload()

Registers a function to be executed when the script unloads.

task.bindToUnload(function() {
    log.info("Cleanup complete")
})

Parameters:

• function (Function) Cleanup handler.

---

wait()

Pauses execution of the current script for a given number of seconds.

task.wait(3)

Parameters:

• seconds (Number) Time to wait in seconds.

Returns:

• Boolean Returns true when completed. Throws if interrupted.

---

waitForScript()

Blocks execution until specified script finishes loading.

task.waitForScript("otherScript.js")

Parameters:

• scriptName (String) Name of the script to wait for.

---

waitForPlugin()

Blocks execution until a plugin becomes available.

task.waitForPlugin("Vault")

Parameters:

• pluginName (String) Name of the plugin.