xyz.xenondevs.particle.task

Class TaskManager

java.lang.Object

xyz.xenondevs.particle.task.TaskManager

public final class TaskManager
extends Object

A manager to handle different ParticleTasks

Author:

ByteZ

See Also:

ParticleTask

Method Summary

Modifier and Type	Method and Description
static TaskManager	getTaskManager() Get the singleton instance of the TaskManager
static int	startFilteredTask(List<Object> packets, int tickDelay, Predicate<org.bukkit.entity.Player> filter) Starts a new FilteredTask.
static int	startGlobalTask(List<Object> packets, int tickDelay) Starts a new GlobalTask.
static int	startSingularTask(List<Object> packets, int tickDelay, org.bukkit.entity.Player target) Starts a new SingularTask.
static int	startSingularTask(List<Object> packets, int tickDelay, UUID target) Starts a new SingularTask.
static int	startSuppliedTask(List<Object> packets, int tickDelay, Supplier<Collection<org.bukkit.entity.Player>> supplier) Starts a new SuppliedTask.
static int	startTargetedTask(List<Object> packets, int tickDelay, Collection<org.bukkit.entity.Player> targets) Starts a new TargetedTask.
int	startTask(ParticleTask task) Starts a new Timer for the given task.
static int	startWorldTask(List<Object> packets, int tickDelay, org.bukkit.World world) Starts a new WorldTask.
void	stopTask(int taskId) Stops a task that is currently running.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

startTask

public int startTask(ParticleTask task)

Starts a new Timer for the given task.

Parameters:

task - the task that should be added to the scheduler

Returns:

the id of the BukkitTask which can be cancelled using stopTask(int)

See Also:

stopTask(int)

stopTask

public void stopTask(int taskId)

Stops a task that is currently running.

Parameters:

taskId - the id of the task to be stopped.

getTaskManager

public static TaskManager getTaskManager()

Get the singleton instance of the TaskManager

Returns:

the singleton instance of the TaskManager

startGlobalTask

public static int startGlobalTask(List<Object> packets,
                                  int tickDelay)

Starts a new GlobalTask.

Parameters:

packets - List of packets

tickDelay - The delay of ticks between each execution

Returns:

the id of the BukkitTask which can be cancelled using stopTask(int)

See Also:

GlobalTask, stopTask(int)

startWorldTask

public static int startWorldTask(List<Object> packets,
                                 int tickDelay,
                                 org.bukkit.World world)

Starts a new WorldTask.

Parameters:

packets - List of packets

tickDelay - The delay of ticks between each execution

world - The target World

Returns:

the id of the BukkitTask which can be cancelled using stopTask(int)

See Also:

WorldTask, stopTask(int)

startTargetedTask

public static int startTargetedTask(List<Object> packets,
                                    int tickDelay,
                                    Collection<org.bukkit.entity.Player> targets)

Starts a new TargetedTask.

Parameters:

packets - List of packets

tickDelay - The delay of ticks between each execution

targets - A Collection of Players that will receive the particles.

Returns:

the id of the BukkitTask which can be cancelled using stopTask(int)

See Also:

TargetedTask, stopTask(int)

startSingularTask

public static int startSingularTask(List<Object> packets,
                                    int tickDelay,
                                    UUID target)

Starts a new SingularTask.

Parameters:

packets - List of packets

tickDelay - The delay of ticks between each execution

target - The UUID of the target Player

Returns:

the id of the BukkitTask which can be cancelled using stopTask(int)

See Also:

SingularTask, stopTask(int)

startSingularTask

public static int startSingularTask(List<Object> packets,
                                    int tickDelay,
                                    org.bukkit.entity.Player target)

Starts a new SingularTask.

Parameters:

packets - List of packets

tickDelay - The delay of ticks between each execution

target - The target Player

Returns:

the id of the BukkitTask which can be cancelled using stopTask(int)

See Also:

SingularTask, stopTask(int)

startFilteredTask

public static int startFilteredTask(List<Object> packets,
                                    int tickDelay,
                                    Predicate<org.bukkit.entity.Player> filter)

Starts a new FilteredTask.

Parameters:

packets - List of packets

tickDelay - The delay of ticks between each execution

filter - The Predicate to filter the Players

Returns:

the id of the BukkitTask which can be cancelled using stopTask(int)

See Also:

FilteredTask, stopTask(int)

startSuppliedTask

public static int startSuppliedTask(List<Object> packets,
                                    int tickDelay,
                                    Supplier<Collection<org.bukkit.entity.Player>> supplier)

Starts a new SuppliedTask.

Parameters:

packets - List of packets

tickDelay - The delay of ticks between each execution

supplier - The Supplier used to retrieve the Collection of target Players

Returns:

the id of the BukkitTask which can be cancelled using stopTask(int)

See Also:

SuppliedTask, stopTask(int)