me.realized.duels.api.match

Interface Match

public interface Match

Represents an ongoing Match.

Method Summary

Modifier and Type	Method and Description
Arena	getArena() The Arena this Match is taking place in.
int	getBet() The bet amount for this Match.
java.util.List<org.bukkit.inventory.ItemStack>	getItems(org.bukkit.entity.Player player) UnmodifiableList of ItemStacks the player has bet for this Match.
Kit	getKit() The Kit used in this Match.
java.util.Set<org.bukkit.entity.Player>	getPlayers() UnmodifiableSet of alive players in this Match.
long	getStart() The start of this match Match milliseconds.
java.util.Set<org.bukkit.entity.Player>	getStartingPlayers() UnmodifiableSet of players who started this Match.
boolean	isFinished() Whether or not this Match is finished.

Method Detail

getArena

@NotNull
Arena getArena()

The Arena this Match is taking place in.

Returns:

Arena this Match is taking place in.

getStart

long getStart()

The start of this match Match milliseconds. Note: System.currentTimeMillis() subtracted by the result of this method will give the duration of the current Match in milliseconds.

Returns:

start of this match in milliseconds.

getKit

@Nullable
Kit getKit()

The Kit used in this Match.

Returns:

Kit used in this Match or null if players are using their own inventories.

getItems

@NotNull
java.util.List<org.bukkit.inventory.ItemStack> getItems(@NotNull
                                                                 org.bukkit.entity.Player player)

UnmodifiableList of ItemStacks the player has bet for this Match.

Parameters:

player - Player to get the list of bet items.

Returns:

Never-null UnmodifiableList of ItemStacks the player has bet for this Match.

getBet

int getBet()

The bet amount for this Match.

Returns:

bet Bet amount for this Match or 0 if no bet was specified.

isFinished

boolean isFinished()

Whether or not this Match is finished.

Returns:

true if this Match has finished or false otherwise.

Since:

3.4.1

getPlayers

@NotNull
java.util.Set<org.bukkit.entity.Player> getPlayers()

UnmodifiableSet of alive players in this Match.

Returns:

Never-null UnmodifiableSet of alive players in this Match.

Since:

3.1.0

getStartingPlayers

@NotNull
java.util.Set<org.bukkit.entity.Player> getStartingPlayers()

UnmodifiableSet of players who started this Match. Note: This set includes players who are offline. If you keep a reference to this match, all the player objects of those who started this match will not be garbage-collected.

Returns:

Never-null UnmodifiableSet of players who started this Match.

Since:

3.4.1