Crossfire Server, Trunk
region Struct Reference

#include <map.h>

+ Collaboration diagram for region:

Data Fields

uint32_t counter
 
int8_t fallback
 
char * jailmap
 
int16_t jailx
 
int16_t jaily
 
char * longname
 
char * msg
 
char * name
 
regionparent
 

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 275 of file map.h.

Field Documentation

◆ counter

uint32_t region::counter

A generic counter for holding temporary data.

Definition at line 285 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 286 of file map.h.

Referenced by init_regions(), main(), and START_TEST().

◆ jailmap

char* region::jailmap

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

Definition at line 288 of file map.h.

Referenced by cfapi_region_get_property(), free_globals(), get_jail_exit(), init_regions(), and RegionWrapper::jailPath().

◆ jailx

int16_t region::jailx

◆ jaily

int16_t region::jaily

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

Definition at line 289 of file map.h.

Referenced by cfapi_region_get_property(), get_jail_exit(), init_regions(), and RegionWrapper::jailY().

◆ longname

char* region::longname

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

Definition at line 282 of file map.h.

Referenced by cfapi_region_get_property(), RegionWrapper::displayName(), fill_json(), free_globals(), get_region_from_string(), init_regions(), list_players(), and main().

◆ msg

char* region::msg

The description of the region

Definition at line 284 of file map.h.

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

◆ name

◆ 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 277 of file map.h.

Referenced by cfapi_region_get_property(), get_jail_exit(), get_region_from_string(), RegionWrapper::jailPath(), RegionWrapper::jailX(), RegionWrapper::jailY(), region_is_child_of_region(), and START_TEST().


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