project_files/frontlib/ipc/mapconn.h
changeset 7275 15f722e0b96f
parent 7271 5608ac657362
child 7314 6171f0bad318
--- a/project_files/frontlib/ipc/mapconn.h	Mon Jun 25 15:21:18 2012 +0200
+++ b/project_files/frontlib/ipc/mapconn.h	Wed Jun 27 18:02:45 2012 +0200
@@ -17,10 +17,14 @@
  * engine process. Once this connection is established, the required information
  * will be sent to the engine, and the reply is read.
  *
+ * The map must be a regular, maze or drawn map - for a preview of a named map,
+ * use the preview images in the map's directory, and for the hog count read the
+ * map information (flib_mapcfg_read).
+ *
  * No NULL parameters allowed, returns NULL on failure.
  * Use flib_mapconn_destroy to free the returned object.
  */
-flib_mapconn *flib_mapconn_create(flib_map *mapdesc);
+flib_mapconn *flib_mapconn_create(const flib_map *mapdesc);
 
 /**
  * Destroy the mapconn object. Passing NULL is allowed and does nothing.