Package fr.prodrivers.bukkit.commons.parties

Interface PartyManager

public interface PartyManager
Prodrivers Commons Party Manager.

Allows interacting with Prodrivers Commons global parties. Invites, kick, disband and others are directly handled by the plugin.

Used implementation can be changed in configuration.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    accept(@NonNull UUID inviterPlayerUniqueId, @NonNull UUID invitedPlayerUniqueId)
    Invites a player to a party
    void
    addPartyInvite(@NonNull UUID invitedPlayerUniqueId, @NonNull Party party)
    Invites a player to a party
    boolean
    addToParty(@NonNull Party party, @NonNull UUID playerUniqueId)
    Assigns an existing party to a player.
    boolean
    assignOwner(@NonNull Party party, @NonNull UUID newOwnerUniqueId)
    Assigns a new owner to a party.
    Party
    createParty(@NonNull UUID ownerUniqueId)
    Creates a new party.
    void
    disband(@NonNull Party party)
    Disband and remove a party.
    Iterable<Party>
    getParties()
    Returns all known parties.
    Party
    getParty(@NonNull UUID playerUniqueId)
    Get player's party.
    Iterable<Party>
    getPartyInvites(@NonNull UUID invitedPlayerUniqueId)
    Get parties on which the player has pending party invitations.
    boolean
    hasPartyInvites(@NonNull UUID invitedPlayerUniqueId)
    Checks if the player has pending party invitations.
    boolean
    invite(@NonNull UUID inviterPlayerUniqueId, @NonNull UUID invitedPlayerUniqueId)
    Invites a player to a party
    boolean
    isInParty(@NonNull UUID playerUniqueId)
    Checks if given player is in a party.
    boolean
    removeFromParty(@NonNull UUID playerUniqueId)
    Removes existing party from the manager.
    void
    removePartyInvites(@NonNull UUID invitedPlayerUniqueId)
    Removes all pending party invitations for a player.

  • Method Details

    • isInParty

      boolean isInParty(@NonNull UUID playerUniqueId)
      Checks if given player is in a party.
      Parameters:
      playerUniqueId - Player unique ID
      Returns:
      true if the player is in a party

    • getParty

      Party getParty(@NonNull UUID playerUniqueId)
      Get player's party.
      Parameters:
      playerUniqueId - Player Unique ID
      Returns:
      Player's party

    • getParties

      Iterable<Party> getParties()
      Returns all known parties.
      Returns:
      Parties

    • createParty

      Party createParty(@NonNull UUID ownerUniqueId)
      Creates a new party.
      Parameters:
      ownerUniqueId - Party owner
      Returns:
      New party instance

    • addToParty

      boolean addToParty(@NonNull Party party, @NonNull UUID playerUniqueId)
      Assigns an existing party to a player.
      Parameters:
      party - Party to add player to
      playerUniqueId - Player's UniqueId
      Returns:
      true if player was added to party

    • removeFromParty

      boolean removeFromParty(@NonNull UUID playerUniqueId)
      Removes existing party from the manager.
      Parameters:
      playerUniqueId - Player's UniqueId
      Returns:
      true if player was removed from party

    • disband

      void disband(@NonNull Party party)
      Disband and remove a party.
      Parameters:
      party - Party to disband

    • invite

      boolean invite(@NonNull UUID inviterPlayerUniqueId, @NonNull UUID invitedPlayerUniqueId) throws PlayerNotConnectedException, PartyCannotInviteYourselfException
      Invites a player to a party
      Parameters:
      inviterPlayerUniqueId - Inviter player
      invitedPlayerUniqueId - Invited player
      Returns:
      true if invite was sent with success
      Throws:
      PlayerNotConnectedException - Inviter or invited player ID is invalid or not connected
      PartyCannotInviteYourselfException - Player trie sto invite itself

    • accept

      void accept(@NonNull UUID inviterPlayerUniqueId, @NonNull UUID invitedPlayerUniqueId) throws PlayerNotConnectedException, PlayerNotInvitedToParty
      Invites a player to a party
      Parameters:
      inviterPlayerUniqueId - Inviter player
      invitedPlayerUniqueId - Invited player
      Throws:
      PlayerNotConnectedException - Inviter or invited player ID is invalid or not connected
      PlayerNotInvitedToParty - Player is not invited to party

    • assignOwner

      boolean assignOwner(@NonNull Party party, @NonNull UUID newOwnerUniqueId)
      Assigns a new owner to a party.
      Parameters:
      party - Party to assign owner to
      newOwnerUniqueId - New owner's Unique ID
      Returns:
      true if new owner was assigned

    • addPartyInvite

      void addPartyInvite(@NonNull UUID invitedPlayerUniqueId, @NonNull Party party)
      Invites a player to a party
      Parameters:
      invitedPlayerUniqueId - Invited player
      party - Associated party

    • hasPartyInvites

      boolean hasPartyInvites(@NonNull UUID invitedPlayerUniqueId)
      Checks if the player has pending party invitations.
      Parameters:
      invitedPlayerUniqueId - Invited player's Unique ID
      Returns:
      true if the player has pending party invites.

    • getPartyInvites

      Iterable<Party> getPartyInvites(@NonNull UUID invitedPlayerUniqueId)
      Get parties on which the player has pending party invitations.
      Parameters:
      invitedPlayerUniqueId - Invited player's Unique ID
      Returns:
      Parties that sent an invitation to the specified player

    • removePartyInvites

      void removePartyInvites(@NonNull UUID invitedPlayerUniqueId)
      Removes all pending party invitations for a player.
      Parameters:
      invitedPlayerUniqueId - Invited player's Unique ID