This is a game region. More...

#include <map.h>

Collaboration diagram for region:

Data Fields
uint32_t	counter
	A generic counter for holding temporary data. More...

int8_t	fallback
	Whether, in the event of a region not existing, this should be the one we fall back on as the default. More...

char *	jailmap
	Where a player that is arrested in this region should be imprisoned. More...

int16_t	jailx

int16_t	jaily
	The coodinates in jailmap to which the player should be sent. More...

char *	longname
	Official title of the region, this might be defined to be the same as name. More...

char *	msg
	The description of the region. More...

char *	name
	Shortend name of the region as maps refer to it. More...

region *	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. More...

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 mapstruct

Definition at line 274 of file map.h.

Field Documentation

◆ counter

uint32_t region::counter

A generic counter for holding temporary data.

Definition at line 284 of file map.h.

Referenced by command_whereabouts().

◆ fallback

int8_t region::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 285 of file map.h.

Referenced by init_regions(), and main().

◆ jailmap

char* region::jailmap

Where a player that is arrested in this region should be imprisoned.

Definition at line 287 of file map.h.

Referenced by cfapi_region_get_property(), free_globals(), get_jail_exit(), and init_regions().

◆ jailx

int16_t region::jailx

Definition at line 288 of file map.h.

Referenced by cfapi_region_get_property(), get_jail_exit(), and init_regions().

◆ jaily

int16_t region::jaily

The coodinates in jailmap to which the player should be sent.

Definition at line 288 of file map.h.

Referenced by cfapi_region_get_property(), get_jail_exit(), and init_regions().

◆ longname

char* region::longname

Official title of the region, this might be defined to be the same as name.

Definition at line 281 of file map.h.

Referenced by cfapi_region_get_property(), fill_json(), free_globals(), get_region_from_string(), get_region_longname(), init_regions(), list_players(), and main().

◆ msg

char* region::msg

The description of the region.

Definition at line 283 of file map.h.

Referenced by cfapi_region_get_property(), fill_json(), free_globals(), get_region_msg(), and init_regions().

◆ name

char* region::name

Shortend name of the region as maps refer to it.

Definition at line 275 of file map.h.

Referenced by cfapi_region_get_property(), do_region(), fill_json(), fix_tiled_map(), free_globals(), get_jail_exit(), get_region_from_string(), get_region_id(), get_region_longname(), get_region_msg(), init_regions(), list_players(), main(), region_is_child_of_region(), and ring_bell().

◆ parent

region* region::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 276 of file map.h.

Referenced by cfapi_region_get_property(), get_jail_exit(), get_region_from_string(), get_region_longname(), get_region_msg(), and region_is_child_of_region().

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

crossfire-crossfire-server/include/map.h

Data Fields