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