Skip to main content

Protection Checker

QuickShop uses a utility called Protection Checker to prevent players from creating shops where they do not have build access (for example, at spawn).

How does it work?​

When a player tries to create a shop, QuickShop creates a fake BlockBreakEvent to simulate the player breaking a block.
If it is canceled by any plugin, QuickShop will refuse the shop creation.

Side Effects​

Some plugins that are incompatible with QuickShop may trigger the item in the player's hand or repeatedly block shop creation.

Resolve plugin conflicts​

When QuickShop detects a possible conflict during an operation performed by a server administrator, the administrator receives a message like the one below:

detected

You can retrieve the following information from the message:

  • PluginName (BreakTest)
  • Plugin Listener Class Name (com.ghsotchu.test.breaktest.TestListener)

To resolve the conflict, configure the ignore list:

shop:
  #The listener list to skip when protection-checking.
  #Examples:
  #- xx.xxx.xxx.xxxxx.BlockBreakListenerClass
  #  This will skip calling the xx.xxx.xxx.xxxxx.BlockBreakListenerClass listener.
  #
  #- xx.xx.xxx.xxxxx
  #  This will skip calling all listener that class name start with xx.xx.xxx.xxxxx.
  #
  #- @PluginName
  #  This will skip calling all listeners registered by this plugin.
  #
  #- REGEX
  #  It also supports regex.
  protection-checking-listener-blacklist:
    - ignored_listener

You can use plugin name to block whole plugin to avoid that plugin receive our simulation events:

shop:
  protection-checking-listener-blacklist:
    - "@BreakTest"

Or only block a listener to prevent target listener catch our simulation events:

shop:
  protection-checking-listener-blacklist:
    - "com.ghsotchu.test.breaktest.TestListener"

Disable Protection Checker​

caution

We're extremely NOT-RECOMMEND you disable protection checker, bad players can use QuickShop to lock other player's chests even in Residence, Land, Island, WorldGuard Region, Town, Plot even your SpawnPoint!

To disable protection checker, you can simple turn off the option in config.yml:

shop:
  #Protection check
  #This will send a FAKE BlockBreakEvent to check if you can break a block.
  #This may conflict with some protection plugins!
  #Integration checking will be checked after this, so disable it when it's conflicting with integration
  #If you don't want this, then please disable it and use the integration below instead.
  protection-checking: true

Or only disable in specific worlds:

shop:
  #The list of worlds in which protection checking is disabled.
  protection-checking-blacklist:
    - disabled_world