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

Interface ICustomPlayerConfigGroupDataAPI

All Known Subinterfaces:
ICustomPlayerConfigGroupAPI
public interface ICustomPlayerConfigGroupDataAPI
API for stored data of a custom player config group

  • Method Details

    • getDirectGroupIds

      @Nonnull Set<String> getDirectGroupIds()
      Gets a set containing all group IDs directly included in this group.
      Returns:
      the set of directly included group IDs, not null

    • copyData

      @Nonnull ICustomPlayerConfigGroupDataAPI copyData()
      Creates a copy of the stored data.
      Returns:
      the copy, not null

    • getSize

      int getSize()
      Gets the size of this custom player group (included members and groups).
      Returns:
      the size of the data

    • getDirectMembers

      @Nonnull Set<ICustomPlayerGroupMemberAPI> getDirectMembers()
      Gets a set of member entries directly included in this group.
      Returns:
      the set of direct member entries, not null

    • playerIdIsIncluded

      boolean playerIdIsIncluded(@Nullable UUID playerId)
      Checks whether the player with a specified UUID is one of the member entries.
      Parameters:
      playerId - the ID of the player, not null
      Returns:
      true if one of the member entries corresponds to the ID, otherwise false

    • playerNameIsIncluded

      boolean playerNameIsIncluded(@Nullable String name)
      Checks whether a specified player name is one of the member entries.
      Parameters:
      name - the player name, can be null
      Returns:
      true if the specified player name is not null and corresponds to a member entry, otherwise false

    • groupIdIsIncluded

      boolean groupIdIsIncluded(@Nullable String groupId)
      Checks whether a specified group ID is included in this group.
      Parameters:
      groupId - the group ID, can be null
      Returns:
      true if the specified group ID is not null and corresponds to a group entry, otherwise false