15 * Start a new map rendering connection (mapconn). This means a listening socket |
15 * Start a new map rendering connection (mapconn). This means a listening socket |
16 * will be started on a random unused port, waiting for a connection from the |
16 * will be started on a random unused port, waiting for a connection from the |
17 * engine process. Once this connection is established, the required information |
17 * engine process. Once this connection is established, the required information |
18 * will be sent to the engine, and the reply is read. |
18 * will be sent to the engine, and the reply is read. |
19 * |
19 * |
|
20 * The map must be a regular, maze or drawn map - for a preview of a named map, |
|
21 * use the preview images in the map's directory, and for the hog count read the |
|
22 * map information (flib_mapcfg_read). |
|
23 * |
20 * No NULL parameters allowed, returns NULL on failure. |
24 * No NULL parameters allowed, returns NULL on failure. |
21 * Use flib_mapconn_destroy to free the returned object. |
25 * Use flib_mapconn_destroy to free the returned object. |
22 */ |
26 */ |
23 flib_mapconn *flib_mapconn_create(flib_map *mapdesc); |
27 flib_mapconn *flib_mapconn_create(const flib_map *mapdesc); |
24 |
28 |
25 /** |
29 /** |
26 * Destroy the mapconn object. Passing NULL is allowed and does nothing. |
30 * Destroy the mapconn object. Passing NULL is allowed and does nothing. |
27 * flib_mapconn_destroy may be called from inside a callback function. |
31 * flib_mapconn_destroy may be called from inside a callback function. |
28 */ |
32 */ |