me.realized.duels.api.arena

Interface Arena

public interface Arena

Represents an Arena loaded on the server.

Method Summary

Modifier and Type	Method and Description
Match	getMatch() The Match being played in this arena.
java.lang.String	getName() The name of this arena.
org.bukkit.Location	getPosition(int pos) The spawnpoint set for the position number.
boolean	has(org.bukkit.entity.Player player) Whether or not the player is playing in this arena.
boolean	isDisabled() Whether or not this arena is currently disabled.
boolean	isRemoved() Whether or not this Arena has been removed.
boolean	isUsed() Whether or not a duel is currently being played in this arena.
boolean	setDisabled(boolean disabled) Calls setDisabled(CommandSender, boolean) with the source being null.
boolean	setDisabled(org.bukkit.command.CommandSender source, boolean disabled) Disables this arena which prevents it from being used in duels.
boolean	setPosition(int pos, org.bukkit.Location location) Calls setPosition(Player, int, Location) with the source being null.
boolean	setPosition(org.bukkit.entity.Player source, int pos, org.bukkit.Location location) Sets a spawnpoint with the given position and location.

Method Detail

getName

@NotNull
java.lang.String getName()

The name of this arena. Will not contain a dash character ("-").

Returns:

Never-null String that is the name of this arena.

isDisabled

boolean isDisabled()

Whether or not this arena is currently disabled.

Returns:

True if this arena is disabled. False otherwise.

See Also:

setDisabled(CommandSender, boolean)

setDisabled

boolean setDisabled(@Nullable
                    org.bukkit.command.CommandSender source,
                    boolean disabled)

Disables this arena which prevents it from being used in duels. Note: Calls ArenaStateChangeEvent.

Parameters:

source - CommandSender that will be the source of the ArenaStateChangeEvent called. May be null!

disabled - True to disable the arena, False to enable.

Returns:

True if arena was disabled successfully. False if called ArenaStateChangeEvent was cancelled by a plugin.

setDisabled

boolean setDisabled(boolean disabled)

Calls setDisabled(CommandSender, boolean) with the source being null.

Returns:

True if arena was disabled successfully. False if called ArenaStateChangeEvent was cancelled by a plugin.

See Also:

setDisabled(CommandSender, boolean)

getPosition

@Nullable
org.bukkit.Location getPosition(int pos)

The spawnpoint set for the position number.

Parameters:

pos - Position number associated with the spawnpoint

Returns:

Location associated with the position number or null if position is unset.

setPosition

boolean setPosition(@Nullable
                    org.bukkit.entity.Player source,
                    int pos,
                    @NotNull
                    org.bukkit.Location location)

Sets a spawnpoint with the given position and location. Note: Calls ArenaSetPositionEvent.

Parameters:

source - Player that will be the source of the ArenaSetPositionEvent called. May be null!

pos - Position number for the spawnpoint.

location - Location to be the spawnpoint. Should not be null!

Returns:

True if the spawnpoint was set successfully. False if called ArenaSetPositionEvent was cancelled by a plugin.

setPosition

boolean setPosition(int pos,
                    @NotNull
                    org.bukkit.Location location)

Calls setPosition(Player, int, Location) with the source being null.

Returns:

True if the spawnpoint was set successfully. False if called ArenaSetPositionEvent was cancelled by a plugin.

See Also:

setPosition(Player, int, Location)

isUsed

boolean isUsed()

Whether or not a duel is currently being played in this arena. If returned true, getMatch() is guaranteed to return a Match instance.

Returns:

True if this arena is in use. False otherwise.

getMatch

@Nullable
Match getMatch()

The Match being played in this arena. May be null if no match is being played.

Returns:

Match instance if a duel is currently being played in this arena. null otherwise.

has

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

Whether or not the player is playing in this arena.

Parameters:

player - Player to check if in this arena. Should not be null!

Returns:

True if the player is in this arena. False otherwise.

isRemoved

boolean isRemoved()

Whether or not this Arena has been removed.

Returns:

True if this Arena has been removed. False otherwise.

Since:

3.2.0

See Also:

ArenaRemoveEvent