diff options
| author | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-06 21:15:05 +0100 |
|---|---|---|
| committer | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-06 21:15:05 +0100 |
| commit | fb1dda5b78646f6a2775efe963d6c1ed05f5f32c (patch) | |
| tree | 964acb78f1a5c410cbce5381a7d2913cb5971036 /docs/task-types | |
| parent | a5395de0b13d1f9f063558acd65de1c649fd0c8d (diff) | |
Add missing task types to documentation
Adds blockshearing, playerpoints_earn, replenishing, smithing,
and missing options in other task types.
Diffstat (limited to 'docs/task-types')
49 files changed, 369 insertions, 148 deletions
diff --git a/docs/task-types/askyblock_level-(task-type).md b/docs/task-types/askyblock_level-(task-type).md index 823a79a6..9753138f 100644 --- a/docs/task-types/askyblock_level-(task-type).md +++ b/docs/task-types/askyblock_level-(task-type).md @@ -1,7 +1,7 @@ --- title: askyblock_level -parent: Task types -nav_order: 27 +parent: External task types +grand_parent: Task types --- # askyblock_level (task type) diff --git a/docs/task-types/bentobox_level-(task-type).md b/docs/task-types/bentobox_level-(task-type).md index 933ee21d..048e8a5f 100644 --- a/docs/task-types/bentobox_level-(task-type).md +++ b/docs/task-types/bentobox_level-(task-type).md @@ -1,7 +1,7 @@ --- title: bentobox_level -parent: Task types -nav_order: 28 +parent: External task types +grand_parent: Task types --- # bentobox_level (task type) diff --git a/docs/task-types/blockbreak-(task-type).md b/docs/task-types/blockbreak-(task-type).md index 66595b5a..2ec16687 100644 --- a/docs/task-types/blockbreak-(task-type).md +++ b/docs/task-types/blockbreak-(task-type).md @@ -1,7 +1,7 @@ --- title: blockbreak -parent: Task types -nav_order: 1 +parent: Built-in task types +grand_parent: Task types --- # blockbreak (task type) @@ -17,15 +17,16 @@ merged into one. Both names can be used to refer to this task. ## Options -| Key | Description | Type | Required | Default | Notes | -|--------------------------|------------------------------------------------------------------------------------------------|--------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of blocks to break. | Integer | Yes | \- | \- | -| `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. | -| `data` | The data code for the block. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with lists of blocks. | -| `reverse-if-placed` | Whether placing blocks should decrement from the quest progress. | Boolean | No | false | This allows negative quest progresses. | -| `check-coreprotect` | Whether the plugin should query CoreProtect if a block has been recently placed. | Boolean | No | false | This requires the CoreProtect plugin. | -| `check-coreprotect-time` | How long ago (in seconds) the plugin should check with CoreProtect whether a block was placed. | Integer | No | \- | This requires the CoreProtect plugin. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|----------------------------|------------------------------------------------------------------------------------------------|--------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of blocks to break. | Integer | Yes | \- | \- | +| `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. | +| `data` | The data code for the block. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with lists of blocks. | +| `reverse-if-placed` | Whether placing blocks should decrement from the quest progress. | Boolean | No | false | This allows negative quest progresses. | +| `check-coreprotect` | Whether the plugin should query CoreProtect if a block has been recently placed. | Boolean | No | false | This requires the CoreProtect plugin. | +| `check-coreprotect-time` | How long ago (in seconds) the plugin should check with CoreProtect whether a block was placed. | Integer | No | \- | This requires the CoreProtect plugin. | +| `check-playerblocktracker` | Whether the plugin should query PlayerBlockTracker if a block has been recently placed. | Boolean | No | false | This requires the PlayerBlockTracker plugin. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/blockplace-(task-type).md b/docs/task-types/blockplace-(task-type).md index e39538c8..16957040 100644 --- a/docs/task-types/blockplace-(task-type).md +++ b/docs/task-types/blockplace-(task-type).md @@ -1,7 +1,7 @@ --- title: blockplace -parent: Task types -nav_order: 2 +parent: Built-in task types +grand_parent: Task types --- # blockplace (task type) @@ -23,6 +23,7 @@ merged into one. Both names can be used to refer to this task. | `block` | The specific blocks to place. | 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. | | `data` | The data code for the block. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with lists of blocks. | | `reverse-if-broken` | Whether breaking blocks should decrement from the quest progress. | Boolean | No | false | This allows negative quest progresses. | +| `allow-silk-touch` | Whether mining a block with a silk touch pickaxe should count. | Boolean | No | true | \- | | `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/blockshearing-(task-type).md b/docs/task-types/blockshearing-(task-type).md new file mode 100644 index 00000000..7c11bc01 --- /dev/null +++ b/docs/task-types/blockshearing-(task-type).md @@ -0,0 +1,39 @@ +--- +title: blockshearing +parent: Built-in task types +grand_parent: Task types +--- + +# blockshearing (task type) + +Since v3.13.3 +{: .label .label-green } + +Minecraft 1.18.2+ required +{: .label .label-purple } + +Paper required +{: .label .label-yellow } + +Shear a set amount of blocks. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|-------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of blocks to shear. | Integer | Yes | \- | \- | +| `block` | The specific block(s) to shear. | Material, or list of material | No | \- | 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. Note that some items are confusingly named, they may refer to the held item or block instead of the crop block. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Carve a pumpkin: + +``` yaml +blockshearing: + type: "blockshearing" + amount: 1 # amount of blocks to be broken + block: "PUMPKIN" # name of block + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/breeding-(task-type).md b/docs/task-types/breeding-(task-type).md index 66459f7d..589f36d3 100644 --- a/docs/task-types/breeding-(task-type).md +++ b/docs/task-types/breeding-(task-type).md @@ -1,7 +1,7 @@ --- title: breeding -parent: Task types -nav_order: 3 +parent: Built-in task types +grand_parent: Task types --- # breeding (task type) diff --git a/docs/task-types/brewing-(task-type).md b/docs/task-types/brewing-(task-type).md index 312e3dfb..65279b23 100644 --- a/docs/task-types/brewing-(task-type).md +++ b/docs/task-types/brewing-(task-type).md @@ -1,7 +1,7 @@ --- title: brewing -parent: Task types -nav_order: 4 +parent: Built-in task types +grand_parent: Task types --- # brewing (task type) @@ -9,14 +9,19 @@ nav_order: 4 Since v2.0.13 {: .label .label-green } -Brew a set amount of potions. +Minecraft 1.17+ required +{: .label .label-purple } + +Brew a set amount of potions, optionally of a specific ingredient. ## Options -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The number of potions to brew. | 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 potions to brew. | Integer | Yes | \- | \- | +| `ingredient` | The specific ingredient to brew. | Material, or ItemStack | No | Any | Accepts standard [item definition](defining_items "wikilink"). 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 | \- | ## Examples @@ -29,3 +34,14 @@ brewing: worlds: # (OPTIONAL) restrict to certain worlds - "world" ``` + +Brew 8 potions using sugar: + +``` yaml +brewing: + type: "brewing" + ingredient: "sugar" + amount: 10 # amount of potions brewed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/bucketempty-(task-type).md b/docs/task-types/bucketempty-(task-type).md index 49806d17..8f434793 100644 --- a/docs/task-types/bucketempty-(task-type).md +++ b/docs/task-types/bucketempty-(task-type).md @@ -1,7 +1,7 @@ --- title: bucketempty -parent: Task types -nav_order: 5 +parent: Built-in task types +grand_parent: Task types --- # bucketempty (task type) diff --git a/docs/task-types/bucketfill-(task-type).md b/docs/task-types/bucketfill-(task-type).md index 3648d06e..85e9b3f1 100644 --- a/docs/task-types/bucketfill-(task-type).md +++ b/docs/task-types/bucketfill-(task-type).md @@ -1,7 +1,7 @@ --- title: bucketfill -parent: Task types -nav_order: 6 +parent: Built-in task types +grand_parent: Task types --- # bucketfill (task type) diff --git a/docs/task-types/built-in-task-types.md b/docs/task-types/built-in-task-types.md new file mode 100644 index 00000000..2215b3f2 --- /dev/null +++ b/docs/task-types/built-in-task-types.md @@ -0,0 +1,13 @@ +--- +title: Built-in task types +parent: Task types +nav_order: 1 +has_children: true +--- + +# Built-in task types + +**Built-in task types** come with the plugin and are readily available out of the box. + +{: .note } +These were previously called *non-dependent task types*.
\ No newline at end of file diff --git a/docs/task-types/citizens_deliver-(task-type).md b/docs/task-types/citizens_deliver-(task-type).md index bc3cb6f3..e82031a6 100644 --- a/docs/task-types/citizens_deliver-(task-type).md +++ b/docs/task-types/citizens_deliver-(task-type).md @@ -1,7 +1,7 @@ --- title: citizens_deliver -parent: Task types -nav_order: 29 +parent: External task types +grand_parent: Task types --- # citizens_deliver (task type) @@ -16,16 +16,17 @@ Deliver a set of items to a Citizens NPC. ## Options -| Key | Description | Type | Required | Default | Notes | -|------------------------------|------------------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of items to deliver. | Integer | Yes | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|------------------------------|------------------------------------------------------------------|------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `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. | -| `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. | Boolean | No | \- | Mutually exclusive with `npc-id`. | -| `npc-id` | The id of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-name`. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| `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. | +| `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. | Boolean | No | \- | Mutually exclusive with `npc-id`. | +| `npc-id` | The id of the NPC to deliver to. | Boolean | 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/citizens_interact-(task-type).md b/docs/task-types/citizens_interact-(task-type).md index f25e9844..34453aac 100644 --- a/docs/task-types/citizens_interact-(task-type).md +++ b/docs/task-types/citizens_interact-(task-type).md @@ -1,7 +1,7 @@ --- title: citizens_interact -parent: Task types -nav_order: 30 +parent: External task types +grand_parent: Task types --- # citizens_interact (task type) diff --git a/docs/task-types/command-(task-type).md b/docs/task-types/command-(task-type).md index 4e2d426f..ab2842e0 100644 --- a/docs/task-types/command-(task-type).md +++ b/docs/task-types/command-(task-type).md @@ -1,7 +1,7 @@ --- title: command -parent: Task types -nav_order: 7 +parent: Built-in task types +grand_parent: Task types --- # command (task type) diff --git a/docs/task-types/consume-(task-type).md b/docs/task-types/consume-(task-type).md index a5e23d13..d298e6c6 100644 --- a/docs/task-types/consume-(task-type).md +++ b/docs/task-types/consume-(task-type).md @@ -1,7 +1,7 @@ --- title: consume -parent: Task types -nav_order: 8 +parent: Built-in task types +grand_parent: Task types --- # consume (task type) @@ -13,12 +13,13 @@ 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](defining_items "wikilink"). 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 | \- | \- | +| 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](defining_items "wikilink"). 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 | \- | ## Examples diff --git a/docs/task-types/crafting-(task-type).md b/docs/task-types/crafting-(task-type).md index 14c9e8fb..dd2f03e7 100644 --- a/docs/task-types/crafting-(task-type).md +++ b/docs/task-types/crafting-(task-type).md @@ -1,7 +1,7 @@ --- title: crafting -parent: Task types -nav_order: 9 +parent: Built-in task types +grand_parent: Task types --- # crafting (task type) @@ -13,12 +13,13 @@ 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](defining_items "wikilink"). 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 | \- | \- | +| 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](defining_items "wikilink"). 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 | \- | ## Examples diff --git a/docs/task-types/dealdamage-(task-type).md b/docs/task-types/dealdamage-(task-type).md index 426f76e2..49d88e4c 100644 --- a/docs/task-types/dealdamage-(task-type).md +++ b/docs/task-types/dealdamage-(task-type).md @@ -1,7 +1,7 @@ --- title: dealdamage -parent: Task types -nav_order: 10 +parent: Built-in task types +grand_parent: Task types --- # dealdamage (task type) diff --git a/docs/task-types/distancefrom-(task-type).md b/docs/task-types/distancefrom-(task-type).md index 5c0e8305..c50b47db 100644 --- a/docs/task-types/distancefrom-(task-type).md +++ b/docs/task-types/distancefrom-(task-type).md @@ -1,7 +1,7 @@ --- title: distancefrom -parent: Task types -nav_order: 11 +parent: Built-in task types +grand_parent: Task types --- # distancefrom (task type) diff --git a/docs/task-types/enchanting-(task-type).md b/docs/task-types/enchanting-(task-type).md index 1e2b6c80..58874434 100644 --- a/docs/task-types/enchanting-(task-type).md +++ b/docs/task-types/enchanting-(task-type).md @@ -1,7 +1,7 @@ --- title: enchanting -parent: Task types -nav_order: 12 +parent: Built-in task types +grand_parent: Task types --- # enchanting (task type) diff --git a/docs/task-types/essentials_balance-(task-type).md b/docs/task-types/essentials_balance-(task-type).md index 6d246376..07bd24ad 100644 --- a/docs/task-types/essentials_balance-(task-type).md +++ b/docs/task-types/essentials_balance-(task-type).md @@ -1,7 +1,7 @@ --- title: essentials_balance -parent: Task types -nav_order: 31 +parent: External task types +grand_parent: Task types --- # essentials_balance (task type) diff --git a/docs/task-types/essentials_moneyearn-(task-type).md b/docs/task-types/essentials_moneyearn-(task-type).md index eba692fa..b29759f8 100644 --- a/docs/task-types/essentials_moneyearn-(task-type).md +++ b/docs/task-types/essentials_moneyearn-(task-type).md @@ -1,7 +1,7 @@ --- title: essentials_moneyearn -parent: Task types -nav_order: 32 +parent: External task types +grand_parent: Task types --- # essentials_moneyearn (task type) diff --git a/docs/task-types/expearn-(task-type).md b/docs/task-types/expearn-(task-type).md index 86cbf5ca..a7e06121 100644 --- a/docs/task-types/expearn-(task-type).md +++ b/docs/task-types/expearn-(task-type).md @@ -1,7 +1,7 @@ --- title: expearn -parent: Task types -nav_order: 13 +parent: Built-in task types +grand_parent: Task types --- # expearn (task type) diff --git a/docs/task-types/external-task-types.md b/docs/task-types/external-task-types.md new file mode 100644 index 00000000..d2c8c50a --- /dev/null +++ b/docs/task-types/external-task-types.md @@ -0,0 +1,13 @@ +--- +title: External task types +parent: Task types +nav_order: 2 +has_children: true +--- + +# External task types + +**External task types** integrate with other plugins and are only loaded if Quests detects a dependency. + +{: .note } +These were previously called **dependent task types**. diff --git a/docs/task-types/fabledskyblock_level-(task-type).md b/docs/task-types/fabledskyblock_level-(task-type).md index eecf2dc0..a23c7f1d 100644 --- a/docs/task-types/fabledskyblock_level-(task-type).md +++ b/docs/task-types/fabledskyblock_level-(task-type).md @@ -1,7 +1,7 @@ --- title: fabledskyblock_level -parent: Task types -nav_order: 33 +parent: External task types +grand_parent: Task types --- # fabledskyblock_level (task type) diff --git a/docs/task-types/farming-(task-type).md b/docs/task-types/farming-(task-type).md index 4207f903..d3705e9a 100644 --- a/docs/task-types/farming-(task-type).md +++ b/docs/task-types/farming-(task-type).md @@ -1,7 +1,7 @@ --- title: farming -parent: Task types -nav_order: 14 +parent: Built-in task types +grand_parent: Task types --- # farming (task type) diff --git a/docs/task-types/fishing-(task-type).md b/docs/task-types/fishing-(task-type).md index 659a6521..f7cb73e1 100644 --- a/docs/task-types/fishing-(task-type).md +++ b/docs/task-types/fishing-(task-type).md @@ -1,7 +1,7 @@ --- title: fishing -parent: Task types -nav_order: 15 +parent: Built-in task types +grand_parent: Task types --- # fishing (task type) @@ -17,11 +17,12 @@ one. Both names can be used to refer to this task. ## Options -| Key | Description | Type | Required | Default | Notes | -|----------|--------------------------------------------------|---------------------|----------|---------|----------------------------------------------------------------| -| `amount` | The number of fish to catch. | Integer | Yes | \- | \- | -| `item` | Specific item which should be used to kill mobs. | ItemStack | No | \- | Accepts standard [item definition](defining_items "wikilink"). | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|---------------|--------------------------------------------------------|---------------------|----------|---------|----------------------------------------------------------------| +| `amount` | The number of fish to catch. | Integer | Yes | \- | \- | +| `item` | Specific item which should be used to kill mobs. | ItemStack | No | \- | Accepts standard [item definition](defining_items "wikilink"). | +| `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/index.md b/docs/task-types/index.md index 4b0e657f..8acf9469 100644 --- a/docs/task-types/index.md +++ b/docs/task-types/index.md @@ -4,4 +4,9 @@ has_children: true nav_order: 6 --- -# Task types
\ No newline at end of file +# Task types + +**Task types** determine how a task should be completed. Each task must have a type. + +Some task types require a specific plugin or Minecraft version to activate. If you are a +developer and are looking to write your own task types, see [creating a new task type](../developer/new-task-type)
\ No newline at end of file diff --git a/docs/task-types/inventory-(task-type).md b/docs/task-types/inventory-(task-type).md index a240207a..4ffc3f5b 100644 --- a/docs/task-types/inventory-(task-type).md +++ b/docs/task-types/inventory-(task-type).md @@ -1,7 +1,7 @@ --- title: inventory -parent: Task types -nav_order: 16 +parent: Built-in task types +grand_parent: Task types --- # inventory (task type) @@ -22,6 +22,7 @@ Obtain a set of items. | `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/iridiumskyblock_value-(task-type).md b/docs/task-types/iridiumskyblock_value-(task-type).md index 40ca8a8c..102593e7 100644 --- a/docs/task-types/iridiumskyblock_value-(task-type).md +++ b/docs/task-types/iridiumskyblock_value-(task-type).md @@ -1,7 +1,7 @@ --- title: iridiumskyblock_value -parent: Task types -nav_order: 34 +parent: External task types +grand_parent: Task types --- # iridiumskyblock_value (task type) @@ -16,9 +16,9 @@ Reach a certain IridiumSkyblock value. ## Options -| Key | Description | Type | Required | Default | Notes | -|---------|--------------------|---------|----------|---------|-------| -| `value` | The valueto reach. | Integer | Yes | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `value` | The value to reach. | Integer | Yes | \- | \- | ## Examples diff --git a/docs/task-types/milking-(task-type).md b/docs/task-types/milking-(task-type).md index 75c2ed86..109dd3d8 100644 --- a/docs/task-types/milking-(task-type).md +++ b/docs/task-types/milking-(task-type).md @@ -1,7 +1,7 @@ --- title: milking -parent: Task types -nav_order: 17 +parent: Built-in task types +grand_parent: Task types --- # milking (task type) diff --git a/docs/task-types/mobkilling-(task-type).md b/docs/task-types/mobkilling-(task-type).md index f0a5c50b..4b4b2564 100644 --- a/docs/task-types/mobkilling-(task-type).md +++ b/docs/task-types/mobkilling-(task-type).md @@ -1,7 +1,7 @@ --- title: mobkilling -parent: Task types -nav_order: 18 +parent: Built-in task types +grand_parent: Task types --- # mobkilling (task type) @@ -17,14 +17,15 @@ 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 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. | -| `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. | -| `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](defining_items "wikilink"). | -| `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 | \- | \- | +| `mob` | The specific mob(s) to kill. | 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. | +| `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. | +| `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](defining_items "wikilink"). | +| `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/mythicmobs_killing-(task-type).md b/docs/task-types/mythicmobs_killing-(task-type).md index 4862f66d..83b686b1 100644 --- a/docs/task-types/mythicmobs_killing-(task-type).md +++ b/docs/task-types/mythicmobs_killing-(task-type).md @@ -1,7 +1,7 @@ --- title: mythicmobs_killing -parent: Task types -nav_order: 35 +parent: External task types +grand_parent: Task types --- # mythicmobs_killing (task type) diff --git a/docs/task-types/permission-(task-type).md b/docs/task-types/permission-(task-type).md index aa55c00a..423edb80 100644 --- a/docs/task-types/permission-(task-type).md +++ b/docs/task-types/permission-(task-type).md @@ -1,7 +1,7 @@ --- title: permission -parent: Task types -nav_order: 19 +parent: Built-in task types +grand_parent: Task types --- # permission (task type) diff --git a/docs/task-types/placeholderapi_evaluate-(task-type).md b/docs/task-types/placeholderapi_evaluate-(task-type).md index 87079d7f..35a27cce 100644 --- a/docs/task-types/placeholderapi_evaluate-(task-type).md +++ b/docs/task-types/placeholderapi_evaluate-(task-type).md @@ -1,7 +1,7 @@ --- title: placeholderapi_evaluate -parent: Task types -nav_order: 36 +parent: External task types +grand_parent: Task types --- # placeholderapi_evaluate (task type) diff --git a/docs/task-types/playerkilling-(task-type).md b/docs/task-types/playerkilling-(task-type).md index 4aee13bf..0ce145a9 100644 --- a/docs/task-types/playerkilling-(task-type).md +++ b/docs/task-types/playerkilling-(task-type).md @@ -1,7 +1,7 @@ --- title: playerkilling -parent: Task types -nav_order: 20 +parent: Built-in task types +grand_parent: Task types --- # playerkilling (task type) diff --git a/docs/task-types/playerpoints_earn.md b/docs/task-types/playerpoints_earn.md new file mode 100644 index 00000000..6bdbf463 --- /dev/null +++ b/docs/task-types/playerpoints_earn.md @@ -0,0 +1,31 @@ +--- +title: playerpoints_earn +parent: External task types +grand_parent: Task types +--- + +# playerpoints_earn (task type) + +Since v3.14 +{: .label .label-green } + +Plugin 'PlayerPoints' required +{: .label } + +Earn a number of points. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-----------------------|---------|----------|---------|-------| +| `amount` | The number of points. | Integer | Yes | \- | \- | + +## Examples + +Earn 10 points: + +``` yaml +playerpoints: + type: "playerpoints_earn" + amount: 10 # number of points to earn +``` diff --git a/docs/task-types/playtime-(task-type).md b/docs/task-types/playtime-(task-type).md index 649b0db4..f0a1fee2 100644 --- a/docs/task-types/playtime-(task-type).md +++ b/docs/task-types/playtime-(task-type).md @@ -1,7 +1,7 @@ --- title: playtime -parent: Task types -nav_order: 21 +parent: Built-in task types +grand_parent: Task types --- # playtime (task type) diff --git a/docs/task-types/position-(task-type).md b/docs/task-types/position-(task-type).md index bf990ca8..829b06c7 100644 --- a/docs/task-types/position-(task-type).md +++ b/docs/task-types/position-(task-type).md @@ -1,7 +1,7 @@ --- title: position -parent: Task types -nav_order: 22 +parent: Built-in task types +grand_parent: Task types --- # position (task type) diff --git a/docs/task-types/replenishing-(task-type).md b/docs/task-types/replenishing-(task-type).md new file mode 100644 index 00000000..3d7c1b65 --- /dev/null +++ b/docs/task-types/replenishing-(task-type).md @@ -0,0 +1,34 @@ +--- +title: replenishing +parent: Built-in task types +grand_parent: Task types +--- + +# replenishing (task type) + +Since v3.14 +{: .label .label-green } + + +Replenish a set amount of certain blocks or entities. + +## Options + +| 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. | + +## Examples + +Replenish 10 inventories: + +``` yaml +replenishing: + type: "replenishing" + amount: 10 # amount of inventories replenished + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/shearing-(task-type).md b/docs/task-types/shearing-(task-type).md index 5c81e1e7..299f646f 100644 --- a/docs/task-types/shearing-(task-type).md +++ b/docs/task-types/shearing-(task-type).md @@ -1,7 +1,7 @@ --- title: shearing -parent: Task types -nav_order: 23 +parent: Built-in task types +grand_parent: Task types --- # shearing (task type) @@ -10,18 +10,20 @@ Since v2.0 {: .label .label-green } -Shear a set amount of sheep. +Shear a set amount of colorables (colourables) or shearables. ## Options -| 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 | \- | \- | +| 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. | ## Examples -Shear 10 sheep: +Shear 10 animals: ``` yaml shearing: @@ -30,3 +32,15 @@ shearing: worlds: # (OPTIONAL) restrict to certain worlds - "world" ``` + +Shear 10 pink sheep: + +``` yaml +shearing: + type: "shearing" + amount: 10 # amount of sheep sheared + color: "PINK" + mob: "SHEEP" + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/shopguiplus_buy-(task-type).md b/docs/task-types/shopguiplus_buy-(task-type).md index 85c03ae9..c84662dd 100644 --- a/docs/task-types/shopguiplus_buy-(task-type).md +++ b/docs/task-types/shopguiplus_buy-(task-type).md @@ -1,7 +1,7 @@ --- title: shopguiplus_buy -parent: Task types -nav_order: 37 +parent: External task types +grand_parent: Task types --- # shopguiplus_buy (task type) diff --git a/docs/task-types/shopguiplus_sell-(task-type).md b/docs/task-types/shopguiplus_sell-(task-type).md index a1c94a10..082da6e2 100644 --- a/docs/task-types/shopguiplus_sell-(task-type).md +++ b/docs/task-types/shopguiplus_sell-(task-type).md @@ -1,7 +1,7 @@ --- title: shopguiplus_sell -parent: Task types -nav_order: 38 +parent: External task types +grand_parent: Task types --- # shopguiplus_sell (task type) diff --git a/docs/task-types/smelting-(task-type).md b/docs/task-types/smelting-(task-type).md index 721740c5..7a68744b 100644 --- a/docs/task-types/smelting-(task-type).md +++ b/docs/task-types/smelting-(task-type).md @@ -1,7 +1,7 @@ --- title: smelting -parent: Task types -nav_order: 24 +parent: Built-in task types +grand_parent: Task types --- # smelting (task type) @@ -17,12 +17,13 @@ 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 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. | -| `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 | \- | \- | +| Key | Description | Type | Required | Default | Notes | +|---------------|--------------------------------------------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `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. | +| `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 new file mode 100644 index 00000000..70019f55 --- /dev/null +++ b/docs/task-types/smithing-(task-type).md @@ -0,0 +1,47 @@ +--- +title: smithing +parent: Built-in task types +grand_parent: Task types +--- + +# smithing (task type) + +Since v3.13.2 +{: .label .label-green } + +Minecraft 1.16+ required +{: .label .label-purple } + +Smith a certain number of items using a smithing table. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------------|--------------------------------------------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `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. | +| `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 + +Smith 10 items: + +``` yaml +smithing: + type: "smithing" + amount: 10 # amount to smith + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Smith a Netherite Chestplate: + +``` yaml +smithing: + type: "smithing" + amount: 1 # amount to smith + item: NETHERITE_CHESTPLATE # type of item + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/superiorskyblock_level-(task-type).md b/docs/task-types/superiorskyblock_level-(task-type).md index c23996b6..96e8b2b9 100644 --- a/docs/task-types/superiorskyblock_level-(task-type).md +++ b/docs/task-types/superiorskyblock_level-(task-type).md @@ -1,7 +1,7 @@ --- title: superiorskyblock_level -parent: Task types -nav_order: 39 +parent: External task types +grand_parent: Task types --- # superiorskyblock_level (task type) diff --git a/docs/task-types/superiorskyblock_worth-(task-type).md b/docs/task-types/superiorskyblock_worth-(task-type).md index a47d50fe..f397dfd5 100644 --- a/docs/task-types/superiorskyblock_worth-(task-type).md +++ b/docs/task-types/superiorskyblock_worth-(task-type).md @@ -1,7 +1,7 @@ --- title: superiorskyblock_worth -parent: Task types -nav_order: 40 +parent: External task types +grand_parent: Task types --- # superiorskyblock_worth (task type) diff --git a/docs/task-types/taming-(task-type).md b/docs/task-types/taming-(task-type).md index 1847bda4..b0b5f66e 100644 --- a/docs/task-types/taming-(task-type).md +++ b/docs/task-types/taming-(task-type).md @@ -1,7 +1,7 @@ --- title: taming -parent: Task types -nav_order: 25 +parent: Built-in task types +grand_parent: Task types --- # taming (task type) diff --git a/docs/task-types/uskyblock_level-(task-type).md b/docs/task-types/uskyblock_level-(task-type).md index 729ca5c6..a67f5b05 100644 --- a/docs/task-types/uskyblock_level-(task-type).md +++ b/docs/task-types/uskyblock_level-(task-type).md @@ -1,7 +1,7 @@ --- title: uskyblock_level -parent: Task types -nav_order: 41 +parent: External task types +grand_parent: Task types --- # uskyblock_level (task type) diff --git a/docs/task-types/votingplugin_vote-(task-type).md b/docs/task-types/votingplugin_vote-(task-type).md index 6a17abac..61f05b86 100644 --- a/docs/task-types/votingplugin_vote-(task-type).md +++ b/docs/task-types/votingplugin_vote-(task-type).md @@ -1,7 +1,7 @@ --- title: votingplugin_vote -parent: Task types -nav_order: 42 +parent: External task types +grand_parent: Task types --- # votingplugin_vote (task type) diff --git a/docs/task-types/walking-(task-type).md b/docs/task-types/walking-(task-type).md index 4c38fc27..83a8f524 100644 --- a/docs/task-types/walking-(task-type).md +++ b/docs/task-types/walking-(task-type).md @@ -1,7 +1,7 @@ --- title: walking -parent: Task types -nav_order: 26 +parent: Built-in task types +grand_parent: Task types --- # walking (task type) |