api/org.kryptonmc.api.scheduling/Task/Builder

Builder

A builder for building a task.

This builder is designed to provide a more familiar way of scheduling tasks, using a more conventional delay and interval (period) system. It is designed to be simple and easy to use, at the cost of flexibility.

If you require greater flexibility over how the scheduler will execute your task, you should use Scheduler.submitTask.

Functions

delay

open fun delay(duration: Duration): Task.Builder

abstract fun delay(time: TaskTime): Task.Builder

open fun delay(amount: Long, unit: TemporalUnit): Task.Builder

Sets the initial execution delay for the task.

executionType

abstract fun executionType(type: ExecutionType): Task.Builder

Sets the execution type for the task.

period

open fun period(duration: Duration): Task.Builder

abstract fun period(time: TaskTime): Task.Builder

open fun period(amount: Long, unit: TemporalUnit): Task.Builder

Sets the delay between subsequent executions of the task.

schedule

abstract fun schedule(): Task

Requests for the scheduler to schedule this task for execution.