blob: 73b0419f2081f48387f1e7d1bff96398f84dca61 (
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
66
67
68
69
70
71
72
73
74
75
|
---
title: inventory
parent: Built-in task types
grand_parent: Task types
---
# inventory (task type)
Since v1.4
{: .label .label-green }
Obtain a set of items.
## Options
| Key | Description | Type | Required | Default | Notes |
|------------------------------|------------------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `amount` | The number of items to obtain. | 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 | \- |
| `remove-items-when-complete` | Whether the items should be taken from the player when complete. | Boolean | No | false | If `allow-partial-completion` is true, then this will also be set to true. |
| `allow-partial-completion` | Whether any number of items counts towards the task progress. | Boolean | No | true | Setting to true will force `remove-items-when-complete` to true as well. If a player obtains any matching item, it will be immediately taken away from them and added towards the quest progress. |
| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- |
## Examples
Obtain 8 of `BEEF`:
``` yaml
beef:
type: "inventory"
item: BEEF # name of item (can be id or minecraft name)
amount: 8 # amount of item needed
data: 0 # (OPTIONAL) data code
remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false
allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true
worlds: # (OPTIONAL) restrict to certain worlds
- "world"
```
Obtain 8 of a specific item:
``` yaml
beef:
type: "inventory"
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 needed
data: 0 # (OPTIONAL) data code
remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false
allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true
worlds: # (OPTIONAL) restrict to certain worlds
- "world"
```
Obtain 8 of [quest item](../configuration/defining-items#quest-items)
`special_beef`:
``` yaml
beef:
type: "inventory"
item: # USING quest-item
quest-item: "specialbeef"
amount: 8 # amount of item needed
data: 0 # (OPTIONAL) data code
remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false
allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true
worlds: # (OPTIONAL) restrict to certain worlds
- "world"
```
|
