Skip to main content

Server Exports

CreateTasks

Creates a new task list and returns a unique task list ID. Duplicate task names are automatically grouped and tracked using counters.
string
required
Title shown in the task UI
table
required
List of task names (strings)
Returns
  • uid (string) - Unique task list identifier
Examples

DeleteTasks

Deletes a task list and force closes it for all viewers.
string
required
Task list ID
Returns
  • boolean - true if deleted, false if not found

OpenTasks

Opens a task list UI for a specific player and registers them as a viewer.
number
required
Player server ID
string
required
Task list ID
string
default:"right"
UI position ("left" or "right")
Returns
  • boolean - true if opened successfully
Example

CloseTasks

Closes a task list UI for a specific player and removes them from the viewer list.
number
required
Player server ID
string
required
Task list ID
Returns
  • boolean - true if closed successfully

UpdateTask

Updates the state of a task. Supports multiple instances of the same task name and tracks progress automatically. When all tasks are completed or failed, the task list closes and is removed.
string
required
Task list ID
string
required
Task label
boolean
required
true = task completed, false = task failed
Returns
  • boolean - true if the update was successful
Example

GetStatus

Returns the current status of a specific task within a task list.
string
required
Task list ID
string
required
Task label
Returns
  • table or nil
    • Done (boolean)
    • Failed (boolean)
    • DoneCount (number)
    • Count (number)

GetIsListCompleted

Checks whether a task list has already been fully completed and cleaned up.
string
required
Task list ID
Returns
  • boolean or nil