#include <map.h>
Collaboration diagram for regiondef:
Data Fields | |
| uint32_t | counter |
| int8_t | fallback |
| char * | jailmap |
| int16_t | jailx |
| int16_t | jaily |
| char * | longname |
| char * | msg |
| char * | name |
| struct regiondef * | next |
| struct regiondef * | parent |
| 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
◆ counter
| uint32_t regiondef::counter |
A generic counter for holding temporary data.
Definition at line 293 of file map.h.
Referenced by command_whereabouts().
◆ fallback
| int8_t 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 294 of file map.h.
Referenced by get_name_of_region_for_map(), get_region_by_name(), and main().
◆ jailmap
| char* regiondef::jailmap |
Where a player that is arrested in this region should be imprisoned.
Definition at line 296 of file map.h.
Referenced by cfapi_region_get_property(), free_globals(), get_jail_exit(), and RegionWrapper::jailPath().
◆ jailx
| int16_t regiondef::jailx |
Definition at line 297 of file map.h.
Referenced by cfapi_region_get_property(), get_jail_exit(), and RegionWrapper::jailX().
◆ jaily
| int16_t regiondef::jaily |
The coodinates in jailmap to which the player should be sent.
Definition at line 297 of file map.h.
Referenced by cfapi_region_get_property(), get_jail_exit(), and RegionWrapper::jailY().
◆ longname
| char* regiondef::longname |
Official title of the region, this might be defined to be the same as name
Definition at line 290 of file map.h.
Referenced by cfapi_region_get_property(), command_whereabouts(), RegionWrapper::displayName(), fill_json(), free_globals(), get_region_from_string(), list_players(), and main().
◆ msg
| char* regiondef::msg |
The description of the region
Definition at line 292 of file map.h.
Referenced by cfapi_region_get_property(), fill_json(), and free_globals().
◆ name
| char* regiondef::name |
Shortend name of the region as maps refer to it
Definition at line 277 of file map.h.
Referenced by assign_region_parents(), cfapi_region_get_property(), command_whereabouts(), do_region(), fill_json(), 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(), list_players(), main(), RegionWrapper::mapAdded(), RegionWrapper::refresh(), region_is_child_of_region(), ring_bell(), and RegionWrapper::shortName().
◆ next
| struct regiondef* regiondef::next |
Pointer to next region, NULL for the last one
Definition at line 276 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(), parse_regions(), and RegionsWrapper::RegionsWrapper().
◆ parent
| 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 285 of file map.h.
Referenced by assign_region_parents(), cfapi_region_get_property(), command_whereabouts(), get_jail_exit(), get_region_from_string(), RegionWrapper::jailPath(), RegionWrapper::jailX(), RegionWrapper::jailY(), and region_is_child_of_region().
◆ parent_name
| 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 278 of file map.h.
Referenced by assign_region_parents(), and free_globals().
The documentation for this struct was generated from the following file:
- crossfire-crossfire-server/include/map.h
