summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/task-types/customfishing_fishing-(task-type).md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/task-types/customfishing_fishing-(task-type).md b/docs/task-types/customfishing_fishing-(task-type).md
new file mode 100644
index 00000000..f1e8e386
--- /dev/null
+++ b/docs/task-types/customfishing_fishing-(task-type).md
@@ -0,0 +1,33 @@
+---
+title: customfishing_fishing
+parent: External task types
+grand_parent: Task types
+---
+
+# customfishing_fishing (task type)
+
+Not released yet (dev builds)
+{: .label .label-green }
+
+Plugin 'CustomFishing' required
+{: .label }
+
+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. |
+
+## Examples
+
+Catch 10 CustomFishing loots:
+
+```yaml
+customfishing:
+ type: "customfishing_fishing"
+ amount: 10 # number needed
+```