server/include/region.h

/*
 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
 * 
 * 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 3 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 this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * 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);
  object_vector_index 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)     \
    statementvar (region *, var, regions [_i])

#endif

Revision:	1.6
Committed:	Sun Jul 1 05:00:18 2007 UTC (19 years, 3 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.5:	+11 -12 lines
Log Message:	- upgrade crossfire trt to the GPL version 3 (hopefully correctly). - add a single file covered by the GNU Affero General Public License (which is not yet released, so I used the current draft, which is legally a bit wavy, but its likely better than nothing as it expresses direct intent by the authors, and we can upgrade as soon as it has been released). * this should ensure availability of source code for the server at least and hopefully also archetypes and maps even when modified versions are not being distributed, in accordance of section 13 of the agplv3.
#	User	Rev	Content
1	root	1.1	/*
2	root	1.6	* This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
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.6	* Crossfire TRT is free software: you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation, either version 3 of the License, or
11			* (at your option) any later version.
12	root	1.1	*
13	root	1.6	* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU General Public License for more details.
17	root	1.1	*
18	root	1.6	* You should have received a copy of the GNU General Public License
19			* along with this program. If not, see <http://www.gnu.org/licenses/>.
20	root	1.3	*
21			* The authors can be reached via e-mail to <crossfire@schmorp.de>
22	root	1.1	*/
23
24			/*
25			* The maptile is allocated each time a new map is opened.
26			* It contains pointers (very indirectly) to all objects on the map.
27			*/
28
29			#ifndef REGION_H
30			#define REGION_H
31
32			/*
33			* Each map is in a given region of the game world and links to a region definiton, so
34			* they have to appear here in the headers, before the mapdef
35			*/
36			INTERFACE_CLASS (region)
37			struct region : zero_initialised
38			{
39			shstr ACC (RW, name); /* Shortend name of the region as maps refer to it */
40			shstr ACC (RW, match); // a perl regex that matches map paths
41			region ACC (RW, parent); /
42			* Pointer to the region that is a parent of the current
43			* region, if a value isn't defined in the current region
44			* we traverse this series of pointers until it is.
45			*/
46			shstr ACC (RW, longname); /* Official title of the region, this might be defined
47			* to be the same as name*/
48			shstr ACC (RW, msg); /* the description of the region */
49			shstr ACC (RW, jailmap); /where a player that is arrested in this region should be imprisoned. /
50	root	1.2	sint16 ACC (RW, jailx), ACC (RW, jaily);/* The coodinates in jailmap to which the player should be sent. */
51			shstr ACC (RW, portalmap);
52			sint16 ACC (RW, portalx), ACC (RW, portaly);
53	root	1.5	object_vector_index ACC (RW, index);
54	root	1.1	uint32 ACC (RW, counter); /* A generic counter for holding temporary data. */
55			bool ACC (RW, fallback); /* whether, in the event of a region not existing,
56			* this should be the one we fall back on as the default */
57			float treasure_density; // chance of treasure per mapspace
58			treasurelist *treasure; // treasure to generate (mostly monsters)
59
60			static region *default_region ();
61			static region find (const char name);
62			static region find_fuzzy (const char name);
63			static region *read (object_thawer &f);
64			};
65
66			typedef object_vector<region, &region::index> regionvec;
67
68			extern regionvec regions;
69
70			#define for_all_regions(var) \
71			for (unsigned _i = 0; _i < regions.size (); ++_i) \
72	root	1.4	statementvar (region *, var, regions [_i])
73	root	1.1
74			#endif
75