Class ScheduledTask
java.lang.Object
be.seeseemelk.mockbukkit.scheduler.ScheduledTask
- All Implemented Interfaces:
BukkitTask
- Direct Known Subclasses:
RepeatingTask
Mock implementation of a
BukkitTask
.-
Constructor Summary
ConstructorDescriptionScheduledTask
(int id, Plugin plugin, boolean isSync, long scheduledTick, @NotNull Runnable runnable) Constructs a newScheduledTask
with the provided parameters.ScheduledTask
(int id, Plugin plugin, boolean isSync, long scheduledTick, @NotNull Consumer<BukkitTask> consumer) Constructs a newScheduledTask
with the provided parameters. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addOnCancelled
(Runnable callback) Adds a callback which is executed when the task is cancelled.void
cancel()
@Nullable Consumer<BukkitTask>
Get the Consumer that will be run.@NotNull Plugin
getOwner()
@Nullable Runnable
Get the task itself that will be run.long
Get the tick at which the task is scheduled to run at.int
boolean
boolean
boolean
isSync()
void
run()
Runs the task if it has not been cancelled.void
setRunning
(boolean running) Sets whether the task is running.protected void
setScheduledTick
(long scheduledTick) Sets the tick at which the task is scheduled to run at.
-
Constructor Details
-
ScheduledTask
public ScheduledTask(int id, Plugin plugin, boolean isSync, long scheduledTick, @NotNull @NotNull Runnable runnable) Constructs a newScheduledTask
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, Plugin plugin, boolean isSync, long scheduledTick, @NotNull @NotNull Consumer<BukkitTask> consumer) Constructs a newScheduledTask
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 ofBukkitSchedulerMock
.- 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
Get the task itself that will be run.- Returns:
- The task that will be run.
-
getConsumer
Get the Consumer that will be run.- Returns:
- The consumer that will be run.
-
run
public void run()Runs the task if it has not been cancelled. -
getTaskId
public int getTaskId()- Specified by:
getTaskId
in interfaceBukkitTask
-
getOwner
- Specified by:
getOwner
in interfaceBukkitTask
-
isSync
public boolean isSync()- Specified by:
isSync
in interfaceBukkitTask
-
isCancelled
public boolean isCancelled()- Specified by:
isCancelled
in interfaceBukkitTask
-
cancel
public void cancel()- Specified by:
cancel
in interfaceBukkitTask
-
addOnCancelled
Adds a callback which is executed when the task is cancelled.- Parameters:
callback
- The callback which gets executed when the task is cancelled.
-