server/include/region.h

/*
 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
 * 
 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
 * Copyright (©) 2002-2005,2007 Mark Wedel & Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Crossfire TRT is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * The authors can be reached via e-mail to <crossfire@schmorp.de>
 */

/*
 * The maptile is allocated each time a new map is opened.
 * It contains pointers (very indirectly) to all objects on the map.
 */

#ifndef REGION_H
#define REGION_H

/*
 * 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
 */
INTERFACE_CLASS (region)
struct region : zero_initialised
{
  shstr ACC (RW, name);                   /* Shortend name of the region as maps refer to it */
  shstr ACC (RW, match);                  // a perl regex that matches map paths
  region *ACC (RW, 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.
                                           */
  shstr ACC (RW, longname);               /* Official title of the region, this might be defined
                                           * to be the same as name*/
  shstr ACC (RW, msg);                    /* the description of the region */
  shstr ACC (RW, jailmap);                /*where a player that is arrested in this region should be imprisoned. */
  sint16 ACC (RW, jailx), ACC (RW, jaily);/* The coodinates in jailmap to which the player should be sent. */
  shstr ACC (RW, portalmap);
  sint16 ACC (RW, portalx), ACC (RW, portaly);
  int ACC (RW, index);
  uint32 ACC (RW, counter);               /* A generic counter for holding temporary data. */
  bool ACC (RW, fallback);                /* whether, in the event of a region not existing,
                                           * this should be the one we fall back on as the default */
  float treasure_density;                 // chance of treasure per mapspace
  treasurelist *treasure;                 // treasure to generate (mostly monsters)

  static region *default_region ();
  static region *find (const char *name);
  static region *find_fuzzy (const char *name);
  static region *read (object_thawer &f);
};

typedef object_vector<region, &region::index> regionvec;

extern regionvec regions;

#define for_all_regions(var)                    \
  for (unsigned _i = 0; _i < regions.size (); ++_i)     \
    declvar (region *, var, regions [_i])

#endif

Revision:	1.3
Committed:	Mon May 28 21:15:56 2007 UTC (17 years ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.2:	+17 -17 lines
Log Message:	- update copyrights in .h files, where applicable - rename preprocess to genkeywords
#	User	Rev	Content
1	root	1.1	/*
2	root	1.3	* This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
3	root	1.1	*
4	root	1.3	* Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5			* Copyright (©) 2002-2005,2007 Mark Wedel & Crossfire Development Team
6			* Copyright (©) 1992,2007 Frank Tore Johansen
7	root	1.1	*
8	root	1.3	* Crossfire TRT is free software; you can redistribute it and/or modify it
9			* under the terms of the GNU General Public License as published by the Free
10			* Software Foundation; either version 2 of the License, or (at your option)
11			* any later version.
12	root	1.1	*
13	root	1.3	* This program is distributed in the hope that it will be useful, but
14			* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15			* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16			* for more details.
17	root	1.1	*
18	root	1.3	* You should have received a copy of the GNU General Public License along
19			* with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
20			* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21			*
22			* The authors can be reached via e-mail to <crossfire@schmorp.de>
23	root	1.1	*/
24
25			/*
26			* The maptile is allocated each time a new map is opened.
27			* It contains pointers (very indirectly) to all objects on the map.
28			*/
29
30			#ifndef REGION_H
31			#define REGION_H
32
33			/*
34			* Each map is in a given region of the game world and links to a region definiton, so
35			* they have to appear here in the headers, before the mapdef
36			*/
37			INTERFACE_CLASS (region)
38			struct region : zero_initialised
39			{
40			shstr ACC (RW, name); /* Shortend name of the region as maps refer to it */
41			shstr ACC (RW, match); // a perl regex that matches map paths
42			region ACC (RW, parent); /
43			* Pointer to the region that is a parent of the current
44			* region, if a value isn't defined in the current region
45			* we traverse this series of pointers until it is.
46			*/
47			shstr ACC (RW, longname); /* Official title of the region, this might be defined
48			* to be the same as name*/
49			shstr ACC (RW, msg); /* the description of the region */
50			shstr ACC (RW, jailmap); /where a player that is arrested in this region should be imprisoned. /
51	root	1.2	sint16 ACC (RW, jailx), ACC (RW, jaily);/* The coodinates in jailmap to which the player should be sent. */
52			shstr ACC (RW, portalmap);
53			sint16 ACC (RW, portalx), ACC (RW, portaly);
54	root	1.1	int ACC (RW, index);
55			uint32 ACC (RW, counter); /* A generic counter for holding temporary data. */
56			bool ACC (RW, fallback); /* whether, in the event of a region not existing,
57			* this should be the one we fall back on as the default */
58			float treasure_density; // chance of treasure per mapspace
59			treasurelist *treasure; // treasure to generate (mostly monsters)
60
61			static region *default_region ();
62			static region find (const char name);
63			static region find_fuzzy (const char name);
64			static region *read (object_thawer &f);
65			};
66
67			typedef object_vector<region, &region::index> regionvec;
68
69			extern regionvec regions;
70
71			#define for_all_regions(var) \
72			for (unsigned _i = 0; _i < regions.size (); ++_i) \
73			declvar (region *, var, regions [_i])
74
75			#endif
76