me.realized.duels.api.spectate

Interface SpectateManager

public interface SpectateManager

Represents the SpectateManager singleton used by Duels.

Since:

3.4.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SpectateManager.Result

Method Summary

Modifier and Type	Method and Description
Spectator	get(org.bukkit.entity.Player player) Attempts to find a Spectator instance associated to the player given.
java.util.List<Spectator>	getSpectators(Arena arena) An UnmodifiableList of Spectators that are currently spectating the given Arena.
boolean	isSpectating(org.bukkit.entity.Player player) Checks if a player is spectating a match.
SpectateManager.Result	startSpectating(org.bukkit.entity.Player player, org.bukkit.entity.Player target) Attempts to put the player in spectator mode and teleports player to target player in match.
void	stopSpectating(org.bukkit.entity.Player player) Puts a player out of spectator mode.

Method Detail

get

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

Attempts to find a Spectator instance associated to the player given.

Parameters:

player - Player to search through the spectator cache. Should not be null!

Returns:

Spectator instance associated to player if exists or null otherwise.

isSpectating

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

Checks if a player is spectating a match.

Parameters:

player - Player to check if spectating. Should not be null!

Returns:

true if player is spectating or false otherwise.

startSpectating

@NotNull
SpectateManager.Result startSpectating(@NotNull
                                                org.bukkit.entity.Player player,
                                                @NotNull
                                                org.bukkit.entity.Player target)

Attempts to put the player in spectator mode and teleports player to target player in match. The method will return a result other than Result.SUCCESS if: - Player is already in spectator mode - Player is in a queue - Player is in a match - Target is not in a match - SpectateStartEvent is cancelled Note: Calls SpectateStartEvent before player is turned into spectator mode.

Parameters:

player - Player to put in spectator mode. Should not be null!

target - Target player to teleport to. Should not be null!

Returns:

Never-null SpectateManager.Result instance indicating the outcome of this call.

stopSpectating

void stopSpectating(@NotNull
                    org.bukkit.entity.Player player)

Puts a player out of spectator mode. Note: Calls SpectateEndEvent after player stops spectating.

Parameters:

player - Player to stop spectating. Should not be null!

getSpectators

@NotNull
java.util.List<Spectator> getSpectators(@NotNull
                                                 Arena arena)

An UnmodifiableList of Spectators that are currently spectating the given Arena.

Parameters:

arena - Arena to get spectators

Returns:

Never-null UnmodifiableList of Spectators spectating given Arena