Skip to content

Commit

Permalink
Add conditions docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Malfrador
Malfrador committed Oct 27, 2024
1 parent 678e93b commit 7aab637
Showing 1 changed file with 246 additions and 78 deletions.
324 changes: 246 additions & 78 deletions src/content/docs/QuestsXL/objectives.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,122 +3,290 @@ title: Objectives
sidebar_position: 4
---

## Craft
:::caution Nicht implementiert
ItemsXL ist noch nicht so weit :/
:::
``craft``
# Objectives

Ein Item herstellen. Sowohl Vanilla als auch JobsXL-Crafting.
## block_interact
This objective is completed when a player interacts with a block at the specified location.

* **id:** ID des Items.
* **amount:** Menge
#### Parameters:

## Enter Region
``enter_region``
| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `location` | The location of the block that the player must interact with. QLocation | | true |

Eine Region betreten.
```yaml
block_interact: x=64; y=64; z=64; world=world
```
* **id:** ID der Region.
```yaml
block_interact:
x: 64
y: 64
z: 64
world: world
```
## Entity Interact
``entity_interact``
## consume_item
An item needs to be consumed to complete this objective. Hephaestus item keys are used.
Mit einer Entity interagieren (Rechtsklick).
#### Parameters:
* **id:** Die Entity. Wenn hier ein Vanilla-Typ angegeben wird, zählt *jede* Vanilla-Entity dieses Typs. Ansonsten versucht QXL, einen Aether-NPC mit dieser ID zu finden.
| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `item` | The key of the item that needs to be consumed. Same as in /give | | true |

## Escort NPC
:::caution Nicht implementiert
:::
``escort_npc``
```yaml
consume_item: item=minecraft:apple
```

Einen NPC bewachen.
```yaml
consume_item:
item: 'minecraft:apple' # Needs to be quoted due to the colon.
```

## Experience
:::caution Nicht implementiert
:::
``experience``
## craft
An item needs to be crafted to complete this objective. Supports both vanilla crafting as well as JobsXL crafting. If both are set, both can be used to complete the objective.

## Impossible
#### Parameters:

Dieses Objective ist unmöglich und wird niemals erfüllt. Kann für Stages nützlich sein.
| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `item` | The key of the item that needs to be crafted. Hephaestus. Same as in /give | | false |
| `jxl_item` | The id of the job item that needs to be crafted. | | false |

## Instant
```yaml
craft: jxl_item=fancy_sword
```

Dieses Objective ist sofort erfüllt. Kann für Stages nützlich sein.
```yaml
craft:
item: 'erethon:fancy_sword' # Needs to be quoted due to the colon.
```

## Item Pickup
:::caution Nicht implementiert
ItemsXL ist noch nicht so weit :/
:::
``item_pickup``
## death
This objective is completed when the player dies.

Ein Item aufsammeln.
#### Parameters:

* **id:** ID des Items.
* **amount:** Menge
| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|

## Job Experience
``job_exp``
```yaml
death:
```

In einem Beruf eine bestimmte Menge Erfahrung erreichen.
```yaml
death:
```

* **amount:** Menge
* **reason:** ``command``, ``crafting``, ``dungeon``, ``item``, ``mob``, ``quest``, ``unknown``
## drop_item
Drop an item to complete this objective. Can optionally cancel the drop event, preventing the item from being dropped.

## Kill Player
``kill_player``
#### Parameters:

Einen oder mehrere Spieler töten.
| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `cancel` | Whether the drop event should be cancelled. | false | false |
| `item` | The key of the item that needs to be dropped. Same as in /give | | true |

* **amount:** Menge der Spieler. Aktuell zählt der gleiche Spieler mehrmals (TODO).
```yaml
drop_item: item=erethon:fancy_sword
```

## Leave Region
``leave_region``
```yaml
drop_item:
item: 'erethon:fancy_sword' # Needs to be quoted due to the colon.
cancel: true
```

Eine Region verlassen.
## enter_region
This objective is completed when a player enters a specific region. QuestsXL regions are used, not Factions. `/q region`

* **id:** Die ID der Region.
#### Parameters:

## Location
``location``
| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `region` | The ID of the region that the player must enter. | | true |

Eine Position erreichen.
```yaml
enter_region: region=region_id
```

* **distance:** Maximaldistanz zur Location
* **QLocation**
```yaml
enter_region:
region: region_id
```

## Mob
``mob``
## impossible
This objective is impossible to complete. It can be used to block progression, for example to only manually progress a stage with the set_stage action

Einen Mob töten. Funktioniert aktuell nur für mit Aether gespawnte Mobs.
#### Parameters:

* **id:** ID des Mobs.
* **amount:** Menge.
| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|

## Server Command
``server_command``
```yaml
impossible:
```

/q command (Identifier) wurde ausgeführt. Nützlich zur Integration mit Commandblocks.
```yaml
impossible:
```

* **identifier:** Der Identifier.
## instant
The opposite of the impossible objective. This objective is instantly completed when the stage starts.

## Use Item
:::caution Nicht implementiert
ItemsXL ist noch nicht so weit :/
:::
``use_item``
#### Parameters:

Ein Item nutzen.
| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|

## Wait
:::note Single-Line-Configs
Das Wait-Objective unterstützt keine Single-Line-Configs.
:::
```yaml
instant:
```

Warten.
```yaml
instant:
```

## job_exp
The player has to gain a certain amount of job experience.

#### Parameters:

| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `amount` | The amount of experience that needs to be gained. | 1 | false |
| `reason` | The reason for the experience gain. One of `command`, `crafting`, `dungeon`, `item`, `mob`, `quest`, `unknown` | `crafting` | false |

```yaml
job_exp: amount=100
```

```yaml
job_exp:
amount: 100
reason: mob
```

## kill_mob
This objective is completed when a player kills a specific mob, optionally within a certain radius around an event.

#### Parameters:

| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `id` | The ID of the mob | | true |
| `radius` | The radius around the event in which the mob has to be killed. Useful for events | -1 | false |

```yaml
kill_mob: id=evil_mob
```

```yaml
kill_mob:
id: 'evil_mob'
radius: 10
```

## leave_region
This objective is completed when a player leaves a specific region. QuestsXL regions are used. `/q region`

#### Parameters:

| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `region` | The ID of the region that the player must leave. | | true |

```yaml
leave_region: region=region_id
```

```yaml
leave_region:
region: 'region_id'
```

## location
This objective is completed when a player reaches a specific location.

#### Parameters:

| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `location` | The location that the player must reach. QLocation | | true |
| `range` | How close the player has to get to the location | 1 | false |

```yaml
location: x=64; y=64; z=64; range=5
```

```yaml
location: # This is completed when the player moves five blocks up from their current location.
x: ~0
y: ~5
z: ~0
```

## pickup_item
This objective is completed when the player picks up a specific item. Can optionally cancel the pickup event, preventing the item from being picked up.

#### Parameters:

| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `cancel` | Whether the pickup event should be cancelled. | false | false |
| `item` | The key of the item that needs to be picked up. Same as in /give | | true |

```yaml
pickup_item: item=erethon:fancy_sword
```

```yaml
pickup_item:
item: 'erethon:fancy_sword' # Needs to be quoted due to the colon.
cancel: true
```

## server_command
This objective is completed when a command is executed on the server, for example by a command block

#### Parameters:

| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `identifier` | The command that has to be executed | | true |

```yaml
server_command: identifier=q trigger 33333
```

```yaml
server_command:
identifier: q trigger 3333
```

## wait
This objective is completed after a certain amount of time has passed, or after a player has been in a certain location for a certain amount of time.

#### Parameters:

| Parameter | Description | Default | Required |
|-----------|-------------|---------|----------|
| `duration` | The time in seconds that the player has to wait. | | true |
| `location` | The location that the player must be in to complete the objective. | | false |
| `range` | How close the player has to get to the location | 1 | false |

```yaml
wait: duration=100
```

```yaml
wait:
duration: 10
x: 100
y: 100
z: 100
range: 5
```

* **duration:** Wartezeit
* **range:** Entfernung von der Warte-Location.
* **QLocation**

0 comments on commit 7aab637

Please sign in to comment.