Package be.seeseemelk.mockbukkit.scheduler

Class ScheduledTask

java.lang.Object
be.seeseemelk.mockbukkit.scheduler.ScheduledTask
All Implemented Interfaces:
org.bukkit.scheduler.BukkitTask, org.bukkit.scheduler.BukkitWorker
Direct Known Subclasses:
RepeatingTask
public class ScheduledTask extends Object implements org.bukkit.scheduler.BukkitTask, org.bukkit.scheduler.BukkitWorker
Mock implementation of a BukkitTask.

  • Constructor Details

    • ScheduledTask

      public ScheduledTask(int id, org.bukkit.plugin.Plugin plugin, boolean isSync, long scheduledTick, @NotNull @NotNull Runnable runnable)
      Constructs a new ScheduledTask with the provided parameters.
      Parameters:
      id - The task ID.
      plugin - The plugin owning the task.
      isSync - Whether the task is synchronous.
      scheduledTick - The tick the task is scheduled to run at.
      runnable - The runnable to run.

    • ScheduledTask

      public ScheduledTask(int id, org.bukkit.plugin.Plugin plugin, boolean isSync, long scheduledTick, @NotNull @NotNull Consumer<? super org.bukkit.scheduler.BukkitTask> consumer)
      Constructs a new ScheduledTask with the provided parameters.
      Parameters:
      id - The task ID.
      plugin - The plugin owning the task.
      isSync - Whether the task is synchronous.
      scheduledTick - The tick the task is scheduled to run at.
      consumer - The consumer to run.

  • Method Details

    • isRunning

      public boolean isRunning()
      Returns:
      Whether the task is running.

    • setRunning

      @Internal public void setRunning(boolean running)
      Sets whether the task is running. Should not be used outside of BukkitSchedulerMock.
      Parameters:
      running - Whether the task is running.

    • getScheduledTick

      public long getScheduledTick()
      Get the tick at which the task is scheduled to run at.
      Returns:
      The tick the task is scheduled to run at.

    • setScheduledTick

      protected void setScheduledTick(long scheduledTick)
      Sets the tick at which the task is scheduled to run at.
      Parameters:
      scheduledTick - The tick at which the task is scheduled to run at.

    • getRunnable

      @Nullable public @Nullable Runnable getRunnable()
      Get the task itself that will be run.
      Returns:
      The task that will be run.

    • getConsumer

      @Nullable public @Nullable Consumer<? super org.bukkit.scheduler.BukkitTask> getConsumer()
      Get the Consumer that will be run.
      Returns:
      The consumer that will be run.

    • submitted

      @Internal protected void submitted()
      Marks the task as being submitted to the async thread pool. This is used to bypass the #isCancelled check if it gets updated before the task is run.

    • run

      public void run()
      Runs the task if it has not been cancelled.

    • getTaskId

      public int getTaskId()
      Specified by:
      getTaskId in interface org.bukkit.scheduler.BukkitTask
      Specified by:
      getTaskId in interface org.bukkit.scheduler.BukkitWorker

    • getOwner

      @NotNull public @NotNull org.bukkit.plugin.Plugin getOwner()
      Specified by:
      getOwner in interface org.bukkit.scheduler.BukkitTask
      Specified by:
      getOwner in interface org.bukkit.scheduler.BukkitWorker

    • getThread

      @NotNull public @NotNull Thread getThread()
      Specified by:
      getThread in interface org.bukkit.scheduler.BukkitWorker

    • isSync

      public boolean isSync()
      Specified by:
      isSync in interface org.bukkit.scheduler.BukkitTask

    • isCancelled

      public boolean isCancelled()
      Specified by:
      isCancelled in interface org.bukkit.scheduler.BukkitTask

    • cancel

      public void cancel()
      Specified by:
      cancel in interface org.bukkit.scheduler.BukkitTask

    • addOnCancelled

      public void addOnCancelled(Runnable callback)
      Adds a callback which is executed when the task is cancelled.
      Parameters:
      callback - The callback which gets executed when the task is cancelled.