org.bukkit.scheduler.BukkitTask Maven / Gradle / Ivy

Go to download

package org.bukkit.scheduler;

import org.bukkit.plugin.Plugin;

/**
 * Represents a task being executed by the scheduler
 */
public interface BukkitTask {

  /**
   * Returns the taskId for the task.
   *
   * @return Task id number
   */
  int getTaskId();

  /**
   * Returns the Plugin that owns this task.
   *
   * @return The Plugin that owns the task
   */
  Plugin getOwner();

  /**
   * Returns true if the Task is a sync task.
   *
   * @return true if the task is run by main thread
   */
  boolean isSync();

  /**
   * Will attempt to cancel this task.
   */
  void cancel();
}