Difference between revisions of "Dokumentation der Konsole"

From VisionaireWiki
Jump to navigation Jump to search
(New page: == Allgemein == Die Konsole im Player kann mit der TAB-Taste ein- und ausgeblendet werden. Sie dient hauptsächlich zum schnelleren und einfacheren Testen eines Spiels, und zum Überprüfe...)
 
Line 274: Line 274:
 
===EXEC===
 
===EXEC===
  
Führt einen Skript-Befehl aus. Genauere Beschreibung zum Skripting (inkl. aller Befehle) siehe TODO Link (Dokumentation in Englisch).
+
Führt einen Skript-Befehl aus. Genauere Beschreibung zum Skripting (inkl. aller Befehle) siehe [[Scripting|Skripting Dokumentation]] (Dokumentation in Englisch).
  
 
Beispiel:
 
Beispiel:

Revision as of 00:44, 15 December 2009

Allgemein

Die Konsole im Player kann mit der TAB-Taste ein- und ausgeblendet werden. Sie dient hauptsächlich zum schnelleren und einfacheren Testen eines Spiels, und zum Überprüfen ob nicht versehentlich noch Aktionen oder Animationen laufen (die bereits beendet sein sollten). Weiters kann in der Konsole leichter nach Fehlern gesucht werden. Die Konsole ist nur bei nicht kompilierten Spielen vorhanden (um nicht bereits fertige Spiele analysieren zu können).

Es sollte sichergestellt werden, dass die Schriftart welche für die Konsole verwendet wird, alle benötigten Sonderzeichen enthält (z.B.: #'".,:>!/%()|- ). Ansonsten werden diese Zeichen nicht dargestellt und es gehen möglicherweise wichtige Informationen verloren.

Groß- und Kleinschreibung spielt bei den Schlüsselwörtern der Konsole keine Rolle (z.B. ist es egal, ob man 'SET', 'set' oder 'Set' schreibt). Wenn man allerdings den Namen eines Visionaire-Objekts (etwa ein Kulissenobjekt) angibt, ist die Groß- und Kleinschreibung von Bedeutung. Wenn ein Name Leerzeichen enthält, so muss dieser zwischen doppelten Hochkomma geschrieben werden (z.B. "Tür offen"). Wenn ein Name keine Leerzeichen enthält, kann dieser auch ohne doppelte Hochkomma geschrieben werden.

Falls die Ausgabe auf der Konsole nicht auf dem Bildschirm Platz findet, kann mit den Tasten 'Bild rauf' und 'Bild runter' die aktuelle Seite der Ausgabe 'geblättert' werden. Mit 'Pos1' / 'Ende' und gleichzeitigem Drücken von 'Strg' wird die erste/letzte Seite der Ausgabe angezeigt. Mit den Pfeiltasten 'Hinauf' / 'Hinunter' und gleichzeitigem Drücken von 'Alt' kann man die letzten Befehle anzeigen, um diese ohne neuerliche Eingabe ausführen zu können.

Die Konsole enthält auch eine Kommando-Vervollständigung welche das Eingeben von Befehlen wesentlich vereinfacht und beschleunigt. Eine Liste mit allen möglichen Optionen für die aktuelle Eingabe wird unterhalb des Cursors angezeigt. Mit den Pfeiltasten 'Hinauf' / 'Hinunter' kann man einen Eintrag aus der Liste auswählen und mit 'Enter' (oder TAB-Taste) verwenden. Durch drücken von 'Esc' werden die Optionen, welche unterhalb des Cursors angezeigt werden, ausgeblendet. Wenn es zuviele Optionen gibt und nicht alle angezeigt werden können, dann sind am Ende der Liste drei Punkte ("...") angezeigt.

Übersicht der Kommandos

  • CHANGE: Ändern der aktuellen Person, Kulisse, etc.
  • SET: dient zum Setzen div. Objekte, Eigenschaften, etc.
  • PRINT: Ausgabe bestimmter Informationen auf der Konsole
  • SHOW: Zeigen eines Visionaire-Objekts
  • ADD: Hinzufügen von Gegenständen
  • REMOVE: Entfernen von Gegenständen, Aktionen oder Animationen
  • CLEAR: Löschen einer Konsolen-Eigenschaft oder der Log-Datei

Die Kommandos im Detail

In der Hilfe werden Schlüsselwörter nur in Großbuchstaben geschrieben. Wörter die Kleinbuchstaben enthalten sind Namen eines Objekts (dies ist jener Name, der im Editor sichtbar ist) oder haben eine spezielle Bedeutung. Wenn es mehrere Optionen gibt, so sind diese in eckigen Klammern ('[' und ']') geschrieben und werden durch einen senkrechten Strich getrennt ('|'). Wenn ein einzelnes Wort in eckigen Klammern ('[' und ']') steht dann ist dies ein optionales Argument.

CHANGE

CHANGE CHARACTER Person

Setzt die aktuelle Person (jene Person die vom Spieler gesteuert wird) und wechselt zur Kulisse dieser Person.

Beispiel:

CHANGE CHARACTER Mother

Wechselt zur Person mit dem Namen 'Mother'.

CHANGE SCENE Kulisse [Objekt]

Wechselt zu einer Kulisse und setzt die aktuelle Person zu dem angegebenen Kulissenobjekt. Falls kein Objekt angegeben wird, wird die Person zu dem ersten Objekt auf der Kulisse gesetzt.

Beispiel:

CHANGE SCENE Forest Grave

Wechselt zu der Kulisse mit dem Namen 'Forest' und setzt die aktuelle Person zu dem Kulissenobjekt mit dem Namen 'Grave'.

SET

SET CONDITION Bedingungsname [TRUE|FALSE]

Setzt eine Bedingung auf wahr oder falsch.

Beispiel:

SET CONDITION "Türe offen" TRUE

Setzt die Bedingung "Türe offen" auf wahr.

SET VALUE Wertname Wert

Setzt einen Wert. Der Wert muss eine Zahl sein.

Beispiel:

SET VALUE Kontostand 1000

Setzt den Wert Kontostand auf 1000.

SET CHARACTERTOOBJECT Person Objekt

Setzt eine Person zu einem Kulissenobjekt. Das Objekt wird zuerst auf der aktuellen Kulisse gesucht, und falls es nicht gefunden wurde, wird es bei allen Kulissenobjekten gesucht.

Beispiel:

SET CHARACTERTOOBJECT Daniel "Schrank (geschlossen)"

Setzt die Person mit dem Namen 'Daniel' zu dem Objekt 'Schrank (geschlossen)'.

SET CHARACTERTOSCENE Person Kulisse

Setzt eine Person zu einer Kulisse. Die Person wird zu dem ersten Objekt in der Kulisse gesetzt.

Beispiel:

SET CHARACTERTOSCENE Daniel Wald

Setzt die Person mit dem Namen 'Daniel' zu der Kulisse 'Wald'.

SET CHARACTERTOSCENEOBJECT Person Kulisse Objekt

Setzt eine Person zu einem Kulissenobjekt. Das Objekt wird auf der angegebenen Kulisse gesucht.

Beispiel:

SET CHARACTERTOSCENEOBJECT Daniel Wald Weg

Setzt die Person mit dem Namen 'Daniel' zu dem Objekt 'Weg' auf der Kulisse 'Wald'.

SET OUTFIT Person Outfit

Setzt das Outfit einer Person.

Beispiel:

SET OUTFIT Daniel "mit Hut"

Setzt das Outfit 'mit Hut' als aktuelles Outfit bei der Person 'Daniel'.

SET TRACE [ANIMATION|ACTION] [ON|OFF]

Aktiviert/Deaktiviert erweiterte Debug-Meldungen die in die Log-Datei geschrieben werden.

  • ANIMATION betrifft Meldungen zum Anzeigen und Beenden von Animationen.
  • ACTION betrifft Meldungen zum Starten und Beenden von Aktionen.
  • ON aktiviert und OFF deaktiviert die ausgewählten Debug-Meldungen.

SET CONSOLEALPHA Alpha

Setzt den Alpha-Wert der Konsolenschrift. Alpha muss eine Zahl zwischen 0 (= transparent) und 100 (= opak) sein.

Beispiel:

SET CONSOLEALPHA 50

Setzt die Konsolenschriftart halbdurchlässig (der Hintergrund ist also zur Hälfte noch sichtbar).

SET CONSOLEFONT Schriftnummer

Setzt die Schriftart welche für die Konsole verwendet wird. Schriftnummer ist die Position der Schrift in der Liste der Schriftarten (im Editor).

Beispiel:

SET CONSOLEFONT 3

Setzt die 3. Schriftart als aktuelle Konsolenschriftart.

SET CONSOLEBGCOLOR Farbe

Setzt die Farbe des Rechtecks welches hinter der Konsolenausgabe gezeichnet wird. Die Farbe muss dabei als eine Folge von 3 hexadezimalen Farbwerten angegeben werden (jeder dieser Farbwerte entspricht dabei entweder Rot, Grün oder Blau). Alternativ kann als Farbe auch einer der vordefinierten Farben verwendet werden: BLACK, BLUE, CYAN, GRAY, GREEN, DARKBLUE, DARKGREEN, DARKRED, PURPLE, RED, WHITE und YELLOW.

Beispiel:

SET CONSOLEBGCOLOR FF0040

Setzt die Farbe des Rechtsecks auf eine rote Farbe mit einem leichten Blaustich (Rot = 'FF hex', Grün = '00 hex', Blau = '40 hex'). Dies entspricht: Rot = 255, Grün = 0 und Blau = 64.

Beispiel:

SET CONSOLEBGCOLOR GREEN

Setzt die Farbe des Rechtsecks auf Grün.

SET CONSOLEBGALPHA Alpha

Setzt den Alpha-Wert des Rechtecks welches unterhalb der Konsolenausgabe gezeichnet wird. Alpha muss eine Zahl zwischen 0 (= transparent) und 100 (= opak) sein.

Beispiel:

SET CONSOLEBGALPHA 20

Setzt das Rechteck auf eine Sichtbarkeit von 20%.

SET CONSOLECOMMANDBGCOLOR Farbe

Setzt die Farbe des Rechtecks welches hinter der Eingabezeile gezeichnet wird. Die Farbe muss dabei als eine Folge von 3 hexadezimalen Farbwerten angegeben werden (jeder dieser Farbwerte entspricht dabei entweder Rot, Grün oder Blau). Alternativ kann als Farbe auch einer der vordefinierten Farben verwendet werden: BLACK, BLUE, CYAN, GRAY, GREEN, DARKBLUE, DARKGREEN, DARKRED, PURPLE, RED, WHITE und YELLOW.

SET CONSOLECOMMANDBGALPHA Alpha

Setzt den Alpha-Wert des Rechtecks welches hinter der Eingabezeile gezeichnet wird. Alpha muss eine Zahl zwischen 0 (= transparent) und 100 (= opak) sein.

SET CONSOLETEXTWRAP [ON|OFF]

Aktiviert/Deaktiviert den automatischen Zeilenumbruch von Ausgabezeilen auf der Konsole.

  • Mit ON werden zu lange Zeilen automatisch auf mehrere Zeilen aufgeteilt.
  • Mit OFF werden zulange Zeilen bei der Ausgabe abgeschnitten.

Beispiel:

SET CONSOLETEXTWRAP OFF

Deaktiviert den automatischen Zeilenumbruch von zulangen Ausgabezeilen.


PRINT

PRINT ANIMATIONS

Gibt alle laufenden Animationen aus. Dies ist z.B. nützlich um zu überprüfen ob noch Animationen auf anderen Kulissen laufen.

PRINT ACTIONS

Gibt alle laufenden Aktionen aus. Dies ist z.B. nützlich um zu überprüfen ob noch Aktionen laufen, von denen man eigentlich angenommen hatte, dass sie bereits beendet sind.

PRINT CACHE

Gibt den Inhalt des Bilder-Cache aus. Der Cache enthält Grafikdateien die im Speicher aufbewahrt werden (bis der Cache voll ist) um das Laden von Bildern zu beschleunigen.

PRINT CONDITIONS

Gibt alle Bedingungen des Spiels aus, sortiert nach Namen.

PRINT VALUES

Gibt alle Werte des Spiels aus, sortiert nach Namen.

PRINT SCENES

Gibt alle Kulissen des Spiels aus, sortiert nach Namen.

PRINT CHARACTERS

Gibt alle Personen des Spiels aus, sortiert nach Namen.

PRINT LOG

Gibt den Inhalt der Log-Datei ('messages.log' im Projektor-Verzeichnis) auf der Konsole aus. Es sollte darauf geachtet werden, dass die Log-Datei nicht zu groß ist (siehe CLEAR Kommando).

PRINT TEXTURES

Gibt Informationen zu den Texturen, die auf der Grafikkarte gespeichert sind, aus.

PRINT SOUNDS

Gibt alle geladenen Sounds aus. Die Sounds werden entweder gerade abgespielt, oder sind im Speicher geladen (z.B. Schrittgeräusche).

SHOW

SHOW ANIMATIONDETAILS [ON|OFF]

Ermöglicht die Anzeige aller momentan geladenen Animationen. Die ausgewählte Animation wird in einem Rechteck (256x256) angezeigt, wobei jenes Bild gezeigt wird welches gerade aktiv ist. Wenn die Anzeige aktiviert ist, kann mit 'Bild rauf' und 'Bild runter' die aktuelle Animation geändert werden. Während die Animationen angezeigt werden, ist keine andere Ausgabe möglich.

Beispiel:

SHOW ANIMATIONDETAILS ON

Aktiviert die Anzeige der Animationen.

SHOW OBJECTANIMATION Objekt Animation

Startet die angegebene Animation eines Kulissenobjekts.

Beispiel:

SHOW OBJECTANIMATION Wasserfall Wasser

Startet die Animation mit dem Namen 'Wasser' welche zum Objekt 'Wasserfall' gehört.

SHOW CHARACTERANIMATION Person Animation

Startet eine Personenanimation. Die Animation wird bei der angegebenen Person gesucht.

Beispiel:

SHOW CHARACTERANIMATION Daniel "Blinzeln vorne"

Startet die Animation 'Blinzeln vorne' der Person 'Daniel'.

SHOW SCENE Kulisse

Zeigt eine Kulisse. Die aktive Person wird dabei aber nicht gesetzt.

Beispiel:

SHOW SCENE Wald

Zeigt die Kulisse mit dem Namen 'Wald'.

SHOW CHARACTER Person

Zeigt eine Person. Es wird zur Kulisse der angegebenen Person gewechselt. Die aktive Person wird dabei aber nicht gewechselt.

Beispiel:

SHOW CHARACTER Mother

Wechselt zur Kulisse auf der sich die Person 'Mother' befindet.

SHOW TEXTURES [ON|OFF]

Ermöglicht die Anzeige der Texturen wie sie auf der Grafikkarte gespeichert werden. Wenn die Anzeige aktiviert ist, kann mit 'Bild rauf' und 'Bild runter' die aktuell angezeigte Textur geändert werden. Während Texturen angezeigt werden, ist keine andere Ausgabe möglich.

Beispiel:

SHOW TEXTURES ON

Aktiviert die Anzeige der Texturen.

ADD

ADD ITEM Gegenstand

Fügt einen Gegenstand zum Interface der aktuellen Person hinzu. Wenn der Gegenstand bereits im Interface der aktuellen Person vorhanden ist, wird der Gegenstand kein zweites Mal mehr hinzugefügt.

Beispiel:

ADD ITEM Schlüssel

Fügt den Gegenstand 'Schlüssel' zum Interface der aktuellen Person hinzu.

REMOVE

REMOVE ITEM Gegenstand

Entfernt einen Gegenstand aus dem Interface der aktuellen Person. Wenn der Gegenstand nicht im Interface der aktuellen Person vorhanden ist, passiert nichts.

Beispiel:

REMOVE ITEM Schlüssel

Entfernt den Gegenstand 'Schlüssel' aus dem Interface der aktuellen Person.

EXEC

Führt einen Skript-Befehl aus. Genauere Beschreibung zum Skripting (inkl. aller Befehle) siehe Skripting Dokumentation (Dokumentation in Englisch).

Beispiel:

EXEC setValue(VGameFadeDelay, 1000, "Game")

Setzt die Einblendverzögerung für eine Kulissenüberblendung auf 1000 Millisekunden.

CLEAR

CLEAR LOG

Löscht den gesamten Inhalt der Log-Datei ('messages.log' im Projektor-Verzeichnis).

CLEAR TRACE [ANIMATION|ACTION]

Deaktiviert erweiterte Debug-Meldungen die in die Log-Datei geschrieben werden. Der Befehl hat die gleiche Auswirkung wie SET TRACE [ANIMATION|ACTION] OFF.