mine_shape

Breaks blocks in a custom 2D grid shape relative to the block the player mines.

Categories: world

Required arguments

Key(s)DescriptionType
shapeA list of strings forming a grid where 'T' is the trigger block and 'X' marks blocks to break.STRING_LIST

Optional arguments

Key(s)DescriptionTypeDefault
depthHow many layers deep to mine behind the trigger block. Supports expressions.EXPRESSION1
whitelistA list of blocks that are allowed to be broken. Defaults to all blocks.BLOCK_LIST[]
blacklisted_blocksA list of blocks that will never be broken by this effect.BLOCK_LIST[]
prevent_triggerWhether to prevent the broken blocks from re-triggering this effect.BOOLEANfalse
disable_on_sneakWhether to disable the shape mining when the player is sneaking.BOOLEANfalse
check_hardnessWhether to skip blocks harder than the trigger block. Defaults to true.BOOLEANtrue

Trigger parameters required

  • PLAYER

Example

effects:
  - id: mine_shape
    args:
      shape: 
        - "XXX"
        - "XTX"
        - "XXX"
      depth: <expression> # ← Optional
      whitelist: <value> # ← Optional
      blacklisted_blocks: <value> # ← Optional
      prevent_trigger: true # ← Optional
      disable_on_sneak: true # ← Optional
      check_hardness: true # ← Optional

Behaviour

SettingValue
Run orderNORMAL
Supports delaytrue
Reloads on plugin reloadtrue