git » fp-git.git » commit 6852646

improved interface. Added more comments

author ecalot
2004-06-14 06:04:31 UTC
committer ecalot
2004-06-14 06:04:31 UTC
parent 015ea4e868a11ed1a0fa1ec484678ab305331c40

improved interface. Added more comments

FP/src/include/maps.h +30 -1

diff --git a/FP/src/include/maps.h b/FP/src/include/maps.h
index 5b021d2..fb08cb7 100644
--- a/FP/src/include/maps.h
+++ b/FP/src/include/maps.h
@@ -9,11 +9,40 @@ int levelUse(void* level);
  */
 
 int levelGetScreenWalls(unsigned char* data,unsigned char* borders);
+/* This will save a screen map into data.
+ * 
+ * data is a pre-allocated array with 10x3=30 bytes with the screen map
+ * dumped over it in left-to-right/upper-to-lower oreder. 
+ *
+ * borders is another pre-allocated array with 10 upper bytes, 10 bottom
+ * bytes, 3 left-side bytes, 3 right-side bytes and 4 bytes for the
+ * corners. This is another 30 bytes. The order has to be determined!
+ * In case the screen doesn't exist the 0x00 (free foreground) byte will
+ * be returned for the bottom and right sides, the wall foreground for
+ * the left side and the simple tile byte for the top side.
+ */
+
 int levelGetScreenItems(unsigned char* data,unsigned char* borders);
+/* This will save a screen map modifiers into data.
+ *
+ * data and borders are in the same form as Walls but they contain
+ * additional modifiers that must be defined in maps.h.
+ * e.g. MAPS_ITEMS_DOOROPEN 0x01
+ */
 
 int levelMoveScreen(tDirection direction);
-
+/* Moves the position screen that is inside the library
+ *
+ * Returns 0 id the screen didn't exist and the screen id
+ * in case the screen was moved
+ */
+ 
 int levelGetGuards(/* TODO: add modifiers */);
 int levelGetDoorMap(/* TODO: idem */);
 
+int levelGetStarPosition(int* screen, int* position); /* TODO: define
+		         position as an int or using x,y coordinate system*/
+
+int levelGetInformation(int* thisScreen, char* UDLRscreens, char* cornerScreens);
+/* TODO: define the format of cornerscreens */