Package xaero.pac.common.server.parties.party.api

Interface IServerPartyAPI

All Superinterfaces:
IPartyAPI
public interface IServerPartyAPI extends IPartyAPI
API for a party on the server side

  • Method Details

    • getMemberCount

      int getMemberCount()
      Description copied from interface: IPartyAPI
      Gets the number of members in this party.
      Specified by:
      getMemberCount in interface IPartyAPI
      Returns:
      the member count

    • getMemberInfo

      @Nullable IPartyMemberAPI getMemberInfo(@Nonnull UUID memberUUID)
      Description copied from interface: IPartyAPI
      Gets info about the party member with a specified UUID.
      Specified by:
      getMemberInfo in interface IPartyAPI
      Parameters:
      memberUUID - the UUID of a party member, not null
      Returns:
      the member info, null if doesn't exist

    • getAllyCount

      int getAllyCount()
      Description copied from interface: IPartyAPI
      Gets the number of parties allied by this one.
      Specified by:
      getAllyCount in interface IPartyAPI
      Returns:
      the ally count

    • isAlly

      boolean isAlly(@Nonnull UUID partyId)
      Description copied from interface: IPartyAPI
      Checks whether the party with a specified UUID is allied by this one.
      Specified by:
      isAlly in interface IPartyAPI
      Parameters:
      partyId - the UUID of the party, not null
      Returns:
      true if the party is allied by this one, otherwise false

    • getInviteCount

      int getInviteCount()
      Description copied from interface: IPartyAPI
      Gets the number of active invitation to this party.
      Specified by:
      getInviteCount in interface IPartyAPI
      Returns:
      the invite count

    • isInvited

      boolean isInvited(@Nonnull UUID playerId)
      Description copied from interface: IPartyAPI
      Checks whether the player with a specified UUID has an active invitation to this party.
      Specified by:
      isInvited in interface IPartyAPI
      Parameters:
      playerId - the UUID of the player, not null
      Returns:
      true if there is a active invitation, otherwise false

    • getMemberInfoStream

      @Nonnull Stream<IPartyMemberAPI> getMemberInfoStream()
      Description copied from interface: IPartyAPI
      Gets a stream of all member info for this party.
      Specified by:
      getMemberInfoStream in interface IPartyAPI
      Returns:
      a Stream of all member info, not null

    • getStaffInfoStream

      @Nonnull Stream<IPartyMemberAPI> getStaffInfoStream()
      Description copied from interface: IPartyAPI
      Gets a stream of all member info for the staff members of this party.
      Specified by:
      getStaffInfoStream in interface IPartyAPI
      Returns:
      a Stream of all staff member info, not null

    • getNonStaffInfoStream

      @Nonnull Stream<IPartyMemberAPI> getNonStaffInfoStream()
      Description copied from interface: IPartyAPI
      Gets a stream of all member info for the regular (non-staff) members of this party.
      Specified by:
      getNonStaffInfoStream in interface IPartyAPI
      Returns:
      a Stream of all regular member info, not null

    • getInvitedPlayersStream

      @Nonnull Stream<IPartyPlayerInfoAPI> getInvitedPlayersStream()
      Description copied from interface: IPartyAPI
      Gets a stream of all active invitations for this party.
      Specified by:
      getInvitedPlayersStream in interface IPartyAPI
      Returns:
      a Stream of all active invitations, not null

    • getAllyPartiesStream

      @Nonnull Stream<IPartyAllyAPI> getAllyPartiesStream()
      Description copied from interface: IPartyAPI
      Gets a stream of UUIDs of all parties allied by this party.
      Specified by:
      getAllyPartiesStream in interface IPartyAPI
      Returns:
      a Stream of all allies, not null

    • getOwner

      @Nonnull IPartyMemberAPI getOwner()
      Description copied from interface: IPartyAPI
      Gets the member info for the owner of this party.
      Specified by:
      getOwner in interface IPartyAPI
      Returns:
      the party owner

    • getId

      @Nonnull UUID getId()
      Description copied from interface: IPartyAPI
      Gets the UUID of this party.
      Specified by:
      getId in interface IPartyAPI
      Returns:
      the UUID of this party, not null

    • getDefaultName

      @Nonnull String getDefaultName()
      Description copied from interface: IPartyAPI
      Gets the default name of this party.
      Specified by:
      getDefaultName in interface IPartyAPI
      Returns:
      the default name, not null

    • setRank

      boolean setRank(@Nonnull IPartyMemberAPI member, @Nonnull xaero.pac.common.parties.party.member.PartyMemberRank rank)
      Description copied from interface: IPartyAPI
      Sets the rank of a specified party member.

      The member info needs to be from this party.

      Specified by:
      setRank in interface IPartyAPI
      Parameters:
      member - the party member, not null
      rank - the rank to set the party member to, not null
      Returns:
      true if the rank is successfully set, otherwise false

    • addMember

      @Nullable IPartyMemberAPI addMember(@Nonnull UUID playerUUID, @Nullable xaero.pac.common.parties.party.member.PartyMemberRank rank, @Nonnull String playerUsername)
      Adds a new party member with specified player UUID, rank and username.
      Parameters:
      playerUUID - the UUID of a player, not null
      rank - the rank for the party member, null for the default rank
      playerUsername - the current username of the player, not null
      Returns:
      the created party member info, null if the player is already in a party

    • removeMember

      @Nullable IPartyMemberAPI removeMember(@Nonnull UUID playerUUID)
      Removes the party member with a specified player UUID, unless the player is the owner of this party.
      Parameters:
      playerUUID - the UUID of a player, not null
      Returns:
      the removed party member info, null if the specified player is the party owner or if the player isn't in the party

    • getMemberInfo

      @Nullable IPartyMemberAPI getMemberInfo(@Nonnull String username)
      Gets info about the party member with a specified username.
      Parameters:
      username - the username of a party member, not null
      Returns:
      the member info, null if doesn't exist

    • addAllyParty

      void addAllyParty(@Nonnull UUID partyId)
      Adds a new ally party to this party.
      Parameters:
      partyId - the UUID of the party to ally, not null

    • removeAllyParty

      void removeAllyParty(@Nonnull UUID partyId)
      Removes an ally party from this party.
      Parameters:
      partyId - the UUID of the party to unally, not null

    • invitePlayer

      @Nullable IPartyPlayerInfoAPI invitePlayer(@Nonnull UUID playerUUID, @Nonnull String playerUsername)
      Invites the player with specified player UUID and username to this party.
      Parameters:
      playerUUID - the UUID of the player, not null
      playerUsername - the current username of the player, not null
      Returns:
      the invitation info, null if the player is already invited to this party

    • uninvitePlayer

      @Nullable IPartyPlayerInfoAPI uninvitePlayer(@Nonnull UUID playerUUID)
      Removes the player invitation for a specified player UUID.
      Parameters:
      playerUUID - the UUID of the player, not null
      Returns:
      the removed invitation info, null if the player has not been invited

    • getOnlineMemberStream

      @Nonnull Stream<net.minecraft.server.level.ServerPlayer> getOnlineMemberStream()
      Gets a stream of all currently online members of this party.
      Returns:
      the stream of online party members, not null