Add missing documentation for mobs in taming and breeding tasks

LMBishop · Jul 7, 2023 · e079568 · e079568
1 parent 7a7298e
commit e079568
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 8 deletions.
diff --git 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
@@ -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"
+```