Package fr.prodrivers.bukkit.commons.parties

Interface Party

public interface Party
Prodrivers Commons Party instance

Used implementation can be changed in configuration.

  • Method Details

    • getOwnerUniqueId

      UUID getOwnerUniqueId()
      Returns owner's unique id.
      Returns:
      Owner's unique id

    • getPlayers

      ArrayList<UUID> getPlayers()
      Returns party members.
      Returns:
      List of party members

    • registerPlayer

      void registerPlayer(UUID playerUniqueId)
      Register a player to the party.
      Parameters:
      playerUniqueId - Player to add Unique ID

    • unregisterPlayer

      void unregisterPlayer(UUID playerUniqueId)
      Unregister a player from the party.
      Parameters:
      playerUniqueId - Player to remove's Unique ID

    • containsPlayer

      boolean containsPlayer(UUID playerUniqueId)
      Checks if a player is present in party list.
      Parameters:
      playerUniqueId - Player's Unique ID
      Returns:
      true if the player is within the party list.

    • isPartyOwner

      boolean isPartyOwner(UUID playerUniqueId)
      Checks if a player is the party owner
      Parameters:
      playerUniqueId - Player's Unique ID
      Returns:
      true if the player is the party owner

    • assignOwner

      boolean assignOwner(UUID newOwner)
      Set a player as the new party owner
      Parameters:
      newOwner - New owner
      Returns:
      true if new owner has been assigned

    • size

      int size()
      Returns the party's number of players.
      Returns:
      Party's number of players

    • clear

      void clear()
      Clear a party of all its players.

    • chatAsPlayer

      void chatAsPlayer(org.bukkit.entity.Player player, String message)
      Send a message as a player.
      Parameters:
      player - Sending player
      message - Message to send

    • send

      void send(UUID receiverUniqueId, PartyMessage message, Object... substitutions)
      Send a message to a player.
      Parameters:
      receiverUniqueId - Sending player
      message - Message to send
      substitutions - Values to pass to string format function

    • broadcast

      void broadcast(PartyMessage message, Object... substitutions)
      Broadcast a message to the party.
      Parameters:
      message - Message to send
      substitutions - Values to pass to string format function

    • broadcast

      void broadcast(PartyMessage message, List<UUID> excluded, Object... substitutions)
      Broadcast a message to the party, except some players.
      Parameters:
      message - Message to send
      excluded - Players that should not receive the message
      substitutions - Values to pass to string format function

    • broadcast

      void broadcast(String message)
      Broadcast a message to the party.
      Parameters:
      message - Message to send

    • broadcast

      void broadcast(String message, List<UUID> excluded)
      Broadcast a message to the party, except some players.
      Parameters:
      message - Message to send
      excluded - Players that should not receive the message