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

Interface IPlayerPartySystemAPI<P>

Type Parameters:
P - the type of parties in the implemented system
All Superinterfaces:
IPlayerPartySystemAPI<P>
@Deprecated public interface IPlayerPartySystemAPI<P> extends IPlayerPartySystemAPI<P>
Deprecated.
use IPlayerPartySystemAPI instead

The interface to be overridden by addons that wish to implement additional party systems to be used by Open Parties and Claims (just the claiming feature as of writing this).

Player position synchronization is a part of the default party system. Similar functionality should be implemented in other party systems and supported separately by the map mods that display party members. OPAC does not synchronize or provide party member/ally positions from other party systems, even if they're implemented using this interface.

Party system implementations must be registered in IPlayerPartySystemRegisterAPI.

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    canCreatePartyConfigGroups(UUID playerId)
    Deprecated.
    Checks if a player is permitted to create player groups in the party's claims config (the party owner's config).
    default boolean
    canEditPartyConfig(UUID playerId)
    Deprecated.
    Checks if a player is permitted to edit the party's claims config (the party owner's config).
    default boolean
    canIncludeGroupsInPartyConfigGroups(UUID playerId)
    Deprecated.
    Checks if a player is permitted to include/exclude player groups in other player groups in the party's claims config (the party owner's config).
    default boolean
    canIncludePlayersInPartyConfigGroups(UUID playerId)
    Deprecated.
    Checks if a player is permitted to include/exclude players in player groups in the party's claims config (the party owner's config).
    default int
    getMemberCount(P party)
    Deprecated.
    Gets the member count of a specified party.
    default net.minecraft.network.chat.Component
    getName(P party)
    Deprecated.
    Gets the display name of a specified party.
    default UUID
    getOwner(P party)
    Deprecated.
    Gets the UUID of the owner of a specified party.

    Methods inherited from interface xaero.pac.common.server.parties.system.api.v2.IPlayerPartySystemAPI

    getColor, getPartyByMember, getPartyByOwner, isPermittedToPartyClaim, isPlayerAllying

  • Method Details

    • canEditPartyConfig

      default boolean canEditPartyConfig(@Nonnull UUID playerId)
      Deprecated.
      Description copied from interface: IPlayerPartySystemAPI
      Checks if a player is permitted to edit the party's claims config (the party owner's config).
      Specified by:
      canEditPartyConfig in interface IPlayerPartySystemAPI<P>
      Parameters:
      playerId - the UUID of the player, not null
      Returns:
      true, if the player is permitted to edit the party's claims config, otherwise false

    • canCreatePartyConfigGroups

      default boolean canCreatePartyConfigGroups(@Nonnull UUID playerId)
      Deprecated.
      Description copied from interface: IPlayerPartySystemAPI
      Checks if a player is permitted to create player groups in the party's claims config (the party owner's config).
      Specified by:
      canCreatePartyConfigGroups in interface IPlayerPartySystemAPI<P>
      Parameters:
      playerId - the UUID of the player, not null
      Returns:
      true, if the player is permitted to create player groups, otherwise false

    • canIncludeGroupsInPartyConfigGroups

      default boolean canIncludeGroupsInPartyConfigGroups(@Nonnull UUID playerId)
      Deprecated.
      Description copied from interface: IPlayerPartySystemAPI
      Checks if a player is permitted to include/exclude player groups in other player groups in the party's claims config (the party owner's config).
      Specified by:
      canIncludeGroupsInPartyConfigGroups in interface IPlayerPartySystemAPI<P>
      Parameters:
      playerId - the UUID of the player, not null
      Returns:
      true, if the player is permitted to include/exclude player groups in other player groups, otherwise false

    • canIncludePlayersInPartyConfigGroups

      default boolean canIncludePlayersInPartyConfigGroups(@Nonnull UUID playerId)
      Deprecated.
      Description copied from interface: IPlayerPartySystemAPI
      Checks if a player is permitted to include/exclude players in player groups in the party's claims config (the party owner's config).
      Specified by:
      canIncludePlayersInPartyConfigGroups in interface IPlayerPartySystemAPI<P>
      Parameters:
      playerId - the UUID of the player, not null
      Returns:
      true, if the player is permitted to include/exclude player groups in other player groups, otherwise false

    • getOwner

      @Nullable default UUID getOwner(@Nonnull P party)
      Deprecated.
      Description copied from interface: IPlayerPartySystemAPI
      Gets the UUID of the owner of a specified party.
      Specified by:
      getOwner in interface IPlayerPartySystemAPI<P>
      Parameters:
      party - the party the owner of which will be returned, not null
      Returns:
      the UUID of the party owner, null if the party has no owner (things won't work!)

    • getName

      @Nullable default net.minecraft.network.chat.Component getName(@Nonnull P party)
      Deprecated.
      Description copied from interface: IPlayerPartySystemAPI
      Gets the display name of a specified party.
      Specified by:
      getName in interface IPlayerPartySystemAPI<P>
      Parameters:
      party - the party the display name of which will be returned, not null
      Returns:
      the party display name as a Component, null if the party doesn't have one

    • getMemberCount

      default int getMemberCount(@Nonnull P party)
      Deprecated.
      Description copied from interface: IPlayerPartySystemAPI
      Gets the member count of a specified party.
      Specified by:
      getMemberCount in interface IPlayerPartySystemAPI<P>
      Parameters:
      party - the party the member count of which will be returned, not null
      Returns:
      the member count of the party