]> git.pond.sub.org Git - empserver/blob - include/sect.h
e931e02bb5845fa27b09a91e5928cd77b437ebe7
[empserver] / include / sect.h
1 /*
2  *  Empire - A multi-player, client/server Internet based war game.
3  *  Copyright (C) 1986-2009, Dave Pare, Jeff Bailey, Thomas Ruschak,
4  *                           Ken Stevens, Steve McClure
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  *  ---
21  *
22  *  See files README, COPYING and CREDITS in the root of the source
23  *  tree for related information and legal notices.  It is expected
24  *  that future projects/authors will amend these files as needed.
25  *
26  *  ---
27  *
28  *  sect.h: Definitions for things having to do with sectors.
29  *
30  *  Known contributors to this file:
31  *     Dave Pare
32  *     Ken Stevens, 1995
33  *     Steve McClure, 1998
34  *     Markus Armbruster, 2004-2009
35  */
36
37
38 #ifndef SECT_H
39 #define SECT_H
40
41 #include <time.h>
42 #include "item.h"
43 #include "types.h"
44
45 struct sctstr {
46     /* initial part must match struct empobj */
47     signed ef_type: 8;
48     unsigned sct_seqno: 12;
49     unsigned sct_generation: 12;
50     int sct_uid;                /* equals XYOFFSET(sct_x, sct_y) */
51     time_t sct_timestamp;       /* Last time this sector was written to */
52     natid sct_own;              /* owner's country num */
53     coord sct_x;                /* x coord of sector */
54     coord sct_y;                /* y coord of sector */
55     signed char sct_type;       /* sector type */
56     /* end of part matching struct empobj */
57     signed char sct_effic;      /* 0% to 100% */
58     signed char sct_mobil;      /* mobility units */
59     unsigned char sct_loyal;    /* updates until civilans "converted" */
60     unsigned char sct_terr;     /* territory 0 id # of sector */
61     unsigned char sct_terr1;    /* territory 1 id # of sector */
62     unsigned char sct_terr2;    /* territory 2 id # of sector */
63     unsigned char sct_terr3;    /* territory 3 id # of sector */
64     unsigned char sct_dterr;    /* deity's territory # */
65     coord sct_dist_x;           /* Dist sector */
66     coord sct_dist_y;
67     short sct_avail;            /* available workforce for "other things" */
68     short sct_flags;            /* temporary flags */
69     short sct_elev;             /* elevation/depth */
70     unsigned char sct_work;     /* pct of civ actually working */
71     unsigned char sct_coastal;  /* is this a coastal sector? */
72     signed char sct_newtype;    /* for changing designations */
73     unsigned char sct_min;      /* ease of mining ore */
74     unsigned char sct_gmin;     /* amount of gold ore */
75     unsigned char sct_fertil;   /* fertility of soil */
76     unsigned char sct_oil;      /* oil content */
77     unsigned char sct_uran;     /* uranium ore content */
78     natid sct_oldown;           /* old owner of sector (for liberation) */
79     unsigned char sct_updated;  /* Has this sect been updated? */
80     unsigned char sct_off;      /* Should this sector produce? */
81     short sct_item[I_MAX+1];    /* amount of items stored here */
82     short sct_del[I_MAX+1];     /* delivieries */
83     short sct_dist[I_MAX+1];    /* distribution thresholds */
84     short sct_mines;            /* number of mines */
85     short sct_pstage;           /* plague stage */
86     short sct_ptime;            /* how many etus remain in this stage */
87     unsigned char sct_che;      /* number of guerrillas */
88     natid sct_che_target;       /* nation targeted by che */
89     unsigned short sct_fallout;
90     short sct_access;           /* Last tick mob was updated (MOB_ACCESS) */
91     unsigned char sct_road;     /* Road value of a sector */
92     unsigned char sct_rail;     /* Rail value of a sector */
93     unsigned char sct_defense;  /* Defensive value of a sector */
94 };
95
96 enum d_navigation {
97     NAV_NONE,   /* ships can't navigate */
98     NAVOK,      /* ships can always navigate */
99     NAV_02,     /* requires 2% effic to navigate */
100     NAV_CANAL,  /* requires 2% effic to navigate and M_CANAL capability */
101     NAV_60      /* requires 60% effic to navigate */
102 };
103
104 struct dchrstr {
105     unsigned char d_uid;
106     char d_mnem;                /* map symbol */
107     unsigned char d_terrain;    /* terrain sector type */
108     int d_prd;                  /* product type */
109     int d_peffic;               /* process efficiency, in percent */
110     float d_mob0, d_mob1;       /* movement cost at 0 and 100% eff */
111     enum d_navigation d_nav;    /* navigation capability */
112     enum i_packing d_pkg;       /* type of packaging in these sects */
113     float d_ostr;               /* offensive strength */
114     float d_dstr;               /* defensive strength */
115     int d_value;                /* resale ("collect") value */
116     int d_cost;                 /* cost to designate the sect */
117     int d_build;                /* cost multiplier for eff */
118     int d_lcms;                 /* lcm's needed per point of eff */
119     int d_hcms;                 /* hcm's needed per point of eff */
120     int d_maint;                /* maintenance cost per ETU */
121     int d_maxpop;               /* maximum population */
122     char *d_name;               /* full name of sector type */
123 };
124
125         /* sector types (must agree with order in dchr, empglb.c) */
126
127 #define SCT_WATER       0       /* basics */
128 #define SCT_MOUNT       1
129 #define SCT_SANCT       2
130 #define SCT_WASTE       3
131 #define SCT_RURAL       4
132 #define SCT_CAPIT       5
133 #define SCT_URAN        6
134 #define SCT_PARK        7
135 #define SCT_ARMSF       8       /* industries */
136 #define SCT_AMMOF       9
137 #define SCT_MINE        10
138 #define SCT_GMINE       11
139 #define SCT_HARBR       12
140 #define SCT_WAREH       13
141 #define SCT_AIRPT       14
142 #define SCT_AGRI        15
143 #define SCT_OIL         16
144 #define SCT_LIGHT       17
145 #define SCT_HEAVY       18
146 #define SCT_FORTR       19      /* military/scientific */
147 #define SCT_TECH        20
148 #define SCT_RSRCH       21
149 #define SCT_NUKE        22
150 #define SCT_LIBR        23
151 #define SCT_HIWAY       24      /* communications */
152 #define SCT_RADAR       25
153 #define SCT_HEADQ       26      /* headquarters */
154 #define SCT_BHEAD       27      /* Bridge head */
155 #define SCT_BSPAN       28      /* Bridge span */
156 #define SCT_BANK        29      /* financial */
157 #define SCT_REFINE      30      /* refinery */
158 #define SCT_ENLIST      31      /* enlistment center */
159 #define SCT_PLAINS      32      /* plains sector */
160 #define SCT_BTOWER      33      /* Bridge tower */
161
162 #define SCT_TYPE_MAX    38
163
164 #define getsect(x, y, p) ef_read(EF_SECTOR, sctoff((x), (y)), (p))
165 #define putsect(p) ef_write(EF_SECTOR, (p)->sct_uid, (p))
166 #define getsectp(x, y) (struct sctstr *)ef_ptr(EF_SECTOR, sctoff((x), (y)))
167 #define getsectid(id) (struct sctstr *)ef_ptr(EF_SECTOR, (id))
168
169 /* things relating to sectors */
170 extern int sctoff(coord x, coord y);
171
172 extern struct dchrstr dchr[SCT_TYPE_MAX + 2];
173 #define IS_BIG_CITY(type) (dchr[(type)].d_pkg == UPKG)
174
175 /* Minimal efficiency of sectors that can be knocked down (bridges) */
176 #define SCT_MINEFF 20
177
178 /* Work required for building */
179 #define SCT_BLD_WORK(lcm, hcm) ((lcm) + 2 * (hcm))
180
181 /* Return SP's defense efficiency */
182 #define SCT_DEFENSE(sp) \
183     (intrchr[INT_DEF].in_enable ? (sp)->sct_defense : (sp)->sct_effic)
184
185 #define FORTEFF 5               /* forts must be 5% efficient to fire. */
186
187 /* Can trains enter sector SP? */
188 #define SCT_HAS_RAIL(sp)                                        \
189     (opt_RAILWAYS ? sct_rail_track((sp)) != 0                   \
190      : intrchr[INT_RAIL].in_enable && (sp)->sct_rail != 0)
191
192 #define SCT_MINES_ARE_SEAMINES(sp) \
193     ((sp)->sct_type == SCT_WATER || (sp)->sct_type == SCT_BSPAN)
194 #define SCT_SEAMINES(sp) \
195     (SCT_MINES_ARE_SEAMINES((sp)) ? (sp)->sct_mines : 0)
196 #define SCT_LANDMINES(sp) \
197     (SCT_MINES_ARE_SEAMINES((sp)) ? 0 : (sp)->sct_mines)
198
199 #define MOB_MOVE    0
200 #define MOB_MARCH   1
201 #define MOB_RAIL    2
202
203 #define INT_ROAD    0
204 #define INT_RAIL    1
205 #define INT_DEF     2
206
207 /* Sector flags */
208 #define MOVE_IN_PROGRESS        bit(0)  /* move in progress */
209
210 /* maximum item amount, must fit into sct_item[], sct_del[], sct_dist[] */
211 #define ITEM_MAX 9999
212 /* maximum number of mines, must fit into struct sctstr member sct_mines */
213 #define MINES_MAX 32767
214 /* maximum number of che, must fit into struct sctstr member sct_che */
215 #define CHE_MAX 255
216 /* maximum fallout, must fit into struct sctstr member sct_fallout */
217 #define FALLOUT_MAX 9999
218 /* maximum territory, must fit into struct sctstr members sct_terr etc */
219 #define TERR_MAX 99
220
221 /* Each cost is per point of efficency */
222 struct sctintrins {
223     char *in_name;
224     unsigned char in_lcms;      /* construction materials */
225     unsigned char in_hcms;
226     unsigned char in_dcost;     /* dollars */
227     unsigned char in_mcost;     /* mobility */
228     unsigned char in_enable;    /* enabled iff non-zero */
229 };
230
231 extern struct sctintrins intrchr[INT_DEF + 2];
232
233 extern int fort_fire(struct sctstr *);
234 extern int sct_rail_track(struct sctstr *);
235
236 #endif