Inhaltsverzeichnis
Store
Das <store>-Tag speichert seinen (ausgewerteten) Inhalt persistent, z.B. zwischen verschiedenen Schritten eines Quests. Das Attribut 'name' gibt dabei an, unter welchem Namen es gespeichert werden soll. Der Inhalt selbst wird an dieser Stelle nicht ausgegeben. Der folgende Code speichert Inhalt der Variable unter dem Namen 'VariablenName' für die Dauer des laufenden Quests:
<store name="VariablenName" scope="quest">Inhalt der Variable</store>
Scopes/Geltungsbereiche
Den Bereich und die Art wie eine Variable gespeichert wird kann man über das Attribut scope festlegen. Im Moment gibt es hierbei fünf verschiedene Möglichkeiten.
Zu beachten ist, dass in Questen standardmäßig der scope "quest" eingestellt ist. Wird für eine Variable ein anderer Scope, z.B. 'hero', festgelegt und wird diese Variable später an einer anderen Stelle im Code verändert, dann muss der zugehörige Scope wieder explizit angegeben werden.
scene
Die Variable wird nicht in der Datenbank zwischengespeichert. Sie kann nur innerhalb derselben Scene verwendet werden.
<store name="VariablenName" scope="scene">Inhalt der Variable</store>
quest
Die Variable wird innerhalb dieser Quest gespeichert. Sobald die Quest beendet wurde wird die Variable gelöscht. Durch eine über den Queststatus pending unterbrochene Quest werden Variablen mit dem Scope quest nicht gelöscht.
<store name="VariablenName" scope="quest">Inhalt der Variable</store>
dungeon
Die Variable ist für alle Helden die diese Quest erleben zugreifbar. Die Variable bleibt erhalten auch wenn ein Held die Quest schon beendet hat, bezieht sich aber im Gegensatz zum Scope 'hero' auf die Quest und nicht auf den sie absolvierenden Helden.
<store name="VariablenName" scope="dungeon">Inhalt der Variable</store>
hero
Die Variable wird an den Helden gebunden, solange dieser existiert, kann auf sie zugegriffen werden.
<store name="VariablenName" scope="hero">Inhalt der Variable</store>
global
Die Variable wird unabhängig von Questen und Helden gespeichert. Sie wird nur manuell von Hand gelöscht.
<store name="VariablenName" scope="global">Inhalt der Variable</store>
expire
Über das Attribut expire kann der Zeitraum angegeben werden in welchem diese (unabhängig vom scope) Gespeichert wird. Folgendes definiert eine Variable die nach 4 Ingame-Tagen wieder gelöscht wird.
<store name="VariablenName" scope="hero" expire="4d">Inhalt der Variable</store>
Expire kann in zwei Formaten angegeben werden "4d" für vier Ingametage, "12h" für zwölf Ingamestunden oder "4D" für vier Reallife-Tage, "12H" für zwölf echte Stunden.
inc-expire
Mittels inc-expire kann der Zeitraum verlängert werden, indem eine Variable gültig ist.
<store name="meineVariable" scope="hero" expire="4d">Inhalt der Variable</store>
...
<!-- Variable um weitere 2 Tage verlängern -->
<store name="meineVariable" scope="hero" inc-expire="2d">neuer Inhalt der Variable</store>
<!-- die Variable ist somit insgesamt 6 Ingame-Tage aktiv -->
Variablen überschreiben
Eine Variable kann einfach überschrieben werden, indem ihr ein neuer Inhalt zugewiesen wird:
<store name="held-hat-gefruehstueckt">nein</store>
...
<store name="held-hat-gefruehstueckt">ja</store>
Zu beachten ist, dass in Questen standardmäßig der scope "quest" eingestellt ist. Wird für eine Variable ein anderer Scope, z.B. 'hero', festgelegt und wird diese Variable später an einer anderen Stelle im Code verändert, dann muss der zugehörige Scope wieder explizit angegeben werden:
<store name="held-ist-ein-schwarzer-ritter" scope="hero">nein</store>
...
<store name="held-ist-ein-schwarzer-ritter" scope="hero">ja</store><!-- Scope 'hero' muss hier wieder angegeben werden, sonst wird Variable nicht überschrieben, sondern eine neue Variable mit dem Scope "quest" gesetzt! -->
Variablen löschen
Variablen können mittels
<store name="meineVar">NULL</store>
<!-- oder -->
<store name="meineVar"/>
gelöscht werden.
Namenskonvention
Die Variablen können zwar technisch frei benannt werden, aber bei scope="hero"-Variablen ist zwingend auf einen aussagekräftigen und eindeutigen Namen zu achten. Dazu wird zunächst der Questname (+ggf. Autor) und danach die Variablenkennung angegeben, z.B.
<store name="SchiffBlutrabe-Tagesablauf" scope="hero">Schlaf</store>
Diese Konvention soll sicherstellen, dass einzelne hero-/global-Variablen sich nicht gegenseitig überschreiben.
fetch
Das <fetch>-Tag ruft derart gespeicherte Inhalte wieder ab. Das Attribut 'name' dient hier zum Identifizieren der richtigen Variable. Sollte kein Inhalt unter diesem Namen gespeichert sein, und nur dann, wird der Inhalt des fetch-Tags ausgewertet, sozusagen als Default. Dies ist einer der Hauptunterschiede zum get-Tag. Bei get wird kein Default-Inhalt ausgewertet.
Folgendes bewirkt zum Beispiel die Ausgabe der Variable "papagei_name".
<p><q>Hallo <fetch name="papagei_name"/>!</q></p>