Package com.velocitypowered.api.scheduler

Interface Scheduler

public interface Scheduler

Represents a scheduler to execute tasks on the proxy.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Scheduler.TaskBuilder	Represents a fluent interface to schedule tasks on the proxy.

Method Summary

Modifier and Type	Method	Description
Scheduler.TaskBuilder	buildTask(@NotNull Object plugin, @NotNull Runnable runnable)	Initializes a new Scheduler.TaskBuilder for creating a task on the proxy.
Scheduler.TaskBuilder	buildTask(@NotNull Object plugin, @NotNull Consumer<ScheduledTask> consumer)	Initializes a new Scheduler.TaskBuilder for creating a task on the proxy.
@NotNull Collection<ScheduledTask>	tasksByPlugin(@NotNull Object plugin)	Get the ScheduledTask for a specific plugin.

Method Detail

buildTask

Scheduler.TaskBuilder buildTask(@NotNull
                                @NotNull Object plugin,
                                @NotNull
                                @NotNull Runnable runnable)

Initializes a new Scheduler.TaskBuilder for creating a task on the proxy.

Parameters:

plugin - the plugin to request the task for

runnable - the task to run when scheduled

Returns:

the task builder

buildTask

Scheduler.TaskBuilder buildTask(@NotNull
                                @NotNull Object plugin,
                                @NotNull
                                @NotNull Consumer<ScheduledTask> consumer)

Initializes a new Scheduler.TaskBuilder for creating a task on the proxy.

Parameters:

plugin - the plugin to request the task for

consumer - the task to be run when scheduled with the capacity to cancel itself

Returns:

the task builder

tasksByPlugin

@NotNull
@NotNull Collection<ScheduledTask> tasksByPlugin(@NotNull
                                                 @NotNull Object plugin)

Get the ScheduledTask for a specific plugin.

Parameters:

plugin - the plugin object

Returns:

the list of ScheduledTask corresponding to a specific plugin