Package xaero.pac.common.player.config.group.custom.api

Interface ICustomPlayerConfigGroupDataManagerAPI

All Known Subinterfaces:
IClientPlayerConfigGroupManagerAPI, IServerPlayerConfigGroupManagerAPI
public interface ICustomPlayerConfigGroupDataManagerAPI
API for a custom player config group data manager

  • 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.
    int
    getMaxGroups()
    Gets the maximum number of groups that a non-op player can create in this group manager.

  • Method Details

    • getMaxGroups

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

    • getGroupSpace

      int getGroupSpace()
      Gets the total group space available in this group manager for non-op players.
      Returns:
      the total group space available to non-op players

    • getAllIdsSorted

      @Nonnull List<String> getAllIdsSorted()
      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.

      Returns:
      the list of all IDs usable as config option exception values

    • dataExists

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