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
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 coord shp_destx[2]; /* location for ship destination */
85 i_type shp_tstart[TMAX]; /* what goods to pick up at start point */
86 i_type shp_tend[TMAX]; /* what goods to pick up at end point */
87 short shp_lstart[TMAX]; /* How much do we pick up at the start */
88 short shp_lend[TMAX]; /* How much do we pick up at the end */
89 unsigned char shp_autonav; /* autonavigation flags */
90 short shp_item[I_MAX+1]; /* amount of items on board */
91 short shp_pstage; /* plague stage */
92 short shp_ptime; /* how many etus remain in this stage */
93 short shp_access; /* Last tick mob was updated (MOB_ACCESS) */
94 unsigned char shp_mobquota; /* mobility quota */
95 char shp_path[MAXSHPPATH];
97 char shp_name[MAXSHPNAMLEN]; /* name set with the "name" command */
99 coord shp_orig_y; /* Where we were built */
100 natid shp_orig_own; /* Who built us */
101 int shp_rflags; /* When do I retreat? */
102 char shp_rpath[RET_LEN]; /* retreat path */
106 short m_item[I_MAX+1]; /* load limit */
107 int m_lcm; /* units of lcm to build */
108 int m_hcm; /* units of hcm to build */
109 int m_armor; /* how well armored it is */
110 int m_speed; /* how fast it can go */
111 int m_visib; /* how well it can be seen */
112 int m_vrnge; /* how well it can see */
113 int m_frnge; /* how far it can fire */
114 int m_glim; /* how many guns it can fire */
115 unsigned char m_nxlight; /* maximum number of xlight planes */
116 unsigned char m_nchoppers; /* maximum number of choppers */
117 char *m_name; /* full name of type of ship */
118 int m_tech; /* tech required to build */
119 int m_cost; /* how much it costs to build */
120 long m_flags; /* what special things can this ship do */
121 unsigned char m_nplanes; /* maximum number of planes this ship holds */
122 unsigned char m_nland; /* maximum number of units this ship holds */
123 signed char m_type; /* index in mchr[] */
126 #define M_FOOD bit(0) /* catch that fish! */
127 #define M_TORP bit(1) /* fire torpedoes */
128 #define M_DCH bit(2) /* drop depth charges on subs */
129 #define M_FLY bit(3) /* launch and recover planes */
130 /* M_MSL will be automatically set in init_global() if m_nplanes > 0
131 and M_FLY is not set */
132 #define M_MSL bit(4) /* launch missiles */
133 #define M_OIL bit(5) /* drill for oil */
134 #define M_SONAR bit(6) /* locate submarines */
135 #define M_MINE bit(7) /* drop mines */
136 #define M_SWEEP bit(8) /* clean up the mines */
137 #define M_SUB bit(9) /* a submarine */
139 #define M_LAND bit(11) /* allows full landing ability */
140 #define M_SUBT bit(12) /* allows torping of other subs */
141 #define M_TRADE bit(13) /* is a trade ship */
142 #define M_SEMILAND bit(14) /* can land 1/4 */
146 #define M_SUPPLY bit(18) /* Can supply units/sects/ships */
147 #define M_CANAL bit(19) /* Can navigate a canal (BIG CITY) */
148 #define M_ANTIMISSILE bit(20) /* Shoot down missile */
150 #define getship(n, p) ef_read(EF_SHIP, (n), (p))
151 #define putship(n, p) ef_write(EF_SHIP, (n), (p))
152 #define getshipp(n) ((struct shpstr *)ef_ptr(EF_SHIP, (n)))
154 extern struct mchrstr mchr[SHP_TYPE_MAX + 2];
156 /* Work required for building 100% */
157 #define SHP_BLD_WORK(lcm, hcm) (20 + (lcm) + 2 * (hcm))
159 /* return codes from shp_check_nav */
160 #define CN_NAVIGABLE 0
161 #define CN_LANDLOCKED 1
162 #define CN_CONSTRUCTION 2
166 SHP_AIROPS_EFF = 50, /* min. efficiency for air ops */
167 SHP_TORP_SHELLS = 3 /* number of shells used by a torpedo */
170 extern int m_armor(struct mchrstr *, int);
171 extern int m_speed(struct mchrstr *, int);
172 extern int m_visib(struct mchrstr *, int);
173 extern int m_frnge(struct mchrstr *, int);
174 extern int m_glim(struct mchrstr *, int);
175 extern int shp_armor(struct shpstr *);
176 extern int shp_speed(struct shpstr *);
177 extern int shp_visib(struct shpstr *);
178 extern int shp_frnge(struct shpstr *);
179 extern int shp_glim(struct shpstr *);
181 extern int shp_nplane(struct shpstr *, int *, int *, int *);
182 extern int shp_nland(struct shpstr *);
184 extern int shp_dchrg(struct shpstr *);
185 extern int shp_fire(struct shpstr *);
186 extern int shp_torp(struct shpstr *, int);
187 extern double shp_fire_range(struct shpstr *);
188 extern int shp_usable_guns(struct shpstr *);
189 extern double shp_torp_hitchance(struct shpstr *, int);