mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-18 15:54:54 +00:00
Code Issues Releases Wiki Activity
25b8a65c5c
CC-Tweaked/doc/events/task_complete.md
Jonathan Coates 52b78f92cd
Use standard Markdown link syntax for references 
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
2023-08-24 11:23:33 +01:00

1.2 KiB
Raw Blame History

module: [kind=event] task_complete see: commands.execAsync To run a command which fires a task_complete event.

The [task_complete] event is fired when an asynchronous task completes. This is usually handled inside the function call that queued the task; however, functions such as [commands.execAsync] return immediately so the user can wait for completion.

Return Values

  1. [string]: The event name.
  2. [number]: The ID of the task that completed.
  3. [boolean]: Whether the command succeeded.
  4. [string]: If the command failed, an error message explaining the failure. (This is not present if the command succeeded.)
  5. …: Any parameters returned from the command.

Example

Prints the results of an asynchronous command:

local taskID = commands.execAsync("say Hello")
local event
repeat
    event = {os.pullEvent("task_complete")}
until event[2] == taskID
if event[3] == true then
  print("Task " .. event[2] .. " succeeded:", table.unpack(event, 4))
else
  print("Task " .. event[2] .. " failed: " .. event[4])
end