Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Malfrador committed Apr 21, 2023
1 parent bc31583 commit 0d67c0f
Show file tree
Hide file tree
Showing 3 changed files with 440 additions and 99 deletions.
222 changes: 125 additions & 97 deletions docs/questsxl/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,150 +9,178 @@ Für einige komplexe Actions steht die Kurzschreibweise nicht zur Verfügung.
In dieser Dokumentation wird die Kurzschreibweise zu erst genannt und dann die Langschreibweise.

## Animation
Spielt eine Animation ab.

`animation: <name>;<instanced>`
``animation``

```yaml
key:
type: animation
name: <name>
instanced: <true/false | true>
```
Spielt eine Animation ab.
* **name:** Der Name einer vorher erstellten Animation
* **instanced:** true/false - Ob die Animation nur für den Spieler (oder seine Gruppe) sichtbar ist (true) oder für alle (false). Default = true.
* **runAfter:** Nachdem die Animation vollständig abgespielt wurde.
* **runAfter:** Actions, nachdem die Animation vollständig abgespielt wurde.
## Command
Führt einen Befehl aus.
``command``

`command: <command>;<op>;<console>`
Führt einen Befehl aus.

```yaml
key:
type: command
command: <command>
op: <true/false | false>
console: <true/false | false>
```
* **command:** Der Befehl. Der Platzhalter `%player%` kann benutzt werden & wird durch den Namen des Spielers ersetzt.
* **op:** true/false - Ob der Befehl als OP (mit *-Permissions) ausgeführt wird oder nicht. Sollte vorsichtig genutzt werden. Default = false.
* **console:** true/false - Ob der Befehl vom Server ausgeführt werden soll. Default = false.
## Cutscene
``cutscene``

Spielt eine vorher erstellte Cutscene ab.

`cutscene: <name>;<teleportBack>`
```
key:
type: cutscene
name: <name>
teleportBack: <true/false | false>
```
* **name:** Der Name einer vorher ingame erstellten Cutscene
* **instanced:** true/false - Ob der Spieler nach Ende der Cutscene wieder an den Start zurückteleportiert wird (true), oder da bleibt wo die Cutscene endet (false). Default = false.
* **runAfter:** Nachdem die Cutscene fertig abgespielt wurde.
## Delay
``delay``

Führt eine oder mehrere Actions verzögert aus. Keine Kurzschreibweise möglich.
```
key:
type: delay
delay: <delay>
actions:
action1:
action2:
```

* **delay:** Die Verzögerung, gemessen in Ticks. Eine Sekunde -> 20 Ticks.
* **actions:** Eine Aufzählung der Actions, die nach dem Delay ausgeführt werden. Kurz- und Langform sind möglich.
* **runAfter:** Nach Ausführung der verzögerten Action.

## Dialogue
``dialogue``

Startet einen Dialog.

* **id:** Die ID des Dialogs.

## Give Item
``give_item``

Vergibt ein oder mehrere Items an den Spieler.

`give_item: <item>;<amount>;<chance>`
```
key:
type: give_item
item: <item>
amount: <amount | 1>
chance: <chance | 100>
```
* **item:** Das Item. Kann ein Vanilla-Item-Name sein oder ein Custom-Item.
* **amount:** Die Menge des Items. Default = 1.
* **chance:** Ein Wert von 0 bis 100, der die Chance angibt mit der dieses Item erhalten werden kann. Default = 100.

## Hide IBC
``hide_ibc``

Versteckt eine IBC.

* **id:** ID der IBC.

## Message
``message``

Sendet eine Nachricht an den Spieler.

`message: <message>`
```
key:
type: message
message: <message>
```
* **message:** Die Nachricht.
## Mob Follow
:::caution Nicht implementiert
:::
``mob_follow_player``

Lässt einen Mob/NPC einem Spieler folgen.

`mob_follow_player: <mob-id>;<instanced>;<distance>;<stopOnTeleport>`
```
key:
type: mob_follow_player
id: <mob-id>
instanced: <true/false | true>
distance: <distance>
stopOnTeleport: <true/false | true>
```
* **id:** Die ID des Mobs.
* **instanced:** true/false - Ob ein neuer InstancedMob erstellt werden soll, der nur für den Spieler sichtbar ist (true) oder ob der echte Mob, für alle sichtbar, dem Spieler folgen soll (false). Default = true.
* **distance:** Die Entfernung, die der Mob versucht zum Spieler einzuhalten. Werte, die oberhalb der Server-Sichtweite liegen, funktionieren wahrscheinlich nicht.
* **stopOnTeleport:** true/false - Ob der Mob sich mit dem Spieler teleportieren soll (false) oder das Folgen abbricht, sobald der Spieler sich teleportiert (true). Default = true.
## Paste schematic
``paste_schematic``

Fügt eine Schematic in der Welt ein.

* **schematic:** Der Name der Schematic
* **time:** Optional. Zeit in Sekunden, nachdem die Schematic automatisch wieder entfernt wird (//undo)
* **location:** QLocation

## Permission
``permission``

Verändert die Permission oder Gruppen eines Spielers.

`permission: <permission>;<action>`
```
key:
type: permission
permission: <permission>
action: <action>
```
* **permission:** Die Permission oder der Gruppen-Name.
* **action:** `add`, `remove`, `add_group`, `remove_group` - Was passieren soll.
## Repeat
``repeat``

Wiederholt eine oder mehrere Actions.

* **delay:** Zeit zwischen einzelnen Wiederholungen, in Ticks (20 ticks -> 1 Sekunde)
* **repetitions:** Wie oft die Actions wiederholt werden.
* **actions:** Die Actions.

## Reset IBC
``reset_ibc``

Setzt eine IBC auf den Weltzustand zurück.

* **id:** Die ID der IBC

## Run as
``run_as``

Führt eine Action für bestimmte Spieler aus.

* **runMode:** ``event_in_range``, ``event_participants`` oder ``online``. Default: ``online``
* **runValue:** Nur wenn ``event_participants``: Mindestwert an Eventbeteiligung.

## Show Beam
:::caution Nicht implementiert in 1.19.3
:::
``show_beam``

Zeigt einen Marker-Lichtstrahl an.

## Show IBC
``show_ibc``

Zeigt eine IBC an.

* **id:** Die ID der IBC

## Spawner
``spawner``

Triggered einen Spawner manuell.
* **id:** Die ID des Spawners.

## Spawn Mob
``stage``

Spawnt einen Mob oder NPC.

`spawn_mob: <mob-id>;<x>;<y>;<z>;<relative>;<instanced>;<ignoreConditions>;<adjust>`
```
key:
type: spawn_mob
id: <mob-id>
x: <x>
y: <y>
z: <z>
relative: <true/false | false>
instanced: <true/false | false>
ignoreConditions: <true/false | false>
adjust: <true/false | false>
```
* **id:** Die ID des Mobs/NPCs.
* **x/y/z:** Koordinaten
* **relative:** Ob die angegebenen Koordinaten relativ zur aktuellen Position des Spielers sind (true) oder normale Koordinaten (false). Default = false
* **instanced:** Ob es sich um einen InstancedMob handelt, der nur für den Spieler bzw. seine Gruppe sichtbar ist (true) oder einen normalen Mob, der für alle sichtbar ist (false). Default = false.
* **ignoreConditions:** Ob der Mob mögliche Spawn-Bedingungen ignorieren soll. Default = false
* **adjust:** Nur sinnvoll, wenn `relative: true`. Ob versucht werden soll den Mob an einer anderen Stelle zu spawnen, sollte das Spawnen an den angegebenen Koordinaten nicht möglich sein (z.B. weil in einem Block).
* **location:** QLocation

## Stage change
Ändert die Stage des Spielers.
`stage: <stage-id>;<complete>`
```
key:
type: stage
id: <stage-id>
complete: <true/false | false>
```
* **id:** Die ID der neuen Stage.
* **complete:** Ob die aktuelle Stage als abgeschlossen markiert werden soll (true) oder nicht (false). Führt dazu, das eventuelle `onFinish`-Actions ausgeführt werden. Default = false.
``stage``

Ändert die Stage des Spielers oder des Events.

* **quest:** Quest-ID
* **id:** Stage-ID

## Start Event
``start_event``

Startet ein Event.

* **id:** ID des Events
* **skipConditions:** Ob Conditions für den Event-Start ignoriert werden sollen.

## Start Quest
``start_quest``

Startet eine Quest.

* **id:** ID der Quest

## Teleport
``teleport``

Teleportiert den Spieler.

* QLocation

## Title
``title``

Sendet einen Titel an den Spieler.

* **title:** Wie Vanilla-Command
* **subtitle:** Wie Vanilla-Command
* **fadeIn:** Wie Vanilla-Command
* **stay:** Wie Vanilla-Command
* **fadeOut:** Wie Vanilla-Command
Loading

0 comments on commit 0d67c0f

Please sign in to comment.