diff options
| author | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-06 13:57:32 +0100 |
|---|---|---|
| committer | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-06 13:57:32 +0100 |
| commit | 7a2a45691068db51ba4e7dc851f44a17f545f0ae (patch) | |
| tree | 4613842f6cd175965dc0920c7e210f417be8f574 /docs/task-types | |
| parent | 467715dcb3ee23e05e8fe445d9e2a2416a26a8e0 (diff) | |
Fix wiki linksmigrate-docs
Diffstat (limited to 'docs/task-types')
43 files changed, 1829 insertions, 0 deletions
diff --git a/docs/task-types/askyblock_level-(task-type).md b/docs/task-types/askyblock_level-(task-type).md new file mode 100644 index 00000000..823a79a6 --- /dev/null +++ b/docs/task-types/askyblock_level-(task-type).md @@ -0,0 +1,31 @@ +--- +title: askyblock_level +parent: Task types +nav_order: 27 +--- + +# askyblock_level (task type) + +Since v1.7.1 +{: .label .label-green } + +Plugin 'ASkyBlock' required +{: .label } + +Reach a certain ASkyBlock level. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `level` | The level to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island level 10: + +``` yaml +askyblock: + type: "askyblock_level" + level: 10 # island level needed +``` diff --git a/docs/task-types/bentobox_level-(task-type).md b/docs/task-types/bentobox_level-(task-type).md new file mode 100644 index 00000000..933ee21d --- /dev/null +++ b/docs/task-types/bentobox_level-(task-type).md @@ -0,0 +1,31 @@ +--- +title: bentobox_level +parent: Task types +nav_order: 28 +--- + +# bentobox_level (task type) + +Since v2.12 +{: .label .label-green } + +Plugin 'BentoBox' required +{: .label } + +Reach a certain BentoBox level. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `level` | The level to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island level 10: + +``` yaml +bentobox: + type: "bentobox_level" + level: 10 # island level needed +``` diff --git a/docs/task-types/blockbreak-(task-type).md b/docs/task-types/blockbreak-(task-type).md new file mode 100644 index 00000000..66595b5a --- /dev/null +++ b/docs/task-types/blockbreak-(task-type).md @@ -0,0 +1,71 @@ +--- +title: blockbreak +parent: Task types +nav_order: 1 +--- + +# blockbreak (task type) + +Since v1.0 +{: .label .label-green } + +Break a set amount of blocks. + +{: .note } +Since Quests v3.13, `blockbreakcertain` and `blockbreak` have been +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 break. | Integer | Yes | \- | \- | +| `block` | The specific blocks to break. | 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-placed` | Whether placing blocks should decrement from the quest progress. | Boolean | No | false | This allows negative quest progresses. | +| `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. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Break 10 of any block: + +``` yaml +mining: + type: "blockbreak" + amount: 10 # amount of blocks to be broken + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Break 10 of stone: + +``` yaml +miningstone: + type: "blockbreakcertain" + amount: 10 # amount of blocks to be brkoen + 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) + 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 + - "world" +``` + +Break 10 of either stone or gold ore: + +``` yaml +miningmultiple: + type: "blockbreakcertain" + amount: 10 # amount of blocks to be placed + 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) + 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 + - "world" +``` diff --git a/docs/task-types/blockplace-(task-type).md b/docs/task-types/blockplace-(task-type).md new file mode 100644 index 00000000..e39538c8 --- /dev/null +++ b/docs/task-types/blockplace-(task-type).md @@ -0,0 +1,65 @@ +--- +title: blockplace +parent: Task types +nav_order: 2 +--- + +# blockplace (task type) + +Since v1.0 +{: .label .label-green} + +Place a set amount of blocks. + +{: .note } +Since Quests v3.13, `blockplacecertain` and `blockplace` have been +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 | \- | \- | + +## Examples + +Place 10 of any block: + +``` yaml +building: + type: "blockplace" + amount: 10 # amount of blocks to be placed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Place 10 of stone: + +``` yaml +buildingstone: + type: "blockplace" + amount: 10 # amount of blocks to be placed + block: STONE # name of block (minecraft name) + data: 1 # (OPTIONAL) data code + reverse-if-broken: false # (OPTIONAL) if true, blocks of same type broken will reverse progression (prevents silk-touch exploit) + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Place 10 of either stone or gold ore: + +``` yaml +buildingmultiple: + type: "blockplace" + amount: 10 # amount of blocks to be placed + 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) + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/breeding-(task-type).md b/docs/task-types/breeding-(task-type).md new file mode 100644 index 00000000..66459f7d --- /dev/null +++ b/docs/task-types/breeding-(task-type).md @@ -0,0 +1,31 @@ +--- +title: breeding +parent: Task types +nav_order: 3 +--- + +# breeding (task type) + +Since v2.2 +{: .label .label-green } + +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 | \- | \- | + +## Examples + +Breed 5 animals: + +``` yaml +breeding: + type: "breeding" + amount: 5 # amount of animals bred + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/brewing-(task-type).md b/docs/task-types/brewing-(task-type).md new file mode 100644 index 00000000..312e3dfb --- /dev/null +++ b/docs/task-types/brewing-(task-type).md @@ -0,0 +1,31 @@ +--- +title: brewing +parent: Task types +nav_order: 4 +--- + +# brewing (task type) + +Since v2.0.13 +{: .label .label-green } + +Brew a set amount of potions. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of potions to brew. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Brew 8 potions: + +``` yaml +brewing: + type: "brewing" + amount: 10 # amount of potions brewed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/bucketempty-(task-type).md b/docs/task-types/bucketempty-(task-type).md new file mode 100644 index 00000000..49806d17 --- /dev/null +++ b/docs/task-types/bucketempty-(task-type).md @@ -0,0 +1,33 @@ +--- +title: bucketempty +parent: Task types +nav_order: 5 +--- + +# bucketempty (task type) + +Since v3.9 +{: .label .label-green } + +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 | \- | \- | + +## Examples + +Empty 8 lava buckets: + +``` yaml +bucketempty : + type: "bucketempty" + bucket: LAVA_BUCKET # bucket to empty + amount: 8 # amount of times to empty + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/bucketfill-(task-type).md b/docs/task-types/bucketfill-(task-type).md new file mode 100644 index 00000000..3648d06e --- /dev/null +++ b/docs/task-types/bucketfill-(task-type).md @@ -0,0 +1,33 @@ +--- +title: bucketfill +parent: Task types +nav_order: 6 +--- + +# bucketfill (task type) + +Since v3.9 +{: .label .label-green } + +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 | \- | \- | + +## Examples + +Fill 8 lava buckets: + +``` yaml +bucketfill: + type: "bucketfill" + bucket: LAVA_BUCKET # bucket to fill + amount: 8 # amount of times to fill + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/citizens_deliver-(task-type).md b/docs/task-types/citizens_deliver-(task-type).md new file mode 100644 index 00000000..bc3cb6f3 --- /dev/null +++ b/docs/task-types/citizens_deliver-(task-type).md @@ -0,0 +1,80 @@ +--- +title: citizens_deliver +parent: Task types +nav_order: 29 +--- + +# citizens_deliver (task type) + +Since v2.0.15 +{: .label .label-green } + +Plugin 'Citizens' required +{: .label } + +Deliver a set of items to a Citizens NPC. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|------------------------------|------------------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to deliver. | Integer | Yes | \- | \- | +| `item` | The specific item to deliver. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](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. | +| `npc-name` | The name of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-id`. | +| `npc-id` | The id of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-name`. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Deliver 8 of `BEEF` to an NPC named Gerald: + +``` yaml +citizensdeliver: + type: "citizens_deliver" + npc-name: "Gerald" # name of NPC + # OR npc-id: "npc1" ID of NPC (mutally exclusive with npc-name) + item: BEEF # name of item (can be id or minecraft name) + amount: 8 # amount of item needed + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: false + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Deliver 8 of a specific item to an NPC named Gerald: + +``` yaml +beef: + type: "citizens_deliver" + npc-name: "Gerald" # name of NPC + item: # SPECIFIC item with name and lore + name: "&cSpecial Beef" + type: "BEEF" + lore: + - "&7This is a special type of beef" + amount: 8 # amount of item needed + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + accept-partial-completion: false # (OPTIONAL) allow partial deliveries - default: false + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Deliver 8 of [quest item](../configuration/defining-items#quest-items) +`special_beef` to an NPC named Gerald: + +``` yaml +beef: + type: "citizens_deliver" + npc-name: "Gerald" # name of NPC + # OR npc-id: "npc1" ID of NPC (mutally exclusive with npc-name) + item: # USING quest-item + quest-item: "special_beef" + amount: 8 # amount of item needed + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + accept-partial-completion: false # (OPTIONAL) allow partial deliveries - default: false + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/citizens_interact-(task-type).md b/docs/task-types/citizens_interact-(task-type).md new file mode 100644 index 00000000..f25e9844 --- /dev/null +++ b/docs/task-types/citizens_interact-(task-type).md @@ -0,0 +1,36 @@ +--- +title: citizens_interact +parent: Task types +nav_order: 30 +--- + +# citizens_interact (task type) + +Since v2.0.15 +{: .label .label-green } + +Plugin 'Citizens' required +{: .label } + +Interact with a Citizens NPC. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|------------|-------------------------------------------------|---------------------|----------|---------|-------------------------------------| +| `npc-name` | The name of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-id`. | +| `npc-id` | The id of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-name`. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Interact with an NPC named Gerald: + +``` yaml +citizensinteract: + type: "citizens_interact" + npc-name: "Gerald" # name of NPC + # OR npc-id: "npc1" ID of NPC (mutally exclusive with npc-name) + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/command-(task-type).md b/docs/task-types/command-(task-type).md new file mode 100644 index 00000000..4e2d426f --- /dev/null +++ b/docs/task-types/command-(task-type).md @@ -0,0 +1,36 @@ +--- +title: command +parent: Task types +nav_order: 7 +--- + +# command (task type) + +Since v2.12 +{: .label .label-green } + +Execute a specific command. + +This task may not work for commands not properly registered with the +server (e.g. commands made with plugins like DeluxeMenu). + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------------|------------------------------------------------------|---------------------|----------|---------|-------| +| `command` | The command to execute. | String | Yes | \- | \- | +| `ignore-case` | Whether the casing of the command should be ignored. | Boolean | No | false | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Ask for help: + +``` yaml +command: + type: "command" + command: "help" # command to execute + ignore-case: true # (OPTIONAL) ignore capitalisation - default: false + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/consume-(task-type).md b/docs/task-types/consume-(task-type).md new file mode 100644 index 00000000..a5e23d13 --- /dev/null +++ b/docs/task-types/consume-(task-type).md @@ -0,0 +1,64 @@ +--- +title: consume +parent: Task types +nav_order: 8 +--- + +# consume (task type) + +Since v3.9 +{: .label .label-green } + +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 | \- | \- | + +## Examples + +Consume 8 of `BEEF`: + +``` yaml +beef: + type: "consume" + item: BEEF # name of item (can be id or minecraft name) + amount: 8 # amount of item consumed + data: 0 # (OPTIONAL) data code + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Consume 8 of a specific item: + +``` yaml +beef: + type: "consume" + item: # SPECIFIC item with name and lore + name: "&cSpecial Beef" + type: "RAW_BEEF" + lore: + - "&7This is a special type of beef" + amount: 8 # amount of item consumed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Consume 8 of [quest item](../configuration/defining-items#quest-items) +`special_beef`: + +``` yaml +beef: + type: "consume" + item: # USING quest-item + quest-item: "special_beef" + amount: 8 # amount of item needed + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/crafting-(task-type).md b/docs/task-types/crafting-(task-type).md new file mode 100644 index 00000000..14c9e8fb --- /dev/null +++ b/docs/task-types/crafting-(task-type).md @@ -0,0 +1,63 @@ +--- +title: crafting +parent: Task types +nav_order: 9 +--- + +# crafting (task type) + +Since v3.0 +{: .label .label-green } + +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 | \- | \- | + +## Examples + +Craft 5 of `COMPASS`: + +``` yaml +compass: + type: "crafting" + item: COMPASS # name of item (can be id or minecraft name) + amount: 5 # amount of item needed + data: 0 # (OPTIONAL) data code + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Craft 5 of a specific item: + +``` yaml +compass: + type: "crafting" + item: # SPECIFIC item with name and lore + name: "&cSuper Compass" + type: "COMPASS" + lore: + - "&7This is special compass with a fancy name" + amount: 5 # amount of item needed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Craft 5 of [quest item](../configuration/defining-items#quest-items) +`super_compass`: + +``` yaml +compass: + type: "crafting" + item: # USING quest-item + quest-item: "super_compass" + amount: 5 # amount of item needed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/dealdamage-(task-type).md b/docs/task-types/dealdamage-(task-type).md new file mode 100644 index 00000000..426f76e2 --- /dev/null +++ b/docs/task-types/dealdamage-(task-type).md @@ -0,0 +1,31 @@ +--- +title: dealdamage +parent: Task types +nav_order: 10 +--- + +# dealdamage (task type) + +Since v2.2 +{: .label .label-green } + +Deal a certain amount of damage. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|----------------------------------------------------------------------------------------------------------| +| `amount` | The amount of damage needed. | Integer | Yes | \- | Damage is measured in HP, 1 heart = 2 HP. A player has 20 HP by default, with no status effects applied. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Deal 100 HP of damage: + +``` yaml +dealdamage: + type: "dealdamage" + amount: 100 # amount of damage inflicted (HP) + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/distancefrom-(task-type).md b/docs/task-types/distancefrom-(task-type).md new file mode 100644 index 00000000..5c0e8305 --- /dev/null +++ b/docs/task-types/distancefrom-(task-type).md @@ -0,0 +1,36 @@ +--- +title: distancefrom +parent: Task types +nav_order: 11 +--- + +# distancefrom (task type) + +Since v2.12 +{: .label .label-green } + +Travel away from a set of co-ordinates. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|------------|-----------------------------------------------------------------|---------|----------|---------|-------| +| `x` | The x co-ordinate. | Integer | Yes | \- | \- | +| `y` | The y co-ordinate. | Integer | Yes | \- | \- | +| `z` | The z co-ordinate. | Integer | Yes | \- | \- | +| `world` | The name of the world. | String | Yes | \- | \- | +| `distance` | The distance away from the co-ordinates the player must travel. | Integer | Yes | \- | \- | + +## Examples + +Travel at least 10 blocks away from (0, 0, 0) in world: + +``` yaml +distancefrom: + type: "distancefrom" + x: 0 # x position + y: 0 # y position + z: 0 # z position + world: world # name of world + distance: 10 # required distance from coordinates +``` diff --git a/docs/task-types/enchanting-(task-type).md b/docs/task-types/enchanting-(task-type).md new file mode 100644 index 00000000..1e2b6c80 --- /dev/null +++ b/docs/task-types/enchanting-(task-type).md @@ -0,0 +1,57 @@ +--- +title: enchanting +parent: Task types +nav_order: 12 +--- + +# enchanting (task type) + +Since v2.2 +{: .label .label-green } + +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 | \- | \- | + +## Examples + +Enchant 10 items: + +``` yaml +enchanting: + type: "enchanting" + amount: 10 # amount of items enchanted + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Enchant 10 items with Protection: + +``` yaml +beef: + type: "enchanting" + amount: 10 # amount of items + enchantment: PROTECTION_ENVIRONMENTAL # (OPTIONAL) enchantment to apply + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Enchant 10 items with Protection IV: + +``` yaml +beef: + type: "enchanting" + amount: 10 # amount of items + enchantment: PROTECTION_ENVIRONMENTAL # (OPTIONAL) enchantment to apply + min-level: 4 # (OPTIONAL) the minimum level of enchantment to apply + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/essentials_balance-(task-type).md b/docs/task-types/essentials_balance-(task-type).md new file mode 100644 index 00000000..6d246376 --- /dev/null +++ b/docs/task-types/essentials_balance-(task-type).md @@ -0,0 +1,31 @@ +--- +title: essentials_balance +parent: Task types +nav_order: 31 +--- + +# essentials_balance (task type) + +Since v2.12 +{: .label .label-green } + +Plugin 'Essentials' required +{: .label } + +Reach a certain balance. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|----------------------|---------|----------|---------|-------| +| `amount` | The amount to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach a balance of \$1000: + +``` yaml +essentialsbalance: + type: "essentials_balance" + amount: 1000 # amount of money to rach +``` diff --git a/docs/task-types/essentials_moneyearn-(task-type).md b/docs/task-types/essentials_moneyearn-(task-type).md new file mode 100644 index 00000000..eba692fa --- /dev/null +++ b/docs/task-types/essentials_moneyearn-(task-type).md @@ -0,0 +1,31 @@ +--- +title: essentials_moneyearn +parent: Task types +nav_order: 32 +--- + +# essentials_moneyearn (task type) + +Since v2.12 +{: .label .label-green } + +Plugin 'Essentials' required +{: .label } + +Earn a certain amount of money after starting quest. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|---------------------|---------|----------|---------|-------| +| `amount` | The amount to earn. | Integer | Yes | \- | \- | + +## Examples + +Earn \$1000: + +``` yaml +essentialsbalance: + type: "essentials_moneyearn" + amount: 1000 # amount of money to earn +``` diff --git a/docs/task-types/expearn-(task-type).md b/docs/task-types/expearn-(task-type).md new file mode 100644 index 00000000..86cbf5ca --- /dev/null +++ b/docs/task-types/expearn-(task-type).md @@ -0,0 +1,31 @@ +--- +title: expearn +parent: Task types +nav_order: 13 +--- + +# expearn (task type) + +Since v2.2 +{: .label .label-green } + +Earn a set amount of exp after starting the quest. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The amount of experience to earn. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Earn 20 experience: + +``` yaml +expearn: + type: "expearn" + amount: 20 # amount of experience earned + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/fabledskyblock_level-(task-type).md b/docs/task-types/fabledskyblock_level-(task-type).md new file mode 100644 index 00000000..eecf2dc0 --- /dev/null +++ b/docs/task-types/fabledskyblock_level-(task-type).md @@ -0,0 +1,31 @@ +--- +title: fabledskyblock_level +parent: Task types +nav_order: 33 +--- + +# fabledskyblock_level (task type) + +Since v3.5 +{: .label .label-green } + +Plugin 'FabledSkyblock' required +{: .label } + +Reach a certain FabledSkyblock level. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `level` | The level to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island level 10: + +``` yaml +fabledskyblock: + type: "fabledskyblock_level" + level: 10 # island level needed +``` diff --git a/docs/task-types/farming-(task-type).md b/docs/task-types/farming-(task-type).md new file mode 100644 index 00000000..4207f903 --- /dev/null +++ b/docs/task-types/farming-(task-type).md @@ -0,0 +1,66 @@ +--- +title: farming +parent: Task types +nav_order: 14 +--- + +# farming (task type) + +Since v3.5 +{: .label .label-green } + +Minecraft 1.13+ required +{: .label .label-purple } + +*For previous versions, use [blockbreak](blockbreak-(task-type)).* + +Farm a set amount of crops. + +{: .note } +Since Quests v3.13, `farmingcertain` and `farming` have been merged into +one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|-------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of crops to farm. | Integer | Yes | \- | \- | +| `block` | The specific crop(s) to farm. | Material, or list of material | No | \- | 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. Note that some items are confusingly named, they may refer to the held item or block instead of the crop block. | +| `mode` | The mode to harvest crops. | String | No | \- | One of: `break`, `harvest`. A harvest is where a block drops an item (usually a crop) but does not change state. If this is not specified, both will be accepted. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Farm 10 crops: + +``` yaml +farming: + type: "farming" + amount: 10 # amount of blocks to be broken + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Farm 10 wheat: + +``` yaml +farming: + type: "farming" + amount: 10 # amount of blocks to be brkoen + block: WHEAT # name of block (can be id or minecraft name) + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Farm 10 wheat or beetroot: + +``` yaml +farmingmultiple: + type: "farming" + amount: 10 # amount of blocks to be placed + blocks: # name of blocks which will count towards progress + - WHEAT + - BEETROOT + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/fishing-(task-type).md b/docs/task-types/fishing-(task-type).md new file mode 100644 index 00000000..659a6521 --- /dev/null +++ b/docs/task-types/fishing-(task-type).md @@ -0,0 +1,60 @@ +--- +title: fishing +parent: Task types +nav_order: 15 +--- + +# fishing (task type) + +Since v2.0 +{: .label .label-green } + +Fish a set amount of items. + +{: .note } +Since Quests v3.13, `fishingcertain` and `fishing` have been merged into +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 | \- | \- | + +## Examples + +Fish 10 of any item: + +``` yaml +fishing: + type: "fishing" + amount: 10 # amount of fish caught + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Fish 10 pufferfish: + +``` yaml +fishingcertain: + type: "fishingcertain" + item: PUFFERFISH # type of item caught + amount: 10 # amount of item caught + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Fish 10 of [quest item](../configuration/defining-items#quest-items) +`super_fish`: + +``` yaml +fishingcertain: + type: "fishingcertain" + item: # type of item caught + quest-item: "super_fish" + amount: 10 # amount of item caught + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/index.md b/docs/task-types/index.md new file mode 100644 index 00000000..4b0e657f --- /dev/null +++ b/docs/task-types/index.md @@ -0,0 +1,7 @@ +--- +title: Task types +has_children: true +nav_order: 6 +--- + +# Task types
\ No newline at end of file diff --git a/docs/task-types/inventory-(task-type).md b/docs/task-types/inventory-(task-type).md new file mode 100644 index 00000000..a240207a --- /dev/null +++ b/docs/task-types/inventory-(task-type).md @@ -0,0 +1,74 @@ +--- +title: inventory +parent: Task types +nav_order: 16 +--- + +# inventory (task type) + +Since v1.4 +{: .label .label-green } + + +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 | \- | \- | + +## Examples + +Obtain 8 of `BEEF`: + +``` yaml +beef: + type: "inventory" + item: BEEF # name of item (can be id or minecraft name) + amount: 8 # amount of item needed + data: 0 # (OPTIONAL) data code + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Obtain 8 of a specific item: + +``` yaml +beef: + type: "inventory" + item: # SPECIFIC item with name and lore + name: "&cSpecial Beef" + type: "RAW_BEEF" + lore: + - "&7This is a special type of beef" + amount: 8 # amount of item needed + data: 0 # (OPTIONAL) data code + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Obtain 8 of [quest item](../configuration/defining-items#quest-items) +`special_beef`: + +``` yaml +beef: + type: "inventory" + item: # USING quest-item + quest-item: "specialbeef" + amount: 8 # amount of item needed + data: 0 # (OPTIONAL) data code + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/iridiumskyblock_value-(task-type).md b/docs/task-types/iridiumskyblock_value-(task-type).md new file mode 100644 index 00000000..40ca8a8c --- /dev/null +++ b/docs/task-types/iridiumskyblock_value-(task-type).md @@ -0,0 +1,31 @@ +--- +title: iridiumskyblock_value +parent: Task types +nav_order: 34 +--- + +# iridiumskyblock_value (task type) + +Since v3.5 +{: .label .label-green } + +Plugin 'IridiumSkyblock' required - version 2.x only +{: .label } + +Reach a certain IridiumSkyblock value. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|--------------------|---------|----------|---------|-------| +| `value` | The valueto reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island value 10: + +``` yaml +iridiumskyblock: + type: "iridiumskyblock_value" + value: 10 # island level needed +``` diff --git a/docs/task-types/milking-(task-type).md b/docs/task-types/milking-(task-type).md new file mode 100644 index 00000000..75c2ed86 --- /dev/null +++ b/docs/task-types/milking-(task-type).md @@ -0,0 +1,31 @@ +--- +title: milking +parent: Task types +nav_order: 17 +--- + +# milking (task type) + +Since v2.0 +{: .label .label-green } + +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 | \- | \- | + +## Examples + +Milk 10 cows: + +``` yaml +milking: + type: "milking" + amount: 10 # amount of cows milked + 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 new file mode 100644 index 00000000..f0a5c50b --- /dev/null +++ b/docs/task-types/mobkilling-(task-type).md @@ -0,0 +1,103 @@ +--- +title: mobkilling +parent: Task types +nav_order: 18 +--- + +# mobkilling (task type) + +Since v2.0 +{: .label .label-green } + +Kill a set amount of mobs. + +{: .note } +Since Quests v3.13, `mobkillingcertain` and `mobkilling` have been +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](defining_items "wikilink"). | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Kill 10 of any mob: + +``` yaml +mobkilling: + type: "mobkilling" + amount: 10 # amount of mobs to be killed + hostile: true # (OPTIONAL) whether or not the mob is hostile - default: both + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Kill 10 of a blaze named (red) "Inferno": + +``` yaml +mobkillingblaze: + type: "mobkilling" + amount: 10 # amount of mobs to be killed + mob: BLAZE # (OPTIONAL) type of mob + name: &cInferno # (OPTIONAL) this only allows blazes called "&cInferno" - default: any name + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Kill 10 of a blade named either (red) "Inferno" or (orange) "Furnace": + +``` yaml +mobkillingblazemultiple: + type: "mobkilling" + amount: 10 # amount of mobs to be killed + mob: BLAZE # (OPTIONAL) type of mob + names: # (OPTIONAL) this only allows blazes called "&cInferno" OR "&6Furnace" - default: any name + - "&cInferno" + - "&6Furnace" + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Kill 10 of a blaze or creeper named either (red) "Inferno" or (orange) +"Furnace": + +``` yaml +mobkillingblazemultiple: + type: "mobkilling" + amount: 10 # amount of mobs to be killed + mob: # (OPTIONAL) types of mobs + - BLAZE + - CREEPER + names: # (OPTIONAL) this only allows blazes called "&cInferno" OR "&6Furnace" - default: any name + - "&cInferno" + - "&6Furnace" + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Kill 10 of a blaze or creeper named either (red) "Inferno" or (orange) +"Furnace" with [quest item](../configuration/defining-items#quest-items) +"super_sword": + +``` yaml +mobkillingblazecreepermultiple: + type: "mobkilling" + amount: 10 # amount of mobs to be killed + mob: # (OPTIONAL) types of mobs + - BLAZE + - CREEPER + names: # (OPTIONAL) this only allows blazes called "&cInferno" OR "&6Furnace" - default: any name + - "&cInferno" + - "&6Furnace" + item: # (OPTIONAL) specific item to kill with + quest-item: "super_sword" + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/mythicmobs_killing-(task-type).md b/docs/task-types/mythicmobs_killing-(task-type).md new file mode 100644 index 00000000..4862f66d --- /dev/null +++ b/docs/task-types/mythicmobs_killing-(task-type).md @@ -0,0 +1,40 @@ +--- +title: mythicmobs_killing +parent: Task types +nav_order: 35 +--- + +# mythicmobs_killing (task type) + +Since v2.3 +{: .label .label-green } + +Plugin 'MythicMobs' required +{: .label } + +Kill a certain MythicMobs mob. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|-------------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of mobs to kill. | Integer | Yes | \- | \- | +| `name` | The MythicMob ID. | String | Yes | \- | \- | +| `level` | The level the mob must be at. | Integer | Yes | \- | \- | +| `min-level` | The minimum level the mob must be at. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Kill 1 mythic mob with the ID "SkeletalKnight": + +``` yaml +mythicmobs: + type: "mythicmobs_killing" + amount: 1 # amount of mobs to be killed + name: "SkeletalKnight" # internal name of mob (name in config - NOT display name) + level: 1 # (OPTIONAL) the exact level the mob must be for it to count + min-level: 1 # (OPTIONAL) the minimum level the mob must be for it to count + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/permission-(task-type).md b/docs/task-types/permission-(task-type).md new file mode 100644 index 00000000..aa55c00a --- /dev/null +++ b/docs/task-types/permission-(task-type).md @@ -0,0 +1,30 @@ +--- +title: permission +parent: Task types +nav_order: 19 +--- + +# permission (task type) + +Since v2.9.5 +{: .label .label-green } + +Test if a player has a permission. + +This task works by regularly polling a player at a certain interval. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|--------------|----------------------------------------|--------|----------|---------|-------| +| `permission` | The permission the player should have. | String | Yes | \- | \- | + +## Examples + +Check if player has permission `some.permission.name`: + +``` yaml +permission: + type: "permission" + permission: "some.permission.name" # permission required to be marked as complete +``` diff --git a/docs/task-types/placeholderapi_evaluate-(task-type).md b/docs/task-types/placeholderapi_evaluate-(task-type).md new file mode 100644 index 00000000..87079d7f --- /dev/null +++ b/docs/task-types/placeholderapi_evaluate-(task-type).md @@ -0,0 +1,49 @@ +--- +title: placeholderapi_evaluate +parent: Task types +nav_order: 36 +--- + +# placeholderapi_evaluate (task type) + +Since v2.9.5 +{: .label .label-green } + +Plugin 'PlaceholderAPI' required +{: .label } + +Evaluate a certain PlaceholderAPI placeholder and compare it against a given condition. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------------|-----------------------------------------------------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `placeholder` | The placeholder to evaluate. | String | Yes | \- | \- | +| `evaluates` | The string the placeholder should evaluate to. | String | Yes | \- | \- | +| `operator` | The comparative operator to use for numeric placeholders. | String | No | \- | One of: `GREATER_THAN`, `LESS_THAN`, `GREATER_THAN_OR_EQUAL_TO`, `LESS_THAN_OR_EQUAL_TO`. The value in `evaluates` **must** be numeric. If this is not specified, then exact equality will be assumed. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Have a player name of "fatpigsarefat": + +``` yaml +papieval: + type: "placeholderapi_evaluate" + placeholder: "%player_name%" # placeholder string + evaluates: "fatpigsarefat" # what it should evaluate as to be marked as complete + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Be online when there are more than 20 empty slots on the server: + +``` yaml +papieval: + type: "placeholderapi_evaluate" + placeholder: "%player_empty_slots%" # placeholder string + evaluates: "20" # number to compare to + operator: "GREATER_THAN" # (OPTIONAL) numerical operator, "evaluates" MUST be an integer + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/playerkilling-(task-type).md b/docs/task-types/playerkilling-(task-type).md new file mode 100644 index 00000000..4aee13bf --- /dev/null +++ b/docs/task-types/playerkilling-(task-type).md @@ -0,0 +1,32 @@ +--- +title: playerkilling +parent: Task types +nav_order: 20 +--- + +# playerkilling (task type) + +Since v2.0 +{: .label .label-green } + + +Kill a set amount of players. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of players to kill. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Kill 10 of any player: + +``` yaml +killplayers: + type: "playerkilling" + amount: 10 # amount of players to kill + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/playtime-(task-type).md b/docs/task-types/playtime-(task-type).md new file mode 100644 index 00000000..649b0db4 --- /dev/null +++ b/docs/task-types/playtime-(task-type).md @@ -0,0 +1,33 @@ +--- +title: playtime +parent: Task types +nav_order: 21 +--- + +# playtime (task type) + +Since v1.8 +{: .label .label-green } + +Play for a certain amount of time after starting the quest. + +{: .note } +Before Quests v2.0, this task was known as `TIMEPLAYED`. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|--------------|----------------------------------------|---------|----------|---------|----------------------| +| `minutes` | The number of minutes to play. | Integer | Yes | \- | \- | +| `ignore-afk` | Whether AFK players should be ignored. | Boolean | Yes | \- | Requires Essentials. | + +## Examples + +Play for 20 minutes: + +``` yaml +playtime: + type: "playtime" + minutes: 10 # amount of minutes played + ignore-afk: false # (OPTIONAL) ignore players marked as AFK by essentials +``` diff --git a/docs/task-types/position-(task-type).md b/docs/task-types/position-(task-type).md new file mode 100644 index 00000000..bf990ca8 --- /dev/null +++ b/docs/task-types/position-(task-type).md @@ -0,0 +1,36 @@ +--- +title: position +parent: Task types +nav_order: 22 +--- + +# position (task type) + +Since v2.0.3 +{: .label .label-green } + +Reach a set of co-ordinates. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|--------------------|-----------------------------------------------------------|---------|----------|---------|----------------------------------------------------------------------| +| `x` | The x co-ordinate. | Integer | Yes | \- | \- | +| `y` | The y co-ordinate. | Integer | Yes | \- | \- | +| `z` | The z co-ordinate. | Integer | Yes | \- | \- | +| `world` | The name of the world. | String | Yes | \- | \- | +| `distance-padding` | The distance around the co-ordinate the player can reach. | Integer | No | \- | Having no padding means the player must reach the exact co-ordinate. | + +## Examples + +Travel to within 10 blocks of (0, 0, 0) in world: + +``` yaml +position: + type: "position" + x: 0 # x position + y: 0 # y position + z: 0 # z position + world: world # name of world + distance-padding: 10 # (OPTIONAL) padding zone in meters/blocks - this will allow within 10 blocks of 0, 0, 0 - default = 0 +``` diff --git a/docs/task-types/shearing-(task-type).md b/docs/task-types/shearing-(task-type).md new file mode 100644 index 00000000..5c81e1e7 --- /dev/null +++ b/docs/task-types/shearing-(task-type).md @@ -0,0 +1,32 @@ +--- +title: shearing +parent: Task types +nav_order: 23 +--- + +# shearing (task type) + +Since v2.0 +{: .label .label-green } + + +Shear a set amount of sheep. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of sheep to shear. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Shear 10 sheep: + +``` yaml +shearing: + type: "shearing" + amount: 10 # amount of sheep sheared + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/shopguiplus_buy-(task-type).md b/docs/task-types/shopguiplus_buy-(task-type).md new file mode 100644 index 00000000..85c03ae9 --- /dev/null +++ b/docs/task-types/shopguiplus_buy-(task-type).md @@ -0,0 +1,39 @@ +--- +title: shopguiplus_buy +parent: Task types +nav_order: 37 +--- + +# shopguiplus_buy (task type) + +Since v2.15 +{: .label .label-green } + +Plugin 'ShopGUI+' required +{: .label } + +Buy a certain number of items from a ShopGUI+ shop. + +{: .note } +Since Quests v3.13, `shopguiplus_buycertain` and `shopguiplus_buy` have +been merged into one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|-----------|-----------------------------|---------|----------|---------|-------| +| `amount` | The number of items to buy. | Integer | Yes | \- | \- | +| `shop-id` | The ID of the shop. | String | Yes | \- | \- | +| `item-id` | The ID of the item to buy. | String | Yes | \- | \- | + +## Examples + +Buy 1000 of item_id from shop_id: + +``` yaml +shopguiplusbuy: + type: "shopguiplus_buy" + shop-id: "shop_id" # shopgui+ id of the shop that contains the item. + item-id: "item_id" # shopgui+ id of item to sell + amount: 1000 # amount of thing to sell +``` diff --git a/docs/task-types/shopguiplus_sell-(task-type).md b/docs/task-types/shopguiplus_sell-(task-type).md new file mode 100644 index 00000000..a1c94a10 --- /dev/null +++ b/docs/task-types/shopguiplus_sell-(task-type).md @@ -0,0 +1,39 @@ +--- +title: shopguiplus_sell +parent: Task types +nav_order: 38 +--- + +# shopguiplus_sell (task type) + +Since v2.15 +{: .label .label-green } + +Plugin 'ShopGUI+' required +{: .label } + +Sell a certain number of items to a ShopGUI+ shop. + +{: .note } +Since Quests v3.13, `shopguiplus_sellcertain` and `shopguiplus_sell` +have been merged into one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|-----------|------------------------------|---------|----------|---------|-------| +| `amount` | The number of items to sell. | Integer | Yes | \- | \- | +| `shop-id` | The ID of the shop. | String | Yes | \- | \- | +| `item-id` | The ID of the item to sell. | String | Yes | \- | \- | + +## Examples + +Sell 1000 of item_id to shop_id: + +``` yaml +shopguiplussell: + type: "shopguiplus_sell" + shop-id: "shop_id" # shopgui+ id of the shop that contains the item. + item-id: "item_id" # shopgui+ id of item to sell + amount: 1000 # amount of thing to sell +``` diff --git a/docs/task-types/smelting-(task-type).md b/docs/task-types/smelting-(task-type).md new file mode 100644 index 00000000..721740c5 --- /dev/null +++ b/docs/task-types/smelting-(task-type).md @@ -0,0 +1,76 @@ +--- +title: smelting +parent: Task types +nav_order: 24 +--- + +# smelting (task type) + +Since v3.12 +{: .label .label-green } + +Cook a set amount of an item. + +{: .note } +Since Quests v3.13, `smeltingcertain` and `smelting` have been merged +into one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to smelt. | Integer | Yes | \- | \- | +| `item` | The specific item to smelt. | 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 this is not specified, any item will count. | +| `mode` | The specific mode of smelting. | String | No | \- | One of: `smoker`, `blast_furnace`, `furnace`. If this is not specified, any furnace will count. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Smelt 10 items: + +``` yaml +smelting: + type: "smelting" + amount: 10 # amount to smelt + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Cook 10 steak: + +``` yaml +smeltingcertain: + type: "smeltingcertain" + amount: 10 # amount to smelt + item: STEAK # type of item + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Cook 10 of a specific item: + +``` yaml +smeltingcertain: + type: "smeltingcertain" + amount: 10 # amount to smelt + item: # SPECIFIC item with name and lore + name: "&cSpecial Beef" + type: "RAW_BEEF" + lore: + - "&7This is a special type of beef" + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Cook 10 of [quest item](../configuration/defining-items#quest-items) +`special_beef`: + +``` yaml +smeltingcertain: + type: "smeltingcertain" + amount: 10 # amount to smelt + item: # type of item + quest-item: "special_beef" + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/superiorskyblock_level-(task-type).md b/docs/task-types/superiorskyblock_level-(task-type).md new file mode 100644 index 00000000..c23996b6 --- /dev/null +++ b/docs/task-types/superiorskyblock_level-(task-type).md @@ -0,0 +1,31 @@ +--- +title: superiorskyblock_level +parent: Task types +nav_order: 39 +--- + +# superiorskyblock_level (task type) + +Since v3.7 +{: .label .label-green } + +Plugin 'SuperiorSkyblock' required +{: .label } + +Reach a certain SuperiorSkyblock level. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `level` | The level to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island level 10: + +``` yaml +superiorskyblock: + type: "superiorskyblock_level" + level: 10 # island level needed +``` diff --git a/docs/task-types/superiorskyblock_worth-(task-type).md b/docs/task-types/superiorskyblock_worth-(task-type).md new file mode 100644 index 00000000..a47d50fe --- /dev/null +++ b/docs/task-types/superiorskyblock_worth-(task-type).md @@ -0,0 +1,31 @@ +--- +title: superiorskyblock_worth +parent: Task types +nav_order: 40 +--- + +# superiorskyblock_worth (task type) + +Since v3.7 +{: .label .label-green } + +Plugin 'SuperiorSkyblock' required +{: .label } + +Reach a certain SuperiorSkyblock worth. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `worth` | The worth to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island worth 100: + +``` yaml +superiorskyblock: + type: "superiorskyblock_worth" + level: 100 # island worth needed +``` diff --git a/docs/task-types/taming-(task-type).md b/docs/task-types/taming-(task-type).md new file mode 100644 index 00000000..1847bda4 --- /dev/null +++ b/docs/task-types/taming-(task-type).md @@ -0,0 +1,31 @@ +--- +title: taming +parent: Task types +nav_order: 25 +--- + +# taming (task type) + +Since v3.13 +{: .label .label-green } + +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 | \- | \- | + +## Examples + +Tame 10 animals: + +``` yaml +taming: + type: "taming" + amount: 10 # amount of mobs tamed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/uskyblock_level-(task-type).md b/docs/task-types/uskyblock_level-(task-type).md new file mode 100644 index 00000000..729ca5c6 --- /dev/null +++ b/docs/task-types/uskyblock_level-(task-type).md @@ -0,0 +1,31 @@ +--- +title: uskyblock_level +parent: Task types +nav_order: 41 +--- + +# uskyblock_level (task type) + +Since v1.7.1 +{: .label .label-green } + +Plugin 'uSkyBlock' required +{: .label } + +Reach a certain uSkyBlock level. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `level` | The level to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island level 10: + +``` yaml +askyblock: + type: "uskyblock_level" + level: 10 # island level needed +``` diff --git a/docs/task-types/votingplugin_vote-(task-type).md b/docs/task-types/votingplugin_vote-(task-type).md new file mode 100644 index 00000000..6a17abac --- /dev/null +++ b/docs/task-types/votingplugin_vote-(task-type).md @@ -0,0 +1,31 @@ +--- +title: votingplugin_vote +parent: Task types +nav_order: 42 +--- + +# votingplugin_vote (task type) + +Since v3.7 +{: .label .label-green } + +Plugin 'VotingPlugin' required +{: .label } + +Vote a number of times using VotingPlugin. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|----------------------|---------|----------|---------|-------| +| `amount` | The number of votes. | Integer | Yes | \- | \- | + +## Examples + +Vote 10 times: + +``` yaml +votingplugin: + type: "votingplugin_vote" + amount: 10 # number of times to vote +``` diff --git a/docs/task-types/walking-(task-type).md b/docs/task-types/walking-(task-type).md new file mode 100644 index 00000000..4c38fc27 --- /dev/null +++ b/docs/task-types/walking-(task-type).md @@ -0,0 +1,43 @@ +--- +title: walking +parent: Task types +nav_order: 26 +--- + +# walking (task type) + +Since v2.0 +{: .label .label-green } + +Walk a set distance. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|------------|-------------------------------------------------|---------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `distance` | The distance in metres to walk. | Integer | Yes | \- | 1 metre is equivalent to 1 block. | +| `mode` | The specific mode to travel | String | No | \- | One of: `boat`, `horse`, `pig`, `minecart` `strider`, `sneaking`, `walking`, `running`, `swimming`, `flying`, `elytra`. Not specifying a mode will allow any of these modes to count. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Travel 1000 metres: + +``` yaml +walking: + type: "walking" + distance: 1000 # distance in blocks travelled + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Travel 1000 metres by sprinting only: + +``` yaml +walking: + type: "walking" + distance: 1000 # distance in blocks travelled + mode: running # (OPTIONAL) specific mode of transport + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` |