diff options
| author | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-11 15:32:54 +0100 |
|---|---|---|
| committer | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-11 15:32:54 +0100 |
| commit | 01c14572e947a7020fd140f076dc35280ac13cea (patch) | |
| tree | 0a62309257b08da40b342b2a1ad37ff2fbaa4278 | |
| parent | 80176425b999c094f984f20642bd77380d32218e (diff) | |
Fix broken links in documentation
| -rw-r--r-- | docs/task-types/brewing-(task-type).md | 12 | ||||
| -rw-r--r-- | docs/task-types/bucketempty-(task-type).md | 10 | ||||
| -rw-r--r-- | docs/task-types/bucketfill-(task-type).md | 10 | ||||
| -rw-r--r-- | docs/task-types/consume-(task-type).md | 14 | ||||
| -rw-r--r-- | docs/task-types/crafting-(task-type).md | 14 | ||||
| -rw-r--r-- | docs/task-types/enchanting-(task-type).md | 14 | ||||
| -rw-r--r-- | docs/task-types/fishing-(task-type).md | 12 | ||||
| -rw-r--r-- | docs/task-types/inventory-(task-type).md | 18 | ||||
| -rw-r--r-- | docs/task-types/mobkilling-(task-type).md | 2 |
9 files changed, 53 insertions, 53 deletions
diff --git a/docs/task-types/brewing-(task-type).md b/docs/task-types/brewing-(task-type).md index 65279b23..c5c9d56b 100644 --- a/docs/task-types/brewing-(task-type).md +++ b/docs/task-types/brewing-(task-type).md @@ -16,12 +16,12 @@ 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 | \- | \- | -| `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 | \- | +| 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](../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 | \- | ## Examples diff --git a/docs/task-types/bucketempty-(task-type).md b/docs/task-types/bucketempty-(task-type).md index 8f434793..ab0b65a3 100644 --- a/docs/task-types/bucketempty-(task-type).md +++ b/docs/task-types/bucketempty-(task-type).md @@ -13,11 +13,11 @@ 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](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 | \- | \- | +| 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 | \- | \- | ## Examples diff --git a/docs/task-types/bucketfill-(task-type).md b/docs/task-types/bucketfill-(task-type).md index 85e9b3f1..fdfd382f 100644 --- a/docs/task-types/bucketfill-(task-type).md +++ b/docs/task-types/bucketfill-(task-type).md @@ -13,11 +13,11 @@ 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](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 | \- | \- | +| 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 | \- | \- | ## Examples diff --git a/docs/task-types/consume-(task-type).md b/docs/task-types/consume-(task-type).md index d298e6c6..e8796630 100644 --- a/docs/task-types/consume-(task-type).md +++ b/docs/task-types/consume-(task-type).md @@ -13,13 +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 | \- | \- | -| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | +| Key | Description | Type | Required | Default | Notes | +|---------------|--------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to consume. | Integer | Yes | \- | \- | +| `item` | The specific item to obtain. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](../configuration/defining-items). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | +| `data` | The data code for the item. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions. | +| `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 dd2f03e7..352c2d9d 100644 --- a/docs/task-types/crafting-(task-type).md +++ b/docs/task-types/crafting-(task-type).md @@ -13,13 +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 | \- | \- | -| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | +| 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](../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 | \- | ## Examples diff --git a/docs/task-types/enchanting-(task-type).md b/docs/task-types/enchanting-(task-type).md index 58874434..754b2a26 100644 --- a/docs/task-types/enchanting-(task-type).md +++ b/docs/task-types/enchanting-(task-type).md @@ -13,13 +13,13 @@ Enchant an item. ## Options -| Key | Description | Type | Required | Default | Notes | -|---------------|-------------------------------------------------|--------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of items to obtain. | Integer | Yes | \- | \- | -| `item` | The specific item to encahnt. | Material, or ItemStack | No | \- | 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. If no item is specified, then any item can be enchanted. | -| `enchantment` | The specific enchantment(s) to apply. | Enchantment, or list of enchantments | No | \- | If no enchantments are specified, then any enchantment can be applied. | -| `min-level` | The minimum level of the enchantments. | Integer | No | \- | If no minimum level is specified, then any enchantment of any level can be applied. | -| `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 obtain. | Integer | Yes | \- | \- | +| `item` | The specific item to encahnt. | 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 no item is specified, then any item can be enchanted. | +| `enchantment` | The specific enchantment(s) to apply. | Enchantment, or list of enchantments | No | \- | If no enchantments are specified, then any enchantment can be applied. | +| `min-level` | The minimum level of the enchantments. | Integer | No | \- | If no minimum level is specified, then any enchantment of any level can be applied. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | ## Examples diff --git a/docs/task-types/fishing-(task-type).md b/docs/task-types/fishing-(task-type).md index f7cb73e1..53244010 100644 --- a/docs/task-types/fishing-(task-type).md +++ b/docs/task-types/fishing-(task-type).md @@ -17,12 +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 | \- | \- | -| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | +| 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](../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 | \- | ## Examples diff --git a/docs/task-types/inventory-(task-type).md b/docs/task-types/inventory-(task-type).md index 4ffc3f5b..ae365d16 100644 --- a/docs/task-types/inventory-(task-type).md +++ b/docs/task-types/inventory-(task-type).md @@ -14,15 +14,15 @@ Obtain a set of items. ## Options -| Key | Description | Type | Required | Default | Notes | -|------------------------------|------------------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of items to obtain. | Integer | Yes | \- | \- | -| `item` | The specific item to obtain. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](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. | -| `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 | \- | +| Key | Description | Type | Required | Default | Notes | +|------------------------------|------------------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to obtain. | Integer | Yes | \- | \- | +| `item` | The specific item to obtain. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](../configuration/defining-items). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | +| `data` | The data code for the item. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions. | +| `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/mobkilling-(task-type).md b/docs/task-types/mobkilling-(task-type).md index 4b4b2564..ecc45030 100644 --- a/docs/task-types/mobkilling-(task-type).md +++ b/docs/task-types/mobkilling-(task-type).md @@ -23,7 +23,7 @@ merged into one. Both names can be used to refer to this task. | `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"). | +| `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 | \- | |