Skip to content

Commit d890f1e

Browse files
committed
feat: actual basic page about checkpoints
1 parent ae0d2bf commit d890f1e

File tree

6 files changed

+59
-5
lines changed

6 files changed

+59
-5
lines changed

assets/actions_list.png

24 KB
Loading

assets/current_actions_empty.png

17.1 KB
Loading

assets/current_actions_example.png

18.7 KB
Loading

docs/sidebar.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
{
55
"title": "Triggers",
66
"pages": [
7-
"triggers/checkpoint"
7+
"triggers/checkpoints"
88
]
99
},
1010
{

docs/triggers/checkpoint.mdx

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/triggers/checkpoints.mdx

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Checkpoints
3+
---
4+
5+
## Checkpoints
6+
7+
Checkpoints are a core feature for creating parkour maps. At their simplest, they work just as you'd expect: they save a player's position and the direction they are facing. However, they can also have custom behavior, executed from a list of predefined actions that a map builder can choose. Such examples are giving players potion effects and items, teleporting them, setting a time limit to reach the next checkpoint, making lava reset the player, and so on.
8+
9+
-----
10+
11+
## Getting a Checkpoint
12+
13+
As a builder, you can get a Checkpoint Plate from the builder menu item, which you are given when you first create a world. If you don't have it, you can get it back by doing `/give mapmaker:builder_menu`, or accessing the menu directly via `/buildermenu`, or `/bm` for short.
14+
15+
Alternatively, you can get a Checkpoint Plate directly by running the command `/give mapmaker:checkpoint_plate`.
16+
17+
-----
18+
19+
## Types of Checkpoints
20+
21+
There are two main types of checkpoints:
22+
23+
1. **Checkpoint Plate**: This is the standard pressure plate item you get from the builder menu or with /give. You place it in the world and right-click it to configure its behavior.
24+
2. **Checkpoint Region**: This is a more advanced, invisible checkpoint that is defined by a volume of space rather than a single block. You can learn more about how to set these up on the [regions]() documentation page.
25+
26+
-----
27+
28+
## The Checkpoint Menu
29+
30+
When you right-click a checkpoint plate or region as a builder, you open its configuration menu.
31+
32+
![An empty list of checkpoint actions](current_actions_empty.png)
33+
*A default checkpoint menu with nothing in it.*
34+
35+
In this default state, the checkpoint will only save the player's position. To add custom behavior, you can click the `+` icon to add an action.
36+
37+
![A list of all available actions](actions_list.png)
38+
*The list of all available actions.*
39+
40+
There are quite a few actions to choose from. We won't go over them here, but you can read about them in the [actions]() section of the docs or experiment with them yourself in-game.
41+
42+
![An example list of checkpoint actions](current_actions_example.png)
43+
*A checkpoint with an example list of actions.*
44+
45+
After selecting the actions you want, opening the menu again will show your chosen configuration. From here, you can further edit an action's settings with a **left-click** or remove it with a **right-click**.
46+
47+
Keep in mind that actions are executed in order, so make sure that, for example, if you want to remove items from someone, you do that *before* adding new ones.
48+
49+
In the top right, you can toggle whether the checkpoint can be activated only once or multiple times.
50+
51+
To test your checkpoint and its actions, get the **test mode** item from the builder menu or simply run the command `/test`.
52+
53+
-----
54+
55+
## Misc. Behavior
56+
57+
* **Copying a Checkpoint**: You can use your "pick block" key on a checkpoint to get a copy of it. When you place the new checkpoint, it will have the exact same configuration as the one you copied.
58+
* **Building Tools Compatibility**: Checkpoints work with **Terraform**, our basic, custom reimplementation of World Edit, so no need to worry about deleting them when you're cutting, moving, and pasting things around. This is not currently the case with Axiom mod, however.

0 commit comments

Comments
 (0)