Package xaero.pac.client.player.config.group.api

Interface IClientPlayerConfigGroupManagerAPI

All Superinterfaces:
ICustomPlayerConfigGroupDataManagerAPI
public interface IClientPlayerConfigGroupManagerAPI extends ICustomPlayerConfigGroupDataManagerAPI
API for player groups of a player config on the client side

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    dataExists(String id)
    Checks whether a specified group ID corresponds to one of the custom groups whose data is stored in this group manager.
    List<String>
    getAllIdsSorted()
    Gets a sorted list of all group IDs that can be used as config option exception values in this config.
    int
    getGroupSpace()
    Gets the total group space available in this group manager for non-op players.
    Set<String>
    getIds()
    Gets a set of all custom group IDs the client is currently aware of for this config.
    int
    getMaxGroups()
    Gets the maximum number of groups that a non-op player can create in this group manager.
    boolean
    isSyncInProgress()
    Checks whether server-client synchronization of player groups is currently in progress.

  • Method Details

    • getMaxGroups

      int getMaxGroups()
      Description copied from interface: ICustomPlayerConfigGroupDataManagerAPI
      Gets the maximum number of groups that a non-op player can create in this group manager.
      Specified by:
      getMaxGroups in interface ICustomPlayerConfigGroupDataManagerAPI
      Returns:
      the group count limit for non-op players

    • getGroupSpace

      int getGroupSpace()
      Description copied from interface: ICustomPlayerConfigGroupDataManagerAPI
      Gets the total group space available in this group manager for non-op players.
      Specified by:
      getGroupSpace in interface ICustomPlayerConfigGroupDataManagerAPI
      Returns:
      the total group space available to non-op players

    • getAllIdsSorted

      @Nonnull List<String> getAllIdsSorted()
      Description copied from interface: ICustomPlayerConfigGroupDataManagerAPI
      Gets a sorted list of all group IDs that can be used as config option exception values in this config.

      This means that the list always includes player groups from the default player config.

      Specified by:
      getAllIdsSorted in interface ICustomPlayerConfigGroupDataManagerAPI
      Returns:
      the list of all IDs usable as config option exception values

    • dataExists

      boolean dataExists(@Nonnull String id)
      Description copied from interface: ICustomPlayerConfigGroupDataManagerAPI
      Checks whether a specified group ID corresponds to one of the custom groups whose data is stored in this group manager.
      Specified by:
      dataExists in interface ICustomPlayerConfigGroupDataManagerAPI
      Parameters:
      id - the group ID, not null
      Returns:
      true if this manager stores data for a custom group with the ID, otherwise false

    • isSyncInProgress

      boolean isSyncInProgress()
      Checks whether server-client synchronization of player groups is currently in progress.
      Returns:
      true if sync is in progress, otherwise false

    • getIds

      @Nonnull Set<String> getIds()
      Gets a set of all custom group IDs the client is currently aware of for this config.
      Returns:
      the set of custom group IDs, not null