| 1 |
/* |
| 2 |
* CrossFire, A Multiplayer game for X-windows |
| 3 |
* |
| 4 |
* Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team |
| 5 |
* Copyright (C) 2002-2005 Mark Wedel & Crossfire Development Team |
| 6 |
* Copyright (C) 1992 Frank Tore Johansen |
| 7 |
* |
| 8 |
* This program is free software; you can redistribute it and/or modify |
| 9 |
* it under the terms of the GNU General Public License as published by |
| 10 |
* the Free Software Foundation; either version 2 of the License, or |
| 11 |
* (at your option) any later version. |
| 12 |
* |
| 13 |
* This program is distributed in the hope that it will be useful, |
| 14 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 |
* GNU General Public License for more details. |
| 17 |
* |
| 18 |
* You should have received a copy of the GNU General Public License |
| 19 |
* along with this program; if not, write to the Free Software |
| 20 |
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
| 21 |
* |
| 22 |
* The authors can be reached via e-mail at crossfire@schmorp.de |
| 23 |
*/ |
| 24 |
|
| 25 |
/* |
| 26 |
* The maptile is allocated each time a new map is opened. |
| 27 |
* It contains pointers (very indirectly) to all objects on the map. |
| 28 |
*/ |
| 29 |
|
| 30 |
#ifndef MAP_H |
| 31 |
#define MAP_H |
| 32 |
|
| 33 |
#include <tr1/unordered_map> |
| 34 |
|
| 35 |
#include "cfperl.h" |
| 36 |
|
| 37 |
/* We set this size - this is to make magic map work properly on |
| 38 |
* tiled maps. There is no requirement that this matches the |
| 39 |
* tiled maps size - it just seemed like a reasonable value. |
| 40 |
* Magic map code now always starts out putting the player in the |
| 41 |
* center of the map - this makes the most sense when dealing |
| 42 |
* with tiled maps. |
| 43 |
* We also figure out the magicmap color to use as we process the |
| 44 |
* spaces - this is more efficient as we already have up to date |
| 45 |
* map pointers. |
| 46 |
*/ |
| 47 |
#define MAGIC_MAP_SIZE 50 |
| 48 |
#define MAGIC_MAP_HALF MAGIC_MAP_SIZE/2 |
| 49 |
|
| 50 |
#define MAP_LAYERS 3 |
| 51 |
|
| 52 |
/* Values for in_memory below. Should probably be an enumerations */ |
| 53 |
enum { |
| 54 |
MAP_IN_MEMORY, |
| 55 |
MAP_SWAPPED, |
| 56 |
MAP_LOADING, |
| 57 |
MAP_SAVING, |
| 58 |
}; |
| 59 |
|
| 60 |
/* GET_MAP_FLAGS really shouldn't be used very often - get_map_flags should |
| 61 |
* really be used, as it is multi tile aware. However, there are some cases |
| 62 |
* where it is known the map is not tiled or the values are known |
| 63 |
* consistent (eg, op->map, op->x, op->y) |
| 64 |
*/ |
| 65 |
// all those macros are herewith declared legacy |
| 66 |
#define GET_MAP_FLAGS(M,X,Y) (M)->at((X),(Y)).flags () |
| 67 |
#define GET_MAP_LIGHT(M,X,Y) (M)->at((X),(Y)).light |
| 68 |
#define GET_MAP_OB(M,X,Y) (M)->at((X),(Y)).bot |
| 69 |
#define GET_MAP_TOP(M,X,Y) (M)->at((X),(Y)).top |
| 70 |
#define GET_MAP_FACE(M,X,Y,L) (M)->at((X),(Y)).faces[L] |
| 71 |
#define GET_MAP_FACE_OBJ(M,X,Y,L) (M)->at((X),(Y)).faces_obj[L] |
| 72 |
#define GET_MAP_MOVE_BLOCK(M,X,Y) (M)->at((X),(Y)).move_block |
| 73 |
#define GET_MAP_MOVE_SLOW(M,X,Y) (M)->at((X),(Y)).move_slow |
| 74 |
#define GET_MAP_MOVE_ON(M,X,Y) (M)->at((X),(Y)).move_on |
| 75 |
#define GET_MAP_MOVE_OFF(M,X,Y) (M)->at((X),(Y)).move_off |
| 76 |
|
| 77 |
/* You should really know what you are doing before using this - you |
| 78 |
* should almost always be using out_of_map instead, which takes into account |
| 79 |
* map tiling. |
| 80 |
*/ |
| 81 |
#define OUT_OF_REAL_MAP(M,X,Y) (!(IN_RANGE_EXC ((X), 0, (M)->width) && IN_RANGE_EXC ((Y), 0, (M)->height))) |
| 82 |
|
| 83 |
/* These are used in the MapLook flags element. They are not used in |
| 84 |
* in the object flags structure. |
| 85 |
*/ |
| 86 |
#define P_BLOCKSVIEW 0x01 |
| 87 |
#define P_NO_MAGIC 0x02 /* Spells (some) can't pass this object */ |
| 88 |
#define P_PLAYER 0x04 /* a player (or something seeing these objects) is on this mapspace */ |
| 89 |
#define P_SAFE 0x08 /* If this is set the map tile is a safe space, |
| 90 |
* that means, nothing harmful can be done, |
| 91 |
* such as: bombs, potion usage, alchemy, spells |
| 92 |
* this was introduced to make shops safer |
| 93 |
* but is useful in other situations */ |
| 94 |
#define P_IS_ALIVE 0x10 /* something alive is on this space */ |
| 95 |
#define P_NO_CLERIC 0x20 /* no clerical spells cast here */ |
| 96 |
|
| 97 |
#define P_UPTODATE 0x80 /* this space is up to date */ |
| 98 |
|
| 99 |
/* The following two values are not stored in the MapLook flags, but instead |
| 100 |
* used in the get_map_flags value - that function is used to return |
| 101 |
* the flag value, as well as other conditions - using a more general |
| 102 |
* function that does more of the work can hopefully be used to replace |
| 103 |
* lots of duplicate checks currently in the code. |
| 104 |
*/ |
| 105 |
#define P_OUT_OF_MAP 0x10000 /* This space is outside the map */ |
| 106 |
#define P_NEW_MAP 0x20000 |
| 107 |
/* Coordinates passed result in a new tiled map */ |
| 108 |
|
| 109 |
/* P_NO_PASS is used for ob_blocked() return value. It needs |
| 110 |
* to be here to make sure the bits don't match with anything. |
| 111 |
*/ |
| 112 |
#define P_NO_PASS 0x80000 |
| 113 |
|
| 114 |
/* Instead of having numerous arrays that have information on a |
| 115 |
* particular space (was map, floor, floor2, map_ob), |
| 116 |
* have this structure take care of that information. |
| 117 |
* This puts it all in one place, and should also make it easier |
| 118 |
* to extend information about a space. |
| 119 |
*/ |
| 120 |
struct mapspace |
| 121 |
{ |
| 122 |
object *bot, *top; /* lowest/highest object on this space */ |
| 123 |
facetile *faces[MAP_LAYERS]; /* faces for the 3 layers */ |
| 124 |
object *faces_obj[MAP_LAYERS];/* face objects for the 3 layers */ |
| 125 |
uint8 flags_; /* flags about this space (see the P_ values above) */ |
| 126 |
sint8 light; /* How much light this space provides */ |
| 127 |
MoveType move_block; /* What movement types this space blocks */ |
| 128 |
MoveType move_slow; /* What movement types this space slows */ |
| 129 |
MoveType move_on; /* What movement types are activated */ |
| 130 |
MoveType move_off; /* What movement types are activated */ |
| 131 |
|
| 132 |
void update_ (); |
| 133 |
void update () |
| 134 |
{ |
| 135 |
if (!(flags_ & P_UPTODATE)) |
| 136 |
update_ (); |
| 137 |
} |
| 138 |
|
| 139 |
uint8 flags () |
| 140 |
{ |
| 141 |
update (); |
| 142 |
return flags_; |
| 143 |
} |
| 144 |
|
| 145 |
// maybe only inline quick flags_ checking? |
| 146 |
object *player () |
| 147 |
{ |
| 148 |
// search from the top, because players are usually on top |
| 149 |
// make usually == always and this non-amortized O(1) |
| 150 |
// could gte rid of P_PLAYER, too, then |
| 151 |
if (flags () & P_PLAYER) |
| 152 |
for (object *op = top; op; op = op->below) |
| 153 |
if (op->type == PLAYER) |
| 154 |
return op; |
| 155 |
|
| 156 |
return 0; |
| 157 |
} |
| 158 |
}; |
| 159 |
|
| 160 |
/* |
| 161 |
* Each map is in a given region of the game world and links to a region definiton, so |
| 162 |
* they have to appear here in the headers, before the mapdef |
| 163 |
*/ |
| 164 |
INTERFACE_CLASS (region) |
| 165 |
struct region : zero_initialised |
| 166 |
{ |
| 167 |
region *ACC (RW, next); /* pointer to next region, NULL for the last one */ |
| 168 |
char *ACC (RW, name); /* Shortend name of the region as maps refer to it */ |
| 169 |
char *ACC (RW, parent_name); /* |
| 170 |
* So that parent and child regions can be defined in |
| 171 |
* any order, we keep hold of the parent_name during |
| 172 |
* initialisation, and the children get assigned to their |
| 173 |
* parents later. (before runtime on the server though) |
| 174 |
* nothing outside the init code should ever use this value. |
| 175 |
*/ |
| 176 |
region *ACC (RW, parent); /* |
| 177 |
* Pointer to the region that is a parent of the current |
| 178 |
* region, if a value isn't defined in the current region |
| 179 |
* we traverse this series of pointers until it is. |
| 180 |
*/ |
| 181 |
char *ACC (RW, longname); /* Official title of the region, this might be defined |
| 182 |
* to be the same as name*/ |
| 183 |
char *ACC (RW, msg); /* the description of the region */ |
| 184 |
uint32 ACC (RW, counter); /* A generic counter for holding temporary data. */ |
| 185 |
sint8 ACC (RW, fallback); /* whether, in the event of a region not existing, |
| 186 |
* this should be the one we fall back on as the default */ |
| 187 |
char *ACC (RW, jailmap); /*where a player that is arrested in this region should be imprisoned. */ |
| 188 |
sint16 ACC (RW, jailx), ACC (RW, jaily); /* The coodinates in jailmap to which the player should be sent. */ |
| 189 |
|
| 190 |
static region *default_region (); |
| 191 |
static region *find (const char *name); |
| 192 |
}; |
| 193 |
|
| 194 |
struct shopitems : zero_initialised |
| 195 |
{ |
| 196 |
const char *name; /* name of the item in question, null if it is the default item */ |
| 197 |
const char *name_pl; /* plural name */ |
| 198 |
int typenum; /* itemtype number we need to match 0 if it is the default price */ |
| 199 |
sint8 strength; /* the degree of specialisation the shop has in this item, |
| 200 |
* as a percentage from -100 to 100 */ |
| 201 |
int index; /* being the size of the shopitems array. */ |
| 202 |
}; |
| 203 |
|
| 204 |
// map I/O, what to load/save |
| 205 |
enum { |
| 206 |
IO_HEADER = 0x01, // the "arch map" pseudo object |
| 207 |
IO_OBJECTS = 0x02, // the non-unique objects |
| 208 |
IO_UNIQUES = 0x04, // unique objects |
| 209 |
}; |
| 210 |
|
| 211 |
/* In general, code should always use the macros |
| 212 |
* above (or functions in map.c) to access many of the |
| 213 |
* values in the map structure. Failure to do this will |
| 214 |
* almost certainly break various features. You may think |
| 215 |
* it is safe to look at width and height values directly |
| 216 |
* (or even through the macros), but doing so will completely |
| 217 |
* break map tiling. |
| 218 |
*/ |
| 219 |
INTERFACE_CLASS (maptile) |
| 220 |
struct maptile : zero_initialised, attachable |
| 221 |
{ |
| 222 |
sint32 ACC (RW, width), ACC (RW, height); /* Width and height of map. */ |
| 223 |
struct mapspace *spaces; /* Array of spaces on this map */ |
| 224 |
uint8 *regions; /* region index per mapspace, if != 0 */ |
| 225 |
struct region **regionmap; /* index to region */ |
| 226 |
|
| 227 |
tstamp ACC (RW, last_access); /* last time this map was accessed somehow */ |
| 228 |
|
| 229 |
shstr ACC (RW, name); /* Name of map as given by its creator */ |
| 230 |
struct region *ACC (RW, default_region); /* What jurisdiction in the game world this map is ruled by |
| 231 |
* points to the struct containing all the properties of |
| 232 |
* the region */ |
| 233 |
double ACC (RW, reset_time); |
| 234 |
uint32 ACC (RW, reset_timeout); /* How many seconds must elapse before this map |
| 235 |
* should be reset |
| 236 |
*/ |
| 237 |
bool ACC (RW, dirty); /* if true, something was inserted or removed */ |
| 238 |
bool ACC (RW, fixed_resettime); /* if true, reset time is not affected by |
| 239 |
* players entering/exiting map |
| 240 |
*/ |
| 241 |
sint32 ACC (RW, timeout); /* swapout is set to this */ |
| 242 |
sint32 ACC (RW, swap_time); /* When it reaches 0, the map will be swapped out */ |
| 243 |
uint32 ACC (RW, in_memory); /* If not true, the map has been freed and must |
| 244 |
* be loaded before used. The map,omap and map_ob |
| 245 |
* arrays will be allocated when the map is loaded */ |
| 246 |
sint16 players; /* How many players are on this map right now */ |
| 247 |
uint16 ACC (RW, difficulty); /* What level the player should be to play here */ |
| 248 |
|
| 249 |
bool ACC (RW, per_player); |
| 250 |
bool ACC (RW, per_party); |
| 251 |
bool ACC (RW, outdoor); /* True if an outdoor map */ |
| 252 |
bool ACC (RW, nodrop); /* avoid dropping anything on this map */ |
| 253 |
uint8 ACC (RW, darkness); /* indicates level of darkness of map */ |
| 254 |
|
| 255 |
uint16 ACC (RW, enter_x); /* enter_x and enter_y are default entrance location */ |
| 256 |
uint16 ACC (RW, enter_y); /* on the map if none are set in the exit */ |
| 257 |
oblinkpt *buttons; /* Linked list of linked lists of buttons */ |
| 258 |
sint16 ACC (RW, temp); /* base temperature of this tile (F) */ |
| 259 |
sint16 ACC (RW, pressure); /* barometric pressure (mb) */ |
| 260 |
sint8 ACC (RW, humid); /* humitidy of this tile */ |
| 261 |
sint8 ACC (RW, windspeed); /* windspeed of this tile */ |
| 262 |
sint8 ACC (RW, winddir); /* direction of wind */ |
| 263 |
sint8 ACC (RW, sky); /* sky conditions */ |
| 264 |
int ACC (RW, worldpartx), ACC (RW, worldparty); /*Highly fasten conversion between worldmap and weathermap */ |
| 265 |
struct shopitems *shopitems; /* a semi-colon seperated list of item-types the map's shop will trade in */ |
| 266 |
shstr ACC (RW, shoprace); /* the preffered race of the local shopkeeper */ |
| 267 |
double ACC (RW, shopgreed); /* how much our shopkeeper overcharges */ |
| 268 |
sint64 ACC (RW, shopmin); /* minimum price a shop will trade for */ |
| 269 |
sint64 ACC (RW, shopmax); /* maximum price a shop will offer */ |
| 270 |
shstr ACC (RW, msg); /* Message map creator may have left */ |
| 271 |
shstr ACC (RW, maplore); /* Map lore information */ |
| 272 |
shstr ACC (RW, tile_path[4]); /* path to adjoining maps */ |
| 273 |
maptile *ACC (RW, tile_map[4]); /* Next map, linked list */ |
| 274 |
shstr ACC (RW, path); /* Filename of the map */ |
| 275 |
|
| 276 |
MTH void activate (); |
| 277 |
MTH void deactivate (); |
| 278 |
|
| 279 |
// allocates all (empty) mapspace |
| 280 |
MTH void alloc (); |
| 281 |
// deallocates the mapspaces (and destroys all objects) |
| 282 |
MTH void clear (); |
| 283 |
|
| 284 |
MTH void fix_auto_apply (); |
| 285 |
MTH void decay_objects (); |
| 286 |
MTH void update_buttons (); |
| 287 |
MTH int change_map_light (int change); |
| 288 |
static void change_all_map_light (int change); //PERL |
| 289 |
MTH void set_darkness_map (); |
| 290 |
MTH int estimate_difficulty () const; |
| 291 |
|
| 292 |
// set the given flag on all objects in the map |
| 293 |
MTH void set_object_flag (int flag, int value = 1); |
| 294 |
|
| 295 |
MTH void link_multipart_objects (); |
| 296 |
MTH void clear_unique_items (); |
| 297 |
|
| 298 |
MTH void clear_header (); |
| 299 |
MTH void clear_links_to (maptile *m); |
| 300 |
|
| 301 |
MTH struct region *region (int x, int y) const; |
| 302 |
|
| 303 |
// loas the header pseudo-object |
| 304 |
bool _load_header (object_thawer &thawer); |
| 305 |
MTH bool _load_header (const char *path); |
| 306 |
|
| 307 |
// load objects into the map |
| 308 |
bool _load_objects (object_thawer &thawer); |
| 309 |
MTH bool _load_objects (const char *path, bool skip_header = true); |
| 310 |
|
| 311 |
// save objects into the given file (uses IO_ flags) |
| 312 |
bool _save_objects (object_freezer &freezer, int flags); |
| 313 |
MTH bool _save_objects (const char *path, int flags); |
| 314 |
|
| 315 |
// save the header pseudo object _only_ |
| 316 |
bool _save_header (object_freezer &freezer); |
| 317 |
MTH bool _save_header (const char *path); |
| 318 |
|
| 319 |
maptile (); |
| 320 |
maptile (int w, int h); |
| 321 |
~maptile (); |
| 322 |
|
| 323 |
void do_destroy (); |
| 324 |
void gather_callbacks (AV *&callbacks, event_type event) const; |
| 325 |
|
| 326 |
MTH int size () const { return width * height; } |
| 327 |
|
| 328 |
MTH object *insert (object *op, int x, int y, object *originator = 0, int flags = 0); |
| 329 |
|
| 330 |
MTH void touch () { last_access = runtime; } |
| 331 |
|
| 332 |
// find the map that is at coordinate x|y relative to this map |
| 333 |
// TODO: need a better way than passing by reference |
| 334 |
// TODO: make perl interface |
| 335 |
maptile *xy_find (sint16 &x, sint16 &y); |
| 336 |
|
| 337 |
// like xy_find, but also loads the map |
| 338 |
maptile *xy_load (sint16 &x, sint16 &y); |
| 339 |
|
| 340 |
void do_load_sync ();//PERL |
| 341 |
|
| 342 |
// make sure the map is loaded |
| 343 |
MTH void load_sync () |
| 344 |
{ |
| 345 |
if (!spaces) |
| 346 |
do_load_sync (); |
| 347 |
} |
| 348 |
|
| 349 |
void make_map_floor (char **layout, char *floorstyle, random_map_params *RP); |
| 350 |
bool generate_random_map (random_map_params *RP); |
| 351 |
|
| 352 |
static maptile *find_sync (const char *path, maptile *original = 0);//PERL |
| 353 |
// async prefetch |
| 354 |
static maptile *find_async (const char *path, maptile *original = 0);//PERL |
| 355 |
|
| 356 |
mapspace const &at (uint32 x, uint32 y) const { return spaces [x * height + y]; } |
| 357 |
mapspace &at (uint32 x, uint32 y) { return spaces [x * height + y]; } |
| 358 |
}; |
| 359 |
|
| 360 |
/* This is used by get_rangevector to determine where the other |
| 361 |
* creature is. get_rangevector takes into account map tiling, |
| 362 |
* so you just can not look the the map coordinates and get the |
| 363 |
* righte value. distance_x/y are distance away, which |
| 364 |
* can be negative. direction is the crossfire direction scheme |
| 365 |
* that the creature should head. part is the part of the |
| 366 |
* monster that is closest. |
| 367 |
* Note: distance should be always >=0. I changed it to UINT. MT |
| 368 |
*/ |
| 369 |
struct rv_vector |
| 370 |
{ |
| 371 |
unsigned int distance; |
| 372 |
int distance_x; |
| 373 |
int distance_y; |
| 374 |
int direction; |
| 375 |
object *part; |
| 376 |
}; |
| 377 |
|
| 378 |
//TODO: these should be refactored into things like xy_normalise |
| 379 |
// and so on. |
| 380 |
int get_map_flags(maptile *oldmap, maptile **newmap, sint16 x, sint16 y, sint16 *nx, sint16 *ny); |
| 381 |
int ob_blocked(const object *ob, maptile *m, sint16 x, sint16 y); |
| 382 |
int out_of_map(maptile *m, int x, int y); |
| 383 |
maptile *get_map_from_coord(maptile *m, sint16 *x, sint16 *y); |
| 384 |
void get_rangevector(object *op1, object *op2, rv_vector *retval, int flags); |
| 385 |
void get_rangevector_from_mapcoord(const maptile *m, int x, int y, const object *op2, rv_vector *retval, int flags); |
| 386 |
int on_same_map(const object *op1, const object *op2); |
| 387 |
|
| 388 |
// adjust map, x and y for tiled maps and return true if the position is valid at all |
| 389 |
inline bool |
| 390 |
xy_normalise (maptile *&map, sint16 &x, sint16 &y) |
| 391 |
{ |
| 392 |
// when in range, do a quick return, otherwise go the slow route |
| 393 |
return |
| 394 |
(IN_RANGE_EXC (x, 0, map->width) && IN_RANGE_EXC (y, 0, map->height)) |
| 395 |
|| !(get_map_flags (map, &map, x, y, &x, &y) & P_OUT_OF_MAP); |
| 396 |
} |
| 397 |
|
| 398 |
inline mapspace & |
| 399 |
object::ms () const |
| 400 |
{ |
| 401 |
return map->at (x, y); |
| 402 |
} |
| 403 |
|
| 404 |
#endif |
| 405 |
|
