aboutsummaryrefslogtreecommitdiffstats
path: root/docs/task-types/blockshearing-(task-type).md
blob: 7c11bc01aea57ee2310ecd3427dadca0cd96aa2c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
---
title: blockshearing
parent: Built-in task types
grand_parent: Task types
---

# blockshearing (task type)

Since v3.13.3
{: .label .label-green }

Minecraft 1.18.2+ required
{: .label .label-purple }

Paper required
{: .label .label-yellow }

Shear a set amount of blocks.

## Options

| Key      | Description                                     | Type                          | Required | Default | Notes                                                                                                                                                                                                                                                                                                                   |
|----------|-------------------------------------------------|-------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `amount` | The number of blocks to shear.                  | Integer                       | Yes      | \-      | \-                                                                                                                                                                                                                                                                                                                      |
| `block`  | The specific block(s) to shear.                 | Material, or list of material | No       | \-      | Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. Note that some items are confusingly named, they may refer to the held item or block instead of the crop block. |
| `worlds` | Worlds which should count towards the progress. | List of world names           | No       | \-      | \-                                                                                                                                                                                                                                                                                                                      |

## Examples

Carve a pumpkin:

``` yaml
blockshearing:
  type: "blockshearing"
  amount: 1                             # amount of blocks to be broken
  block: "PUMPKIN"                      # name of block
  worlds:                               # (OPTIONAL) restrict to certain worlds
   - "world"
```