blob: 1b6d053b808fdb34c77d4f463b36764311126fed (
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
65
|
---
title: consume
parent: Built-in task types
grand_parent: Task types
---
# consume (task type)
Since v3.9
{: .label .label-green }
Consume a specific item.
## Options
| Key | Description | Type | Required | Default | Notes |
|---------------|--------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `amount` | The number of items to consume. | Integer | Yes | \- | \- |
| `item` | The specific item to obtain. | 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
Consume 8 of `BEEF`:
``` yaml
beef:
type: "consume"
item: BEEF # name of item (can be id or minecraft name)
amount: 8 # amount of item consumed
data: 0 # (OPTIONAL) data code
worlds: # (OPTIONAL) restrict to certain worlds
- "world"
```
Consume 8 of a specific item:
``` yaml
beef:
type: "consume"
item: # SPECIFIC item with name and lore
name: "&cSpecial Beef"
type: "RAW_BEEF"
lore:
- "&7This is a special type of beef"
amount: 8 # amount of item consumed
worlds: # (OPTIONAL) restrict to certain worlds
- "world"
```
Consume 8 of [quest item](../configuration/defining-items#quest-items)
`special_beef`:
``` yaml
beef:
type: "consume"
item: # USING quest-item
quest-item: "special_beef"
amount: 8 # amount of item needed
remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false
worlds: # (OPTIONAL) restrict to certain worlds
- "world"
```
|
