Class PlayerConfigOptions

java.lang.Object
xaero.pac.common.server.player.config.api.v2.PlayerConfigOptions

public class PlayerConfigOptions extends Object
An access point for all static player config option specifications/representations.

Use the client/server sided player config manager API to access the dynamic options generated based on the server config values.

  • Field Details

    • OPTIONS

      public static final Map<String,IPlayerConfigOptionSpecAPI<?>> OPTIONS
      An ID->specification map of all static player config options.
    • USED_SUBCLAIM

      public static final IPlayerConfigOptionSpecAPI<String> USED_SUBCLAIM
      The current sub-config ID that the player uses for their own new claims.
    • USED_SERVER_SUBCLAIM

      public static final IPlayerConfigOptionSpecAPI<String> USED_SERVER_SUBCLAIM
      The current sub-config ID that the player uses for new server claims.
    • USED_PARTY_SUBCLAIM

      public static final IPlayerConfigOptionSpecAPI<String> USED_PARTY_SUBCLAIM
      The current sub-config ID that the player uses for new party claims.
    • PARTY_NAME

      public static final IPlayerConfigOptionSpecAPI<String> PARTY_NAME
      The name of the player's party if they own one.
    • BONUS_CHUNK_CLAIMS

      public static final IPlayerConfigOptionSpecAPI<Integer> BONUS_CHUNK_CLAIMS
      The bonus chunk claims on top of the normal limit.
    • BONUS_CHUNK_FORCELOADS

      public static final IPlayerConfigOptionSpecAPI<Integer> BONUS_CHUNK_FORCELOADS
      The bonus chunk forceloads on top of the normal limit.
    • CLAIMS_NAME

      public static final IPlayerConfigOptionSpecAPI<String> CLAIMS_NAME
      The display name of the player's claimed chunks.
    • CLAIMS_COLOR

      public static final IPlayerConfigOptionSpecAPI<Integer> CLAIMS_COLOR
      The display color of the player's claimed chunks.
    • CUSTOM_PLAYER_GROUPS

      public static final IPlayerConfigOptionSpecAPI<List<String>> CUSTOM_PLAYER_GROUPS
      The option used to store player groups. Can't be used directly, isn't up-to-date with effective player groups.
    • BONUS_PLAYER_GROUPS

      public static final IPlayerConfigOptionSpecAPI<Integer> BONUS_PLAYER_GROUPS
      The number of bonus player groups that this player can create.
    • BONUS_PLAYER_GROUP_SPACE

      public static final IPlayerConfigOptionSpecAPI<Integer> BONUS_PLAYER_GROUP_SPACE
      The bonus player group total that this player can create. The total is the sum of sizes of all player groups.
    • PROTECT_CLAIMED_CHUNKS

      public static final IPlayerConfigOptionSpecAPI<Boolean> PROTECT_CLAIMED_CHUNKS
      Whether the player's claimed chunks are protected at all.
    • FULL_ACCESS

      public static final IPlayerConfigOptionSpecAPI<String> FULL_ACCESS
      Which player group has full access to the claimed chunks.
    • CLAIM_EXCEPTION_BLOCKS_BY_PLAYERS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_BLOCKS_BY_PLAYERS
      Whether the claimed chunk protection makes an exception for players breaking and interacting with blocks.
    • CLAIM_EXCEPTION_BLOCKS_BY_MOBS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_BLOCKS_BY_MOBS
      Whether the claimed chunk protection makes an exception for mobs breaking/placing blocks.
    • CLAIM_EXCEPTION_BLOCKS_BY_OTHER

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_BLOCKS_BY_OTHER
      Whether the claimed chunk protection makes an exception for non-living entities breaking/placing blocks.
    • CLAIM_EXCEPTION_BLOCKS_REDIRECT

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_BLOCKS_REDIRECT
      Whether the claimed chunk block protection redirects the used config option to the owner of the entity.
    • CLAIM_EXCEPTION_FIRE_SPREAD

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_FIRE_SPREAD
      Whether the claimed chunk protection makes an exception for fire spread.
    • CLAIM_EXCEPTION_FROST_WALKING

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_FROST_WALKING
      Whether the claimed chunk protection makes an exception for frost walking.
    • CLAIM_EXCEPTION_BLOCKS_BY_EXPLOSIONS

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_BLOCKS_BY_EXPLOSIONS
      Whether the claimed chunk protection makes an exception for explosions affecting blocks.
    • CLAIM_EXCEPTION_BUTTONS_BY_PROJECTILES

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_BUTTONS_BY_PROJECTILES
      Whether the claimed chunk protection makes an exception for buttons being pressed by projectiles.
    • CLAIM_EXCEPTION_TARGETS_BY_PROJECTILES

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_TARGETS_BY_PROJECTILES
      Whether the claimed chunk protection makes an exception for target blocks being pressed by projectiles.
    • CLAIM_EXCEPTION_PLATES_BY_PLAYERS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_PLATES_BY_PLAYERS
      Whether the claimed chunk protection makes an exception for pressure plates being pressed by players.
    • CLAIM_EXCEPTION_PLATES_BY_MOBS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_PLATES_BY_MOBS
      Whether the claimed chunk protection makes an exception for pressure plates being pressed by mobs.
    • CLAIM_EXCEPTION_PLATES_BY_OTHER

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_PLATES_BY_OTHER
      Whether the claimed chunk protection makes an exception for pressure plates being pressed by non-living entities.
    • CLAIM_EXCEPTION_TRIPWIRE_BY_PLAYERS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_TRIPWIRE_BY_PLAYERS
      Whether the claimed chunk protection makes an exception for tripwires being pressed by players.
    • CLAIM_EXCEPTION_TRIPWIRE_BY_MOBS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_TRIPWIRE_BY_MOBS
      Whether the claimed chunk protection makes an exception for tripwires being pressed by mobs.
    • CLAIM_EXCEPTION_TRIPWIRE_BY_OTHER

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_TRIPWIRE_BY_OTHER
      Whether the claimed chunk protection makes an exception for tripwires being pressed by non-living entities.
    • CLAIM_EXCEPTION_ENTITIES_BY_PLAYERS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_ENTITIES_BY_PLAYERS
      Whether the claimed chunk protection makes an exception for players interacting with entities.
    • CLAIM_EXCEPTION_ENTITIES_BY_MOBS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_ENTITIES_BY_MOBS
      Whether the claimed chunk protection makes an exception for mobs interacting with entities.
    • CLAIM_EXCEPTION_ENTITIES_BY_OTHER

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_ENTITIES_BY_OTHER
      Whether the claimed chunk protection makes an exception for non-living entities interacting with entities.
    • CLAIM_EXCEPTION_ENTITIES_REDIRECT

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_ENTITIES_REDIRECT
      Whether the claimed chunk entity protection redirects the used config option to the owner of the attacking entity.
    • CLAIM_EXCEPTION_ENTITIES_BY_EXPLOSIONS

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_ENTITIES_BY_EXPLOSIONS
      Whether the claimed chunk protection makes an exception for explosions affecting entities.
    • CLAIM_EXCEPTION_ENTITIES_BY_FIRE

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_ENTITIES_BY_FIRE
      Whether the claimed chunk protection makes an exception for fire hurting entities.
    • CLAIM_EXCEPTION_PLAYERS_BY_PLAYERS

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_PLAYERS_BY_PLAYERS
      Whether the claimed chunk protection makes an exception for player VS player combat.
    • CLAIM_EXCEPTION_PLAYERS_BY_MOBS

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_PLAYERS_BY_MOBS
      Whether the claimed chunk protection makes an exception for mobs attacking players.
    • CLAIM_EXCEPTION_PLAYERS_BY_OTHER

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_PLAYERS_BY_OTHER
      Whether the claimed chunk protection makes an exception for other entities attacking players.
    • CLAIM_EXCEPTION_PLAYERS_REDIRECT

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_PLAYERS_REDIRECT
      Whether the claimed chunk player protection redirects the used config option to the owner of the attacking entity.
    • CLAIM_EXCEPTION_CHORUS_FRUIT

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_CHORUS_FRUIT
      Whether the claimed chunk protection makes an exception for chorus fruit teleportation into the claim.
    • CLAIM_EXCEPTION_NETHER_PORTALS_PLAYERS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_NETHER_PORTALS_PLAYERS
      Whether the claimed chunk protection makes an exception for players using nether portals.
    • CLAIM_EXCEPTION_NETHER_PORTALS_MOBS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_NETHER_PORTALS_MOBS
      Whether the claimed chunk protection makes an exception for mobs using nether portals.
    • CLAIM_EXCEPTION_NETHER_PORTALS_OTHER

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_NETHER_PORTALS_OTHER
      Whether the claimed chunk protection makes an exception for non-living entities using nether portals.
    • CLAIM_EXCEPTION_PLAYER_LIGHTNING

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_PLAYER_LIGHTNING
      Whether the claimed chunk protection makes an exception for player-caused lightnings.
    • CLAIM_EXCEPTION_CROP_TRAMPLE

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_CROP_TRAMPLE
      Whether the claimed chunk protection makes an exception for crop trample.
    • CLAIM_FLUID_BARRIER

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_FLUID_BARRIER
      Whether the claimed chunk protection includes protection against fluids flowing into the claim.
    • CLAIM_DISPENSER_BARRIER

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_DISPENSER_BARRIER
      Whether the claimed chunk protection includes protection against directly dispensing into the claim.
    • CLAIM_PISTON_BARRIER

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_PISTON_BARRIER
      Whether the claimed chunk protection includes protection against pistons pushing into the claim.
    • CLAIM_EXCEPTION_ITEM_TOSS_PLAYERS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_ITEM_TOSS_PLAYERS
      Whether the claimed chunk protection makes an exception for items being dropped by players.
    • CLAIM_EXCEPTION_ITEM_TOSS_MOBS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_ITEM_TOSS_MOBS
      Whether the claimed chunk protection makes an exception for items being dropped by mobs.
    • CLAIM_EXCEPTION_ITEM_TOSS_OTHER

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_ITEM_TOSS_OTHER
      Whether the claimed chunk protection makes an exception for items being dropped by non-living entities.
    • CLAIM_EXCEPTION_ITEM_TOSS_REDIRECT

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_ITEM_TOSS_REDIRECT
      Whether the claimed chunk item drop protection redirects the used config option to the owner of the dropping entity.
    • CLAIM_EXCEPTION_MOB_LOOT

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_MOB_LOOT
      Whether the claimed chunk protection makes an exception for mob loot being dropped.
    • CLAIM_PROTECTION_PLAYER_DEATH_LOOT

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_PROTECTION_PLAYER_DEATH_LOOT
      Whether the claimed chunk protection makes an exception for items dropped on player death.
    • CLAIM_EXCEPTION_ITEM_PICKUP_PLAYERS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_ITEM_PICKUP_PLAYERS
      Whether the claimed chunk protection makes an exception for items being picked up by players.
    • CLAIM_EXCEPTION_ITEM_PICKUP_MOBS

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_ITEM_PICKUP_MOBS
      Whether the claimed chunk protection makes an exception for items being picked up by mobs.
    • CLAIM_EXCEPTION_ITEM_PICKUP_REDIRECT

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_ITEM_PICKUP_REDIRECT
      Whether the claimed chunk item pickup protection redirects the used config option to the owner of the entity picking up the item.
    • CLAIM_EXCEPTION_XP_PICKUP

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_XP_PICKUP
      Whether the claimed chunk protection makes an exception for experience orbs being picked up by players.
    • CLAIM_EXCEPTION_ITEM_USE

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_ITEM_USE
      Whether the claimed chunk protection makes an exception for item use.
    • CLAIM_PROTECTION_NEIGHBOR_CHUNKS_ITEM_USE

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_PROTECTION_NEIGHBOR_CHUNKS_ITEM_USE
      Whether the claimed chunk protection includes protection against at-air (or sometimes other) item use in neighbor chunks of the claim.
    • CLAIM_MOB_GRIEFING_OVERRIDE

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_MOB_GRIEFING_OVERRIDE
      Whether the claimed chunk protection options for block/entity/items override the value of the vanilla "mob griefing" game rule.
    • CLAIM_EXCEPTION_RAIDS

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_RAIDS
      Whether the claimed chunk protection makes an exception for village raids.
    • CLAIM_EXCEPTION_HOSTILE_NATURAL_SPAWN

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_HOSTILE_NATURAL_SPAWN
      Whether the claimed chunk protection makes an exception for natural spawn of hostile mobs.
    • CLAIM_EXCEPTION_FRIENDLY_NATURAL_SPAWN

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_FRIENDLY_NATURAL_SPAWN
      Whether the claimed chunk protection makes an exception for natural spawn of friendly mobs.
    • CLAIM_EXCEPTION_HOSTILE_SPAWNERS

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_HOSTILE_SPAWNERS
      Whether the claimed chunk protection disables spawners for hostile mobs.
    • CLAIM_EXCEPTION_FRIENDLY_SPAWNERS

      public static final IPlayerConfigOptionSpecAPI<Boolean> CLAIM_EXCEPTION_FRIENDLY_SPAWNERS
      Whether the claimed chunk protection disables spawners for friendly mobs.
    • CLAIM_EXCEPTION_PROJECTILE_HIT_HOSTILE_SPAWN

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_PROJECTILE_HIT_HOSTILE_SPAWN
      Whether the claimed chunk protection makes an exception for hostile mobs being spawned by landing projectiles (e.g. endermites).
    • CLAIM_EXCEPTION_PROJECTILE_HIT_FRIENDLY_SPAWN

      public static final IPlayerConfigOptionSpecAPI<String> CLAIM_EXCEPTION_PROJECTILE_HIT_FRIENDLY_SPAWN
      Whether the claimed chunk protection makes an exception for non-hostile mobs being spawned by landing projectiles (e.g. chicken).
    • FORCELOAD

      public static final IPlayerConfigOptionSpecAPI<Boolean> FORCELOAD
      Whether the player's forceloadable claims are forceloaded, at least while the player is online.
    • OFFLINE_FORCELOAD

      public static final IPlayerConfigOptionSpecAPI<Boolean> OFFLINE_FORCELOAD
      Whether the player's forceloaded claims stay forceloaded when they go offline.
    • WHOLE_PARTY_CAN_CLAIM

      public static final IPlayerConfigOptionSpecAPI<Boolean> WHOLE_PARTY_CAN_CLAIM
      Whether every player in the primary party owned by this player can claim/unclaim as the party, without any rank or permission requirement.
    • SHARE_LOCATION_WITH_PARTY

      public static final IPlayerConfigOptionSpecAPI<Boolean> SHARE_LOCATION_WITH_PARTY
      Whether the player shares their in-game location with their party.
    • SHARE_LOCATION_WITH_PARTY_MUTUAL_ALLIES

      public static final IPlayerConfigOptionSpecAPI<Boolean> SHARE_LOCATION_WITH_PARTY_MUTUAL_ALLIES
      Whether the player shares their in-game location with their party's mutual allies.
    • RECEIVE_LOCATIONS_FROM_PARTY

      public static final IPlayerConfigOptionSpecAPI<Boolean> RECEIVE_LOCATIONS_FROM_PARTY
      Whether the player receives the in-game locations shared by their fellow party members.
    • RECEIVE_LOCATIONS_FROM_PARTY_MUTUAL_ALLIES

      public static final IPlayerConfigOptionSpecAPI<Boolean> RECEIVE_LOCATIONS_FROM_PARTY_MUTUAL_ALLIES
      Whether the player receives the in-game locations shared by their party's mutual allies.
  • Constructor Details

    • PlayerConfigOptions

      public PlayerConfigOptions()