Class ConfigKeys

java.lang.Object
me.lucko.luckperms.common.config.ConfigKeys
public final class ConfigKeys extends Object
All of the ConfigKeys used by LuckPerms.

The getKeys() method and associated behaviour allows this class to function a bit like an enum, but with generics.

  • Field Details

    • SERVER

      public static final ConfigKey<String> SERVER
      The name of the server

    • SYNC_TIME

      public static final ConfigKey<Integer> SYNC_TIME
      How many minutes to wait between syncs. A value invalid input: '<'= 0 will disable syncing.

    • GLOBAL_QUERY_OPTIONS

      public static final ConfigKey<net.luckperms.api.query.QueryOptions> GLOBAL_QUERY_OPTIONS
      The default global contexts instance

    • CONTEXT_SATISFY_MODE

      public static final ConfigKey<net.luckperms.api.context.ContextSatisfyMode> CONTEXT_SATISFY_MODE
      The default contexts satisfy mode

    • DISABLED_CONTEXTS

      public static final ConfigKey<Set<String>> DISABLED_CONTEXTS
      A set of disabled contexts

    • USE_SERVER_UUID_CACHE

      public static final ConfigKey<Boolean> USE_SERVER_UUID_CACHE
      # If the servers own UUID cache/lookup facility should be used when there is no record for a player in the LuckPerms cache.

    • ALLOW_INVALID_USERNAMES

      public static final ConfigKey<Boolean> ALLOW_INVALID_USERNAMES
      If LuckPerms should allow usernames with non alphanumeric characters.

    • SKIP_BULKUPDATE_CONFIRMATION

      public static final ConfigKey<Boolean> SKIP_BULKUPDATE_CONFIRMATION
      If LuckPerms should not require users to confirm bulkupdate operations.

    • DISABLE_BULKUPDATE

      public static final ConfigKey<Boolean> DISABLE_BULKUPDATE
      If LuckPerms should prevent bulkupdate operations.

    • DEBUG_LOGINS

      public static final ConfigKey<Boolean> DEBUG_LOGINS
      If LuckPerms should produce extra logging output when it handles logins.

    • CANCEL_FAILED_LOGINS

      public static final ConfigKey<Boolean> CANCEL_FAILED_LOGINS
      If LP should cancel login attempts for players whose permission data could not be loaded.

    • UPDATE_CLIENT_COMMAND_LIST

      public static final ConfigKey<Boolean> UPDATE_CLIENT_COMMAND_LIST
      If LuckPerms should update the list of commands sent to the client when permissions are changed.

    • REGISTER_COMMAND_LIST_DATA

      public static final ConfigKey<Boolean> REGISTER_COMMAND_LIST_DATA
      If LuckPerms should attempt to register "Brigadier" command list data for its commands.

    • RESOLVE_COMMAND_SELECTORS

      public static final ConfigKey<Boolean> RESOLVE_COMMAND_SELECTORS
      If LuckPerms should attempt to resolve Vanilla command target selectors for LP commands.

    • TEMPORARY_ADD_BEHAVIOUR

      public static final ConfigKey<net.luckperms.api.model.data.TemporaryNodeMergeStrategy> TEMPORARY_ADD_BEHAVIOUR
      Controls how temporary add commands should behave

    • PRIMARY_GROUP_CALCULATION_METHOD

      public static final ConfigKey<String> PRIMARY_GROUP_CALCULATION_METHOD
      How primary groups should be calculated.

    • PRIMARY_GROUP_CALCULATION

      public static final ConfigKey<Function<User, PrimaryGroupHolder>> PRIMARY_GROUP_CALCULATION
      A function to create primary group holder instances based upon the PRIMARY_GROUP_CALCULATION_METHOD setting.

    • PREVENT_PRIMARY_GROUP_REMOVAL

      public static final ConfigKey<Boolean> PREVENT_PRIMARY_GROUP_REMOVAL
      If set to false, the plugin will allow a Users primary group to be removed with the 'parent remove' command, and will set their primary group back to default.

    • USE_ARGUMENT_BASED_COMMAND_PERMISSIONS

      public static final ConfigKey<Boolean> USE_ARGUMENT_BASED_COMMAND_PERMISSIONS
      If the plugin should check for "extra" permissions with users run LP commands

    • REQUIRE_SENDER_GROUP_MEMBERSHIP_TO_MODIFY

      public static final ConfigKey<Boolean> REQUIRE_SENDER_GROUP_MEMBERSHIP_TO_MODIFY
      If the plugin should check whether senders are a member of a given group before they're able to edit the groups permissions or add/remove it from other users.

    • READ_ONLY_MODE_PLAYERS

      public static final ConfigKey<Boolean> READ_ONLY_MODE_PLAYERS
      If the plugin is in read-only mode for players

    • READ_ONLY_MODE_CONSOLE

      public static final ConfigKey<Boolean> READ_ONLY_MODE_CONSOLE
      If the plugin is in read-only mode for the server console

    • DISABLE_LUCKPERMS_COMMANDS_PLAYERS

      public static final ConfigKey<Boolean> DISABLE_LUCKPERMS_COMMANDS_PLAYERS
      If LuckPerms commands are disabled for players

    • DISABLE_LUCKPERMS_COMMANDS_CONSOLE

      public static final ConfigKey<Boolean> DISABLE_LUCKPERMS_COMMANDS_CONSOLE
      If LuckPerms commands are disabled for the server console

    • APPLYING_WILDCARDS

      public static final ConfigKey<Boolean> APPLYING_WILDCARDS
      If wildcards are being applied

    • APPLYING_WILDCARDS_SPONGE

      public static final ConfigKey<Boolean> APPLYING_WILDCARDS_SPONGE
      If Sponge's implicit permission inheritance system should be applied

    • APPLY_DEFAULT_NEGATIONS_BEFORE_WILDCARDS

      public static final ConfigKey<Boolean> APPLY_DEFAULT_NEGATIONS_BEFORE_WILDCARDS
      If default negated permissions should be applied before wildcards.

    • APPLYING_REGEX

      public static final ConfigKey<Boolean> APPLYING_REGEX
      If regex permissions are being applied

    • APPLYING_SHORTHAND

      public static final ConfigKey<Boolean> APPLYING_SHORTHAND
      If shorthand permissions are being applied

    • APPLY_BUKKIT_CHILD_PERMISSIONS

      public static final ConfigKey<Boolean> APPLY_BUKKIT_CHILD_PERMISSIONS
      If Bukkit child permissions are being applied. This setting is ignored on other platforms.

    • APPLY_BUKKIT_DEFAULT_PERMISSIONS

      public static final ConfigKey<Boolean> APPLY_BUKKIT_DEFAULT_PERMISSIONS
      If Bukkit default permissions are being applied. This setting is ignored on other platforms.

    • APPLY_BUKKIT_ATTACHMENT_PERMISSIONS

      public static final ConfigKey<Boolean> APPLY_BUKKIT_ATTACHMENT_PERMISSIONS
      If Bukkit attachment permissions are being applied. This setting is ignored on other platforms.

    • APPLY_NUKKIT_CHILD_PERMISSIONS

      public static final ConfigKey<Boolean> APPLY_NUKKIT_CHILD_PERMISSIONS
      If Nukkit child permissions are being applied. This setting is ignored on other platforms.

    • APPLY_NUKKIT_DEFAULT_PERMISSIONS

      public static final ConfigKey<Boolean> APPLY_NUKKIT_DEFAULT_PERMISSIONS
      If Nukkit default permissions are being applied. This setting is ignored on other platforms.

    • APPLY_NUKKIT_ATTACHMENT_PERMISSIONS

      public static final ConfigKey<Boolean> APPLY_NUKKIT_ATTACHMENT_PERMISSIONS
      If Nukkit attachment permissions are being applied. This setting is ignored on other platforms.

    • APPLY_BUNGEE_CONFIG_PERMISSIONS

      public static final ConfigKey<Boolean> APPLY_BUNGEE_CONFIG_PERMISSIONS
      If BungeeCord configured permissions are being applied. This setting is ignored on other platforms.

    • APPLY_SPONGE_DEFAULT_SUBJECTS

      public static final ConfigKey<Boolean> APPLY_SPONGE_DEFAULT_SUBJECTS
      If Sponge default subjects should be applied

    • INHERITANCE_TRAVERSAL_ALGORITHM

      public static final ConfigKey<TraversalAlgorithm> INHERITANCE_TRAVERSAL_ALGORITHM
      The algorithm LuckPerms should use when traversing the "inheritance tree"

    • POST_TRAVERSAL_INHERITANCE_SORT

      public static final ConfigKey<Boolean> POST_TRAVERSAL_INHERITANCE_SORT
      If a final sort according to "inheritance rules" should be performed after the traversal algorithm has resolved the inheritance tree

    • META_VALUE_SELECTOR

      public static final ConfigKey<net.luckperms.api.query.meta.MetaValueSelector> META_VALUE_SELECTOR
      The meta value selector

    • GROUP_WEIGHTS

      public static final ConfigKey<Map<String,Integer>> GROUP_WEIGHTS
      The configured group weightings

    • PREFIX_FORMATTING_OPTIONS

      public static final ConfigKey<net.luckperms.api.metastacking.MetaStackDefinition> PREFIX_FORMATTING_OPTIONS
      Creates a new prefix MetaStack element based upon the configured values.

    • SUFFIX_FORMATTING_OPTIONS

      public static final ConfigKey<net.luckperms.api.metastacking.MetaStackDefinition> SUFFIX_FORMATTING_OPTIONS
      Creates a new suffix MetaStack element based upon the configured values.

    • LOG_NOTIFY

      public static final ConfigKey<Boolean> LOG_NOTIFY
      If log notifications are enabled

    • LOG_NOTIFY_FILTERED_DESCRIPTIONS

      public static final ConfigKey<List<Pattern>> LOG_NOTIFY_FILTERED_DESCRIPTIONS
      Defines a list of log entries which should not be sent as notifications to users.

    • LOG_SYNCHRONOUSLY_IN_COMMANDS

      public static final ConfigKey<Boolean> LOG_SYNCHRONOUSLY_IN_COMMANDS
      If log should be posted synchronously to storage/messaging in commands

    • AUTO_INSTALL_TRANSLATIONS

      public static final ConfigKey<Boolean> AUTO_INSTALL_TRANSLATIONS
      If LuckPerms should automatically install translation bundles and periodically update them.

    • AUTO_OP

      public static final ConfigKey<Boolean> AUTO_OP
      If auto op is enabled. Only used by the Bukkit platform.

    • OPS_ENABLED

      public static final ConfigKey<Boolean> OPS_ENABLED
      If server operators should be enabled. Only used by the Bukkit platform.

    • COMMANDS_ALLOW_OP

      public static final ConfigKey<Boolean> COMMANDS_ALLOW_OP
      If server operators should be able to use LuckPerms commands by default. Only used by the Bukkit platform.

    • COMMANDS_RATE_LIMIT

      public static final ConfigKey<Boolean> COMMANDS_RATE_LIMIT
      If LuckPerms should rate-limit command executions.

    • VAULT_UNSAFE_LOOKUPS

      public static final ConfigKey<Boolean> VAULT_UNSAFE_LOOKUPS
      If Vault lookups for offline players on the main server thread should be enabled

    • VAULT_GROUP_USE_DISPLAYNAMES

      public static final ConfigKey<Boolean> VAULT_GROUP_USE_DISPLAYNAMES
      If LuckPerms should use the 'display name' of a group when returning groups in Vault API calls.

    • VAULT_NPC_GROUP

      public static final ConfigKey<String> VAULT_NPC_GROUP
      Controls which group LuckPerms should use for NPC players when handling Vault requests

    • VAULT_NPC_OP_STATUS

      public static final ConfigKey<Boolean> VAULT_NPC_OP_STATUS
      Controls how LuckPerms should consider the OP status of NPC players when handing Vault requests

    • USE_VAULT_SERVER

      public static final ConfigKey<Boolean> USE_VAULT_SERVER
      If the vault server option should be used

    • VAULT_SERVER

      public static final ConfigKey<String> VAULT_SERVER
      The name of the server to use for Vault.

    • VAULT_INCLUDING_GLOBAL

      public static final ConfigKey<Boolean> VAULT_INCLUDING_GLOBAL
      If Vault should apply global permissions

    • VAULT_IGNORE_WORLD

      public static final ConfigKey<Boolean> VAULT_IGNORE_WORLD
      If any worlds provided with Vault lookups should be ignored

    • INTEGRATED_SERVER_OWNER_BYPASSES_CHECKS

      public static final ConfigKey<Boolean> INTEGRATED_SERVER_OWNER_BYPASSES_CHECKS
      If the owner of an integrated server should automatically bypass all permission checks. On fabric and forge, this only applies on an Integrated Server.

    • DISABLED_CONTEXT_CALCULATORS

      public static final ConfigKey<Set<Predicate<String>>> DISABLED_CONTEXT_CALCULATORS
      Disabled context calculators

    • WORLD_REWRITES

      public static final ConfigKey<WorldNameRewriter> WORLD_REWRITES
      The world rewrites map

    • GROUP_NAME_REWRITES

      public static final ConfigKey<Map<String,String>> GROUP_NAME_REWRITES
      The group name rewrites map

    • DATABASE_VALUES

      public static final ConfigKey<StorageCredentials> DATABASE_VALUES
      The database settings, username, password, etc for use by any database

    • SQL_TABLE_PREFIX

      public static final ConfigKey<String> SQL_TABLE_PREFIX
      The prefix for any SQL tables

    • MONGODB_COLLECTION_PREFIX

      public static final ConfigKey<String> MONGODB_COLLECTION_PREFIX
      The prefix for any MongoDB collections

    • MONGODB_CONNECTION_URI

      public static final ConfigKey<String> MONGODB_CONNECTION_URI
      MongoDB ClientConnectionURI to override default connection options

    • REST_STORAGE_URL

      public static final ConfigKey<String> REST_STORAGE_URL
      The REST storage URL

    • REST_STORAGE_AUTH_KEY

      public static final ConfigKey<String> REST_STORAGE_AUTH_KEY
      The REST storage auth key

    • STORAGE_METHOD

      public static final ConfigKey<StorageType> STORAGE_METHOD
      The name of the storage method being used

    • WATCH_FILES

      public static final ConfigKey<Boolean> WATCH_FILES
      If storage files should be monitored for changes

    • SPLIT_STORAGE

      public static final ConfigKey<Boolean> SPLIT_STORAGE
      If split storage is being used

    • SPLIT_STORAGE_OPTIONS

      public static final ConfigKey<Map<SplitStorageType, StorageType>> SPLIT_STORAGE_OPTIONS
      The options for split storage

    • MESSAGING_SERVICE

      public static final ConfigKey<String> MESSAGING_SERVICE
      The name of the messaging service in use, or "none" if not enabled

    • AUTO_PUSH_UPDATES

      public static final ConfigKey<Boolean> AUTO_PUSH_UPDATES
      If updates should be automatically pushed by the messaging service

    • PUSH_LOG_ENTRIES

      public static final ConfigKey<Boolean> PUSH_LOG_ENTRIES
      If LuckPerms should push logging entries to connected servers via the messaging service

    • BROADCAST_RECEIVED_LOG_ENTRIES

      public static final ConfigKey<Boolean> BROADCAST_RECEIVED_LOG_ENTRIES
      If LuckPerms should broadcast received logging entries to players on this platform

    • REDIS_ENABLED

      public static final ConfigKey<Boolean> REDIS_ENABLED
      If redis messaging is enabled

    • REDIS_ADDRESS

      public static final ConfigKey<String> REDIS_ADDRESS
      The address of the redis server

    • REDIS_ADDRESSES

      public static final ConfigKey<List<String>> REDIS_ADDRESSES
      The addresses of the redis servers (only for redis clusters)

    • REDIS_USERNAME

      public static final ConfigKey<String> REDIS_USERNAME
      The username to connect with, or an empty string if it should use default

    • REDIS_PASSWORD

      public static final ConfigKey<String> REDIS_PASSWORD
      The password in use by the redis server, or an empty string if there is no password

    • REDIS_SSL

      public static final ConfigKey<Boolean> REDIS_SSL
      If the redis connection should use SSL

    • NATS_ENABLED

      public static final ConfigKey<Boolean> NATS_ENABLED
      If nats messaging is enabled

    • NATS_ADDRESS

      public static final ConfigKey<String> NATS_ADDRESS
      The address of the nats server

    • NATS_USERNAME

      public static final ConfigKey<String> NATS_USERNAME
      The username to connect with, or an empty string if it should use default

    • NATS_PASSWORD

      public static final ConfigKey<String> NATS_PASSWORD
      The password in use by the nats server, or an empty string if there is no password

    • NATS_SSL

      public static final ConfigKey<Boolean> NATS_SSL
      If the nats connection should use SSL

    • RABBITMQ_ENABLED

      public static final ConfigKey<Boolean> RABBITMQ_ENABLED
      If rabbitmq messaging is enabled

    • RABBITMQ_ADDRESS

      public static final ConfigKey<String> RABBITMQ_ADDRESS
      The address of the rabbitmq server

    • RABBITMQ_VIRTUAL_HOST

      public static final ConfigKey<String> RABBITMQ_VIRTUAL_HOST
      The virtual host to be used by the rabbitmq server

    • RABBITMQ_USERNAME

      public static final ConfigKey<String> RABBITMQ_USERNAME
      The username in use by the rabbitmq server

    • RABBITMQ_PASSWORD

      public static final ConfigKey<String> RABBITMQ_PASSWORD
      The password in use by the rabbitmq server, or an empty string if there is no password

    • EDITOR_LAZILY_GENERATE_KEY

      public static final ConfigKey<Boolean> EDITOR_LAZILY_GENERATE_KEY
      If the editor key should be generated lazily (only when needed)

    • BYTEBIN_URL

      public static final ConfigKey<String> BYTEBIN_URL
      The URL of the bytebin instance used to upload data

    • BYTESOCKS_HOST

      public static final ConfigKey<String> BYTESOCKS_HOST
      The host of the bytesocks instance used to communicate with

    • BYTESOCKS_USE_TLS

      public static final ConfigKey<Boolean> BYTESOCKS_USE_TLS
      If TLS (https/wss) should be used when connecting to bytesocks

    • WEB_EDITOR_URL_PATTERN

      public static final ConfigKey<String> WEB_EDITOR_URL_PATTERN
      The URL of the web editor

    • VERBOSE_VIEWER_URL_PATTERN

      public static final ConfigKey<String> VERBOSE_VIEWER_URL_PATTERN
      The URL of the verbose viewer

    • TREE_VIEWER_URL_PATTERN

      public static final ConfigKey<String> TREE_VIEWER_URL_PATTERN
      The URL of the tree viewer

  • Method Details

    • getKeys

      public static List<? extends ConfigKey<?>> getKeys()

    • shouldCensorValue

      public static boolean shouldCensorValue(String path)
      Check if the value at the given path should be censored in console/log output
      Parameters:
      path - the path
      Returns:
      true if the value should be censored