Robot Karol für Delphi: Entwicklerhandbuch

Robot Karol für Delphi: Entwicklerhandbuch
Reinhard Nitzsche, OSZ Handel I
Version 0.1 vom 24. Januar 2003
Zusammenfassung
Dieses Handbuch beschreibt die Delphi-Klasse cKarol für Entwickler
und Entwicklerinnen von Anwendungen mit Karol für Delphi.
Inhaltsverzeichnis
1 Karol für Delphi 2
1.1 Unterschiede zwischen dem Original Robot Karol und Karol
für Delphi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2 Karol für Delphi einbinden . . . . . . . . . . . . . . . . . . . 2
2 Schnittstellenbeschreibung 3
2.1 Exemplare von Karol erzeugen und löschen . . . . . . . . . . 3
2.2 Karol bewegen . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.3 Karols Sensoren . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.4 Ablaufsteuerung . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.5 Erweiterungen . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3 Laufzeitfehler 6
4 Bekannte Fehler 7
1

1 Karol für Delphi
1.1 Unterschiede zwischen dem Original Robot Karol und Karol
für Delphi
Karol für Delphi orientiert sich weitgehend an Robot Karol. In folgenden
unwesentlichen Punkten weicht Karol für Delphi jedoch vom Original ab:
• Die Höhe der Welt wird nicht berücksichtigt.
• Das Spielfeld von Karol für Delphi hat keine frei wählbare Höhenbeschränkung,
die Ziegelstapel dürfen bis zu 32725 Steine hoch werden.
• Es bestehen keinerlei Beschränkungem von Karols Tragekapazität.
Karol hat auch immer genügend Ziegel dabei.
• Es ist keine 3D-Darstellung verfügbar.
• Die maximal mögliche Sprunghöhe von Karol kann nicht verändert
werden.
• Alle wesentlichen Einstellungen, die beim Original-Karol im Menupunkt
„Einstellungen“ zu tätigen waren, sind Methoden von Karol
für Delphi geworden oder wurden nicht implementiert.
• Die Methoden Schritt(〈n〉), Hinlegen(〈n〉) und Aufheben(〈n〉)
sind nicht implementiert.
• Erweiterungen siehe Abschnitt 2.5.
1.2 Karol für Delphi einbinden
Karol für Delphi befindet sich in der Unit uKarol. Sie wird in die Liste
importierter Units im Interface-Abschnitt der eigenen Unit aufgenommen.
Die Unit uKarol stellt die Klasse cKarol zur Verfügung, deren Methoden
und Eigenschaften in diesem Dokument beschrieben werden.
Beim Erzeugen eines Karol-Exemplars wird automatisch ein Formular geöffnet,
in dem Karol und seine Welt angezeigt werden.
2

2 Schnittstellenbeschreibung
2.1 Exemplare von Karol erzeugen und löschen
Create(〈owner〉: TForm;
〈breite〉, 〈hoehe〉: Word;
〈posx〉, 〈posy〉: Word);
CreateFromFile(〈owner〉:TForm;
const 〈f 〉: string);
Create und CreateFromFile erzeugen einen neuen Karol inklusive
Spielfeld und zeigen das Spielfeld sofort an. Die Größe von Karols Spielfeld
lässt sich im Nachhinein nicht mehr ändern.
〈owner〉 ist das Formular, an das Karol gebunden sein soll. In der Regel wird
dies das Hauptfenster der Anwendung sein.
Bei Create hat das Spielfeld die Breite 〈breite〉 und die Höhe 〈hoehe〉. Karol
steht auf dem Feld (〈posx〉/〈posy〉) mit Blick nach Süden. Werden 〈posx〉
und 〈posy〉 nicht angegeben, so wird Karol in die linke obere Ecke gesetzt
(0/0).
Beispiel:
Create(NavigatorFrm, 20, 10);
Erstellt einen neuen Karol. Seine Welt hat die Breite 20 und die Höhe 10.
Weil 〈posx〉 und 〈posy〉 nicht angegeben sind, steht Karol in der Nordostecke
seiner Welt.
Bei CreateFromFile wird das Spielfeld aus der Datei mit dem Pfad und
dem Namen 〈f 〉 ausgelesen. Diese Datei muss zuvor von Karol 2 deutsch
(Freiberger/Krško) gespeichert worden sein.
Beispiel:
CreateFromFile(NavigatorFrm, ’test.kdw’);
Erstellt einen neuen Karol und liest die im Arbeitsverzeichnis liegende Datei
test.kdw ein.
Dies ist die einzige Möglichkeit Quader in Karols Welt zu platzieren!
Destroy;
Löscht das Karol-Exemplar.
Bitte Abschnitt 4 beachten!
3

2.2 Karol bewegen
Schritt;
Schritt(〈n〉: Byte);
Karol macht einen Schritt (bzw. 〈n〉 Schritte) nach vorne.
Mögliche Fehler: Sofern Karol dabei zu hoch oder zu tief springen oder in
einen Quader oder durch eine Wand laufen müsste, wird der Schritt nicht
ausgeführt. Fehlerbehandlung siehe Abschnitt 3.
LinksDrehen;
RechtsDrehen;
Karol dreht sich nach links bzw. rechts.
Hinlegen;
Aufheben;
Karol legt einen Ziegel auf das Feld vor sich bzw. nimmt von dort einen
auf. Anders als im Original gibt es keine Beschränkung von Karols Tragfähigkeit.
Karol hat also immer genügend Platz im Rucksack und immer
noch einen Ziegel verfügbar.
Mögliche Fehler: Die Methode wird nicht ausgeführt, wenn Karol vor ei-
ner Wand oder vor einem Quader steht oder bei Aufheben kein Ziegel
vorhanden ist. Fehlerbehandlung siehe Abschnitt 3.
Die Höhe der Ziegelstapel ist auf 32 725 Ziegel begrenzt. Hinlegen über-
prüft nicht auf das Überschreiten dieser Grenze!
MarkeSetzen;
MarkeLoeschen;
Karol setzt bzw. löscht Marken. Bereits markierte Felder dürfen nochmals
markiert werden. Ebenso dürfen die „Marken“ unmarkierte Felder gelöscht
werden.
2.3 Karols Sensoren
Die Eigenschaften dieses Abschnittes können vom Entwickler nicht direkt
verändert werden (read-only). Sie repräsentieren sozusagen Karols Sensoren.
4

IstZiegel: Boolean;
IstZiegel(〈n〉:Byte): Boolean;
Wahr, wenn Karol auf einen Ziegelstapel schaut. Die zweite Version der
Eigenschaft ist wahr, wenn der Ziegelstapel genau die Höhe 〈n〉 hat.
IstWand: Boolean;
Wahr, wenn Karol auf eine Wand oder einen Quader schaut.
IstMarke: Boolean;
Wahr, wenn Karol auf einem markierten Feld steht.
IstVoll: Boolean;
IstLeer: Boolean;
Wahr, wenn Karols Rucksack voll bzw. leer ist. Diese beiden Eigenschaften
liefern zur Zeit immer „wahr“ (true).
IstSueden: Boolean;
IstNorden: Boolean;
IstWesten: Boolean;
IstOsten: Boolean;
Diese Eigenschaften sind wahr, wenn Karol in die entsprechende Richtung
schaut.
2.4 Ablaufsteuerung
Diese Methoden sind im Original-Karol Teil der Benutzeroberfläche bzw.
der Programmiersprache.
Schnell;
Die Aktualisierung der Anzeige wird ausgeschaltet. Bei Fehlern (siehe Abschnitt
3) wird die Anzeige in jedem Fall aktualisiert.
Langsam;
Die Aktualisierung der Anzeige wird wieder angeschaltet. Nach jeder Veränderung
von Karol oder seiner Welt wird die Anzeige aktualisiert.
5

SetVerzoegerung(〈t〉: LongInt);
function GetVerzoegerung: LongInt;
Setzt bzw. liefert die Wartezeit, die vor dem Neuzeichnen von Karol verstreicht.
Sofern Karol auf „Schnell“ geschaltet wurde, hat dieser Wert keine
Bedeutung!
2.5 Erweiterungen
Pos_x: Word;
Pos_y: Word;
Diese beiden Eigenschaften liefern die Koordinaten, an denen Karol sich
gerade befindet. Sie können nur gelesen, nicht aber geschrieben werden!
Repaint;
Repaint(〈komplett〉: Boolean);
Diese Methoden sind nur zur Korrektur von etwaigen Fehlern von Karol
für Delphi wichtig. Sie zeichnen Karol und seine Welt neu. Standardmäßig
(Repaint und Repaint(false)) wird nur derjenige Teil der Welt neu
gezeichnet, der sich seit der letzten Operation verändert haben könnte. 1
Nur der Aufruf Repaint(true) führt zu einem kompletten Neuzeichnen
der gesamten Welt.
3 Laufzeitfehler
In bestimmten Fehlersituationen ist es notwendig, dass der Benutzer Karol
sagt, was er tun soll, weil Karol selbst diese Entscheidung nicht treffen
kann. Diese Situationen können jederzeit während der Laufzeit des Programms
auftreten:
1. Karol steht vor einer Wand oder einem Quader und soll einen Schritt
nach vorne machen.
2. Karol soll einen zu hohen Sprung ausführen.
3. Karol soll einen Ziegel aufheben und es ist keiner da.
In allen diesen Situationen wird wie folgt verfahren:
1 Also das Feld auf dem Karol steht und alle direkt benachbarten Felder.
6

1. Die Anzeige wird aktualisiert.
2. Der Benutzer bekommt eine entsprechende Meldung angezeigt und
wird aufgefordert zu entscheiden, ob Karol weiter machen oder das
Programm beendet werden soll.
4 Bekannte Fehler
• Die Größe der Welt (Spielfeld) ist derzeit auf 20 mal 20 Felder be-
grenzt. Bei größeren Welten gab es Programmabstürze beim Erzeugen
der Welt. Die verfügbare Größe erscheint für die meisten Anwendungen
ausreichend.
• Beim Löschen und anschließenden Wiederherstellen von Karol über
den Konstruktor Create kommt es zum Programmabsturz. 2
• Die Fehlerbehandlung beim Erstellen von Karol ist äußerst lücken-
haft (z. B. kann Karol außerhalb seiner Welt stehen.).
2 Der Grund ist unbekannt. Besonders merkwürdig: Das Problem tritt bei
CreateFromFile nicht auf, obwohl dabei intern auf Create zurückgegriffen wird.
7