summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKrakenied <Krakenied1@gmail.com>2024-03-13 12:24:18 +0100
committerLeonardo Bishop <13875753+LMBishop@users.noreply.github.com>2024-03-16 00:18:37 +0000
commit9ccf0753cff441a19b45bb1bbd1ab24a1fb3184d (patch)
treee127c8d5a7dd6f578d968ccdf05852b22e611d72 /docs
parente0b4ce77f6ec8f78a16c4fc58d1d67a6fae2e7a2 (diff)
[ci skip] Update building, mining, mob killing and milking task type docs
Diffstat (limited to 'docs')
-rw-r--r--docs/task-types/blockbreak-(task-type).md8
-rw-r--r--docs/task-types/blockplace-(task-type).md15
-rw-r--r--docs/task-types/milking-(task-type).md11
-rw-r--r--docs/task-types/mobkilling-(task-type).md19
4 files changed, 29 insertions, 24 deletions
diff --git a/docs/task-types/blockbreak-(task-type).md b/docs/task-types/blockbreak-(task-type).md
index ae245236..1964dfbe 100644
--- a/docs/task-types/blockbreak-(task-type).md
+++ b/docs/task-types/blockbreak-(task-type).md
@@ -27,7 +27,7 @@ merged into one. Both names can be used to refer to this task.
| `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 task progress unless `allow-negative-progress` is set to `false`. |
| `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-coreprotect-time` | How long ago (in seconds) the plugin should check with CoreProtect whether a block was placed. | Integer | No | \- | Used with `check-coreprotect`. |
| `check-playerblocktracker` | Whether the plugin should query PlayerBlockTracker if a block has been recently placed. | Boolean | No | false | This requires the PlayerBlockTracker plugin. |
| `allow-silk-touch` | Whether mining a block with a silk touch pickaxe should count. | Boolean | No | true | \- |
| `allow-negative-progress` | Whether progress can be allowed to enter the negatives. | Boolean | No | true | Used with `reverse-if-placed`. |
@@ -50,7 +50,7 @@ Break 10 of stone:
``` yaml
miningstone:
type: "blockbreakcertain"
- amount: 10 # amount of blocks to be brkoen
+ amount: 10 # amount of blocks to be broken
block: STONE # name of block (can be id or minecraft name)
data: 1 # (OPTIONAL) data code
reverse-if-placed: false # (OPTIONAL) if true, blocks of same type placed will reverse progression (prevents silk-touch exploit)
@@ -65,11 +65,11 @@ Break 10 of either stone or gold ore:
``` yaml
miningmultiple:
type: "blockbreakcertain"
- amount: 10 # amount of blocks to be placed
+ amount: 10 # amount of blocks to be broken
blocks: # name of blocks which will count towards progress
- STONE
- GOLD_ORE
- reverse-if-broken: false # (OPTIONAL) if true, blocks of same type broken will reverse progression (prevents silk-touch exploit)
+ reverse-if-placed: false # (OPTIONAL) if true, blocks of same type placed will reverse progression (prevents silk-touch exploit)
check-coreprotect: false # (OPTIONAL) if true and CoreProtect is present, the plugin will check its logs for player placed blocks
check-coreprotect-time: 3600 # (OPTIONAL) time in seconds for the maximum logging period to check
worlds: # (OPTIONAL) restrict to certain worlds
diff --git a/docs/task-types/blockplace-(task-type).md b/docs/task-types/blockplace-(task-type).md
index fd3550d4..5e78968a 100644
--- a/docs/task-types/blockplace-(task-type).md
+++ b/docs/task-types/blockplace-(task-type).md
@@ -17,13 +17,14 @@ 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 place. | Integer | Yes | \- | \- |
-| `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. |
-| `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 place. | Integer | Yes | \- | \- |
+| `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 task progress unless `allow-negative-progress` is set to `false`. |
+| `allow-negative-progress` | Whether progress can be allowed to enter the negatives. | Boolean | No | true | Used with `reverse-if-broken`. |
+| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- |
## Examples
diff --git a/docs/task-types/milking-(task-type).md b/docs/task-types/milking-(task-type).md
index 109dd3d8..5f4aee53 100644
--- a/docs/task-types/milking-(task-type).md
+++ b/docs/task-types/milking-(task-type).md
@@ -13,10 +13,12 @@ Milk a set amount of cows.
## Options
-| Key | Description | Type | Required | Default | Notes |
-|----------|-------------------------------------------------|---------------------|----------|---------|-------|
-| `amount` | The number of cows to milk. | 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 mobs to milk. | Integer | Yes | \- | \- |
+| `mob` | The specific mob(s) to milk. | Entity type, or list of entity types | 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. |
+| `spawn-reason` | The specific spawn reason(s) of mobs to milk. | Spawn reason, or list of spawn reasons | No | \- | Works only on Paper and its forks. Not specifying this field will allow mobs with any spawn reasons to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.SpawnReason.html) for spawn reasons. |
+| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- |
## Examples
@@ -26,6 +28,7 @@ Milk 10 cows:
milking:
type: "milking"
amount: 10 # amount of cows milked
+ mob: COW # (OPTIONAL) restrict to certain mobs
worlds: # (OPTIONAL) restrict to certain worlds
- "world"
```
diff --git a/docs/task-types/mobkilling-(task-type).md b/docs/task-types/mobkilling-(task-type).md
index 1a8d107d..e6c93a5c 100644
--- a/docs/task-types/mobkilling-(task-type).md
+++ b/docs/task-types/mobkilling-(task-type).md
@@ -20,15 +20,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 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](../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 | \- |
+| 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 entity types | 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` | 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. |
+| `spawn-reason` | The specific spawn reason(s) of mobs to kill. | Spawn reason, or list of spawn reasons | No | \- | Works only on Paper and its forks. Not specifying this field will allow mobs with any spawn reasons to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.SpawnReason.html) for spawn reasons. |
+| `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](../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
generated by cgit v1.2.3-70-g09d2 (git 2.51.2) at 2025-11-25 18:35:30 +0000