/* * CrossFire, A Multiplayer game for X-windows * * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team * Copyright (C) 2002-2005 Mark Wedel & Crossfire Development Team * Copyright (C) 1992 Frank Tore Johansen * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. * * The authors can be reached via e-mail at crossfire@schmorp.de */ /* * The maptile is allocated each time a new map is opened. * It contains pointers (very indirectly) to all objects on the map. */ #ifndef MAP_H #define MAP_H #include #include "cfperl.h" /* We set this size - this is to make magic map work properly on * tiled maps. There is no requirement that this matches the * tiled maps size - it just seemed like a reasonable value. * Magic map code now always starts out putting the player in the * center of the map - this makes the most sense when dealing * with tiled maps. * We also figure out the magicmap color to use as we process the * spaces - this is more efficient as we already have up to date * map pointers. */ #define MAGIC_MAP_SIZE 50 #define MAGIC_MAP_HALF MAGIC_MAP_SIZE/2 #define MAP_LAYERS 3 /* options passed to ready_map_name and load_original_map */ #define MAP_FLUSH 0x01 #define MAP_PLAYER_UNIQUE 0x02 #define MAP_BLOCK 0x04 #define MAP_STYLE 0x08 #define MAP_OVERLAY 0x10 /* Values for in_memory below. Should probably be an enumerations */ enum { MAP_IN_MEMORY, MAP_SWAPPED, MAP_LOADING, MAP_SAVING, }; /* GET_MAP_FLAGS really shouldn't be used very often - get_map_flags should * really be used, as it is multi tile aware. However, there are some cases * where it is known the map is not tiled or the values are known * consistent (eg, op->map, op->x, op->y) */ // all those macros are herewith declared legacy #define GET_MAP_FLAGS(M,X,Y) (M)->at((X),(Y)).flags () #define GET_MAP_LIGHT(M,X,Y) (M)->at((X),(Y)).light #define GET_MAP_OB(M,X,Y) (M)->at((X),(Y)).bot #define GET_MAP_TOP(M,X,Y) (M)->at((X),(Y)).top #define GET_MAP_FACE(M,X,Y,L) (M)->at((X),(Y)).faces[L] #define GET_MAP_FACE_OBJ(M,X,Y,L) (M)->at((X),(Y)).faces_obj[L] #define GET_MAP_MOVE_BLOCK(M,X,Y) (M)->at((X),(Y)).move_block #define GET_MAP_MOVE_SLOW(M,X,Y) (M)->at((X),(Y)).move_slow #define GET_MAP_MOVE_ON(M,X,Y) (M)->at((X),(Y)).move_on #define GET_MAP_MOVE_OFF(M,X,Y) (M)->at((X),(Y)).move_off /* You should really know what you are doing before using this - you * should almost always be using out_of_map instead, which takes into account * map tiling. */ #define OUT_OF_REAL_MAP(M,X,Y) ((X)<0 || (Y)<0 || (X)>=(M)->width || (Y)>=(M)->height) /* These are used in the MapLook flags element. They are not used in * in the object flags structure. */ #define P_BLOCKSVIEW 0x01 #define P_NO_MAGIC 0x02 /* Spells (some) can't pass this object */ #define P_PLAYER 0x04 /* a player (or something seeing these objects) is on this mapspace */ #define P_SAFE 0x08 /* If this is set the map tile is a safe space, * that means, nothing harmful can be done, * such as: bombs, potion usage, alchemy, spells * this was introduced to make shops safer * but is useful in other situations */ #define P_IS_ALIVE 0x10 /* something alive is on this space */ #define P_NO_CLERIC 0x20 /* no clerical spells cast here */ #define P_UPTODATE 0x80 /* this space is up to date */ /* The following two values are not stored in the MapLook flags, but instead * used in the get_map_flags value - that function is used to return * the flag value, as well as other conditions - using a more general * function that does more of the work can hopefully be used to replace * lots of duplicate checks currently in the code. */ #define P_OUT_OF_MAP 0x10000 /* This space is outside the map */ #define P_NEW_MAP 0x20000 /* Coordinates passed result in a new tiled map */ /* P_NO_PASS is used for ob_blocked() return value. It needs * to be here to make sure the bits don't match with anything. */ #define P_NO_PASS 0x80000 /* Instead of having numerous arrays that have information on a * particular space (was map, floor, floor2, map_ob), * have this structure take care of that information. * This puts it all in one place, and should also make it easier * to extend information about a space. */ struct mapspace { object *bot, *top; /* lowest/highest object on this space */ New_Face *faces[MAP_LAYERS]; /* faces for the 3 layers */ object *faces_obj[MAP_LAYERS];/* face objects for the 3 layers */ uint8 flags_; /* flags about this space (see the P_ values above) */ sint8 light; /* How much light this space provides */ MoveType move_block; /* What movement types this space blocks */ MoveType move_slow; /* What movement types this space slows */ MoveType move_on; /* What movement types are activated */ MoveType move_off; /* What movement types are activated */ void update_ (); void update () { if (!(flags_ & P_UPTODATE)) update_ (); } uint8 flags () { update (); return flags_; } // maybe only inline quick flags_ checking? object *player () { // search from the top, because players are usually on top // make usually == always and this non-amortized O(1) // could gte rid of P_PLAYER, too, then if (flags () & P_PLAYER) for (object *op = top; op; op = op->below) if (op->type == PLAYER) return op; return 0; } }; /* * Each map is in a given region of the game world and links to a region definiton, so * they have to appear here in the headers, before the mapdef */ INTERFACE_CLASS (region) struct region : zero_initialised { struct region *ACC (RW, next); /* pointer to next region, NULL for the last one */ char *ACC (RW, name); /* Shortend name of the region as maps refer to it */ char *ACC (RW, parent_name); /* * So that parent and child regions can be defined in * any order, we keep hold of the parent_name during * initialisation, and the children get assigned to their * parents later. (before runtime on the server though) * nothing outside the init code should ever use this value. */ struct region *ACC (RW, parent); /* * Pointer to the region that is a parent of the current * region, if a value isn't defined in the current region * we traverse this series of pointers until it is. */ char *ACC (RW, longname); /* Official title of the region, this might be defined * to be the same as name*/ char *ACC (RW, msg); /* the description of the region */ uint32 ACC (RW, counter); /* A generic counter for holding temporary data. */ sint8 ACC (RW, fallback); /* whether, in the event of a region not existing, * this should be the one we fall back on as the default */ char *ACC (RW, jailmap); /*where a player that is arrested in this region should be imprisoned. */ sint16 ACC (RW, jailx), ACC (RW, jaily); /* The coodinates in jailmap to which the player should be sent. */ }; struct shopitems : zero_initialised { const char *name; /* name of the item in question, null if it is the default item */ const char *name_pl; /* plural name */ int typenum; /* itemtype number we need to match 0 if it is the default price */ sint8 strength; /* the degree of specialisation the shop has in this item, * as a percentage from -100 to 100 */ int index; /* being the size of the shopitems array. */ }; // map I/O, what to load/save enum { IO_HEADER = 0x01, // the "arch map" pseudo object IO_OBJECTS = 0x02, // the non-unique objects IO_UNIQUES = 0x04, // unique objects }; /* In general, code should always use the macros * above (or functions in map.c) to access many of the * values in the map structure. Failure to do this will * almost certainly break various features. You may think * it is safe to look at width and height values directly * (or even through the macros), but doing so will completely * break map tiling. */ INTERFACE_CLASS (maptile) struct maptile : zero_initialised, attachable { sint32 ACC (RW, width), ACC (RW, height); /* Width and height of map. */ struct mapspace *spaces; /* Array of spaces on this map */ tstamp ACC (RW, last_access); /* last time this map was accessed somehow */ shstr ACC (RW, name); /* Name of map as given by its creator */ struct region *ACC (RW, region); /* What jurisdiction in the game world this map is ruled by * points to the struct containing all the properties of * the region */ double ACC (RW, reset_time); uint32 ACC (RW, reset_timeout); /* How many seconds must elapse before this map * should be reset */ bool ACC (RW, dirty); /* if true, something was inserted or removed */ bool ACC (RW, fixed_resettime); /* if true, reset time is not affected by * players entering/exiting map */ sint32 ACC (RW, timeout); /* swapout is set to this */ sint32 ACC (RW, swap_time); /* When it reaches 0, the map will be swapped out */ uint32 ACC (RW, in_memory); /* If not true, the map has been freed and must * be loaded before used. The map,omap and map_ob * arrays will be allocated when the map is loaded */ sint16 players; /* How many players are on this map right now */ uint16 ACC (RW, difficulty); /* What level the player should be to play here */ bool ACC (RW, per_player); bool ACC (RW, per_party); bool ACC (RW, outdoor); /* True if an outdoor map */ uint8 ACC (RW, darkness); /* indicates level of darkness of map */ uint16 ACC (RW, enter_x); /* enter_x and enter_y are default entrance location */ uint16 ACC (RW, enter_y); /* on the map if none are set in the exit */ oblinkpt *buttons; /* Linked list of linked lists of buttons */ sint16 ACC (RW, temp); /* base temperature of this tile (F) */ sint16 ACC (RW, pressure); /* barometric pressure (mb) */ sint8 ACC (RW, humid); /* humitidy of this tile */ sint8 ACC (RW, windspeed); /* windspeed of this tile */ sint8 ACC (RW, winddir); /* direction of wind */ sint8 ACC (RW, sky); /* sky conditions */ int ACC (RW, worldpartx), ACC (RW, worldparty); /*Highly fasten conversion between worldmap and weathermap */ struct shopitems *shopitems; /* a semi-colon seperated list of item-types the map's shop will trade in */ shstr ACC (RW, shoprace); /* the preffered race of the local shopkeeper */ double ACC (RW, shopgreed); /* how much our shopkeeper overcharges */ sint64 ACC (RW, shopmin); /* minimum price a shop will trade for */ sint64 ACC (RW, shopmax); /* maximum price a shop will offer */ shstr ACC (RW, msg); /* Message map creator may have left */ shstr ACC (RW, maplore); /* Map lore information */ shstr ACC (RW, tile_path[4]); /* path to adjoining maps */ maptile *ACC (RW, tile_map[4]); /* Next map, linked list */ shstr ACC (RW, path); /* Filename of the map */ MTH void activate (); MTH void deactivate (); // allocates all (empty) mapspace MTH void alloc (); // deallocates the mapspaces (and destroys all objects) MTH void clear (); MTH void fix_auto_apply (); MTH void decay_objects (); MTH void update_buttons (); MTH int change_map_light (int change); static void change_all_map_light (int change); //PERL MTH void set_darkness_map (); MTH int estimate_difficulty () const; // set the given flag on all objects in the map MTH void set_object_flag (int flag, int value = 1); MTH void link_multipart_objects (); MTH void clear_unique_items (); MTH void clear_header (); MTH void clear_links_to (maptile *m); // loas the header pseudo-object bool _load_header (object_thawer &thawer); MTH bool _load_header (const char *path); // load objects into the map bool _load_objects (object_thawer &thawer); MTH bool _load_objects (const char *path, bool skip_header = true); // save objects into the given file (uses IO_ flags) bool _save_objects (object_freezer &freezer, int flags); MTH bool _save_objects (const char *path, int flags); // save the header pseudo object _only_ bool _save_header (object_freezer &freezer); MTH bool _save_header (const char *path); maptile (); maptile (int w, int h); ~maptile (); void do_destroy (); void gather_callbacks (AV *&callbacks, event_type event) const; MTH int size () const { return width * height; } MTH object *insert (object *op, int x, int y, object *originator = 0, int flags = 0); MTH void touch () { last_access = runtime; } // find the map that is at coordinate x|y relative to this map // TODO: need a better way than passing by reference // TODO: make perl interface maptile *xy_find (sint16 &x, sint16 &y); // like xy_find, but also loads the map maptile *xy_load (sint16 &x, sint16 &y); void do_load_sync ();//PERL // make sure the map is loaded MTH void load_sync () { if (!spaces) do_load_sync (); } void make_map_floor (char **layout, char *floorstyle, random_map_params *RP); bool generate_random_map (random_map_params *RP); static maptile *find_sync (const char *path, maptile *original = 0);//PERL // async prefetch static maptile *find_async (const char *path, maptile *original = 0);//PERL mapspace const &at (uint32 x, uint32 y) const { return spaces [x * height + y]; } mapspace &at (uint32 x, uint32 y) { return spaces [x * height + y]; } }; /* This is used by get_rangevector to determine where the other * creature is. get_rangevector takes into account map tiling, * so you just can not look the the map coordinates and get the * righte value. distance_x/y are distance away, which * can be negative. direction is the crossfire direction scheme * that the creature should head. part is the part of the * monster that is closest. * Note: distance should be always >=0. I changed it to UINT. MT */ struct rv_vector { unsigned int distance; int distance_x; int distance_y; int direction; object *part; }; //TODO: these should be refactored into things like xy_normalise // and so on. int get_map_flags(maptile *oldmap, maptile **newmap, sint16 x, sint16 y, sint16 *nx, sint16 *ny); int ob_blocked(const object *ob, maptile *m, sint16 x, sint16 y); int out_of_map(maptile *m, int x, int y); maptile *get_map_from_coord(maptile *m, sint16 *x, sint16 *y); void get_rangevector(object *op1, object *op2, rv_vector *retval, int flags); void get_rangevector_from_mapcoord(const maptile *m, int x, int y, const object *op2, rv_vector *retval, int flags); int on_same_map(const object *op1, const object *op2); // adjust map, x and y for tiled maps and return true if the position is valid at all inline bool xy_normalise (maptile *&map, sint16 &x, sint16 &y) { // when in range, do a quick return, otherwise go the slow route return (IN_RANGE_EXC (x, 0, map->width) && IN_RANGE_EXC (y, 0, map->height)) || !(get_map_flags (map, &map, x, y, &x, &y) & P_OUT_OF_MAP); } inline mapspace & object::ms () const { return map->at (x, y); } #endif