Jedes Element der Benutzeroberfläche besitzt eine kontextbezogene Hilfe. Wenn der Mauscursor über ein Element bewegt wird, erscheint eine kurze Beschreibung der Funktion. Für eine ausführliche Beschreibung kann das Fragezeichen in der Titelleiste des Fenster gewählt und damit das Element angeklickt werden.
Im 3D-Modus können Scripte ausgeführt werden. Damit lassen sich z.B. Kamerafahrten programmieren oder Skyboxen anfertigen. Alle Scripte müssen im Verzeichnis "./enginefiles/scripts/" gespeichert sein und die Dateiendung ".txt" besitzen.
Zum Starten eines Scripts muss zuerst die Konsole geöffnet werde. Dafür ist im 3D-Modus die Taste "^" zu betätigen. Dort kann ein Script über die Eingabe von "scripts.loadScript("rotateloop")" gestartet werden, wobei für rotateloop auch der Name eines anderen Scripts stehen kann.
Ein Script lässt sich mit einem beliebigen Texteditor erstellen oder bearbeiten. Ein "HelloWorld"-Script sieht z.B. so aus:
<script>
<0>
<time>5.0</time>
<method>console.addMessage("Hello World!")</method>
</0>
<1>
<time>7.0</time>
<method>console.addMessage("Bye...")</method>
</1>
</script>
Das gesamte Script muss durch ein "script"-tag eingeklammert sein. Darin befinden sich beliebig viele durchnummerierte Aktionen, die der Reihe nach ausgeführt werden. Im "time"-tag steht die Sekunde, in der die Aktion ausgeführt wird. Diese Zeiten müssen absolut angegeben werden. In diesem Beispiel wird die Aktion 1 also zwei Sekunden nach Aktion 0 ausgeführt. Das tag "method" gibt an, welche Methode von der Engine gestartet werden soll. Hier sind alle Funktionen möglich, die auch in der Konsole des 3D-Modus eingegeben werden können. Folgende Methoden sind zur Zeit möglich:
-
camera.makeScreenshot()
Speichert das aktuelle Bild als Screenshot im Verzeichnis "./screenshots".
-
camera.makeScreenshotEx("prefix", aspect)
Speichert das aktuelle Bild als Screenshot im Verzeichnis "./screenshots". Dabei kann mit prefix ein String angegeben wird, der dem Namen des Screenshots vorangestellt wird. Aspect gibt das Format des Screenshots an. Ein aspect von 2 bedeutet ein rechteckiges Bild (Breite = 2 * Höhe). Dabei wird das Bild nicht skaliert, sondern überstehende Bereiche abgeschnitten.
-
camera.moveLookAt(startDirX, startDirY, startDirZ, endPosX, endPosY, endPosZ, endDirX, endDirY, endDirZ, duration)
Bewegt den Blickpunkt der Kamera in einem Zeitraum von duration Sekunden an die Position endPosX/endPosY/endPosZ. Dabei startet Sie in Richtung des Vektors startDirX/startDirY/startDirZ und endet mit Richtung des Vectors endDirX/endDirY/endDirZ.
-
camera.movePosition(startDirX, startDirY, startDirZ, endPosX, endPosY, endPosZ, endDirX, endDirY, endDirZ, duration)
Bewegt die Kamera in einem Zeitraum von duration Sekunden an die Position endPosX/endPosY/endPosZ. Dabei startet Sie in Richtung des Vektors startDirX/startDirY/startDirZ und endet mit Richtung des Vectors endDirX/endDirY/endDirZ.
-
camera.setFieldOfView(verticalAngle)
Setzt den Sichtbereich der Kamera. Dabei gibt verticalAngle an, wieviel Grad (Bogenmaß) in vertikaler Richtung sichtbar sein soll.
-
camera.setLookAt(x, y, z)
Setzt den Blickpunkt der Kamera auf Position x/y/z.
-
camera.setPosition(x, y, z)
Setzt die Kamera auf Position x/y/z.
-
console.addMessage("text")
Gibt text auf der Konsole aus.
-
console.close()
Schließt die Konsole, falls sie geöffnet ist.
-
console.open()
Öffnet die Konsole, falls sie geschlossen ist.
-
heightBasedFog.disable()
Deaktiviert den höhenbasierten Nebel.
-
heightBasedFog.enable()
Aktiviert den höhenbasierten Nebel. Dies sollte nur aufgerufen werden, wenn der Nebel zuvor deaktiviert wurde.
-
hud.hide()
Blendet alle eingeblendeten Informationen aus (Debugleiste und Minimap).
-
hud.show()
Blendet alle eingeblendeten Informationen ein (Debugleiste und Minimap).
-
scripts.loadScript("name")
Startet das Script name.txt im Verzeichnis "./enginefiles/scripts/".
-
scripts.showAll()
Zeigt alle verfügbaren Scripte an.
-
scripts.stopAll()
Stoppt alle gerade aktive Scripte. Dabei werden noch laufende Kamerafahrten nicht unterbrochen.
-
terrain.disableWireframe()
Zeigt die Landschaft normal an.
-
terrain.enableWireframe()
Zeigt das Drahtgittermodell der Landschaft an.
-
time.setGameTimeFactor(factor)
Setzt die Geschwindigkeit der Engine. Ein factor von 2 bedeutet doppelte, 0.5 halbe und 1 normale Geschwindigkeit. Mit 0 kann die Szene pausiert werden.
-
water.disable()
Stellt das Wasser aus.
-
water.disableWireframe()
Zeigt das Wasser normal an.
-
water.enable()
Stellt das Wasser an.
-
water.enableWireframe()
Zeigt das Wasser als Drahtgitter an.
In den Parametern der Befehle können festgelegte Konstanten verwendet werden. Folgene Konstanten existieren:
-
px, py und pz
Diese drei Konstanten können für jeden Zahlparamter verwendet werden. Der Vektor (px,py,pz) ist die aktuelle Position der Kamera. Um z.B. die Kamera 5 Einheiten höher zu setzen, sieht der Befehl so aus: "camera.setPosition(px,py+5,pz)". Als Operatoren sind +, -, * und / möglich.
-
project
Diese Konstante kann für jeden Textparamter verwendet werden. project enthält den Namen der aktuellen Landschaft. Um z.B. "Diese Landschaft heißt test" auszugeben, kann dieser Befehl benutzt werden: "console.addMessage("Diese Landschaft heißt "+project)". Als Operator ist nur + möglich.
Folgende Scripte werden mitgeliefert und können sofort verwendet werden:
-
rotateloop
Startet eine Endloskamerafahrt über die Landschaft. Dieses Script muss mit "scripts.stopAll()" manuell beendet werden.
-
skybox
Erstellt die 6 notwendigen Bilder für eine Skybox. Die 6 Bilder werden im Verzeichnis "./screenshots/" gespeichert.