Skip to content

Commit

Permalink
Add bartering docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Krakenied committed Sep 11, 2024
1 parent 97e32fe commit 534831b
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/task-types/bartering-(task-type).md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: bartering
parent: Built-in task types
grand_parent: Task types
---

# bartering (task type)

Not released yet (dev builds)
{: .label .label-green }

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

Make a bartering interaction with a piglin.

## Options

| Key | Description | Type | Required | Default | Notes |
|----------------------|---------------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `amount` | The number of items. | Integer | Yes | \- | \- |
| `input` | The specific item to be picked up by a piglin. | Material, or ItemStack | No | \- | 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. |
| `input-exact-match` | Whether the input item should exactly match what is defined. | Boolean | No | true | \- |
| `output` | The specific item to be dropped by a piglin. | Material, or ItemStack | No | \- | 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. |
| `output-exact-match` | Whether the output item should exactly match what is defined. | Boolean | No | true | \- |
| `mode` | The specific mode of bartering. | String | No | output | One of: `input`, `output`. |
| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- |

## Examples

Get 100 spectral arrows for gold ingots from a piglin:

``` yaml
barter_spectral_arrows:
type: "bartering"
amount: 100 # amount of items to be dropped (with output mode) by a piglin
mode: output # (OPTIONAL) whether output or input items should count towards the progress
input: GOLD_INGOT # (OPTIONAL) the item to be picked up by a piglin
output: SPECTRAL_ARROW # (OPTIONAL) the item to be dropped by a piglin
input-exact-match: false # (OPTIONAL) we don't care about item nbt
output-exact-match: false # (OPTIONAL) we don't care about item nbt
worlds: # (OPTIONAL) restrict to certain worlds
- "world_nether"
```

0 comments on commit 534831b

Please sign in to comment.