docs/task-types/citizens_interact-(task-type).md


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: citizens_interact
parent: External task types
grand_parent: Task types
---

# 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 interact with.           | String              | No       | \-      | Mutually exclusive with `npc-id`.   |
| `npc-id`   | The id of the NPC to interact with.             | Integer             | 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"
```