diff options
Diffstat (limited to 'docs/task-types')
| -rw-r--r-- | docs/task-types/blockbreak-(task-type).md | 5 | ||||
| -rw-r--r-- | docs/task-types/blockitemdropping-(task-type).md | 42 | ||||
| -rw-r--r-- | docs/task-types/breeding-(task-type).md | 3 | ||||
| -rw-r--r-- | docs/task-types/ecomobs_killing-(task-type).md | 36 | ||||
| -rw-r--r-- | docs/task-types/mobkilling-(task-type).md | 3 | ||||
| -rw-r--r-- | docs/task-types/projectilelaunching-(task-type).md | 45 | ||||
| -rw-r--r-- | docs/task-types/pyrofishingpro_fishing-(task-type).md | 33 |
7 files changed, 166 insertions, 1 deletions
diff --git a/docs/task-types/blockbreak-(task-type).md b/docs/task-types/blockbreak-(task-type).md index 2ec16687..d4dd1ab6 100644 --- a/docs/task-types/blockbreak-(task-type).md +++ b/docs/task-types/blockbreak-(task-type).md @@ -9,7 +9,10 @@ grand_parent: Task types Since v1.0 {: .label .label-green } -Break a set amount of blocks. +Break a set amount of blocks. For items which can be broken by +breaking a block underneath it (such as torches or signs), consider +using the [blockitemdropping task type](blockitemdropping-(task-type)) +instead. {: .note } Since Quests v3.13, `blockbreakcertain` and `blockbreak` have been diff --git a/docs/task-types/blockitemdropping-(task-type).md b/docs/task-types/blockitemdropping-(task-type).md new file mode 100644 index 00000000..c4deba4a --- /dev/null +++ b/docs/task-types/blockitemdropping-(task-type).md @@ -0,0 +1,42 @@ +--- +title: blockitemdropping +parent: Built-in task types +grand_parent: Task types +--- + +# blockitemdropping (task type) + +Since v3.15 +{: .label .label-green } + +Drop a certain amount of items from a block. In most cases, the +player must be in survival mode for this to be triggered. + +This is triggered by [`BlockDropItemEvent`](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/event/block/BlockDropItemEvent.html): + +> Called if a block broken by a player drops an item. +> This event will also be called if the player breaks +> a multi block structure, for example a torch on top +> of a stone. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------------|--------------------------------------------------------|--------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items. | Integer | Yes | \- | \- | +| `item` | The specific item to be dropped. | Material, or ItemStack | Yes | \- | 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. | +| `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 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 | \- | \- | +| `exact-match` | Whether the item should exactly match what is defined. | Boolean | No | true | \- | + +## Examples + +Break 8 torches: + +``` yaml +torch: + type: "blockitemdropping" + item: TORCH # name of item (can be id or minecraft name) + amount: 8 # amount of item dropped +``` diff --git a/docs/task-types/breeding-(task-type).md b/docs/task-types/breeding-(task-type).md index 1d527402..19039744 100644 --- a/docs/task-types/breeding-(task-type).md +++ b/docs/task-types/breeding-(task-type).md @@ -11,6 +11,9 @@ Since v2.2 Breed a certain amount of animals. +This task type has specific logic implemented for compatibility with +[WildStacker](https://bg-software.com/wildstacker/). + ## Options | Key | Description | Type | Required | Default | Notes | diff --git a/docs/task-types/ecomobs_killing-(task-type).md b/docs/task-types/ecomobs_killing-(task-type).md new file mode 100644 index 00000000..04ea7224 --- /dev/null +++ b/docs/task-types/ecomobs_killing-(task-type).md @@ -0,0 +1,36 @@ +--- +title: ecomobs_killing +parent: External task types +grand_parent: Task types +--- + +# ecomobs_killing (task type) + +Since v3.15 +{: .label .label-green } + +Plugin 'EcoMobs' required +{: .label } + +Kill a certain number of EcoMobs mob. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|--------------|-------------------------------------------------|----------------------------|----------|---------|-------| +| `amount` | The number of bosses to kill. | Integer | Yes | \- | \- | +| `id` / `ids` | The EcoMobs boss ID(s). | String, or list of strings | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Kill 1 EcoMobs mobs with the ID "skeletalknight": + +``` yaml +ecobosses: + type: "ecomobs_killing" + amount: 1 # amount of mobs to be killed + id: "skeletalknight" # internal name of mob (name in config - NOT display name) + 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 ecc45030..1a8d107d 100644 --- a/docs/task-types/mobkilling-(task-type).md +++ b/docs/task-types/mobkilling-(task-type).md @@ -11,6 +11,9 @@ Since v2.0 Kill a set amount of mobs. +This task type has specific logic implemented for compatibility with +[WildStacker](https://bg-software.com/wildstacker/). + {: .note } Since Quests v3.13, `mobkillingcertain` and `mobkilling` have been merged into one. Both names can be used to refer to this task. diff --git a/docs/task-types/projectilelaunching-(task-type).md b/docs/task-types/projectilelaunching-(task-type).md new file mode 100644 index 00000000..b8dcc238 --- /dev/null +++ b/docs/task-types/projectilelaunching-(task-type).md @@ -0,0 +1,45 @@ +--- +title: projectilelaunching +parent: Built-in task types +grand_parent: Task types +--- + +# projectilelaunching (task type) + +Since v3.15 +{: .label .label-green } + +Launch a certain number of projectiles. This happens when +a player fires a bow, throws a snowball, etc. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|------------------------------|-------------------------------------------------|----------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of projectiles to launch. | Integer | Yes | \- | \- | +| `projectile` / `projectiles` | The specific projectile(s) to launch. | Entity type, or list of entities | No | \- | Not specifying this field will allow all entity 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 + +Shoot 5 arrows: + +``` yaml +projectilelaunching: + type: "projectilelaunching" + amount: 5 # amount of projectiles launched + projectile: 'ARROW' # the projectile to launch + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Throw 5 snowballs: + +``` yaml +projectilelaunching: + type: "projectilelaunching" + amount: 5 # amount of projectiles launched + projectile: 'SNOWBALL' # the projectile to launch + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/pyrofishingpro_fishing-(task-type).md b/docs/task-types/pyrofishingpro_fishing-(task-type).md new file mode 100644 index 00000000..4ba4a978 --- /dev/null +++ b/docs/task-types/pyrofishingpro_fishing-(task-type).md @@ -0,0 +1,33 @@ +--- +title: pyrofishingpro_fishing +parent: External task types +grand_parent: Task types +--- + +# pyrofishingpro_fishing (task type) + +Since v3.15 +{: .label .label-green } + +Plugin 'PyroFishingPro' required +{: .label } + +Catch a set amount of a Pyro fish from the sea. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------------|-------------------------------------|---------|----------|---------|-------------------------------------------------------------------| +| `amount` | The number of Pyro fish to catch. | Integer | Yes | \- | \- | +| `fish-number` | The specific fish number to catch. | Integer | No | \- | If this value is not specified, then any fish will count. | +| `tier` | The specific tier of fish to catch. | Integer | No | \- | If this value is not specified, then any tier of fish will count. | + +## Examples + +Catch 10 Pyro fish: + +```yaml +pyrofishing: + type: "pyrofishingpro_fishing" + amount: 10 # number needed +``` |