Crossfire Server, Trunk  R20513
Data Fields
regiondef Struct Reference

This is a game region. More...

#include <map.h>

Collaboration diagram for regiondef:
Collaboration graph

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...
 
struct regiondefnext
 Pointer to next region, NULL for the last one. More...
 
struct regiondefparent
 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...
 
char * 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. 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 mapdef

Definition at line 276 of file map.h.

Field Documentation

uint32_t regiondef::counter

A generic counter for holding temporary data.

Definition at line 294 of file map.h.

Referenced by command_whereabouts().

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

Referenced by cfapi_region_get_property(), free_globals(), get_jail_exit(), and CRERegionPanel::setItem().

int16_t regiondef::jailx

Definition at line 298 of file map.h.

Referenced by cfapi_region_get_property(), get_jail_exit(), and CRERegionPanel::setItem().

int16_t regiondef::jaily

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

Definition at line 298 of file map.h.

Referenced by cfapi_region_get_property(), get_jail_exit(), and CRERegionPanel::setItem().

char* regiondef::longname

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

Definition at line 291 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().

char* regiondef::msg

The description of the region.

Definition at line 293 of file map.h.

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

char* regiondef::name
struct regiondef* regiondef::next
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 286 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(), region_is_child_of_region(), and CRERegionPanel::setItem().

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

Referenced by assign_region_parents(), and free_globals().


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