map.c File Reference

#include <stdio.h>
#include <global.h>
#include <sproto.h>
#include <loader.h>
#include <unistd.h>
#include "path.h"

Include dependency graph for map.c:

Go to the source code of this file.

Data Structures
struct	Map_Layer_Info

Macros
#define	TEMP_EXT   ".savefile"

Typedefs
typedef struct Map_Layer_Info	Map_Layer_Info

Functions
static void	add_face_layer (int low_layer, int high_layer, object *ob, object *layers[], int honor_visibility)
static int	adjacent_map (const mapstruct *map1, const mapstruct *map2, int *dx, int *dy)
static void	allocate_map (mapstruct *m)
int	blocked_link (object *ob, mapstruct *m, int sx, int sy)
int	calculate_difficulty (mapstruct *m)
int	change_map_light (mapstruct *m, int change)
int	check_path (const char *name, int prepend_dir)
void	clean_object (object *op)
void	clean_tmp_map (mapstruct *m)
static void	create_items_path (const char *s, char *buf, size_t size)
void	create_overlay_pathname (const char *name, char *buf, size_t size)
char *	create_pathname (const char *name, char *buf, size_t size)
void	create_template_pathname (const char *name, char *buf, size_t size)
void	delete_map (mapstruct *m)
static void	delete_unique_items (mapstruct *m)
void	dump_all_maps (void)
void	dump_map (const mapstruct *m)
void	fix_container (object *container)
static void	fix_container_multipart (object *container)
void	free_all_maps (void)
static void	free_all_objects (mapstruct *m)
void	free_map (mapstruct *m)
mapstruct *	get_empty_map (int sizex, int sizey)
mapstruct *	get_linked_map (void)
int	get_map_flags (mapstruct *oldmap, mapstruct **newmap, sint16 x, sint16 y, sint16 *nx, sint16 *ny)
mapstruct *	get_map_from_coord (mapstruct *m, sint16 *x, sint16 *y)
void	get_rangevector (object *op1, const object *op2, rv_vector *retval, int flags)
void	get_rangevector_from_mapcoord (const mapstruct *m, int x, int y, const object *op2, rv_vector *retval, int flags)
mapstruct *	has_been_loaded (const char *name)
static void	link_multipart_objects (mapstruct *m)
static mapstruct *	load_and_link_tiled_map (mapstruct *orig_map, int tile_num)
static int	load_map_header (FILE *fp, mapstruct *m)
static void	load_objects (mapstruct *m, FILE *fp, int mapflags)
mapstruct *	load_original_map (const char *filename, int flags)
static mapstruct *	load_overlay_map (const char *filename, mapstruct *m)
static mapstruct *	load_temporary_map (mapstruct *m)
static void	load_unique_objects (mapstruct *m)
void	map_remove_unique_files (const mapstruct *map)
int	ob_blocked (const object *ob, mapstruct *m, sint16 x, sint16 y)
int	on_same_map (const object *op1, const object *op2)
int	out_of_map (mapstruct *m, int x, int y)
static shopitems *	parse_shop_string (const char *input_string)
static void	print_shop_string (mapstruct *m, char *output_string, int size)
mapstruct *	ready_map_name (const char *name, int flags)
int	save_map (mapstruct *m, int flag)
static int	save_objects (mapstruct *m, FILE *fp, FILE *fp2, int flag)
void	set_map_reset_time (mapstruct *map)
void	update_position (mapstruct *m, int x, int y)

Variables
static Map_Layer_Info	map_layer_info [MAP_LAYERS]
const char *	map_layer_name [MAP_LAYERS]
int	nrofallocobjects
int	nroffreeobjects

Detailed Description

Map-related functions.

Definition in file map.c.

Macro Definition Documentation

#define TEMP_EXT   ".savefile"

Referenced by save_map().

Typedef Documentation

typedef struct Map_Layer_Info Map_Layer_Info

Information about a layer.

Function Documentation

static void add_face_layer ( int  low_layer, int  high_layer, object *  ob, object *  layers[], int  honor_visibility  )

inlinestatic

This function is used for things that can have multiple layers - NO_PICK, ITEM, LIVING, FLYING. Basically, we want to store in the empty spot, and if both full, store highest visiblity objects. Since update_position() goes from bottom to top order, if the new object is equal to existing we take the new object since it is higher in the stack.

Parameters

low_layer	lower bounds to check (inclusive).
high_layer	upper bounds to check (inclusive).
ob	object to add to the layer.
layers	layers to change.
honor_visibility	if it is set to 0,then we do a pure stacking logic - this is used for the no pick layer, since stacking ordering there is basically fixed - don't want to re-order walls, pentagrams, etc.

Definition at line 2055 of file map.c.

References obj::face, and new_face_struct::visibility.

Referenced by update_position().

Here is the caller graph for this function:

static int adjacent_map ( const mapstruct *  map1, const mapstruct *  map2, int *  dx, int *  dy  )

static

Return whether map2 is adjacent to map1. If so, store the distance from map1 to map2 in dx/dy.

Parameters

map1
map2	maps to consider.
dx
dy	distance. Must not be NULL. Not altered if returns 0.

Returns

1 if maps are adjacent, 0 else.

Definition at line 2427 of file map.c.

References MAP_HEIGHT, MAP_WIDTH, and mapdef::tile_map.

Referenced by get_rangevector(), get_rangevector_from_mapcoord(), and on_same_map().

Here is the caller graph for this function:

static void allocate_map ( mapstruct *  m )

static

This basically allocates the dynamic array of spaces for the map.

Parameters

m	map to check.

Note

will never fail, since it calls fatal() if memory allocation failure.

Definition at line 854 of file map.c.

References fatal(), mapdef::in_memory, llevError, LOG(), MAP_HEIGHT, MAP_IN_MEMORY, MAP_WIDTH, OUT_OF_MEMORY, mapdef::path, and mapdef::spaces.

Referenced by get_empty_map(), load_original_map(), and load_temporary_map().

Here is the call graph for this function:

Here is the caller graph for this function:

int blocked_link	(	object *	ob,
		mapstruct *	m,
		int	sx,
		int	sy
	)

Returns true if the given coordinate is blocked except by the object passed is not blocking. This is used with multipart monsters - if we want to see if a 2x2 monster can move 1 space to the left, we don't want its own area to block it from moving there.

Parameters

ob	object we ignore. Must not be NULL.
m	map we're considering.
sx
sy	target coordinates

Returns

TRUE if the space is blocked by something other than ob.

Note

the coordinates & map passed in should have been updated for tiling by the caller.

Definition at line 373 of file map.c.

References obj::above, CHECK_INV, check_inv_recursive(), obj::contr, DOOR, draw_ext_info(), FLAG_ALIVE, FLAG_WIZ, MapSpace::flags, GET_MAP_MOVE_BLOCK, GET_MAP_OB, obj::head, pl::hidden, obj::last_sp, llevError, LOG(), obj::move_type, obj::msg, MSG_TYPE_ATTACK, MSG_TYPE_ATTACK_NOKEY, NDI_NAVY, NDI_UNIQUE, OB_MOVE_BLOCK, OB_TYPE_MOVE_BLOCK, OUT_OF_REAL_MAP, P_IS_ALIVE, PLAYER, QUERY_FLAG, mapdef::spaces, TRANSPORT, obj::type, and mapdef::width.

Referenced by move_ob(), and path_to_player().

Here is the call graph for this function:

Here is the caller graph for this function:

int calculate_difficulty

(

mapstruct *

m

)

This routine is supposed to find out the difficulty of the map. Difficulty does not have a lot to do with character level, but does have a lot to do with treasure on the map.

Difficulty can now be set by the map creature. If the value stored in the map is zero, then use this routine. Maps should really have a difficulty set than using this function - human calculation is much better than this functions guesswork.

Parameters

m	map for which to compute difficulty.

Returns

difficulty of the map.

Definition at line 1917 of file map.c.

References obj::above, archt::clone, liv::exp, FLAG_GENERATOR, FLAG_MONSTER, GENERATE_TYPE, get_archetype_by_type_subtype(), GET_MAP_OB, level_exp(), MAP_DIFFICULTY, MAP_HEIGHT, MAP_WIDTH, QUERY_FLAG, and obj::stats.

Referenced by cfapi_map_get_map_property(), generate_random_map(), and load_original_map().

Here is the call graph for this function:

Here is the caller graph for this function:

int change_map_light	(	mapstruct *	m,
		int	change
	)

Used to change map light level (darkness) up or down. It should now be possible to change a value by more than 1.

Move this from los.c to map.c since this is more related to maps than los. postive values make it darker, negative make it brighter

Will inform players on the map.

Parameters

m	map to change.
change	delta of light.

Returns

TRUE if light changed, FALSE else.

Definition at line 2000 of file map.c.

References mapdef::darkness, ext_info_map(), MAX_DARKNESS, MSG_SUBTYPE_NONE, MSG_TYPE_MISC, NDI_BLACK, and update_all_map_los().

Referenced by cast_change_map_lightlevel(), cfapi_map_change_light(), dawn_to_dusk(), and set_darkness_map().

Here is the call graph for this function:

Here is the caller graph for this function:

int check_path	(	const char *	name,
		int	prepend_dir
	)

This function checks if a file with the given path exists.

It tries out all the compression suffixes listed in the uncomp[] array, except for Windows which checks an exact file.

Parameters

name	map path to check.
prepend_dir	If set, then we call create_pathname (which prepends libdir & mapdir). Otherwise, we assume the name given is fully complete.

Returns

-1 if it fails, otherwise the mode of the file is returned.

Note

Only the editor actually cares about the writablity of this - the rest of the code only cares that the file is readable. when the editor goes away, the call to stat should probably be replaced by an access instead (similar to the windows one, but that seems to be missing the prepend_dir processing

Definition at line 216 of file map.c.

References create_pathname(), MAX_BUF, NROF_COMPRESS_METHODS, S_IRGRP, S_IROTH, S_IRUSR, S_ISREG, S_IWGRP, S_IWOTH, S_IWUSR, snprintf(), and uncomp.

Referenced by cfapi_system_check_path(), check_login(), and load_map_header().

Here is the call graph for this function:

Here is the caller graph for this function:

void clean_object

(

object *

op

)

Remove and free all objects in the inventory of the given object.

Parameters

op	object to clean.

Todo:

move to common/object.c ?

Definition at line 1640 of file map.c.

References obj::below, clean_object(), FLAG_IS_LINKED, free_object(), obj::inv, QUERY_FLAG, remove_button_link(), and remove_ob().

Referenced by cfapi_object_clean_object(), clean_object(), delete_unique_items(), and free_all_objects().

Here is the call graph for this function:

Here is the caller graph for this function:

void clean_tmp_map

(

mapstruct *

m

)

Removse the temporary file used by the map.

Parameters

m	map, which mustn't be NULL but can have no temporary file set.

Definition at line 1959 of file map.c.

References mapdef::tmpname, and unlink.

Referenced by clean_tmp_files(), flush_old_maps(), and ready_map_name().

Here is the caller graph for this function:

static void create_items_path ( const char *  s, char *  buf, size_t  size  )

static

This makes absolute path to the itemfile where unique objects will be saved. Converts '/' to '@'. I think it's essier maintain files than full directory structure, but if this is problem it can be changed.

Parameters

s	path of the map for the item.
buf	buffer that will contain path. Must not be NULL.
size	buffer's length.

Definition at line 178 of file map.c.

References Settings::localdir, settings, snprintf(), and Settings::uniquedir.

Referenced by load_unique_objects(), map_remove_unique_files(), and save_map().

Here is the call graph for this function:

Here is the caller graph for this function:

void create_overlay_pathname	(	const char *	name,
		char *	buf,
		size_t	size
	)

Same as create_pathname(), but for the overlay maps. /

Parameters

name	path of the overlay map.
buf	buffer that will contain the full path.
size	buffer's length.

Definition at line 135 of file map.c.

References Settings::localdir, Settings::mapdir, settings, and snprintf().

Referenced by cfapi_map_create_path(), command_overlay_reset(), load_original_map(), load_overlay_map(), and save_map().

Here is the call graph for this function:

Here is the caller graph for this function:

char* create_pathname	(	const char *	name,
		char *	buf,
		size_t	size
	)

This makes a path absolute outside the world of Crossfire. In other words, it prepends LIBDIR/MAPDIR/ to the given path and returns the pointer to a static array containing the result. it really should be called create_mapname

Parameters

name	path of the map.
buf	buffer that will contain the full path.
size	buffer's length.

Returns

buf.

Definition at line 114 of file map.c.

References Settings::datadir, Settings::mapdir, settings, and snprintf().

Referenced by cfapi_map_create_path(), check_path(), enter_fixed_template_map(), enter_unique_map(), load_original_map(), process_map(), ready_map_name(), and save_map().

Here is the call graph for this function:

Here is the caller graph for this function:

void create_template_pathname	(	const char *	name,
		char *	buf,
		size_t	size
	)

same as create_pathname(), but for the template maps.

Parameters

name	path of the template map.
buf	buffer that will contain the full path.
size	buf's length

Definition at line 155 of file map.c.

References Settings::localdir, settings, snprintf(), and Settings::templatedir.

Referenced by enter_fixed_template_map(), and enter_random_template_map().

Here is the call graph for this function:

Here is the caller graph for this function:

void delete_map

(

mapstruct *

m

)

Frees the map, including the mapstruct.

This deletes all the data on the map (freeing pointers) and then removes this map from the global linked list of maps.

Parameters

m	pointer to mapstruct, if NULL no action. Will be invalid after this function.

Definition at line 1745 of file map.c.

References first_map, free_map(), mapdef::in_memory, llevError, LOG(), MAP_IN_MEMORY, MAP_SAVING, mapdef::next, mapdef::path, mapdef::tile_map, and mapdef::tmpname.

Referenced by cfapi_map_delete_map(), flush_old_maps(), free_all_maps(), free_style_maps(), init_dynamic(), key_confirm_quit(), load_original_map(), load_overlay_map(), load_temporary_map(), process_map(), ready_map_name(), START_TEST(), and swap_map().

Here is the call graph for this function:

Here is the caller graph for this function:

static void delete_unique_items ( mapstruct *  m )

static

This goes through map 'm' and removed any unique items on the map.

Parameters

m	map to check.

Definition at line 1379 of file map.c.

References obj::above, clean_object(), FLAG_IS_FLOOR, FLAG_IS_LINKED, FLAG_UNIQUE, free_object(), GET_MAP_OB, obj::head, MAP_HEIGHT, MAP_WIDTH, QUERY_FLAG, remove_button_link(), and remove_ob().

Referenced by load_unique_objects().

Here is the call graph for this function:

Here is the caller graph for this function:

void dump_all_maps

(

void

)

Prints out debug-information about all maps. This basically just goes through all the maps and calls dump_map() on each one. Can be used by a DM with the dumpallmaps command.

Definition at line 298 of file map.c.

References dump_map(), first_map, and mapdef::next.

Referenced by command_dumpallmaps().

Here is the call graph for this function:

Here is the caller graph for this function:

void dump_map

(

const mapstruct *

m

)

Prints out debug-information about a map. Dumping these at llevError doesn't seem right, but is necessary to make sure the information is in fact logged. Can be used by a DM with the dumpmap command.

Parameters

m	map to dump.

Definition at line 275 of file map.c.

References mapdef::darkness, mapdef::difficulty, mapdef::in_memory, llevError, LOG(), MAP_ENTER_X, MAP_ENTER_Y, MAP_HEIGHT, MAP_WIDTH, mapdef::maplore, mapdef::msg, mapdef::path, and mapdef::tmpname.

Referenced by command_dumpmap(), and dump_all_maps().

Here is the call graph for this function:

Here is the caller graph for this function:

void fix_container

(

object *

container

)

When the map is loaded, load_object() does not actually insert objects into inventory, but just links them. What this does is go through and insert them properly.

Parameters

container

object that contains the inventory. This is needed so that we can update the containers weight.

Todo:

This is unusued, should it be used somewhere?

Definition at line 580 of file map.c.

References obj::below, fix_container(), insert_ob_in_ob(), obj::inv, and sum_weight().

Referenced by fix_container().

Here is the call graph for this function:

Here is the caller graph for this function:

static void fix_container_multipart ( object *  container )

static

Go through all the objects in a container (recursively) looking for objects whose arch says they are multipart yet according to the info we have, they only have the head (as would be expected when they are saved). We do have to look for the old maps that did save the more sections and not re-add sections for them.

Parameters

container

object that contains the inventory.

Definition at line 607 of file map.c.

References add_string(), obj::arch, arch_to_object(), obj::below, CLEAR_FLAG, obj::env, FLAG_REMOVED, free_string(), obj::head, obj::inv, obj::more, archt::more, obj::name, and obj::title.

Referenced by link_multipart_objects().

Here is the call graph for this function:

Here is the caller graph for this function:

void free_all_maps

(

void

)

Frees all allocated maps.

Definition at line 1968 of file map.c.

References delete_map(), first_map, mapdef::in_memory, llevDebug, LOG(), MAP_IN_MEMORY, and MAP_SAVING.

Referenced by cleanup().

Here is the call graph for this function:

Here is the caller graph for this function:

static void free_all_objects ( mapstruct *  m )

static

Remove and free all objects in the given map.

Parameters

m	map to free.

Definition at line 1659 of file map.c.

References clean_object(), FLAG_REMOVED, free_object(), GET_MAP_OB, obj::head, mapdef::in_memory, llevDebug, LOG(), obj::map, MAP_HEIGHT, MAP_IN_MEMORY, MAP_WIDTH, obj::name, obj::next, objects, QUERY_FLAG, and remove_ob().

Referenced by free_map(), and save_map().

Here is the call graph for this function:

Here is the caller graph for this function:

void free_map

(

mapstruct *

m

)

Frees everything allocated by the given mapstructure. Don't free tmpname - our caller is left to do that. Mapstructure itself is not freed.

Parameters

m	map to free.

Definition at line 1707 of file map.c.

References mapdef::background_music, mapdef::buttons, EVENT_MAPUNLOAD, execute_global_event(), free_all_objects(), FREE_AND_CLEAR, free_objectlinkpt(), mapdef::in_memory, llevError, LOG(), MAP_SWAPPED, mapdef::maplore, mapdef::msg, mapdef::name, mapdef::shopitems, mapdef::shoprace, mapdef::spaces, mapdef::tile_map, and mapdef::tile_path.

Referenced by delete_map(), START_TEST(), swap_map(), and teardown().

Here is the call graph for this function:

Here is the caller graph for this function:

mapstruct* get_empty_map	(	int	sizex,
		int	sizey
	)

Creates and returns a map of the specific size. Used in random map code and the editor.

Parameters

sizex
sizey	map size.

Returns

new map.

Note

will never return NULL, as get_linked_map() never fails.

Definition at line 884 of file map.c.

References allocate_map(), get_linked_map(), mapdef::height, mapdef::in_memory, MAP_SWAPPED, and mapdef::width.

Referenced by cfapi_map_get_map(), make_map_floor(), setup(), and START_TEST().

Here is the call graph for this function:

Here is the caller graph for this function:

mapstruct* get_linked_map

(

void

)

Allocates, initialises, and returns a pointer to a mapstruct. Modified to no longer take a path option which was not being used anyways. MSW 2001-07-01

Returns

new structure.

Note

will never return NULL, but call fatal() if memory error.

Definition at line 816 of file map.c.

References fatal(), first_map, mapdef::in_memory, mapdef::last_reset_time, MAP_ENTER_X, MAP_ENTER_Y, MAP_HEIGHT, MAP_RESET_TIMEOUT, MAP_SWAPPED, MAP_TIMEOUT, MAP_WIDTH, mapdef::next, and OUT_OF_MEMORY.

Referenced by get_empty_map(), load_original_map(), and read_map_log().

Here is the call graph for this function:

Here is the caller graph for this function:

int get_map_flags	(	mapstruct *	oldmap,
		mapstruct **	newmap,
		sint16	x,
		sint16	y,
		sint16 *	nx,
		sint16 *	ny
	)

This rolls up wall, blocks_magic, blocks_view, etc, all into one function that just returns a P_.. value (see map.h) it will also do map translation for tiled maps, returning new values into newmap, nx, and ny. Any and all of those values can be null, in which case if a new map is needed (returned by a P_NEW_MAP value, another call to get_map_from_coord is needed. The case of not passing values is if we're just checking for the existence of something on those spaces, but don't expect to insert/remove anything from those spaces.

Parameters

oldmap	map for which we want information.
newmap	if not NULL, will contain the actual map checked if not oldmap.
x
y	coordinates to check
nx
ny	if not NULL, will contain the actual coordinates checked.

Returns

flags for specified position, with maybe P_OUT_OF_MAP or P_NEW_MAP set.

Definition at line 330 of file map.c.

References MapSpace::flags, get_map_from_coord(), out_of_map(), P_NEW_MAP, P_OUT_OF_MAP, mapdef::spaces, and mapdef::width.

Referenced by alchemy(), animate_weapon(), armour_improver_type_apply(), attempt_jump(), can_see_monsterP(), cast_cause_disease(), cast_cone(), cast_create_obj(), cast_destruction(), cast_detection(), cast_earth_to_dust(), cast_light(), cast_polymorph(), cast_raise_dead_spell(), cast_spell(), cast_transfer(), cfapi_map_get_map_property(), cfapi_map_get_object_at(), check_bullet(), check_infection(), check_wall(), command_save(), common_process_projectile(), communicate(), counterspell(), create_bomb(), dimension_door(), dispel_rune(), do_harvest(), do_skill_ident(), do_throw(), draw_client_map(), execute_word_of_recall(), expand_lighted_sight(), expand_sight(), find_dir(), find_multi_free_spot_within_radius(), find_nearest_living_creature(), find_target_for_friendly_spell(), find_traps(), fire_arch_from_position(), fire_bolt(), fire_bow(), fire_bullet(), forklightning(), get_pet_enemy(), get_pointed_target(), hideability(), hit_map(), magic_mapping_mark(), magic_mapping_mark_recursive(), magic_wall(), mood_change(), move_aura(), move_ball_spell(), move_bolt(), move_bullet(), move_golem(), move_missile(), move_ob(), move_player_mover(), move_swarm_spell(), npc_call_help(), ob_blocked(), ok_to_put_more(), path_to_player(), pet_move(), pick_arrow_target(), probe(), process_players1(), remove_adjacent_doors(), remove_trap(), roll_ob(), singing(), skill_attack(), spell_failure(), spell_find_dir(), stand_in_light(), stand_near_hostile(), steal(), teleport(), try_fit(), use_oratory(), weapon_improver_type_apply(), and write_rune().

Here is the call graph for this function:

mapstruct* get_map_from_coord	(	mapstruct *	m,
		sint16 *	x,
		sint16 *	y
	)

This is basically the same as out_of_map above(), but instead we return NULL if no map is valid (coordinates out of bounds and no tiled map), otherwise it returns the map as that the coordinates are really on, and updates x and y to be the localized coordinates. Using this is more efficient of calling out_of_map and then figuring out what the real map is

Parameters

m	map we want to look at.
x
y	coordinates, which will contain the real position that was checked.

Returns

map that is at specified location. Should not be NULL.

Definition at line 2366 of file map.c.

References get_map_from_coord(), mapdef::in_memory, load_and_link_tiled_map(), MAP_HEIGHT, MAP_IN_MEMORY, MAP_WIDTH, mapdef::tile_map, and mapdef::tile_path.

Referenced by cfapi_map_get_map(), draw_client_map2(), follow_owner(), get_map_flags(), get_map_from_coord(), insert_ob_in_map(), look_at(), monster_use_bow(), move_ob(), move_player_attack(), pet_move(), remove_ob(), and summon_object().

Here is the call graph for this function:

Here is the caller graph for this function:

void get_rangevector	(	object *	op1,
		const object *	op2,
		rv_vector *	retval,
		int	flags
	)

From map.c This is used by get_player 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 right 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.

get_rangevector looks at op1 and op2, and fills in the structure for op1 to get to op2. We already trust that the caller has verified that the two objects are at least on adjacent maps. If not, results are not likely to be what is desired. if the objects are not on maps, results are also likely to be unexpected

Parameters

op1	object which wants to go to op2's location.
op2	target of op1.
retval	vector for op1 to go to op2.
flags	if 1, don't translate for closest body part of 'op1'

Definition at line 2504 of file map.c.

References adjacent_map(), rv_vector::direction, rv_vector::distance, rv_vector::distance_x, rv_vector::distance_y, find_dir_2(), isqrt(), obj::map, obj::more, rv_vector::part, obj::x, and obj::y.

Referenced by can_detect_enemy(), can_hit(), find_enemy(), flee_player(), get_pet_enemy(), monster_cast_spell(), monster_use_bow(), monster_use_scroll(), move_monster(), path_to_player(), player_can_view(), process_players1(), and spring_trap().

Here is the call graph for this function:

Here is the caller graph for this function:

void get_rangevector_from_mapcoord	(	const mapstruct *	m,
		int	x,
		int	y,
		const object *	op2,
		rv_vector *	retval,
		int	flags
	)

This is basically the same as get_rangevector() above, but instead of the first parameter being an object, it instead is the map and x,y coordinates - this is used for path to player - since the object is not infact moving but we are trying to traverse the path, we need this. flags has no meaning for this function at this time - I kept it in to be more consistant with the above function and also in case they are needed for something in the future. Also, since no object is pasted, the best field of the rv_vector is set to NULL.

Parameters

m	map to consider.
x
y	origin coordinates.
op2	target object.
retval	vector to get to op2.
flags	unused.

Definition at line 2573 of file map.c.

References adjacent_map(), rv_vector::direction, rv_vector::distance, rv_vector::distance_x, rv_vector::distance_y, find_dir_2(), isqrt(), obj::map, rv_vector::part, obj::x, and obj::y.

Referenced by path_to_player().

Here is the call graph for this function:

Here is the caller graph for this function:

mapstruct* has_been_loaded

(

const char *

name

)

Checks whether map has been loaded.

Parameters

name	path of the map to search. Can be NULL.

Returns

the mapstruct which has a name matching the given argument. return NULL if no match is found.

Definition at line 87 of file map.c.

References first_map, mapdef::next, and mapdef::path.

Referenced by cfapi_map_has_been_loaded(), command_reset(), is_legal_2ways_exit(), and ready_map_name().

Here is the caller graph for this function:

static void link_multipart_objects ( mapstruct *  m )

static

Go through all the objects on the map looking for objects whose arch says they are multipart yet according to the info we have, they only have the head (as would be expected when they are saved). We do have to look for the old maps that did save the more sections and not re-add sections for them.

Parameters

m	map to check.

Definition at line 652 of file map.c.

References obj::above, fix_container_multipart(), fix_multipart_object(), GET_MAP_OB, obj::head, obj::inv, MAP_HEIGHT, MAP_WIDTH, and obj::more.

Referenced by load_objects().

Here is the call graph for this function:

Here is the caller graph for this function:

static mapstruct* load_and_link_tiled_map ( mapstruct *  orig_map, int  tile_num  )

static

This updates the orig_map->tile_map[tile_num] value after loading the map. It also takes care of linking back the freshly loaded maps tile_map values if it tiles back to this one. It returns the value of orig_map->tile_map[tile_num]. It really only does this so that it is easier for calling functions to verify success.

Parameters

orig_map	map for which we load the tiled map.
tile_num	tile to load. Must be between 0 and 3 inclusive.

Returns

linked map, or NULL on failure.

Todo:

check ready_map_name() 's return value, which can be NULL?

Definition at line 2267 of file map.c.

References HUGE_BUF, mapdef::path, path_combine_and_normalize(), ready_map_name(), mapdef::tile_map, and mapdef::tile_path.

Referenced by get_map_from_coord(), and out_of_map().

Here is the call graph for this function:

Here is the caller graph for this function:

static int load_map_header ( FILE *  fp, mapstruct *  m  )

static

This loads the header information of the map. The header contains things like difficulty, size, timeout, etc. this used to be stored in the map object, but with the addition of tiling, fields beyond that easily named in an object structure were needed, so it just made sense to put all the stuff in the map object so that names actually make sense. This could be done in lex (like the object loader), but I think currently, there are few enough fields this is not a big deal. MSW 2001-07-01

Parameters

fp	file to read from.
m	map being read.

Returns

0 on success, 1 on failure.

Definition at line 1019 of file map.c.

References mapdef::background_music, check_path(), mapdef::darkness, mapdef::difficulty, mapdef::enter_x, mapdef::enter_y, mapdef::fixed_resettime, get_region_by_name(), mapdef::height, HUGE_BUF, mapdef::is_template, mapdef::last_reset_time, llevError, LOG(), mapdef::maplore, mapdef::msg, mapdef::name, mapdef::nosmooth, mapdef::outdoor, parse_shop_string(), mapdef::path, path_combine_and_normalize(), mapdef::region, mapdef::reset_timeout, mapdef::shopgreed, mapdef::shopitems, mapdef::shopmax, mapdef::shopmin, mapdef::shoprace, snprintf(), strdup_local(), mapdef::tile_path, mapdef::timeout, mapdef::unique, and mapdef::width.

Referenced by load_original_map(), load_overlay_map(), and load_temporary_map().

Here is the call graph for this function:

Here is the caller graph for this function:

static void load_objects ( mapstruct *  m, FILE *  fp, int  mapflags  )

static

Loads (and parses) the objects into a given map from the specified file pointer.

Parameters

m	m being loaded.
fp	file to read from.
mapflags	the same as we get with load_original_map()

Definition at line 682 of file map.c.

References obj::arch, FLAG_IS_FLOOR, FLAG_OBJ_ORIGINAL, FLAG_OVERLAY_FLOOR, FLAG_UNIQUE, free_object(), GET_MAP_OB, get_object(), obj::head, mapdef::height, INS_ABOVE_FLOOR_ONLY, INS_MAP_LOAD, INS_NO_MERGE, INS_NO_WALK_ON, INS_ON_TOP, insert_ob_in_map(), obj::inv, link_multipart_objects(), LL_MORE, LL_NORMAL, llevDebug, LO_NEWFILE, LO_REPEAT, load_object(), LOG(), obj::map, MAP_OVERLAY, MAP_PLAYER_UNIQUE, MAP_STYLE, obj::more, obj::name, QUERY_FLAG, remove_from_active_list(), SET_FLAG, sum_weight(), and mapdef::width.

Referenced by load_original_map(), load_overlay_map(), load_temporary_map(), and load_unique_objects().

Here is the call graph for this function:

Here is the caller graph for this function:

mapstruct* load_original_map	(	const char *	filename,
		int	flags
	)

Opens the file "filename" and reads information about the map from the given file, and stores it in a newly allocated mapstruct. A pointer to this structure is returned, or NULL on failure. flags correspond to those in map.h. Main ones used are MAP_PLAYER_UNIQUE, in which case we don't do any name changes, and

Parameters

filename	map path.
flags	how to interpret the path, and misc information (can be combined): MAP_PLAYER_UNIQUE: this is a unique map, path isn't changed MAP_OVERLAY: map is an overlay MAP_BLOCK: we block on this load. This happens in all cases, no matter if this flag is set or not. MAP_STYLE: style map - don't add active objects, don't add to server managed map list.

Returns

loaded map, or NULL if failure.

Definition at line 1226 of file map.c.

References allocate_map(), calculate_difficulty(), close_and_delete(), mapdef::compressed, create_overlay_pathname(), create_pathname(), delete_map(), EVENT_MAPLOAD, execute_global_event(), get_linked_map(), mapdef::in_memory, llevDebug, llevError, load_map_header(), load_objects(), LOG(), MAP_BLOCK, MAP_DIFFICULTY, MAP_IN_MEMORY, MAP_LOADING, MAP_OVERLAY, MAP_PLAYER_UNIQUE, MAP_STYLE, MAX_BUF, open_and_uncompress(), mapdef::path, set_map_reset_time(), snprintf(), strerror_local(), and update_buttons().

Referenced by enter_fixed_template_map(), enter_unique_map(), load_overlay_map(), load_style_map(), load_temporary_map(), and ready_map_name().

Here is the call graph for this function:

Here is the caller graph for this function:

static mapstruct* load_overlay_map ( const char *  filename, mapstruct *  m  )

static

Loads an overlay for a map, which has been loaded earlier, from file.

Parameters

filename	filename for overlay.
m	map we want to load.

Returns

map object we load into (this can change from the passed option if we can't find the original map)

Definition at line 1341 of file map.c.

References close_and_delete(), mapdef::compressed, create_overlay_pathname(), delete_map(), mapdef::in_memory, llevError, load_map_header(), load_objects(), load_original_map(), LOG(), MAP_IN_MEMORY, MAP_LOADING, MAP_OVERLAY, MAX_BUF, open_and_uncompress(), and mapdef::path.

Referenced by ready_map_name().

Here is the call graph for this function:

Here is the caller graph for this function:

static mapstruct* load_temporary_map ( mapstruct *  m )

static

Loads a map, which has been loaded earlier, from file.

Parameters

m	map we want to reload.

Returns

map object we load into (this can change from the passed option if we can't find the original map)

Todo:

check spurious logic for load_map_header failure (shouldn't it return m?)

Definition at line 1288 of file map.c.

References allocate_map(), close_and_delete(), mapdef::compressed, delete_map(), fix_auto_apply(), mapdef::in_memory, llevError, load_map_header(), load_objects(), load_original_map(), LOG(), MAP_IN_MEMORY, MAP_LOADING, MAX_BUF, open_and_uncompress(), mapdef::path, snprintf(), strerror_local(), and mapdef::tmpname.

Referenced by ready_map_name().

Here is the call graph for this function:

Here is the caller graph for this function:

static void load_unique_objects ( mapstruct *  m )

static

Loads unique objects from file(s) into the map which is in memory

Parameters

m	map to load unique items into.

Definition at line 1406 of file map.c.

References close_and_delete(), create_items_path(), delete_unique_items(), mapdef::in_memory, llevDebug, LO_NOREAD, load_object(), load_objects(), LOG(), MAP_IN_MEMORY, MAP_LOADING, MAX_BUF, open_and_uncompress(), mapdef::path, R_OK, snprintf(), and mapdef::tmpname.

Referenced by ready_map_name().

Here is the call graph for this function:

Here is the caller graph for this function:

void map_remove_unique_files

(

const mapstruct *

map

)

Remove files containing the map's unique items.

Parameters

map

Definition at line 2619 of file map.c.

References create_items_path(), HUGE_BUF, mapdef::path, snprintf(), mapdef::unique, and unlink.

Referenced by command_reset().

Here is the call graph for this function:

Here is the caller graph for this function:

int ob_blocked	(	const object *	ob,
		mapstruct *	m,
		sint16	x,
		sint16	y
	)

Returns true if the given object can't fit in the given spot. This is meant for multi space objects - for single space objecs, just calling get_map_blocked and checking that against movement type of object. This function goes through all the parts of the multipart object and makes sure they can be inserted.

While this doesn't call out of map, the get_map_flags does.

This function has been used to deprecate arch_out_of_map - this function also does that check, and since in most cases, a call to one would follow the other, doesn't make a lot of sense to have two seperate functions for this.

This returns nonzero if this arch can not go on the space provided, 0 otherwise. the return value will contain the P_.. value so the caller can know why this object can't go on the map. Note that callers should not expect P_NEW_MAP to be set in return codes - since the object is multispace - if we did return values, what do you return if half the object is one map, half on another.

Parameters

ob	object to test.
m
x
y	map and coordinates to check.

Returns

0 if the object can fit on specified space, non-zero else.

Note

This used to be arch_blocked, but with new movement code, we need to have actual object to check its move_type against the move_block values.

Definition at line 525 of file map.c.

References AB_NO_PASS, obj::arch, archt::clone, get_map_flags(), GET_MAP_MOVE_BLOCK, obj::more, archt::more, MOVE_ALL, obj::move_type, OB_TYPE_MOVE_BLOCK, P_IS_ALIVE, P_OUT_OF_MAP, TRANSPORT, obj::type, obj::x, and obj::y.

Referenced by compute_path(), enter_map(), find_first_free_spot(), find_free_spot(), find_multi_free_spot_around(), find_multi_free_spot_within_radius(), move_creator(), summon_golem(), summon_object(), and turn_one_transport().

Here is the call graph for this function:

Here is the caller graph for this function:

int on_same_map	(	const object *	op1,
		const object *	op2
	)

Checks whether 2 objects are on the same map or not.

Note we only look one map out to keep the processing simple and efficient. This could probably be a macro. MSW 2001-08-05

Parameters

op1	first object.
op2	second object.

Returns

TRUE if op1 and op2 are effectively on the same map (as related to map tiling).

Note

This looks for a path from op1 to op2, so if the tiled maps are assymetric and op2 has a path to op1, this will still return false.

Definition at line 2609 of file map.c.

References adjacent_map(), and obj::map.

Referenced by abort_attack(), adj_attackroll(), can_detect_enemy(), cfapi_object_on_same_map(), check_enemy(), find_enemy(), get_attack_mode(), get_pet_enemy(), move_ball_spell(), move_monster(), pet_move(), remove_all_pets(), and share_exp().

Here is the call graph for this function:

Here is the caller graph for this function:

int out_of_map	(	mapstruct *	m,
		int	x,
		int	y
	)

this returns TRUE if the coordinates (x,y) are out of map m. This function also takes into account any tiling considerations, loading adjacant maps as needed. This is the function should always be used when it necessary to check for valid coordinates. This function will recursively call itself for the tiled maps.

Parameters

m	map to consider.
x
y	coordinates.

Returns

1 if out of map, 0 else

Definition at line 2300 of file map.c.

References mapdef::in_memory, load_and_link_tiled_map(), MAP_HEIGHT, MAP_IN_MEMORY, MAP_WIDTH, out_of_map(), mapdef::tile_map, and mapdef::tile_path.

Referenced by animate_bomb(), attack_message(), cfapi_map_out_of_map(), cfapi_object_teleport(), command_create(), enter_map(), esrv_draw_look(), explode_bullet(), get_map_flags(), insert_ob_in_map(), look_at(), move_player_attack(), move_teleporter(), out_of_map(), pick_lock(), present(), and present_arch().

Here is the call graph for this function:

Here is the caller graph for this function:

static shopitems* parse_shop_string ( const char *  input_string )

static

Takes a string from a map definition and outputs a pointer to the array of shopitems corresponding to that string. Memory is allocated for this, it must be freed at a later date. Called by parse_map_headers() below.

Parameters

input_string

shop item line.

Returns

new array that should be freed by the caller.

Definition at line 904 of file map.c.

References CALLOC, get_typedata(), get_typedata_by_name(), shopitem::index, llevDebug, llevError, LOG(), shopitem::name, typedata::name, shopitem::name_pl, typedata::name_pl, typedata::number, strdup_local(), shopitem::strength, strip_endline(), and shopitem::typenum.

Referenced by load_map_header().

Here is the call graph for this function:

Here is the caller graph for this function:

static void print_shop_string ( mapstruct *  m, char *  output_string, int  size  )

static

Opposite of parse string(), this puts the string that was originally fed in to the map (or something equivilent) into output_string.

Parameters

m	map we're considering.
output_string	string to write to.
size	output_string's length.

Definition at line 979 of file map.c.

References shopitem::index, MAX_BUF, shopitem::name, mapdef::shopitems, snprintf(), shopitem::strength, and shopitem::typenum.

Referenced by save_map().

Here is the call graph for this function:

Here is the caller graph for this function:

mapstruct* ready_map_name	(	const char *	name,
		int	flags
	)

Makes sure the given map is loaded and swapped in.

Parameters

name	path name of the map.
flags	0x1 (MAP_FLUSH): flush the map - always load from the map directory, and don't do unique items or the like. 0x2 (MAP_PLAYER_UNIQUE) - this is a unique map for each player. dont do any more name translation on it.

Returns

pointer to the given map, NULL on failure.

Definition at line 1809 of file map.c.

References clean_tmp_map(), create_pathname(), decay_objects(), delete_map(), fix_auto_apply(), gettimeofday(), has_been_loaded(), mapdef::in_memory, mapdef::last_reset_time, llevDebug, load_original_map(), load_overlay_map(), load_temporary_map(), load_unique_objects(), LOG(), MAP_FLUSH, MAP_IN_MEMORY, MAP_LOADING, MAP_OVERLAY, MAP_PLAYER_UNIQUE, MAX_BUF, mapdef::outdoor, set_darkness_map(), and mapdef::tmpname.

Referenced by cast_create_town_portal(), cfapi_map_get_map(), enter_exit(), enter_fixed_template_map(), enter_random_template_map(), enter_unique_map(), init_dynamic(), is_legal_2ways_exit(), load_and_link_tiled_map(), place_exits(), process_map(), and START_TEST().

Here is the call graph for this function:

Here is the caller graph for this function:

int save_map	(	mapstruct *	m,
		int	flag
	)

Saves a map to file. If flag is SAVE_MODE_INPLACE, it is saved into the same file it was (originally) loaded from. Otherwise a temporary filename will be genarated, and the file will be stored there. The temporary filename will be stored in the mapstructure. If the map is unique, we also save to the filename in the map (this should have been updated when first loaded)

Parameters

m	map to save.
flag	One of SAVE_MODE_xxx values.

Returns

one of SAVE_ERROR_xxx values.

Definition at line 1453 of file map.c.

References mapdef::background_music, mapdef::compressed, create_items_path(), create_overlay_pathname(), create_pathname(), mapdef::darkness, mapdef::difficulty, mapdef::enter_x, mapdef::enter_y, mapdef::fixed_resettime, free_all_objects(), mapdef::height, mapdef::in_memory, mapdef::is_template, mapdef::last_reset_time, llevDebug, llevError, LOG(), make_path_to_file(), MAP_IN_MEMORY, MAP_SAVING, mapdef::maplore, MAX_BUF, mapdef::msg, regiondef::name, mapdef::name, mapdef::nosmooth, mapdef::outdoor, mapdef::path, pclose, popen, print_shop_string(), mapdef::region, mapdef::reset_timeout, SAVE_ERROR_CLOSE, SAVE_ERROR_NO_PATH, SAVE_ERROR_OK, SAVE_ERROR_RCREATION, SAVE_ERROR_RRENAME, SAVE_ERROR_UCREATION, SAVE_ERROR_URENAME, SAVE_FLAG_NO_REMOVE, SAVE_MODE, SAVE_MODE_NORMAL, SAVE_MODE_OVERLAY, save_objects(), settings, mapdef::shopgreed, mapdef::shopitems, mapdef::shopmax, mapdef::shopmin, mapdef::shoprace, snprintf(), strerror_local(), mapdef::swap_time, TEMP_EXT, tempnam_local(), mapdef::tile_path, Settings::tmpdir, mapdef::tmpname, uncomp, mapdef::unique, unlink, and mapdef::width.

Referenced by clean_tmp_files(), command_overlay_save(), main(), START_TEST(), and swap_map().

Here is the call graph for this function:

Here is the caller graph for this function:

static int save_objects ( mapstruct *  m, FILE *  fp, FILE *  fp2, int  flag  )

static

This saves all the objects on the map in a non destructive fashion. Modified by MSW 2001-07-01 to do in a single pass - reduces code, and we only save the head of multi part objects - this is needed in order to do map tiling properly.

Parameters

m	map to save.
fp	file where regular objects are saved.
fp2	file to save unique objects.
flag	combination of SAVE_FLAG_xxx flags.

Returns

one of SAVE_ERROR_xxx value.

Definition at line 768 of file map.c.

References obj::above, FLAG_IS_FLOOR, FLAG_OBJ_ORIGINAL, FLAG_UNIQUE, FLAG_UNPAID, GET_MAP_OB, obj::head, llevDebug, LOG(), MAP_HEIGHT, MAP_WIDTH, obj::owner, PLAYER, QUERY_FLAG, SAVE_FLAG_NO_REMOVE, SAVE_FLAG_SAVE_UNPAID, save_object(), and obj::type.

Referenced by save_map().

Here is the call graph for this function:

Here is the caller graph for this function:

void set_map_reset_time

(

mapstruct *

map

)

Updates the map's timeout.

Parameters

map	map to update.

Definition at line 2239 of file map.c.

References MAP_DEFAULTRESET, MAP_MAXRESET, MAP_RESET_TIMEOUT, MAP_WHEN_RESET, and seconds().

Referenced by load_original_map(), and swap_map().

Here is the call graph for this function:

Here is the caller graph for this function:

void update_position	(	mapstruct *	m,
		int	x,
		int	y
	)

This function updates various attributes about a specific space on the map (what it looks like, whether it blocks magic, has a living creatures, prevents people from passing through, etc)

Parameters

m	map considered
x
y	coordinates to update

Definition at line 2124 of file map.c.

References obj::above, add_face_layer(), blank_face, obj::contr, obj::face, FLAG_ALIVE, FLAG_BLOCKSVIEW, FLAG_DAMNED, FLAG_IS_FLOOR, FLAG_MONSTER, FLAG_NO_MAGIC, FLAG_NO_PICK, FLAG_WIZ, flags, GET_MAP_FACE_OBJS, GET_MAP_FLAGS, GET_MAP_OB, obj::glow_radius, pl::hidden, Map_Layer_Info::high_layer, Map_Layer_Info::honor_visibility, obj::invisible, llevDebug, llevError, LOG(), obj::map_layer, MAP_LAYER_FLOOR, MAP_LAYER_FLY1, MAP_LAYER_FLY2, MAP_LAYER_ITEM1, MAP_LAYER_ITEM3, MAP_LAYER_LIVING1, MAP_LAYER_LIVING2, MAP_LAYER_NO_PICK1, MAP_LAYER_NO_PICK2, MAP_LAYERS, obj::move_allow, obj::move_block, MOVE_FLYING, obj::move_off, obj::move_on, obj::move_slow, obj::move_type, P_BLOCKSVIEW, P_IS_ALIVE, P_NEED_UPDATE, P_NO_CLERIC, P_NO_ERROR, P_NO_MAGIC, P_PLAYER, mapdef::path, PLAYER, QUERY_FLAG, SET_MAP_FLAGS, SET_MAP_LIGHT, SET_MAP_MOVE_BLOCK, SET_MAP_MOVE_OFF, SET_MAP_MOVE_ON, SET_MAP_MOVE_SLOW, SET_MAP_PLAYER, and obj::type.

Referenced by cfapi_map_update_position(), cfapi_object_set_property(), do_turn(), draw_client_map(), insert_ob_in_ob(), remove_ob(), and update_object().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

Map_Layer_Info map_layer_info[MAP_LAYERS]

static

Initial value:

= {
    { MAP_LAYER_FLOOR, 1 },
    { MAP_LAYER_NO_PICK2, 0 }, { MAP_LAYER_NO_PICK2, 0 },
    { MAP_LAYER_ITEM3, 1 }, { MAP_LAYER_ITEM3, 1 }, { MAP_LAYER_ITEM3, 1 },
    { MAP_LAYER_LIVING2, 1 }, { MAP_LAYER_LIVING2, 1 },
    { MAP_LAYER_FLY2, 1 }, { MAP_LAYER_FLY2, 1 }
}

the ob->map_layer holds the low layer. For the update_position() logic, we also need to know the higher layer and whether visibility should be honored. This table has that information, so that it doesn't need to be hardcoded.

Definition at line 71 of file map.c.

const char* map_layer_name[MAP_LAYERS]

Initial value:

= {
    "floor", "no_pick", "no_pick", "item", "item",
    "item", "living", "living", "fly", "fly"
}

These correspond to the layer names in map.h - since some of the types can be on multiple layers, names are duplicated to correspond to that layer.

Definition at line 54 of file map.c.

int nrofallocobjects

How many OBs allocated (free + used)

Definition at line 67 of file object.c.

Referenced by swap_below_max().

int nroffreeobjects

How many OBs allocated and free (free)

Definition at line 66 of file object.c.

Referenced by swap_below_max().