Questlog 3.0
~ von Caesar ~
Inhalt
1. Was ist das Questlog?......................................................................................................................3
1.1. Neues in Version 3....................................................................................................................3
2. Verwendung.................................................................................................................................... 4
2.1. Einfügen und Entfernen von Quests......................................................................................... 4
2.1. Parameter................................................................................................................................. 4
2.1.1. INSERT_AT_TOP............................................................................................................4
2.1.2. LINE_HEIGHT.................................................................................................................4
2.1.3. WINDOWSKIN................................................................................................................4
2.1.4. HEADER_TEXT.............................................................................................................. 4
2.1.5. SCROLL_SPEED............................................................................................................. 5
2.1.6. STYLES........................................................................................................................... 5
2.1.7. ON_CLOSE...................................................................................................................... 5
2.2. Tags..........................................................................................................................................5
2.2.1. <br>..................................................................................................................................6
2.2.2. <b>Text</b>..................................................................................................................... 6
2.2.3. <i>Text</i>....................................................................................................................... 6
2.2.4. <u>Text</u>..................................................................................................................... 6
2.2.5. <color=X>Text</color>....................................................................................................6
2.2.6 <size=X>Text</size>.........................................................................................................7
2.2.7. <small>Text</small>........................................................................................................7
2.2.8. <big>Text</big>............................................................................................................... 7
2.2.9. <font=X>Text</font>....................................................................................................... 7
2.2.10. <shadow>Text</shadow>...............................................................................................7
2.2.11. <icon=X>........................................................................................................................ 7
2.2.12. <image=X>..................................................................................................................... 7
2.2.13. <line>............................................................................................................................. 7
2.2.14. <down=X>...................................................................................................................... 7
2.2.15. <space=X>...................................................................................................................... 7
2.2.16. <if=X>Text<else>Anderer Text</if>............................................................................. 7
2.2.17. <var=X>..........................................................................................................................8
2.2.18. <eval={X}>.....................................................................................................................8
2.2.19. <style=X>Text</style>................................................................................................... 8
2.3. Beispiel.................................................................................................................................... 8
3. Einbau..............................................................................................................................................9
1. Was ist das Questlog?
Das Questlog ist ein RGSS (Ruby Game Scripting System) geschriebenes Script für den RPG
Maker XP1. Es erweitert RPGs um die Möglichkeit, Aufgaben des Spielers in einem Buch zu
verwalten.
1.1. Neues in Version 3
Die erste Version war sehr statisch. Optional konnten für den Titel ein Icon und für die Beschreibung ein Bild verwendet werden, ansonsten war keine Formatierung möglich. Version 2.0 behob einige Fehler und erweiterte das Questlog um Formatierungsmöglichkeiten in Form von HTML-ähnlichen Tags. Diese Formatierung war ein Schritt in die richtige Richtung (die Inhalte
dynamisch zu gestalten), sah aber nur Formatierung des Textes vor (Schriftfarbe, Schriftart, kursive und fette Schrift, Schatten, Unterstreichung...). Außerdem war der Platz für die Questbeschreibung
auf 268 × 328 Pixel beschränkt. Die wesentliche Neuerung in Version 3.0 ist die HTML-Rendering- Engine, die den Spielemacher befähigt, selbst komplexe Dokumentstrukturen abzubilden. Die (Pseudo-)HTML-Tags wurden um viele neue erweitert, so dass neben bekannten Textformatierungen auch eingebettete Bilder und Icons, Einrückungen, Absätze, Trennlinien und
dynamisch erzeugter Inhalt möglich sind. Außerdem ist der Platz der Beschreibung nun theoretisch unbegrenzt, denn das rechte Fenster lässt sich nun mit den Tasten Pageup und Pagedown vertikal scrollen. Des weiteren wurden zwei Bugs behoben: (Eventgescriptete) Bilder werden nun nicht
mehr über dem Questlog angezeigt; und wer das Questlog einbaut und einen älteren Spielstand lädt, der das Questlog noch nicht enthält, bekommt keine Fehlermeldung, sondern ein leeres Questlog wird neu erstellt. Auch sind nun viele Eigenschaften des Scripts nicht mehr tief im Code verankert,
sondern als Parameter an zentraler Stelle konfigurierbar.
_________________________________________________________________
1 Der RPG Maker XP ist ein Tool der Firma Enterbrain, das es ermöglicht, eigene Rollenspiele (RPGs) ohne
Programmierkenntnis zu erstellen.Neuerungen:
● HTML-Rendering-Engine
● Unbegrenzte Höhe der Beschreibung durch Scrollen
● Konfiguration per Scriptparameter
Bugfixes:
● Bilder nun unter Questlog
● Beim Laden eines Spielstandes ohne Questlog keine
Fehlermeldung mehr
2. Verwendung
Allgemein wird das Questlog aufgerufen durch Ausführung des folgenden RGSS-Codes:
$scene = Scene_Questlog.new
Dies kann ein einem Call-Script aufgerufen werden, im Menü oder auf Knopfdruck auf der Map. Der Aufruf per Knopfdruck wird unter Einbau beschrieben. Die Möglichkeit, Questtitel per „disable“ auszugrauen, ist in dieser Version entfallen, kann aber bei etwas Mehraufwand mit HTML-Tags umgesetzt werden.
2.1. Einfügen und Entfernen von Quests
Da Bilder und Icons nun über HTML-Tags eingefügt werden können, ist die Möglichkeit, beim Einfügen von Quests ein Icon und ein Bild anzugeben, obsolet. Der Aufruf enthält daher nur noch zwei Parameter: den Titel und die Beschreibung. Bei beiden ist HTML-Formatierung möglich, beim Titel selbstverständlich nur einzeilig. Der Code zum Einfügen neuer Quests sieht daher wie folgt aus:
Questlog.add("Titel", "Beschreibung")
Zum Löschen von Quests wird der Titel benötigt. Er muss genau mit dem übereinstimmen, der beim Einfügen des Quests angegeben wurde, einschließlich der HTML-Tags:
Questlog.remove("Titel")
2.1. Parameter
Ganz oben im Script lassen sich viele Funktionen des Scripts konfigurieren. Im Folgenden beschreibe ich die einzelnen Parameter.
2.1.1. INSERT_AT_TOP
Dieser boolesche Wert (true oder false) bestimmt, ob neu eingefügte Quests im Questlog ganz oben oder ganz unten erscheinen. Wenn der Wert true ist werden, neue Quests oben eingefügt, wenn er false ist, werden sie unten eingefügt.
2.1.2. LINE_HEIGHT
Wie der Name schon sagt, beschreibt dieser Integer-Wert die Zeilenhöhe der Beschreibungen in Pixeln. Je höher dieser Wert ist, desto größer ist der Zeilenabstand.
2.1.3. WINDOWSKIN
In den alten Versionen wurde für das Questlog immer der in der Database eingestellte Standardwindowskin des Spiels verwendet. In der Version 3.0 kann ein alternativer Windowskin festgelegt werden, der das Aussehen des Questlogs bestimmt. Die Variable WINDOWSKIN enthält per Default den Wert nil, d.h. der Standardwindowskin wird verwendet. Wenn ein anderer Windowskin benutzt werden soll, muss die Variable den Namen des importierten) Windowskins als String enthalten.
2.1.4. HEADER_TEXT
In dem kleinen Fenster oben im Questlog-Interface steht normalerweise der Text „Questlog“, aber dies kann mit dieser Variable auch geändert werden.
2.1.5. SCROLL_SPEED
Wie schon oben beschrieben, können Questbeschreibungen eine theoretisch unbegrenzte Höhe haben, da man mit den Tasten Page-Up und Page-Down (Bild rauf und Bild runter) vertikal scrollen kann. Wie schnell gescrollt wird (Default: 7), lässt sich in dieser Variable festlegen. Die Einheit ist
Pixel pro Frame.
2.1.6. STYLES
Ein besonderes Schmankerl der HTML-Rendering-Engine sind die vordefinierten Styles. Angenommen, alle Questbeschreibungen enthalten Überschriften. Man könnte jetzt für jede Überschrift die entsprechenden Tags setzen, fett, unterstrichen, Schriftgröße, Schriftart, Zeilenabstand etc. Will man jetzt aber alle Überschriften um einen Grad größer machen, hat man ganz schön Probleme, denn man muss für jede Überschrift die Tags ändern. Hier kommt das so genannte Semantische Tagging zum Einsatz: Alle Styles werden an zentraler Stelle definiert und die einzelnen Überschriften werden nur anhand ihrer Semantik bezeichnet, d.h. anhand ihrer Funktion im Dokument (z.B. Überschrift). Im Idealfall enthält das Dokument selbst dann gar keine absoluten Formatierungen mehr. Genau das gleiche Prinzip kommt bei der Gestaltung von Webseiten zum Einsatz, wenn die Formatierungen in Cascading Style Sheets (CSS) definiert werden. Die STYLESVariable
entspricht insofern dem Stylesheet. Die Variable ist ein Hash. Die Schlüssel entsprechen den Namen der Styles und die Werte enthalten die Informationen zur Formatierung. An der Stelle des senkrechten Striches (|) wird später der
getaggte Text eingefügt. Beispiel: Ein Style enthält Informationen zur Formatierung von Überschriften. Wir verwenden die Schriftgröße 45, die Schriftart Cambria, stellen den Text fett dar und lassen einen Zeilenabstand von 40 Pixeln zur nächsten Zeile. Der Style sieht demnach wie folgt aus:
<size=45><font=Cambria><b>|</b></font></size><down=40>
Die einzelnen Tags werden unten genauer beschrieben.
2.1.7. ON_CLOSE
Diese Variable enthält einen Process, der aufgerufen wird, sobald das Questlog geschlossen wird. Per Default gelangt man zurück auf die Map („$scene = Scene_Map.new“), aber baut man das Questlog beispielsweise ins Menü ein, möchte man bei Schließen des Questlogs zurück ins Menü.
In diesem Fall kann hier der Proces geändert werden, z.B. zu „$scene = Scene_Menu.new(4)“ (Zahl in Klammern = Index der Questlog-Auswahl).
2.2. Tags
Generell sind die Tags HTML nachempfunden, dennoch sind selbstverständlich nicht alle HTMLTags im Questlog verwendbar und umgekehrt existieren nicht alle Questlog-Tags auch in HTML. Die Tags sind außerdem nicht XML-konform, d.h. es gibt auch Tags die nicht geschlossen werden.
Schande über mein Haupt, aber was soll's ;-) Leider habe ich es nicht hinbekommen, zentrierte und rechtsbündige Ausrichtung zu
implementieren; außerdem ist es zuweilen etwas mühselig, die richtigen Stellen der Zeilenumbrüche herauszufinden, da hilft meist nur Ausprobieren.
Questtitel kann man übrigens mit Formatierungen gut kategorisieren, beispielsweise in Haupt- und Nebenquests. Und die Einbindung von Variablen, der If-Tag und die Code-Evaluation ermöglichen in der Questbeschreibung eine (dynamisch erzeugte) Übersicht über den Fortschritt des Quests, wie
auch auf den Demoscreens zu sehen ist.
Es existieren die folgenden Tags:
● <br>
● <b>Text</b>
● <i>Text</i>
● <u>Text</u>
● <color=X>Text</color>
● <size=X>Text</size>
● <small>Text</small>
● <big>Text</big>
● <font=X>Text</font>
● <shadow>Text</shadow>
● <icon=X>
● <image=X>
● <line>
● <down=X>
● <space=X>
● <if=X>Text<else>Anderer Text</if>
● <var=X>
● <eval={X}>
● <style=X>Text</style>
2.2.1. <br>
Zeilenumbruch
2.2.2. <b>Text</b>
Fetter Text
2.2.3. <i>Text</i>
Kursiver Text
2.2.4. <u>Text</u>
Unterstrichener Text
2.2.5. <color=X>Text</color>
Farbiger Text
Für X muss einer der folgenden Parameter eingesetzt werden:
a) Ein Farbcode in Hexadezimalschreibweise mit vorangestelltem #, z.B. #ffffff = weiß. Die gleichen Farbcodes können in HTML bzw. CSS verwendet werden, daher gibt es im Internet viele Farbtabellen für diese Hexcodes.
b) Ein Farbwort, dabei sind folgende möglich: normal_color (weiß), system_color (blau), disabled_color (grau), crisis_color (gelb), knockout_color (rot), white, black, red, green, blue, yellow, cyan, magenta, light_gray, gray, dark_gray, pink, orange.
c) Ein Message-Farbcode, der auch beim Messagecode \c[X] verwendet wird, also eine Zahl von 0-7.
2.2.6 <size=X>Text</size>
Der Text wird in der angegebenen Schriftgröße dargestellt.
2.2.7. <small>Text</small>
Kleinerer Text
2.2.8. <big>Text</big>
Größerer Text
2.2.9. <font=X>Text</font>
[FONT="Comic Sans MS"]Der Text wird in der angegebenen Schriftart dargestellt.[/FONT]
2.2.10. <shadow>Text</shadow>
Der Text wirft einen Schatten.
2.2.11. <icon=X>
Ein Icon wird (innerhalb der Zeile) gezeichnet. Für X ist der Name des (importierten) Icons einzusetzen.
2.2.12. <image=X>
Ein Bild wird zentriert in einer neuen Zeile gezeichnet. Für X ist der Name des (importierten) Bildes einzusetzen.
2.2.13. <line>
Zeichnet eine Trennlinie, entspricht <hr> aus HTML.
2.2.14. <down=X>
Wie Zeilenumbruch, aber Zeilenabstand ist einstellbar. Für X ist der vertikale Versatz in Pixeln einzusetzen.
2.2.15. <space=X>
Lässt eine (horizontale) Lücke von X Pixeln. Z.B. für Einrückung am Zeilenanfang zu gebrauchen.
2.2.16. <if=X>Text<else>Anderer Text</if>
Schalterabhängiger Text. Für X ist die ID eines Switches einzusetzen. Wenn der Switch an ist, wird „Text“ dargestellt, ansonsten der „Andere Text“.
2.2.17. <var=X>
Wert der Variable mit der ID X.
2.2.18. <eval={X}>
Hiermit kann beliebiger RGSS-Code eingebettet werden, der erst zum Zeitpunkt der Darstellung evaluiert wird. Die Tags <if> und <var> sind im Grunde nur Spezialformen dieser dynamischen Inhaltserzeugung. Mit dem Eval-Tag können so spezielle Variablen wie Heldennamen, Statuswerte und Systemvariablen eingebunden werden.
2.2.19. <style=X>Text</style>
Eines der wichtigsten Tags: das Style-Tag. Wie schon bei den Parametern beschrieben, werden die konkreten Formatierungen idealerweise zentral (bei den Parametern) definiert und die Dokumente semantisch getaggt. Dieses Semantische Tagging geschieht durch den Style-Tag. Für X ist der
Name des Styles einzusetzen, der natürlich im Styles-Parameter definiert sein muss.
2.3. Beispiel
Zur Verdeutlichung zeige ich im Folgenden ein Beispiel mit Code und Screenshot. Das Call Script zum Einfügen des Quests sieht wie folgt aus:
Questlog.add("Fischfang", "Kaufe dir eine Angel, lass dich <br>vom Angler unterweisen und
<br>fange mindestens 10 Fische.<br><image=fish><down=8><space=20><style=system>Bereits gefangen:
</style><var=1>/10<br><space=20><style=system>Ort:
</style>Grindmoore<br><space=20><style=system>Belohnung: </style>100 $")
3. Einbau
Da die HTML-Rendering-Engine prinzipiell auch in anderen Scripts einsetzbar ist, wird sie als ein
Extra-Script in den Script-Editor eingefügt. Der Code:
Der Code für das eigentliche Questlog, ebenfalls einzufügen in einem neuen Script über Main:
Wenn das Questlog auf der Map per Tastendruck aufrufbar sein soll, müssen im Script Scene_Map
ein paar Zeilen eingefügt werden. Was dies betrifft, hat sich zur alten Questlog-Version nichts
geändert. Wer also schon eine ältere Version des Questlogs eingebaut hat, muss in Scene_Map
nichts mehr ändern. Im folgenden ist beschrieben, wie das Questlog per F5 aufrufbar gemacht wird;
will man eine andere Taste (möglich sind z.B. auch F6-F8) verwenden, funktioniert dies analog zu
F5.
Man suche in Scene_Map die folgenden Zeilen (unter def update):
Und ändere diesen Code durch Einfügen einiger Zeilen, so dass dann da steht:
Zitat von Kelven
Berechtigungen
Zitieren