diff options
Diffstat (limited to 'docs/task-types')
30 files changed, 231 insertions, 95 deletions
diff --git a/docs/task-types/blockitemdropping-(task-type).md b/docs/task-types/blockitemdropping-(task-type).md index c4deba4a..ec877687 100644 --- a/docs/task-types/blockitemdropping-(task-type).md +++ b/docs/task-types/blockitemdropping-(task-type).md @@ -24,11 +24,11 @@ This is triggered by [`BlockDropItemEvent`](https://hub.spigotmc.org/javadocs/bu | Key | Description | Type | Required | Default | Notes | |---------------|--------------------------------------------------------|--------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `amount` | The number of items. | Integer | Yes | \- | \- | -| `item` | The specific item to be dropped. | 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. | | `block` | The specific blocks to break. | Material, or list of materials | No | \- | Not specifying this field will allow all blocks to count towards the task. 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 block names. | +| `item` | The specific item to be dropped. | 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. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | | `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 diff --git a/docs/task-types/brewing-(task-type).md b/docs/task-types/brewing-(task-type).md index c5c9d56b..6bf722ee 100644 --- a/docs/task-types/brewing-(task-type).md +++ b/docs/task-types/brewing-(task-type).md @@ -20,8 +20,8 @@ Brew a set amount of potions, optionally of a specific ingredient. |---------------|--------------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `amount` | The number of potions to brew. | Integer | Yes | \- | \- | | `ingredient` | The specific ingredient to brew. | Material, or ItemStack | No | Any | 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. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | | `exact-match` | Whether the ingredient should exactly match what is defined. | Boolean | No | true | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/bucketempty-(task-type).md b/docs/task-types/bucketempty-(task-type).md index ab0b65a3..15f4bdd2 100644 --- a/docs/task-types/bucketempty-(task-type).md +++ b/docs/task-types/bucketempty-(task-type).md @@ -13,11 +13,13 @@ Empty a bucket. ## Options -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of buckets to empty. | Integer | Yes | \- | \- | -| `item` | The specific bucket to empty. | 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. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|---------------|--------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of buckets to empty. | Integer | Yes | \- | \- | +| `item` | The specific bucket to capture. | 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. | +| `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 diff --git a/docs/task-types/bucketfill-(task-type).md b/docs/task-types/bucketfill-(task-type).md index fdfd382f..b33e170c 100644 --- a/docs/task-types/bucketfill-(task-type).md +++ b/docs/task-types/bucketfill-(task-type).md @@ -13,11 +13,13 @@ Fill a bucket up. ## Options -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of buckets to fill. | Integer | Yes | \- | \- | -| `item` | The specific bucket to fill. | 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. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|---------------|--------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of buckets to fill. | Integer | Yes | \- | \- | +| `item` | The specific bucket to capture. | 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. | +| `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 diff --git a/docs/task-types/citizens_deliver-(task-type).md b/docs/task-types/citizens_deliver-(task-type).md index c4850325..0d6d85cb 100644 --- a/docs/task-types/citizens_deliver-(task-type).md +++ b/docs/task-types/citizens_deliver-(task-type).md @@ -21,12 +21,12 @@ Deliver a set of items to a Citizens NPC. | `amount` | The number of items to deliver. | Integer | Yes | \- | \- | | `item` | The specific item to deliver. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](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. | | `npc-name` | The name of the NPC to deliver to. | String | No | \- | Mutually exclusive with `npc-id`. | | `npc-id` | The id of the NPC to deliver to. | Integer | No | \- | Mutually exclusive with `npc-name`. | | `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | -| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | ## Examples diff --git a/docs/task-types/command-(task-type).md b/docs/task-types/command-(task-type).md index ab2842e0..b059673e 100644 --- a/docs/task-types/command-(task-type).md +++ b/docs/task-types/command-(task-type).md @@ -16,11 +16,12 @@ server (e.g. commands made with plugins like DeluxeMenu). ## Options -| Key | Description | Type | Required | Default | Notes | -|---------------|------------------------------------------------------|---------------------|----------|---------|-------| -| `command` | The command to execute. | String | Yes | \- | \- | -| `ignore-case` | Whether the casing of the command should be ignored. | Boolean | No | false | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|------------------------|------------------------------------------------------|----------------------------|----------|---------|-----------------------------------------------| +| `command` / `commands` | The command(s) to execute. | String, or list of strings | Yes | \- | \- | +| `ignore-case` | Whether the casing of the command should be ignored. | Boolean | No | false | \- | +| `command-match-mode` | The match mode to be used to compare the strings | String | No | EQUALS | One of: `EQUALS`, `STARTS_WITH`, `ENDS_WITH`. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/composting-(task-type).md b/docs/task-types/composting-(task-type).md new file mode 100644 index 00000000..e84fde94 --- /dev/null +++ b/docs/task-types/composting-(task-type).md @@ -0,0 +1,35 @@ +--- +title: composting +parent: Built-in task types +grand_parent: Task types +--- + +# composting (task type) + +Not released yet (dev builds) +{: .label .label-green } + +Compost a specific item. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------------|--------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to compost. | Integer | Yes | \- | \- | +| `item` | The specific item to compost. | 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. | +| `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 + +Compost 10 carrots: + +``` yaml +compostcarrots: + type: "composting" + amount: 8 # amount of items to compost + item: CARROT # (OPTIONAL) item to compost + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/consume-(task-type).md b/docs/task-types/consume-(task-type).md index e8796630..1b6d053b 100644 --- a/docs/task-types/consume-(task-type).md +++ b/docs/task-types/consume-(task-type).md @@ -18,8 +18,8 @@ Consume a specific item. | `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. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | | `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 diff --git a/docs/task-types/crafting-(task-type).md b/docs/task-types/crafting-(task-type).md index 352c2d9d..2a664f81 100644 --- a/docs/task-types/crafting-(task-type).md +++ b/docs/task-types/crafting-(task-type).md @@ -18,8 +18,8 @@ Craft a set of items. | `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. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | | `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 diff --git a/docs/task-types/customfishing_fishing-(task-type).md b/docs/task-types/customfishing_fishing-(task-type).md index f1e8e386..a767fbf3 100644 --- a/docs/task-types/customfishing_fishing-(task-type).md +++ b/docs/task-types/customfishing_fishing-(task-type).md @@ -16,11 +16,14 @@ Catch a set amount of CustomFishing loots. ## Options -| Key | Description | Type | Required | Default | Notes | -|----------|--------------------------------------|---------|----------|---------|--------------------------------------------------------------------| -| `amount` | The number of loots to catch. | Integer | Yes | \- | \- | -| `loot` | The specific loot id to catch. | String | No | \- | If this value is not specified, then any loot will count. | -| `group` | The specific group of loot to catch. | String | No | \- | If this value is not specified, then any group of loot will count. | +| Key | Description | Type | Required | Default | Notes | +|--------------------|--------------------------------------------------|---------------------|----------|---------|--------------------------------------------------------------------| +| `amount` | The number of loots to catch. | Integer | Yes | \- | \- | +| `loot` / `loots` | The specific loot id(s) to catch. | String | No | \- | If this value is not specified, then any loot will count. | +| `loot-match-mode` | The match mode to be used to compare the strings | String | No | EQUALS | One of: `EQUALS`, `STARTS_WITH`, `ENDS_WITH`. | +| `group` / `groups` | The specific group of loot to catch. | String | No | \- | If this value is not specified, then any group of loot will count. | +| `group-match-mode` | The match mode to be used to compare the strings | String | No | EQUALS | One of: `EQUALS`, `STARTS_WITH`, `ENDS_WITH`. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/dealdamage-(task-type).md b/docs/task-types/dealdamage-(task-type).md index 49d88e4c..59288c7c 100644 --- a/docs/task-types/dealdamage-(task-type).md +++ b/docs/task-types/dealdamage-(task-type).md @@ -13,10 +13,11 @@ Deal a certain amount of damage. ## Options -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|----------------------------------------------------------------------------------------------------------| -| `amount` | The amount of damage needed. | Integer | Yes | \- | Damage is measured in HP, 1 heart = 2 HP. A player has 20 HP by default, with no status effects applied. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|------------------------|-------------------------------------------------|---------------------|----------|---------|----------------------------------------------------------------------------------------------------------| +| `amount` | The amount of damage needed. | Integer | Yes | \- | Damage is measured in HP, 1 heart = 2 HP. A player has 20 HP by default, with no status effects applied. | +| `allow-only-creatures` | Whether the entity must be a creature. | Boolean | No | True | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/ecobosses_killing-(task-type).md b/docs/task-types/ecobosses_killing-(task-type).md index 472a0f7c..028ea6e2 100644 --- a/docs/task-types/ecobosses_killing-(task-type).md +++ b/docs/task-types/ecobosses_killing-(task-type).md @@ -16,11 +16,12 @@ Kill a certain number of EcoBosses bosses. ## Options -| Key | Description | Type | Required | Default | Notes | -|--------------|-------------------------------------------------|----------------------------|----------|---------|-------| -| `amount` | The number of bosses to kill. | Integer | Yes | \- | \- | -| `id` / `ids` | The EcoBosses boss ID(s). | String, or list of strings | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|-----------------|--------------------------------------------------|----------------------------|----------|---------|-----------------------------------------------| +| `amount` | The number of bosses to kill. | Integer | Yes | \- | \- | +| `id` / `ids` | The EcoBosses boss ID(s). | String, or list of strings | Yes | \- | \- | +| `id-match-mode` | The match mode to be used to compare the strings | String | No | EQUALS | One of: `EQUALS`, `STARTS_WITH`, `ENDS_WITH`. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/ecomobs_killing-(task-type).md b/docs/task-types/ecomobs_killing-(task-type).md index 04ea7224..428a16cb 100644 --- a/docs/task-types/ecomobs_killing-(task-type).md +++ b/docs/task-types/ecomobs_killing-(task-type).md @@ -16,11 +16,12 @@ Kill a certain number of EcoMobs mob. ## Options -| Key | Description | Type | Required | Default | Notes | -|--------------|-------------------------------------------------|----------------------------|----------|---------|-------| -| `amount` | The number of bosses to kill. | Integer | Yes | \- | \- | -| `id` / `ids` | The EcoMobs boss ID(s). | String, or list of strings | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|-----------------|--------------------------------------------------|----------------------------|----------|---------|-----------------------------------------------| +| `amount` | The number of bosses to kill. | Integer | Yes | \- | \- | +| `id` / `ids` | The EcoMobs boss ID(s). | String, or list of strings | Yes | \- | \- | +| `id-match-mode` | The match mode to be used to compare the strings | String | No | EQUALS | One of: `EQUALS`, `STARTS_WITH`, `ENDS_WITH`. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/hatching-(task-type).md b/docs/task-types/hatching-(task-type).md index 3c895cd1..8ef3388a 100644 --- a/docs/task-types/hatching-(task-type).md +++ b/docs/task-types/hatching-(task-type).md @@ -19,11 +19,11 @@ Hatch a set amount of entities of certain types. ## Options -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|----------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of entities to hatch. | Integer | Yes | \- | \- | -| `mob` | The specific entity type(s) to hatch. | Entity type, or list of entities | No | \- | Not specifying this field will allow all entity types to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) for entity types. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|----------------|-------------------------------------------------|----------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of entities to hatch. | Integer | Yes | \- | \- | +| `mob` / `mobs` | The specific entity type(s) to hatch. | Entity type, or list of entities | No | \- | Not specifying this field will allow all entity types to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) for entity types. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/interact-(task-type).md b/docs/task-types/interact-(task-type).md new file mode 100644 index 00000000..61f0ca9d --- /dev/null +++ b/docs/task-types/interact-(task-type).md @@ -0,0 +1,43 @@ +--- +title: interact +parent: Built-in task types +grand_parent: Task types +--- + +# interact (task type) + +Since v3.13.2 +{: .label .label-green } + +Interact with an item a certain amount of times. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------------------------------------------------------------|-----------------------------------------------------------|-------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of interactions. | Integer | Yes | \- | \- | +| `item` | The specific item to be used while interacting. | 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. | +| `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 | \- | +| `block` / `blocks` | The specific block(s) to interact with. | Material, or list of material | No | \- | Not specifying this field will allow all blocks to count towards the task. 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. | +| `action` / `actions` | The specific interact action(s). | Action, or list of actions | No | \- | Not specifying this field will allow all actions to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/event/block/Action.html) for action names. | +| `hand` / `hands` | The specific hand(s) to interact with. | Hand, or list of hands | No | \- | Not specifying this field will allow all hands to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/EquipmentSlot.html) for hand names. | +| `use-interacted-block-result` / `use-interacted-block-results` | The specific block use result(s) of the interaction event | Result, or list of results | No | \- | Not specifying this field will allow all results except DENY to count towards the task (in most setups it's the proper option). | +| `use-item-in-hand-result` / `use-item-in-hand-results` | The specific item use result(s) of the interaction event | Result, or list of results | No | \- | Not specifying this field will allow all results to count towards the task (in most setups it's the proper option). | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Right click sand with a diamond pickaxe 100 times: + +``` yaml +interact_example_task: + type: "interact" + block: "SAND" # (OPTIONAL) block to be clicked + action: RIGHT_CLICK_BLOCK # (OPTIONAL) the action the player have to perform with the item and block + item: DIAMOND_PICKAXE # (OPTIONAL) the item player have to interact with the sand with + exact-match: false # (OPTIONAL) ignore diamond pickaxe nbt + amount: 100 # amount of interactions needed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/inventory-(task-type).md b/docs/task-types/inventory-(task-type).md index ae365d16..73b0419f 100644 --- a/docs/task-types/inventory-(task-type).md +++ b/docs/task-types/inventory-(task-type).md @@ -19,10 +19,10 @@ Obtain a set of items. | `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 | \- | \- | -| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | ## Examples diff --git a/docs/task-types/milking-(task-type).md b/docs/task-types/milking-(task-type).md index 5f4aee53..8a20f90d 100644 --- a/docs/task-types/milking-(task-type).md +++ b/docs/task-types/milking-(task-type).md @@ -13,12 +13,12 @@ Milk a set amount of cows. ## Options -| Key | Description | Type | Required | Default | Notes | -|----------------|-------------------------------------------------|----------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of mobs to milk. | Integer | Yes | \- | \- | -| `mob` | The specific mob(s) to milk. | Entity type, or list of entity types | No | \- | Not specifying this field will allow all mob types to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) for entity types. | -| `spawn-reason` | The specific spawn reason(s) of mobs to milk. | Spawn reason, or list of spawn reasons | No | \- | Works only on Paper and its forks. Not specifying this field will allow mobs with any spawn reasons to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.SpawnReason.html) for spawn reasons. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|----------------------------------|-------------------------------------------------|----------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of mobs to milk. | Integer | Yes | \- | \- | +| `mob` / `mobs` | The specific mob(s) to milk. | Entity type, or list of entity types | No | \- | Not specifying this field will allow all mob types to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) for entity types. | +| `spawn-reason` / `spawn-reasons` | The specific spawn reason(s) of mobs to milk. | Spawn reason, or list of spawn reasons | No | \- | Works only on Paper and its forks. Not specifying this field will allow mobs with any spawn reasons to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.SpawnReason.html) for spawn reasons. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/mobkilling-(task-type).md b/docs/task-types/mobkilling-(task-type).md index e6c93a5c..5288ff54 100644 --- a/docs/task-types/mobkilling-(task-type).md +++ b/docs/task-types/mobkilling-(task-type).md @@ -20,16 +20,18 @@ merged into one. Both names can be used to refer to this task. ## Options -| Key | Description | Type | Required | Default | Notes | -|----------------|--------------------------------------------------------|----------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of mobs to kill. | Integer | Yes | \- | \- | -| `mob` | The specific mob(s) to kill. | Entity type, or list of entity types | No | \- | Not specifying this field will allow all mob types to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) for entity types. | -| `name` | The specific name(s) of mobs to kill. | String, or list of strings | No | \- | Not specifying this field will allow mobs with any names to count towards the task. Ensure any colour codes in the name of the entity are specified, otherwise the match will not work. | -| `spawn-reason` | The specific spawn reason(s) of mobs to kill. | Spawn reason, or list of spawn reasons | No | \- | Works only on Paper and its forks. Not specifying this field will allow mobs with any spawn reasons to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.SpawnReason.html) for spawn reasons. | -| `hostile` | Whether the mob must be hostile. | Boolean | No | \- | If specified and set to false, only non-hostile mobs will count. | -| `item` | Specific item which should be used to kill mobs. | ItemStack | No | \- | Accepts standard [item definition](../configuration/defining-items). | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | -| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | +| Key | Description | Type | Required | Default | Notes | +|----------------------------------|--------------------------------------------------------|----------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of mobs to kill. | Integer | Yes | \- | \- | +| `mob` / `mobs` | The specific mob(s) to kill. | Entity type, or list of entity types | No | \- | Not specifying this field will allow all mob types to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) for entity types. | +| `name` / `names` | The specific name(s) of mobs to kill. | String, or list of strings | No | \- | Not specifying this field will allow mobs with any names to count towards the task. Ensure any colour codes in the name of the entity are specified, otherwise the match will not work. | +| `name-match-mode` | The match mode to be used to compare the strings | String | No | EQUALS | One of: `EQUALS`, `STARTS_WITH`, `ENDS_WITH`. | +| `spawn-reason` / `spawn-reasons` | The specific spawn reason(s) of mobs to kill. | Spawn reason, or list of spawn reasons | No | \- | Works only on Paper and its forks. Not specifying this field will allow mobs with any spawn reasons to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.SpawnReason.html) for spawn reasons. | +| `hostile` | Whether the mob must be hostile. | Boolean | No | \- | If specified and set to false, only non-hostile mobs will count. | +| `item` | Specific item which should be used to kill mobs. | ItemStack | No | \- | Accepts standard [item definition](../configuration/defining-items). | +| `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 diff --git a/docs/task-types/mythicmobs_killing-(task-type).md b/docs/task-types/mythicmobs_killing-(task-type).md index 83b686b1..d7cd5a2f 100644 --- a/docs/task-types/mythicmobs_killing-(task-type).md +++ b/docs/task-types/mythicmobs_killing-(task-type).md @@ -16,13 +16,14 @@ Kill a certain MythicMobs mob. ## Options -| Key | Description | Type | Required | Default | Notes | -|-------------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The number of mobs to kill. | Integer | Yes | \- | \- | -| `name` | The MythicMob ID. | String | Yes | \- | \- | -| `level` | The level the mob must be at. | Integer | Yes | \- | \- | -| `min-level` | The minimum level the mob must be at. | Integer | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|-------------------|--------------------------------------------------|---------------------|----------|---------|-----------------------------------------------| +| `amount` | The number of mobs to kill. | Integer | Yes | \- | \- | +| `name` / `names` | The MythicMob ID. | String | Yes | \- | \- | +| `name-match-mode` | The match mode to be used to compare the strings | String | No | EQUALS | One of: `EQUALS`, `STARTS_WITH`, `ENDS_WITH`. | +| `level` | The level the mob must be at. | Integer | Yes | \- | \- | +| `min-level` | The minimum level the mob must be at. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/pyrofishingpro_fishing-(task-type).md b/docs/task-types/pyrofishingpro_fishing-(task-type).md index 40e98966..864e5a36 100644 --- a/docs/task-types/pyrofishingpro_fishing-(task-type).md +++ b/docs/task-types/pyrofishingpro_fishing-(task-type).md @@ -16,11 +16,12 @@ Catch a set amount of a Pyro fish from the sea. ## Options -| Key | Description | Type | Required | Default | Notes | -|---------------|-------------------------------------|---------|----------|---------|-------------------------------------------------------------------| -| `amount` | The number of Pyro fish to catch. | Integer | Yes | \- | \- | -| `fish-number` | The specific fish number to catch. | Integer | No | \- | If this value is not specified, then any fish will count. | -| `tier` | The specific tier of fish to catch. | String | No | \- | If this value is not specified, then any tier of fish will count. | +| Key | Description | Type | Required | Default | Notes | +|---------------|-------------------------------------------------|---------------------|----------|---------|-------------------------------------------------------------------| +| `amount` | The number of Pyro fish to catch. | Integer | Yes | \- | \- | +| `fish-number` | The specific fish number to catch. | Integer | No | \- | If this value is not specified, then any fish will count. | +| `tier` | The specific tier of fish to catch. | String | No | \- | If this value is not specified, then any tier of fish will count. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/replenishing-(task-type).md b/docs/task-types/replenishing-(task-type).md index 3d7c1b65..208e954a 100644 --- a/docs/task-types/replenishing-(task-type).md +++ b/docs/task-types/replenishing-(task-type).md @@ -17,9 +17,9 @@ Replenish a set amount of certain blocks or entities. | Key | Description | Type | Required | Default | Notes | |--------------------|-------------------------------------------------|----------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `amount` | The number of sheep to shear. | Integer | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | | `block` / `blocks` | The specific block(s) to replenish. | Material, or list of material | No | \- | Not specifying this field will allow all blocks to count towards the task. 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. | | `mob` / `mobs` | The specific mob(s) to replenish. | Entity type, or list of entities | No | \- | Not specifying this field will allow all mob types to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) for entity types. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/servernpc_deliver-(task-type).md b/docs/task-types/servernpc_deliver-(task-type).md index 1d37e3a2..b2449f7e 100644 --- a/docs/task-types/servernpc_deliver-(task-type).md +++ b/docs/task-types/servernpc_deliver-(task-type).md @@ -21,12 +21,12 @@ Deliver a set of items to a ServerNPC NPC. | `amount` | The number of items to deliver. | Integer | Yes | \- | \- | | `item` | The specific item to deliver. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](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. | | `npc-name` | The name of the NPC to deliver to. | String | No | \- | Mutually exclusive with `npc-id`. | | `npc-id` | The id of the NPC to deliver to. | Integer | No | \- | Mutually exclusive with `npc-name`. | | `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | -| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | ## Examples diff --git a/docs/task-types/shearing-(task-type).md b/docs/task-types/shearing-(task-type).md index 299f646f..22047d22 100644 --- a/docs/task-types/shearing-(task-type).md +++ b/docs/task-types/shearing-(task-type).md @@ -17,9 +17,9 @@ Shear a set amount of colorables (colourables) or shearables. | Key | Description | Type | Required | Default | Notes | |--------------------|-------------------------------------------------|----------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `amount` | The number of sheep to shear. | Integer | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | | `color` / `colors` | The specific color(s) to shear. | Color / list of colors | No | \- | Not specifying this field will allow all colors to count towards this task. For a list of valid colors, visit [this page](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/DyeColor.html). | | `mob` / `mobs` | The specific mob(s) to shear. | Entity type, or list of entities | No | \- | Not specifying this field will allow all mob types to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) for entity types. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/shopguiplus_buy-(task-type).md b/docs/task-types/shopguiplus_buy-(task-type).md index c84662dd..564fd3cc 100644 --- a/docs/task-types/shopguiplus_buy-(task-type).md +++ b/docs/task-types/shopguiplus_buy-(task-type).md @@ -20,11 +20,12 @@ been merged into one. Both names can be used to refer to this task. ## Options -| Key | Description | Type | Required | Default | Notes | -|-----------|-----------------------------|---------|----------|---------|-------| -| `amount` | The number of items to buy. | Integer | Yes | \- | \- | -| `shop-id` | The ID of the shop. | String | Yes | \- | \- | -| `item-id` | The ID of the item to buy. | String | Yes | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|-----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of items to buy. | Integer | Yes | \- | \- | +| `shop-id` | The ID of the shop. | String | Yes | \- | \- | +| `item-id` | The ID of the item to buy. | String | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/shopguiplus_sell-(task-type).md b/docs/task-types/shopguiplus_sell-(task-type).md index 082da6e2..dc0145aa 100644 --- a/docs/task-types/shopguiplus_sell-(task-type).md +++ b/docs/task-types/shopguiplus_sell-(task-type).md @@ -20,11 +20,12 @@ have been merged into one. Both names can be used to refer to this task. ## Options -| Key | Description | Type | Required | Default | Notes | -|-----------|------------------------------|---------|----------|---------|-------| -| `amount` | The number of items to sell. | Integer | Yes | \- | \- | -| `shop-id` | The ID of the shop. | String | Yes | \- | \- | -| `item-id` | The ID of the item to sell. | String | Yes | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|-----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of items to sell. | Integer | Yes | \- | \- | +| `shop-id` | The ID of the shop. | String | Yes | \- | \- | +| `item-id` | The ID of the item to sell. | String | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/smelting-(task-type).md b/docs/task-types/smelting-(task-type).md index 7a68744b..495e4fee 100644 --- a/docs/task-types/smelting-(task-type).md +++ b/docs/task-types/smelting-(task-type).md @@ -21,9 +21,10 @@ into one. Both names can be used to refer to this task. |---------------|--------------------------------------------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `amount` | The number of items to smelt. | Integer | Yes | \- | \- | | `item` | The specific item to smelt. | 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. If this is not specified, any item will count. | +| `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 | \- | | `mode` | The specific mode of smelting. | String | No | \- | One of: `smoker`, `blast_furnace`, `furnace`. If this is not specified, any furnace will count. | | `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | -| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | ## Examples diff --git a/docs/task-types/smithing-(task-type).md b/docs/task-types/smithing-(task-type).md index 7379c138..21704991 100644 --- a/docs/task-types/smithing-(task-type).md +++ b/docs/task-types/smithing-(task-type).md @@ -20,9 +20,9 @@ Smith a certain number of items using a smithing table. |---------------|--------------------------------------------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `amount` | The number of items to smith. | Integer | Yes | \- | \- | | `item` | The specific item to smith. | 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. If this is not specified, any item will count. | +| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | | `mode` | The specific mode of smithing. | String | 1.20+ | \- | One of: `any`, `transform`, `trim`. | | `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | -| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | ## Examples diff --git a/docs/task-types/trading-(task-type).md b/docs/task-types/trading-(task-type).md new file mode 100644 index 00000000..fb63949a --- /dev/null +++ b/docs/task-types/trading-(task-type).md @@ -0,0 +1,40 @@ +--- +title: trading +parent: Built-in task types +grand_parent: Task types +--- + +# trading (task type) + +Not released yet (dev builds) +{: .label .label-green } + +Minecraft 1.16+ required +{: .label .label-purple } + +Paper required +{: .label .label-yellow } + +Trade with a Villager or Wandering Trader. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------------|--------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to trade. | Integer | Yes | \- | \- | +| `item` | The specific item to trade. | 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. | +| `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 + +Buy 10 carrots from a Villager: + +``` yaml +tradecarrots: + type: "trading" + amount: 10 # amount of items to trade + item: CARROT # (OPTIONAL) item to trade + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/walking-(task-type).md b/docs/task-types/walking-(task-type).md index 83a8f524..2b819e61 100644 --- a/docs/task-types/walking-(task-type).md +++ b/docs/task-types/walking-(task-type).md @@ -13,11 +13,11 @@ Walk a set distance. ## Options -| Key | Description | Type | Required | Default | Notes | -|------------|-------------------------------------------------|---------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `distance` | The distance in metres to walk. | Integer | Yes | \- | 1 metre is equivalent to 1 block. | -| `mode` | The specific mode to travel | String | No | \- | One of: `boat`, `horse`, `pig`, `minecart` `strider`, `sneaking`, `walking`, `running`, `swimming`, `flying`, `elytra`. Not specifying a mode will allow any of these modes to count. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|------------|-------------------------------------------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `distance` | The distance in metres to walk. | Integer | Yes | \- | 1 metre is equivalent to 1 block. | +| `mode` | The specific mode to travel | String | No | \- | One of: `boat`, `camel`, `donkey`, `horse`, `llama`, `minecart`, `mule`, `pig`, `skeleton_horse`, `strider`, `zombie_horse`, `sneaking`, `walking`, `running`, `swimming`, `flying`, `elytra`. Not specifying a mode will allow any of these modes to count. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/znpcsplus_deliver-(task-type).md b/docs/task-types/znpcsplus_deliver-(task-type).md index 074439ed..7bb168dc 100644 --- a/docs/task-types/znpcsplus_deliver-(task-type).md +++ b/docs/task-types/znpcsplus_deliver-(task-type).md @@ -21,12 +21,12 @@ Deliver a set of items to a ZNPCsPlus NPC. | `amount` | The number of items to deliver. | Integer | Yes | \- | \- | | `item` | The specific item to deliver. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](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. | | `npc-name` | The name of the NPC to deliver to. | String | No | \- | Mutually exclusive with `npc-id`. | | `npc-id` | The id of the NPC to deliver to. | Integer | No | \- | Mutually exclusive with `npc-name`. | | `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | -| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | ## Examples |