#include <map.h>
Collaboration diagram for regiondef:
Data Fields | |
| uint32 | counter |
| sint8 | fallback |
| char * | jailmap |
| sint16 | jailx |
| sint16 | jaily |
| const char * | longname |
| const char * | msg |
| const char * | name |
| struct regiondef * | next |
| struct regiondef * | parent |
| const char * | parent_name |
Detailed Description
This is a game region. 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
Field Documentation
| uint32 regiondef::counter |
A generic counter for holding temporary data.
Definition at line 315 of file map.h.
Referenced by command_whereabouts().
| sint8 regiondef::fallback |
Whether, in the event of a region not existing, this should be the one we fall back on as the default.
Definition at line 316 of file map.h.
Referenced by get_name_of_region_for_map(), get_region_by_name(), and main().
| char* regiondef::jailmap |
Where a player that is arrested in this region should be imprisoned.
Definition at line 318 of file map.h.
Referenced by free_globals(), and get_jail_exit().
| sint16 regiondef::jailx |
Definition at line 319 of file map.h.
Referenced by get_jail_exit().
| sint16 regiondef::jaily |
The coodinates in jailmap to which the player should be sent.
Definition at line 319 of file map.h.
Referenced by get_jail_exit().
| const char* regiondef::longname |
Official title of the region, this might be defined to be the same as name
Definition at line 312 of file map.h.
Referenced by cfapi_region_get_property(), command_whereabouts(), free_globals(), get_region_from_string(), get_region_longname(), list_players(), and main().
| const char* regiondef::msg |
The description of the region
Definition at line 314 of file map.h.
Referenced by cfapi_region_get_property(), free_globals(), and get_region_msg().
| const char* regiondef::name |
Shortend name of the region as maps refer to it
Definition at line 299 of file map.h.
Referenced by add_region_link(), cfapi_region_get_property(), command_whereabouts(), do_region(), fix_tiled_map(), free_globals(), get_jail_exit(), get_name_of_region_for_map(), get_region_by_name(), get_region_from_string(), get_region_id(), get_region_longname(), get_region_msg(), list_players(), main(), region_is_child_of_region(), save_map(), write_map_page(), write_region_index(), and write_region_page().
| struct regiondef* regiondef::next |
Pointer to next region, NULL for the last one
Definition at line 298 of file map.h.
Referenced by assign_region_parents(), cfapi_region_get_property(), command_whereabouts(), free_globals(), get_name_of_region_for_map(), get_region_by_name(), get_region_from_string(), main(), and parse_regions().
| struct regiondef* regiondef::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.
Definition at line 307 of file map.h.
Referenced by assign_region_parents(), cfapi_region_get_property(), command_whereabouts(), get_jail_exit(), get_region_from_string(), get_region_longname(), get_region_msg(), and region_is_child_of_region().
| const char* regiondef::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.
Definition at line 300 of file map.h.
Referenced by assign_region_parents(), and free_globals().
The documentation for this struct was generated from the following file:
- crossfire-code/server/branches/1.12/include/map.h
