aboutsummaryrefslogtreecommitdiffstats
path: root/docs/task-types/position-(task-type).md
blob: 829b06c7884979f5ef684ccea103e3c807eb6ca7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
---
title: position
parent: Built-in task types
grand_parent: Task types
---

# 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
```