retreat: Rewrite automatic retreat code to fix its many bugs
[empserver] / include / ship.h
1 /*
2  *  Empire - A multi-player, client/server Internet based war game.
3  *  Copyright (C) 1986-2015, Dave Pare, Jeff Bailey, Thomas Ruschak,
4  *                Ken Stevens, Steve McClure, Markus Armbruster
5  *
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.
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, see <http://www.gnu.org/licenses/>.
18  *
19  *  ---
20  *
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.
24  *
25  *  ---
26  *
27  *  ship.h: Definitions for things having to do with ships
28  *
29  *  Known contributors to this file:
30  *     Dave Pare
31  *     Thomas Ruschak, 1992
32  *     Ken Stevens, 1995
33  *     Steve McClure, 1998
34  *     Markus Armbruster, 2004-2015
35  */
36
37 #ifndef SHIP_H
38 #define SHIP_H
39
40 #include <time.h>
41 #include "item.h"
42 #include "retreat.h"
43 #include "types.h"
44
45 #define SHP_TYPE_MAX    46
46 #define SHIP_MINEFF     20
47
48 #define MAXSHPPATH      28
49 #define MAXSHPNAMLEN    24
50
51 struct shpstr {
52     /* initial part must match struct empobj */
53     signed ef_type: 8;
54     unsigned shp_seqno: 12;
55     unsigned shp_generation: 12;
56     int shp_uid;                /* unit it (ship #) */
57     time_t shp_timestamp;       /* Last time this ship was touched. */
58     natid shp_own;              /* owner's country num */
59     coord shp_x;                /* x location in abs coords */
60     coord shp_y;                /* y location in abs coords */
61     signed char shp_type;       /* index in mchr[] */
62     signed char shp_effic;      /* 0% to 100% */
63     signed char shp_mobil;      /* mobility units */
64     unsigned char shp_off;      /* repairs stopped? */
65     short shp_tech;             /* tech level ship was built at */
66     char shp_fleet;             /* group membership */
67     coord shp_opx, shp_opy;     /* Op sector coords */
68     short shp_mission;          /* mission code */
69     short shp_radius;           /* mission radius */
70     /* end of part matching struct empobj */
71     short shp_item[I_MAX+1];    /* amount of items on board */
72     short shp_pstage;           /* plague stage */
73     short shp_ptime;            /* how many etus remain in this stage */
74     short shp_access;           /* Last tick mob was updated (MOB_ACCESS) */
75     char shp_name[MAXSHPNAMLEN]; /* name set with the "name" command */
76     coord shp_orig_x;
77     coord shp_orig_y;           /* Where we were built */
78     natid shp_orig_own;         /* Who built us */
79     int shp_rflags;             /* When do I retreat? */
80     char shp_rpath[RET_LEN];    /* retreat path */
81 };
82
83 struct mchrstr {
84     short m_item[I_MAX+1];      /* load limit */
85     int m_lcm;                  /* units of lcm to build */
86     int m_hcm;                  /* units of hcm to build */
87     int m_armor;                /* how well armored it is */
88     int m_speed;                /* how fast it can go */
89     int m_visib;                /* how well it can be seen */
90     int m_vrnge;                /* how well it can see */
91     int m_frnge;                /* how far it can fire */
92     int m_glim;                 /* how many guns it can fire */
93     unsigned char m_nxlight;    /* maximum number of xlight planes */
94     unsigned char m_nchoppers;  /* maximum number of choppers */
95     char *m_name;               /* full name of type of ship */
96     int m_tech;                 /* tech required to build */
97     int m_cost;                 /* how much it costs to build */
98     int m_flags;                /* what special things can this ship do */
99     unsigned char m_nplanes;    /* maximum number of planes this ship holds */
100     unsigned char m_nland;      /* maximum number of units this ship holds */
101     signed char m_type;         /* index in mchr[] */
102 };
103
104 #define M_FOOD          bit(0)  /* catch that fish! */
105 #define M_TORP          bit(1)  /* fire torpedoes */
106 #define M_DCH           bit(2)  /* drop depth charges on subs */
107 #define M_FLY           bit(3)  /* launch and recover planes */
108 /* M_MSL will be automatically set in init_mchr() if m_nplanes > 0
109    and M_FLY is not set */
110 #define M_MSL           bit(4)  /* launch missiles */
111 #define M_OIL           bit(5)  /* drill for oil */
112 #define M_SONAR         bit(6)  /* locate submarines */
113 #define M_MINE          bit(7)  /* drop mines */
114 #define M_SWEEP         bit(8)  /* clean up the mines */
115 #define M_SUB           bit(9)  /* a submarine */
116 /* unused               bit(10) */
117 #define M_LAND          bit(11) /* allows full landing ability */
118 #define M_SUBT          bit(12) /* allows torping of other subs */
119 #define M_TRADE         bit(13) /* is a trade ship */
120 #define M_SEMILAND      bit(14) /* can land 1/4 */
121 /* unused               bit(15) */
122 /* unused               bit(16) */
123 /* unused               bit(17) */
124 #define M_SUPPLY        bit(18) /* Can supply units/sects/ships */
125 #define M_CANAL         bit(19) /* Can navigate a canal (BIG CITY) */
126 #define M_ANTIMISSILE   bit(20) /* Shoot down missile */
127
128 #define getship(n, p) ef_read(EF_SHIP, (n), (p))
129 #define putship(n, p) ef_write(EF_SHIP, (n), (p))
130 #define getshipp(n) ((struct shpstr *)ef_ptr(EF_SHIP, (n)))
131
132 extern struct mchrstr mchr[SHP_TYPE_MAX + 2];
133
134 /* Work required for building 100% */
135 #define SHP_BLD_WORK(lcm, hcm) (20 + (lcm) + 2 * (hcm))
136
137 enum {
138     SHP_AIROPS_EFF = 50,        /* min. efficiency for air ops */
139     SHP_TORP_SHELLS = 3         /* number of shells used by a torpedo */
140 };
141
142 /* Whether and why a ship is stuck in a sector */
143 enum shp_stuck {
144     SHP_STUCK_NOT,              /* not stuck */
145     SHP_STUCK_CONSTRUCTION,     /* sector not efficient enough */
146     SHP_STUCK_CANAL,            /* ship lacks M_CANAL */
147     SHP_STUCK_IMPASSABLE        /* sector type not navigable */
148 };
149
150 extern int m_armor(struct mchrstr *, int);
151 extern int m_speed(struct mchrstr *, int);
152 extern int m_visib(struct mchrstr *, int);
153 extern int m_frnge(struct mchrstr *, int);
154 extern int m_glim(struct mchrstr *, int);
155 extern int shp_armor(struct shpstr *);
156 extern int shp_speed(struct shpstr *);
157 extern int shp_visib(struct shpstr *);
158 extern int shp_frnge(struct shpstr *);
159 extern int shp_glim(struct shpstr *);
160
161 extern int shp_nplane(struct shpstr *, int *, int *, int *);
162 extern int shp_nland(struct shpstr *);
163
164 extern int shp_dchrg(struct shpstr *);
165 extern int shp_fire(struct shpstr *);
166 extern int shp_torp(struct shpstr *, int);
167 extern double shp_fire_range(struct shpstr *);
168 extern int shp_usable_guns(struct shpstr *);
169 extern double shp_torp_hitchance(struct shpstr *, int);
170
171 /* src/lib/subs/shpsub.c */
172 extern int shp_may_nav(struct shpstr *, struct shpstr *, char *);
173 extern void shp_sel(struct nstr_item *, struct emp_qelem *);
174 extern struct ulist *shp_insque(struct shpstr *, struct emp_qelem *);
175 extern void shp_nav_stay_behind(struct emp_qelem *, natid);
176 extern void shp_nav_put(struct emp_qelem *, natid);
177 extern int shp_sweep(struct emp_qelem *, int, int, natid);
178 extern enum shp_stuck shp_check_nav(struct shpstr *, struct sctstr *);
179 extern int sect_has_dock(struct sctstr *);
180 extern int shp_hardtarget(struct shpstr *);
181 extern int shp_nav_dir(struct emp_qelem *, int, natid);
182 extern int shp_nav_gauntlet(struct emp_qelem *, int, natid);
183 extern int shp_missile_defense(coord, coord, natid, int);
184 extern void shp_missdef(struct shpstr *, natid);
185 extern double shp_mobcost(struct shpstr *);
186 extern void shp_set_tech(struct shpstr *, int);
187
188 #endif