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

Interface IPlayerConfigPermissionAPI

public interface IPlayerConfigPermissionAPI
The API for the permissions a player has for a config

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canClaimAs()
    Checks whether the player can claim chunks as this config.
    boolean
    canCreateGroups()
    Checks whether the player can create/delete player groups in this config.
    boolean
    canEdit()
    Checks whether the player can edit the config.
    boolean
    canIncludeGroupsInGroups()
    Checks whether the player can include/exclude player groups in other player groups of this config.
    boolean
    canIncludePlayersInGroups()
    Checks whether the player can include/exclude players in the player groups of this config.
    boolean
    canView()
    Checks whether the player can view the config.

  • Method Details

    • canView

      boolean canView()
      Checks whether the player can view the config.

      This is not a security feature, it mostly disables the config button to keep the UI clean for normal players.

      The config is still synchronized to every player and can be accessed programmatically.

      Returns:
      true if the player should be able to view the config, otherwise false

    • canEdit

      boolean canEdit()
      Checks whether the player can edit the config.
      Returns:
      true if the player should be able to edit the config, otherwise false

    • canIncludeGroupsInGroups

      boolean canIncludeGroupsInGroups()
      Checks whether the player can include/exclude player groups in other player groups of this config.
      Returns:
      true if the player should be able to include/exclude player groups in this config's player groups, otherwise false

    • canIncludePlayersInGroups

      boolean canIncludePlayersInGroups()
      Checks whether the player can include/exclude players in the player groups of this config.
      Returns:
      true if the player should be able to include/exclude players in this config's player groups, otherwise false

    • canCreateGroups

      boolean canCreateGroups()
      Checks whether the player can create/delete player groups in this config.
      Returns:
      true if the player should be able to create/delete player groups in this config, otherwise false

    • canClaimAs

      boolean canClaimAs()
      Checks whether the player can claim chunks as this config.
      Returns:
      true if the player should be able to claim chunks as this config, otherwise false