Crossfire Server, Branches 1.12  R18729
mapdef Struct Reference

#include <map.h>

+ Collaboration diagram for mapdef:

Data Fields

char * background_music
 
oblinkptbuttons
 
uint8 compressed
 
uint8 darkness
 
uint16 difficulty
 
uint16 enter_x
 
uint16 enter_y
 
uint32 fixed_resettime:1
 
uint16 height
 
uint32 in_memory
 
uint32 is_template:1
 
struct timeval last_reset_time
 
char * maplore
 
char * msg
 
char * name
 
struct mapdefnext
 
uint32 nosmooth:1
 
uint32 outdoor:1
 
char path [HUGE_BUF]
 
sint16 players
 
struct regiondefregion
 
uint32 reset_time
 
uint32 reset_timeout
 
double shopgreed
 
struct shopitemshopitems
 
uint64 shopmax
 
uint64 shopmin
 
char * shoprace
 
MapSpacespaces
 
sint32 swap_time
 
struct mapdeftile_map [4]
 
char * tile_path [4]
 
sint32 timeout
 
char * tmpname
 
uint32 unique:1
 
uint16 width
 

Detailed Description

This is a game-map.

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.

Definition at line 346 of file map.h.

Field Documentation

char* mapdef::background_music

Background music to use for this map.

Definition at line 386 of file map.h.

Referenced by enter_map(), free_map(), load_map_header(), and save_map().

oblinkpt* mapdef::buttons
uint8 mapdef::compressed

Compression method used.

Definition at line 367 of file map.h.

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

uint16 mapdef::enter_x

Enter_x and enter_y are default entrance location.

Definition at line 371 of file map.h.

Referenced by cfapi_map_get_map_property(), cfapi_object_transfer(), load_map_header(), and save_map().

uint16 mapdef::enter_y

on the map if none are set in the exit.

Definition at line 372 of file map.h.

Referenced by cfapi_map_get_map_property(), cfapi_object_transfer(), load_map_header(), and save_map().

uint32 mapdef::fixed_resettime

If true, reset time is not affected by players entering/exiting map.

Definition at line 356 of file map.h.

Referenced by load_map_header(), save_map(), and swap_map().

uint16 mapdef::height

Width and height of map.

Definition at line 370 of file map.h.

Referenced by cfapi_map_get_map_property(), compute_path(), get_empty_map(), load_map_header(), load_objects(), and save_map().

uint32 mapdef::is_template

If set, this is a template map.

Definition at line 359 of file map.h.

Referenced by enter_fixed_template_map(), enter_random_template_map(), flush_old_maps(), load_map_header(), and save_map().

struct timeval mapdef::last_reset_time

A timestamp of the last original map loading.

Definition at line 385 of file map.h.

Referenced by cast_create_town_portal(), generate_random_map(), get_linked_map(), load_map_header(), ready_map_name(), and save_map().

char* mapdef::maplore

Map lore information.

Definition at line 381 of file map.h.

Referenced by dump_map(), free_map(), load_map_header(), process_map(), and save_map().

char* mapdef::msg

Message map creator may have left.

Definition at line 380 of file map.h.

Referenced by cfapi_map_get_map_property(), current_map_info(), dump_map(), free_map(), generate_random_map(), load_map_header(), and save_map().

uint32 mapdef::nosmooth

If set the content of this map has smoothlevel=0 forced.

Definition at line 360 of file map.h.

Referenced by load_map_header(), and save_map().

uint32 mapdef::outdoor

True if an outdoor map.

Definition at line 361 of file map.h.

Referenced by dawn_to_dusk(), expand_lighted_sight(), load_map_header(), ready_map_name(), save_map(), and set_darkness_map().

sint16 mapdef::players

How many players are on this level right now. Automatically updated by the object handling functions.

Definition at line 365 of file map.h.

Referenced by cfapi_map_get_map_property(), command_kick(), command_nowiz(), current_map_info(), do_wizard_hide(), enter_map(), insert_ob_in_map(), leave(), map_info(), and remove_ob().

struct regiondef* mapdef::region

What jurisdiction in the game world this map is ruled by points to the struct containing all the properties of the region.

Definition at line 350 of file map.h.

Referenced by generate_random_map(), get_map_id(), get_name_of_region_for_map(), load_map_header(), and save_map().

uint32 mapdef::reset_time

When this map should reset.

Definition at line 353 of file map.h.

Referenced by cfapi_map_get_map_property(), command_reset(), process_map(), read_map_log(), swap_map(), and write_map_log().

uint32 mapdef::reset_timeout

How many seconds must elapse before this map should be reset.

Definition at line 354 of file map.h.

Referenced by cfapi_map_get_map_property(), load_map_header(), and save_map().

double mapdef::shopgreed

How much our shopkeeper overcharges.

Definition at line 377 of file map.h.

Referenced by describe_shop(), load_map_header(), save_map(), and shop_greed().

struct shopitem* mapdef::shopitems

List of item-types the map's shop will trade in.

Definition at line 375 of file map.h.

Referenced by describe_shop(), free_map(), load_map_header(), print_shop_string(), save_map(), and shop_specialisation_ratio().

uint64 mapdef::shopmax

MMaximum price a shop will offer.

Definition at line 379 of file map.h.

Referenced by describe_shop(), load_map_header(), save_map(), and value_limit().

uint64 mapdef::shopmin

Minimum price a shop will trade for.

Definition at line 378 of file map.h.

Referenced by describe_shop(), load_map_header(), save_map(), and value_limit().

char* mapdef::shoprace

The preffered race of the local shopkeeper.

Definition at line 376 of file map.h.

Referenced by describe_shop(), free_map(), load_map_header(), save_map(), and shopkeeper_approval().

MapSpace* mapdef::spaces

Array of spaces on this map.

Definition at line 374 of file map.h.

Referenced by allocate_map(), blocked_link(), free_map(), and get_map_flags().

sint32 mapdef::swap_time

When it reaches 0, the map will be swapped out.

Definition at line 363 of file map.h.

Referenced by save_map().

struct mapdef* mapdef::tile_map[4]

Adjoining maps.

Definition at line 383 of file map.h.

Referenced by adjacent_map(), delete_map(), free_map(), get_map_from_coord(), load_and_link_tiled_map(), out_of_map(), and update_all_los().

char* mapdef::tile_path[4]

Path to adjoining maps.

Definition at line 382 of file map.h.

Referenced by free_map(), get_map_from_coord(), load_and_link_tiled_map(), load_map_header(), out_of_map(), process_map(), and save_map().

uint32 mapdef::unique

If set, this is a per player unique map.

Definition at line 358 of file map.h.

Referenced by cfapi_map_get_map_property(), command_reset(), decay_objects(), enter_unique_map(), flush_old_maps(), load_map_header(), map_remove_unique_files(), and save_map().


The documentation for this struct was generated from the following file: