aboutsummaryrefslogtreecommitdiffstats
path: root/docs/task-types/crafting-(task-type).md
blob: 2a664f815540e98a711a3f138a0718985e9b39a5 (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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
---
title: crafting
parent: Built-in task types
grand_parent: Task types
---

# crafting (task type)

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

Craft a set of items.

## Options

| Key           | Description                                            | Type                   | Required | Default | Notes                                                                                                                                                                                                                                                                        |
|---------------|--------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `amount`      | The number of items to craft.                          | Integer                | Yes      | \-      | \-                                                                                                                                                                                                                                                                           |
| `item`        | The specific item to craft.                            | Material, or ItemStack | Yes      | \-      | Accepts standard [item definition](../configuration/defining-items). 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. |
| `data`        | The data code for the item.                            | Integer                | No       | 0       | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions.                                                                                                                                                                         |
| `exact-match` | Whether the item should exactly match what is defined. | Boolean                | No       | true    | \-                                                                                                                                                                                                                                                                           |
| `worlds`      | Worlds which should count towards the progress.        | List of world names    | No       | \-      | \-                                                                                                                                                                                                                                                                           |

## Examples

Craft 5 of `COMPASS`:

``` yaml
compass:
  type: "crafting"
  item: COMPASS                         # name of item (can be id or minecraft name)
  amount: 5                             # amount of item needed
  data: 0                               # (OPTIONAL) data code
  worlds:                               # (OPTIONAL) restrict to certain worlds
   - "world"
```

Craft 5 of a specific item:

``` yaml
compass:
  type: "crafting"
  item:                                 # SPECIFIC item with name and lore
    name: "&cSuper Compass"
    type: "COMPASS"
    lore:
     - "&7This is special compass with a fancy name"
  amount: 5                             # amount of item needed
  worlds:                               # (OPTIONAL) restrict to certain worlds
   - "world"
```

Craft 5 of [quest item](../configuration/defining-items#quest-items)
`super_compass`:

``` yaml
compass:
  type: "crafting"
  item:                                 # USING quest-item
    quest-item: "super_compass"
  amount: 5                             # amount of item needed
  worlds:                               # (OPTIONAL) restrict to certain worlds
   - "world"
```