Package com.xyrisdev.cloud.implementation.model

Class DuelSession

java.lang.Object
com.xyrisdev.cloud.implementation.model.DuelSession
public class DuelSession extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    DuelSession(DuelArena arena, String displayName, UUID player1, UUID player2, String kit, int rounds)
    Constructs a new DuelSession.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addSpectator(@NotNull UUID playerId)
    Adds a player as a spectator to the duel.
    UUID
    getOpponent(@NotNull UUID playerId)
    Gets the opponent's UUID for the given player ID.
    Set<UUID>
    getSpectators()
    Gets the set of all spectators of the duel.
    void
    increment(@NotNull UUID winnerId)
    Increments the win count for the given player and advances to the next round.
    boolean
    isSpectator(@NotNull UUID playerId)
    Checks if a player is currently spectating the duel.
    int
    needed(@NotNull UUID playerId)
    Calculates how many more rounds the specified player needs to win to win the duel.
    boolean
    over()
    Determines if the duel is over.
    void
    removeSpectator(@NotNull UUID playerId)
    Removes a player from the list of spectators.
    int
    score(@NotNull UUID playerId)
    Gets the current score for the specified player.
    UUID
    winner()
    Determines the winner of the duel.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • DuelSession

      public DuelSession(DuelArena arena, String displayName, UUID player1, UUID player2, String kit, int rounds)
      Constructs a new DuelSession.

      This initializes the session with the provided arena, display name, players, kit, and total rounds.

      Parameters:
      arena - The arena where the duel takes place.
      displayName - The display name of the arena.
      player1 - The first player participating in the duel.
      player2 - The second player participating in the duel.
      kit - The kit used in the duel.
      rounds - The total number of rounds in the duel.

  • Method Details

    • getOpponent

      public UUID getOpponent(@NotNull @NotNull UUID playerId)
      Gets the opponent's UUID for the given player ID.

      This method returns the UUID of the opposing player in the duel.

      Parameters:
      playerId - The UUID of the player whose opponent is being retrieved.
      Returns:
      The UUID of the opponent.
      Throws:
      IllegalArgumentException - if the player ID does not belong to either of the duel participants.

    • over

      public boolean over()
      Determines if the duel is over.

      The duel is over when one player has won the required number of rounds.

      Returns:
      true if the duel is over, false otherwise.

    • increment

      public void increment(@NotNull @NotNull UUID winnerId)
      Increments the win count for the given player and advances to the next round.

      This method updates the round and the score based on which player won the current round.

      Parameters:
      winnerId - The UUID of the player who won the round.

    • winner

      public UUID winner()
      Determines the winner of the duel.

      This method returns the UUID of the player who has won the duel (i.e., who reached the total number of wins).

      Returns:
      The UUID of the winner, or null if the duel is not over yet.

    • needed

      public int needed(@NotNull @NotNull UUID playerId)
      Calculates how many more rounds the specified player needs to win to win the duel.

      This method is used to determine how close a player is to winning the duel.

      Parameters:
      playerId - The UUID of the player whose required wins are being calculated.
      Returns:
      The number of rounds the player needs to win to finish the duel.
      Throws:
      IllegalArgumentException - if the player ID does not belong to either of the duel participants.

    • score

      public int score(@NotNull @NotNull UUID playerId)
      Gets the current score for the specified player.

      This method returns the number of rounds won by the specified player in the duel.

      Parameters:
      playerId - The UUID of the player whose score is being retrieved.
      Returns:
      The number of rounds won by the player.
      Throws:
      IllegalArgumentException - if the player ID does not belong to either of the duel participants.

    • addSpectator

      public void addSpectator(@NotNull @NotNull UUID playerId)
      Adds a player as a spectator to the duel.

      This method allows a player to spectate the duel without participating directly.

      Parameters:
      playerId - The UUID of the player who will be added as a spectator.
      Throws:
      NullPointerException - if the playerId is null.

    • removeSpectator

      public void removeSpectator(@NotNull @NotNull UUID playerId)
      Removes a player from the list of spectators.

      This method removes a player from the list of spectators, meaning they will no longer be able to spectate the duel.

      Parameters:
      playerId - The UUID of the player to be removed from the spectators.
      Throws:
      NullPointerException - if the playerId is null.

    • isSpectator

      public boolean isSpectator(@NotNull @NotNull UUID playerId)
      Checks if a player is currently spectating the duel.

      This method returns true if the player is in the list of spectators, false otherwise.

      Parameters:
      playerId - The UUID of the player being checked.
      Returns:
      true if the player is a spectator, false otherwise.
      Throws:
      NullPointerException - if the playerId is null.

    • getSpectators

      public Set<UUID> getSpectators()
      Gets the set of all spectators of the duel.

      This method returns an unmodifiable set of UUIDs representing all players currently spectating the duel.

      Returns:
      An unmodifiable set containing the UUIDs of all spectators.