summaryrefslogtreecommitdiffstats
path: root/docs/configuration/creating-a-quest.md
diff options
context:
space:
mode:
authorLeonardo Bishop <me@leonardobishop.com>2024-02-17 13:48:40 +0000
committerLeonardo Bishop <me@leonardobishop.com>2024-02-17 13:48:40 +0000
commit3c354a0a45f0492cf075816c080c927c1cc656b6 (patch)
tree76d1ec2f5ba880ffc01150c0aea60c611ad8b24c /docs/configuration/creating-a-quest.md
parent832e99ce535008ffeb1bf2d63cebb21583262035 (diff)
Update documentation for release 3.15
Diffstat (limited to 'docs/configuration/creating-a-quest.md')
-rw-r--r--docs/configuration/creating-a-quest.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/configuration/creating-a-quest.md b/docs/configuration/creating-a-quest.md
index 4e7353a6..6b47e3e6 100644
--- a/docs/configuration/creating-a-quest.md
+++ b/docs/configuration/creating-a-quest.md
@@ -141,6 +141,20 @@ startcommands:
- "broadcast {player} has started a quest"
```
+## Cancel commands
+
+
+*`cancelcommands`*
+
+**Optional.** This is a list of commands which will be executed when the
+player cancels the quest. You can use `{player}` and the player's name
+will be substituted in place.
+
+``` yaml
+cancelcommands:
+ - "broadcast {player} has cancelled a quest"
+```
+
## Start string
@@ -190,6 +204,37 @@ These placeholders will be called using PlaceholderAPI. See [quest
progress in scoreboard](../guides/quest-progress-in-scoreboard) for a
guide which utilises this feature.
+## Progress placeholders
+
+*`progress-placeholders`*
+
+**Optional.** This is a list of placeholders which represent the progress
+of each task. These are used by the [bossbar](/configuration/basic-options#bossbar)
+and [actionbar](/configuration/basic-options#actionbar) configuration options.
+
+You can define a placeholder for each task, or for all of them as a catch-all.
+
+```yaml
+progress-placeholders:
+ <task-name>: "Progress for <task-name>"
+ '*': "Progress for tasks not defined above"
+```
+
+For example, in an actual quest:
+
+```yaml
+tasks:
+ mining:
+ type: "blockbreak"
+ amount: 100
+ building:
+ type: "blockplace"
+ amount: 100
+# ...
+progress-placeholders:
+ mining: "&f{mining:progress}/100 &7blocks broken"
+ building: "&f{building:progress}/100 &7blocks placed"
+```
## Options