Package com.velocitypowered.api.scheduler

Interface ScheduledTask

public interface ScheduledTask
Represents a task that is scheduled to run on the proxy.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancel()
    Cancels this task.
    @NotNull Object
    plugin()
    Returns the plugin that scheduled this task.
    TaskStatus
    status()
    Returns the current status of this task.

  • Method Details

    • plugin

      @NotNull @NotNull Object plugin()
      Returns the plugin that scheduled this task.
      Returns:
      the plugin that scheduled this task

    • status

      TaskStatus status()
      Returns the current status of this task.
      Returns:
      the current status of this task

    • cancel

      void cancel()
      Cancels this task. If the task is already running, the thread in which it is running will be interrupted. If the task is not currently running, Velocity will terminate it safely.