me.realized.duels.api.queue

Interface DQueueManager

public interface DQueueManager

Represents the QueueManager singleton used by Duels.

Since:

3.2.0

Method Summary

Modifier and Type	Method and Description
boolean	addToQueue(org.bukkit.entity.Player player, DQueue queue) Adds the Player to the given DQueue.
DQueue	create(org.bukkit.command.CommandSender source, Kit kit, int bet) Creates a new DQueue.
DQueue	create(Kit kit, int bet) Calls create(CommandSender, Kit, int) with source being null.
DQueue	get(Kit kit, int bet) Gets a DQueue with the given kit and bet.
DQueue	get(org.bukkit.entity.Player player) Gets a DQueue with the given Player.
java.util.List<DQueue>	getQueues() An UnmodifiableList of DQueues that are currently loaded.
boolean	isInQueue(org.bukkit.entity.Player player) Whether or not the Player is in a queue.
DQueue	remove(org.bukkit.command.CommandSender source, Kit kit, int bet) Removes a new DQueue.
DQueue	remove(Kit kit, int bet) Calls remove(CommandSender, Kit, int) with source being null.
DQueue	removeFromQueue(org.bukkit.entity.Player player) Removes the Player from the queue.

Method Detail

get

@Nullable
DQueue get(@Nullable
                     Kit kit,
                     int bet)

Gets a DQueue with the given kit and bet.

Parameters:

kit - Kit to check for match in the queues.

bet - Bet to check for match in the queues.

Returns:

DQueue with the given kit and bet if found, otherwise null.

get

@Nullable
DQueue get(@NotNull
                     org.bukkit.entity.Player player)

Gets a DQueue with the given Player.

Parameters:

player - Player to check if in queue

Returns:

The queue player is in or null if not in queue

create

@Nullable
DQueue create(@Nullable
                        org.bukkit.command.CommandSender source,
                        @Nullable
                        Kit kit,
                        int bet)

Creates a new DQueue. Note: Calls QueueCreateEvent on successful creation.

Parameters:

kit - Kit of the DQueue to create

bet - Bet of the DQueue to create

Returns:

The newly created DQueue or null if a queue with given kit and bet already exists

create

@Nullable
DQueue create(@Nullable
                        Kit kit,
                        int bet)

Calls create(CommandSender, Kit, int) with source being null.

See Also:

create(CommandSender, Kit, int)

remove

@Nullable
DQueue remove(@Nullable
                        org.bukkit.command.CommandSender source,
                        @Nullable
                        Kit kit,
                        int bet)

Removes a new DQueue. Note: Calls QueueRemoveEvent on successful removal.

Parameters:

kit - Kit to check for match in the queues

bet - Bet to check for match in the queues

Returns:

The removed DQueue if found, otherwise null

See Also:

DQueue.isRemoved()

remove

@Nullable
DQueue remove(@Nullable
                        Kit kit,
                        int bet)

Calls remove(CommandSender, Kit, int) with source being null.

See Also:

remove(CommandSender, Kit, int)

isInQueue

boolean isInQueue(@NotNull
                  org.bukkit.entity.Player player)

Whether or not the Player is in a queue.

Parameters:

player - Player to check if in queue.

Returns:

True if Player is in a queue. False otherwise.

addToQueue

boolean addToQueue(@NotNull
                   org.bukkit.entity.Player player,
                   @NotNull
                   DQueue queue)

Adds the Player to the given DQueue. Note: Calls QueueJoinEvent.

Parameters:

player - Player to add to DQueue.

queue - DQueue to add the Player.

Returns:

True if Player was successfully queued. False otherwise.

removeFromQueue

@Nullable
DQueue removeFromQueue(@NotNull
                                 org.bukkit.entity.Player player)

Removes the Player from the queue. Note: Calls QueueLeaveEvent if Player was in a DQueue.

Parameters:

player - Player to remove from queue.

Returns:

The DQueue that Player was in or null if Player was not in a queue.

getQueues

@NotNull
java.util.List<DQueue> getQueues()

An UnmodifiableList of DQueues that are currently loaded.

Returns:

Never-null UnmodifiableList of DQueues that are currently loaded.