diff options
| author | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-07 02:28:06 +0100 |
|---|---|---|
| committer | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-07 02:28:06 +0100 |
| commit | e079568be93661e39d766fd3fd41267006fb87cf (patch) | |
| tree | 7bd0569fba3a922b40a97926327eb447b2f64e7e /docs | |
| parent | 7a7298e91cf53af8697a699bb4d015102d38e3ae (diff) | |
Add missing documentation for mobs in taming and breeding tasks
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/task-types/breeding-(task-type).md | 20 | ||||
| -rw-r--r-- | docs/task-types/taming-(task-type).md | 20 |
2 files changed, 32 insertions, 8 deletions
diff --git a/docs/task-types/breeding-(task-type).md b/docs/task-types/breeding-(task-type).md index 589f36d3..1d527402 100644 --- a/docs/task-types/breeding-(task-type).md +++ b/docs/task-types/breeding-(task-type).md @@ -13,10 +13,11 @@ Breed a certain amount of animals. ## Options -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The number of animals to breed. | 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 animals to breed. | Integer | Yes | \- | \- | +| `mob` / `mobs` | The specific mob(s) to breed. | 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 @@ -29,3 +30,14 @@ breeding: worlds: # (OPTIONAL) restrict to certain worlds - "world" ``` + +Breed 5 pigs: + +``` yaml +breeding: + type: "breeding" + amount: 5 # amount of animals bred + mob: "PIG" # type of mob + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/taming-(task-type).md b/docs/task-types/taming-(task-type).md index b0b5f66e..6683105d 100644 --- a/docs/task-types/taming-(task-type).md +++ b/docs/task-types/taming-(task-type).md @@ -13,10 +13,11 @@ Tame a set amount of animals. ## Options -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The number of animals to tame. | 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 animals to tame. | Integer | Yes | \- | \- | +| `mob` / `mobs` | The specific mob(s) to tame. | 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 @@ -29,3 +30,14 @@ taming: worlds: # (OPTIONAL) restrict to certain worlds - "world" ``` + +Tame 10 pigs: + +``` yaml +taming: + type: "taming" + amount: 10 # amount of mobs tamed + mob: "PIG" # mob to tame + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` |