aboutsummaryrefslogtreecommitdiffstats
path: root/docs/task-types/servernpc_interact-(task-type).md
blob: 278bd8d6cde0e30324844d6bb396b0efd6027f30 (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
---
title: servernpc_interact
parent: External task types
grand_parent: Task types
---

# servernpc_interact (task type)

Since v3.15
{: .label .label-green }

Plugin 'ServerNPC' required
{: .label }

Interact with a ServerNPC 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.             | String              | No       | \-      | Mutually exclusive with `npc-name`. |
| `worlds`   | Worlds which should count towards the progress. | List of world names | No       | \-      | \-                                  |

## Examples

Interact with an NPC with ID "gerald":

``` yaml
servernpcinteract:
  type: "servernpc_interact"
  npc-id: "gerald"                      # ID of NPC
  worlds:                               # (OPTIONAL) restrict to certain worlds
   - "world"
```