me.realized.duels.api

Interface Duels

All Superinterfaces:

org.bukkit.command.CommandExecutor, org.bukkit.plugin.Plugin, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor

public interface Duels
extends org.bukkit.plugin.Plugin

Method Summary

Modifier and Type	Method and Description
void	cancelTask(org.bukkit.scheduler.BukkitTask task) Cancels the task if not already cancelled.
void	cancelTask(int id) Cancels a task with id if found and running.
org.bukkit.scheduler.BukkitTask	doAsync(java.lang.Runnable task) Runs the task asynchronously.
org.bukkit.scheduler.BukkitTask	doAsyncAfter(java.lang.Runnable task, long delay) Runs the task after delay asynchronously.
org.bukkit.scheduler.BukkitTask	doAsyncRepeat(java.lang.Runnable task, long delay, long interval) Runs the task after delay asynchronously repeatedly.
org.bukkit.scheduler.BukkitTask	doSync(java.lang.Runnable task) Runs the task on server thread.
org.bukkit.scheduler.BukkitTask	doSyncAfter(java.lang.Runnable task, long delay) Runs the task after delay on server thread.
org.bukkit.scheduler.BukkitTask	doSyncRepeat(java.lang.Runnable task, long delay, long interval) Runs the task after delay on server thread repeatedly.
void	error(java.lang.String message) Logs a message with Level.SEVERE.
void	error(java.lang.String message, java.lang.Throwable thrown) Logs a message and the Throwable provided with Level.SEVERE.
ArenaManager	getArenaManager() Gets the ArenaManager singleton used by Duels.
KitManager	getKitManager() Gets the KitManager singleton used by Duels.
DQueueManager	getQueueManager() Gets the DQueueManager singleton used by Duels.
QueueSignManager	getQueueSignManager() Gets the QueueSignManager singleton used by Duels.
SpectateManager	getSpectateManager() Gets the SpectateManager singleton used by Duels.
UserManager	getUserManager() Gets the UserManager singleton used by Duels.
java.lang.String	getVersion() Current plugin version.
void	info(java.lang.String message) Logs a message with Level.INFO.
void	registerListener(org.bukkit.event.Listener listener) Registers a Listener that will be automatically unregistered on unload of Duels.
boolean	registerSubCommand(java.lang.String command, SubCommand subCommand) Registers a SubCommand to a Command registered by Duels.
boolean	reload() Reloads the plugin.
void	warn(java.lang.String message) Logs a message with Level.WARNING.

Methods inherited from interface org.bukkit.plugin.Plugin

getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getLogger, getName, getPluginLoader, getResource, getServer, isEnabled, isNaggable, onDisable, onEnable, onLoad, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setNaggable

Methods inherited from interface org.bukkit.command.TabCompleter

onTabComplete

Methods inherited from interface org.bukkit.command.CommandExecutor

onCommand

Method Detail

getUserManager

@NotNull
UserManager getUserManager()

Gets the UserManager singleton used by Duels.

Returns:

UserManager singleton

getArenaManager

@NotNull
ArenaManager getArenaManager()

Gets the ArenaManager singleton used by Duels.

Returns:

ArenaManager singleton

getKitManager

@NotNull
KitManager getKitManager()

Gets the KitManager singleton used by Duels.

Returns:

KitManager singleton

getSpectateManager

@NotNull
SpectateManager getSpectateManager()

Gets the SpectateManager singleton used by Duels.

Returns:

SpectateManager singleton

Since:

3.4.1

getQueueManager

@NotNull
DQueueManager getQueueManager()

Gets the DQueueManager singleton used by Duels.

Returns:

DQueueManager singleton

getQueueSignManager

@NotNull
QueueSignManager getQueueSignManager()

Gets the QueueSignManager singleton used by Duels.

Returns:

QueueSignManager singleton

registerSubCommand

boolean registerSubCommand(@NotNull
                           java.lang.String command,
                           @NotNull
                           SubCommand subCommand)

Registers a SubCommand to a Command registered by Duels.

Parameters:

command - Name of the parent command to register the SubCommand.

subCommand - SubCommand to register.

Returns:

True if sub command was successfully registered. False otherwise.

registerListener

void registerListener(@NotNull
                      org.bukkit.event.Listener listener)

Registers a Listener that will be automatically unregistered on unload of Duels.

Parameters:

listener - Listener to register.

Since:

3.1.2

reload

boolean reload()

Reloads the plugin.

Returns:

True if reload was successful. False otherwise.

doSync

org.bukkit.scheduler.BukkitTask doSync(@NotNull
                                       java.lang.Runnable task)

Runs the task on server thread.

Parameters:

task - Task to run.

Returns:

BukkitTask executed.

Since:

3.1.0

doSyncAfter

org.bukkit.scheduler.BukkitTask doSyncAfter(@NotNull
                                            java.lang.Runnable task,
                                            long delay)

Runs the task after delay on server thread.

Parameters:

task - Task to run.

delay - time to delay. 20L = 1s

Returns:

BukkitTask executed.

Since:

3.1.0

doSyncRepeat

org.bukkit.scheduler.BukkitTask doSyncRepeat(@NotNull
                                             java.lang.Runnable task,
                                             long delay,
                                             long interval)

Runs the task after delay on server thread repeatedly.

Parameters:

task - Task to run.

delay - time to delay the start of repeat. 20L = 1s

interval - interval of this task. 20L = 1s

Returns:

BukkitTask executed.

Since:

3.1.0

doAsync

org.bukkit.scheduler.BukkitTask doAsync(@NotNull
                                        java.lang.Runnable task)

Runs the task asynchronously.

Parameters:

task - Task to run asynchronously.

Returns:

BukkitTask executed.

Since:

3.1.0

doAsyncAfter

org.bukkit.scheduler.BukkitTask doAsyncAfter(@NotNull
                                             java.lang.Runnable task,
                                             long delay)

Runs the task after delay asynchronously.

Parameters:

task - Task to run asynchronously.

delay - time to delay. 20L = 1s

Returns:

BukkitTask executed.

Since:

3.1.0

doAsyncRepeat

org.bukkit.scheduler.BukkitTask doAsyncRepeat(@NotNull
                                              java.lang.Runnable task,
                                              long delay,
                                              long interval)

Runs the task after delay asynchronously repeatedly.

Parameters:

task - Task to run asynchronously.

delay - time to delay the start of repeat. 20L = 1s

interval - interval of this task. 20L = 1s

Returns:

BukkitTask executed.

Since:

3.1.0

cancelTask

void cancelTask(@NotNull
                org.bukkit.scheduler.BukkitTask task)

Cancels the task if not already cancelled.

Parameters:

task - Task to cancel if not already cancelled.

Since:

3.2.0

cancelTask

void cancelTask(int id)

Cancels a task with id if found and running.

Parameters:

id - Id of the task to cancel.

Since:

3.2.0

info

void info(@NotNull
          java.lang.String message)

Logs a message with Level.INFO.

Parameters:

message - message to log.

Since:

3.1.0

warn

void warn(@NotNull
          java.lang.String message)

Logs a message with Level.WARNING.

Parameters:

message - message to log.

Since:

3.1.0

error

void error(@NotNull
           java.lang.String message)

Logs a message with Level.SEVERE.

Parameters:

message - message to log.

Since:

3.1.0

error

void error(@NotNull
           java.lang.String message,
           @NotNull
           java.lang.Throwable thrown)

Logs a message and the Throwable provided with Level.SEVERE.

Parameters:

message - message to log.

thrown - Throwable to log.

Since:

3.1.0

getVersion

java.lang.String getVersion()

Current plugin version.

Returns:

version of the plugin.

Since:

3.1.0