2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
4 * Ken Stevens, Steve McClure
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.
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.
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
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.
28 * ship.h: Definitions for things having to do with ships
30 * Known contributors to this file:
32 * Thomas Ruschak, 1992
35 * Markus Armbruster, 2004-2008
47 #define SHP_TYPE_MAX 46
48 #define SHIP_MINEFF 20
50 /* bit masks for the autonav mode flags */
52 #define AN_AUTONAV bit(2)
53 #define AN_STANDBY bit(3)
54 #define AN_LOADING bit(4)
55 #define AN_SCUTTLE bit(5) /* Auto-scuttle of trade ships */
57 /* TMAX is the number of cargo holds a ship use in the autonav code. */
62 #define MAXSHPNAMLEN 24
65 /* initial part must match struct empobj */
67 short shp_uid; /* unit id (ship #) */
69 time_t shp_timestamp; /* Last time this ship was touched. */
70 natid shp_own; /* owner's country num */
71 coord shp_x; /* x location in abs coords */
72 coord shp_y; /* y location in abs coords */
73 signed char shp_type; /* index in mchr[] */
74 signed char shp_effic; /* 0% to 100% */
75 signed char shp_mobil; /* mobility units */
76 unsigned char shp_off; /* repairs stopped? */
77 short shp_tech; /* tech level ship was built at */
78 char shp_fleet; /* group membership */
79 coord shp_opx, shp_opy; /* Op sector coords */
80 short shp_mission; /* mission code */
81 short shp_radius; /* mission radius */
82 /* end of part matching struct empobj */
83 unsigned char shp_nplane; /* number of planes on board */
84 unsigned char shp_nland; /* number of land units on board */
85 coord shp_destx[2]; /* location for ship destination */
87 i_type shp_tstart[TMAX]; /* what goods to pick up at start point */
88 i_type shp_tend[TMAX]; /* what goods to pick up at end point */
89 short shp_lstart[TMAX]; /* How much do we pick up at the start */
90 short shp_lend[TMAX]; /* How much do we pick up at the end */
91 unsigned char shp_autonav; /* autonavigation flags */
92 short shp_item[I_MAX+1]; /* amount of items on board */
93 short shp_pstage; /* plague stage */
94 short shp_ptime; /* how many etus remain in this stage */
95 short shp_access; /* Last tick mob was updated (MOB_ACCESS) */
96 unsigned char shp_mobquota; /* mobility quota */
97 char shp_path[MAXSHPPATH];
99 char shp_name[MAXSHPNAMLEN]; /* name set with the "name" command */
100 unsigned char shp_nchoppers; /* How many choppers on board? */
101 unsigned char shp_nxlight; /* How many xlight planes on board? */
103 coord shp_orig_y; /* Where we were built */
104 natid shp_orig_own; /* Who built us */
105 int shp_rflags; /* When do I retreat? */
106 char shp_rpath[RET_LEN]; /* retreat path */
110 short m_item[I_MAX+1]; /* load limit */
111 int m_lcm; /* units of lcm to build */
112 int m_hcm; /* units of hcm to build */
113 int m_armor; /* how well armored it is */
114 int m_speed; /* how fast it can go */
115 int m_visib; /* how well it can be seen */
116 int m_vrnge; /* how well it can see */
117 int m_frnge; /* how far it can fire */
118 int m_glim; /* how many guns it can fire */
119 unsigned char m_nxlight; /* maximum number of xlight planes */
120 unsigned char m_nchoppers; /* maximum number of choppers */
121 char *m_name; /* full name of type of ship */
122 int m_tech; /* tech required to build */
123 int m_cost; /* how much it costs to build */
124 long m_flags; /* what special things can this ship do */
125 unsigned char m_nplanes; /* maximum number of planes this ship holds */
126 unsigned char m_nland; /* maximum number of units this ship holds */
127 signed char m_type; /* index in mchr[] */
130 #define M_FOOD bit(0) /* catch that fish! */
131 #define M_TORP bit(1) /* fire torpedoes */
132 #define M_DCH bit(2) /* drop depth charges on subs */
133 #define M_FLY bit(3) /* launch and recover planes */
134 /* M_MSL will be automatically set in init_global() if m_nplanes > 0
135 and M_FLY is not set */
136 #define M_MSL bit(4) /* launch missiles */
137 #define M_OIL bit(5) /* drill for oil */
138 #define M_SONAR bit(6) /* locate submarines */
139 #define M_MINE bit(7) /* drop mines */
140 #define M_SWEEP bit(8) /* clean up the mines */
141 #define M_SUB bit(9) /* a submarine */
143 #define M_LAND bit(11) /* allows full landing ability */
144 #define M_SUBT bit(12) /* allows torping of other subs */
145 #define M_TRADE bit(13) /* is a trade ship */
146 #define M_SEMILAND bit(14) /* can land 1/4 */
150 #define M_SUPPLY bit(18) /* Can supply units/sects/ships */
151 #define M_CANAL bit(19) /* Can navigate a canal (BIG CITY) */
152 #define M_ANTIMISSILE bit(20) /* Shoot down missile */
154 #define getship(n, p) ef_read(EF_SHIP, (n), (p))
155 #define putship(n, p) ef_write(EF_SHIP, (n), (p))
156 #define getshipp(n) ((struct shpstr *)ef_ptr(EF_SHIP, (n)))
158 extern struct mchrstr mchr[SHP_TYPE_MAX + 2];
160 /* Work required for building 100% */
161 #define SHP_BLD_WORK(lcm, hcm) (20 + (lcm) + 2 * (hcm))
163 /* return codes from shp_check_nav */
164 #define CN_NAVIGABLE 0
165 #define CN_LANDLOCKED 1
166 #define CN_CONSTRUCTION 2
170 SHP_AIROPS_EFF = 50, /* min. efficiency for air ops */
171 SHP_TORP_SHELLS = 3 /* number of shells used by a torpedo */
174 extern int m_armor(struct mchrstr *, int);
175 extern int m_speed(struct mchrstr *, int);
176 extern int m_visib(struct mchrstr *, int);
177 extern int m_frnge(struct mchrstr *, int);
178 extern int m_glim(struct mchrstr *, int);
179 extern int shp_armor(struct shpstr *);
180 extern int shp_speed(struct shpstr *);
181 extern int shp_visib(struct shpstr *);
182 extern int shp_frnge(struct shpstr *);
183 extern int shp_glim(struct shpstr *);
185 extern int shp_dchrg(struct shpstr *);
186 extern int shp_fire(struct shpstr *);
187 extern int shp_torp(struct shpstr *, int);
188 extern double shp_fire_range(struct shpstr *);
189 extern int shp_usable_guns(struct shpstr *);
190 extern double shp_torp_hitchance(struct shpstr *, int);