]> git.pond.sub.org Git - empserver/blob - src/lib/subs/unitsub.c
Clean up path finding in unit_sub()
[empserver] / src / lib / subs / unitsub.c
1 /*
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
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  *  unitsub.c: Common subroutines for multiple type of units
28  *
29  *  Known contributors to this file:
30  *     Ron Koenderink, 2007
31  *     Markus Armbruster, 2009-2011
32  */
33
34 #include <config.h>
35
36 #include "empobj.h"
37 #include "file.h"
38 #include "path.h"
39 #include "player.h"
40 #include "optlist.h"
41 #include "prototypes.h"
42 #include "unit.h"
43
44 void
45 unit_list(struct emp_qelem *unit_list)
46 {
47     struct emp_qelem *qp;
48     struct emp_qelem *next;
49     struct ulist *ulp;
50     int type, npln, nch, nxl;
51     struct empobj *unit;
52     struct lndstr *lnd;
53     struct shpstr *shp;
54
55     if (CANT_HAPPEN(QEMPTY(unit_list)))
56         return;
57     qp = unit_list->q_back;
58     ulp = (struct ulist *)qp;
59     type = ulp->unit.gen.ef_type;
60     if (CANT_HAPPEN(type != EF_LAND && type != EF_SHIP))
61         return;
62
63     if (type == EF_LAND)
64         pr("lnd#     land type       x,y    a  eff  sh gun xl  mu tech retr\n");
65     else
66         pr("shp#     ship type       x,y   fl  eff mil  sh gun pn he xl ln mob tech\n");
67
68     for (; qp != unit_list; qp = next) {
69         next = qp->q_back;
70         ulp = (struct ulist *)qp;
71         lnd = &ulp->unit.land;
72         shp = &ulp->unit.ship;
73         unit = &ulp->unit.gen;
74         if (CANT_HAPPEN(type != unit->ef_type))
75             continue;
76         pr("%4d ", unit->uid);
77         pr("%-16.16s ", empobj_chr_name(unit));
78         prxy("%4d,%-4d ", unit->x, unit->y);
79         pr("%1.1s", &unit->group);
80         pr("%4d%%", unit->effic);
81         if (type == EF_LAND) {
82             pr("%4d", lnd->lnd_item[I_SHELL]);
83             pr("%4d", lnd->lnd_item[I_GUN]);
84             pr("%3d", lnd_nxlight(lnd));
85         } else {
86             pr("%4d", shp->shp_item[I_MILIT]);
87             pr("%4d", shp->shp_item[I_SHELL]);
88             pr("%4d", shp->shp_item[I_GUN]);
89             npln = shp_nplane(shp, &nch, &nxl, NULL);
90             pr("%3d%3d%3d", npln - nch - nxl, nch, nxl);
91             pr("%3d", shp_nland(shp));
92         }
93         pr("%4d", unit->mobil);
94         pr("%4d", unit->tech);
95         if (type == EF_LAND) {
96             pr("%4d%%", lnd->lnd_retreat);
97         }
98         pr("\n");
99     }
100 }
101
102 void
103 unit_put(struct emp_qelem *list, natid actor)
104 {
105     struct emp_qelem *qp;
106     struct emp_qelem *newqp;
107     struct ulist *ulp;
108     struct empobj *unit;
109
110     qp = list->q_back;
111     while (qp != list) {
112         ulp = (struct ulist *)qp;
113         unit = &ulp->unit.gen;
114         if (CANT_HAPPEN(unit->ef_type != EF_LAND
115                         && unit->ef_type != EF_SHIP))
116             continue;
117         if (actor) {
118             mpr(actor, "%s stopped at %s\n", obj_nameof(unit),
119                 xyas(unit->x, unit->y, actor));
120             if (unit->ef_type == EF_LAND) {
121                 if (ulp->mobil < -127)
122                     ulp->mobil = -127;
123                 unit->mobil = ulp->mobil;
124             }
125         }
126         if (unit->ef_type == EF_SHIP)
127             unit->mobil = (int)ulp->mobil;
128         put_empobj(unit->ef_type, unit->uid, unit);
129         newqp = qp->q_back;
130         emp_remque(qp);
131         free(qp);
132         qp = newqp;
133     }
134 }
135
136 char *
137 unit_path(int together, struct empobj *unit, char *buf)
138 {
139     coord destx;
140     coord desty;
141     struct sctstr sect;
142     size_t len;
143     double c;
144     int mtype;
145
146     if (CANT_HAPPEN(unit->ef_type != EF_LAND && unit->ef_type != EF_SHIP))
147         return NULL;
148
149     if (!sarg_xy(buf, &destx, &desty))
150         return NULL;
151     if (!together) {
152         pr("Cannot go to a destination sector if not all starting in the same sector\n");
153         return NULL;
154     }
155     if (unit->ef_type == EF_SHIP) {
156         c = path_find(unit->x, unit->y, destx, desty,
157                       player->cnum, MOB_SAIL);
158         if (c < 0 || unit->mobil <= 0) {
159             pr("Can't get to '%s' right now.\n",
160                xyas(destx, desty, player->cnum));
161             return NULL;
162         }
163     } else {
164         getsect(unit->x, unit->y, &sect);
165         mtype = lnd_mobtype((struct lndstr *)unit);
166         /*
167          * Note: passing sect.sct_own for actor is funny, but works:
168          * its only effect is to confine the search to that nation's
169          * land.  It doesn't affect mobility costs.  The real actor is
170          * different for marching in allied land, and passing it would
171          * break path finding there.
172          */
173         c = path_find(unit->x, unit->y, destx, desty, sect.sct_own, mtype);
174         if (c < 0) {
175             buf[0] = 0;
176             pr("No owned %s from %s to %s!\n",
177                mtype == MOB_RAIL ? "railway" : "path",
178                xyas(unit->x, unit->y, player->cnum),
179                xyas(destx, desty, player->cnum));
180             return NULL;
181         }
182     }
183     len = path_find_route(buf, sizeof(buf), unit->x, unit->y, destx, desty);
184     if (len == 0 || unit->ef_type == EF_LAND) {
185         if (len + 1 < sizeof(buf))
186             strcpy(buf + len, "h");
187         len++;
188     }
189     if (len >= sizeof(buf)) {
190         pr("Can't handle path to %s, it's too long, sorry\n",
191            xyas(destx, desty, player->cnum));
192         return NULL;
193     }
194     if (unit->ef_type == EF_LAND)
195         pr("Using path '%s'\n", buf);
196     return buf;
197 }
198
199 void
200 unit_view(struct emp_qelem *list)
201 {
202     struct sctstr sect;
203     struct emp_qelem *qp;
204     struct emp_qelem *next;
205     struct ulist *ulp;
206
207     for (qp = list->q_back; qp != list; qp = next) {
208         next = qp->q_back;
209         ulp = (struct ulist *)qp;
210         if (CANT_HAPPEN(!(ef_flags(ulp->unit.gen.ef_type) & EFF_XY)))
211             continue;
212         getsect(ulp->unit.gen.x, ulp->unit.gen.y, &sect);
213         if (ulp->unit.gen.ef_type == EF_SHIP) {
214             if (((struct mchrstr *)ulp->chrp)->m_flags & M_FOOD)
215                 pr("[fert:%d] ", sect.sct_fertil);
216             if (((struct mchrstr *)ulp->chrp)->m_flags & M_OIL)
217                 pr("[oil:%d] ", sect.sct_oil);
218         }
219         pr("%s @ %s %d%% %s\n", obj_nameof(&ulp->unit.gen),
220            xyas(ulp->unit.gen.x, ulp->unit.gen.y, player->cnum),
221            sect.sct_effic, dchr[sect.sct_type].d_name);
222     }
223 }
224
225 /*
226  * Update cargo of CARRIER for movement or destruction.
227  * If the carrier is destroyed, destroy its cargo (planes, land units,
228  * nukes).
229  * Else update their location to the carrier's.  Any op sectors equal
230  * to location get updated, too.
231  */
232 void
233 unit_update_cargo(struct empobj *carrier)
234 {
235     int cargo_type;
236     struct nstr_item ni;
237     union empobj_storage obj;
238
239     for (cargo_type = EF_PLANE; cargo_type <= EF_NUKE; cargo_type++) {
240         snxtitem_cargo(&ni, cargo_type, carrier->ef_type, carrier->uid);
241         while (nxtitem(&ni, &obj)) {
242             if (!carrier->own) {
243                 mpr(obj.gen.own, "%s lost!\n", obj_nameof(&obj.gen));
244                 obj.gen.effic = 0;
245             } else {
246                 /* mission op-area centered on the obj travels with it */
247                 if (obj.gen.opx == obj.gen.x && obj.gen.opy == obj.gen.y) {
248                     obj.gen.opx = carrier->x;
249                     obj.gen.opy = carrier->y;
250                 }
251                 obj.gen.x = carrier->x;
252                 obj.gen.y = carrier->y;
253             }
254             put_empobj(cargo_type, obj.gen.uid, &obj);
255         }
256     }
257 }
258
259 /*
260  * Drop cargo of UNIT.
261  * Give it to NEWOWN, unless it's zero.
262  */
263 void
264 unit_drop_cargo(struct empobj *unit, natid newown)
265 {
266     int type;
267     struct nstr_item ni;
268     union empobj_storage cargo;
269
270     for (type = EF_PLANE; type <= EF_NUKE; type++) {
271         snxtitem_cargo(&ni, type, unit->ef_type, unit->uid);
272         while (nxtitem(&ni, &cargo)) {
273             switch (type) {
274             case EF_PLANE:
275                 cargo.plane.pln_ship = cargo.plane.pln_land = -1;
276                 break;
277             case EF_LAND:
278                 cargo.land.lnd_ship = cargo.land.lnd_land = -1;
279                 break;
280             case EF_NUKE:
281                 cargo.nuke.nuk_plane = -1;
282                 break;
283             }
284             mpr(cargo.gen.own, "%s transferred off %s %d to %s\n",
285                 obj_nameof(&cargo.gen),
286                 ef_nameof(unit->ef_type), unit->uid,
287                 xyas(cargo.gen.x, cargo.gen.y, cargo.gen.own));
288             if (newown)
289                 unit_give_away(&cargo.gen, newown, cargo.gen.own);
290             put_empobj(type, cargo.gen.uid, &cargo.gen);
291         }
292     }
293 }
294
295 /*
296  * Give UNIT and its cargo to RECIPIENT.
297  * No action if RECIPIENT already owns UNIT.
298  * If GIVER is non-zero, inform RECIPIENT and GIVER of the transaction.
299  * Clears mission and group on the units given away.
300  */
301 void
302 unit_give_away(struct empobj *unit, natid recipient, natid giver)
303 {
304     int type;
305     struct nstr_item ni;
306     union empobj_storage cargo;
307
308     if (unit->own == recipient)
309         return;
310
311     if (giver) {
312         mpr(unit->own, "%s given to %s\n",
313             obj_nameof(unit), cname(recipient));
314         mpr(recipient, "%s given to you by %s\n",
315             obj_nameof(unit), cname(giver));
316     }
317
318     unit->own = recipient;
319     unit_wipe_orders(unit);
320     put_empobj(unit->ef_type, unit->uid, unit);
321
322     for (type = EF_PLANE; type <= EF_NUKE; type++) {
323         snxtitem_cargo(&ni, type, unit->ef_type, unit->uid);
324         while (nxtitem(&ni, &cargo))
325             unit_give_away(&cargo.gen, recipient, giver);
326     }
327 }
328
329 /*
330  * Wipe orders and such from UNIT.
331  */
332 void
333 unit_wipe_orders(struct empobj *unit)
334 {
335     struct shpstr *sp;
336     struct plnstr *pp;
337     struct lndstr *lp;
338     int i;
339
340     unit->group = 0;
341     unit->opx = unit->opy = 0;
342     unit->mission = 0;
343     unit->radius = 0;
344
345     switch (unit->ef_type) {
346     case EF_SHIP:
347         sp = (struct shpstr *)unit;
348         sp->shp_destx[0] = sp->shp_desty[0] = 0;
349         sp->shp_destx[1] = sp->shp_desty[1] = 0;
350         for (i = 0; i < TMAX; ++i) {
351             sp->shp_tstart[i] = I_NONE;
352             sp->shp_tend[i] = I_NONE;
353             sp->shp_lstart[i] = 0;
354             sp->shp_lend[i] = 0;
355         }
356         sp->shp_autonav = 0;
357         sp->shp_mobquota = 0;
358         sp->shp_path[0] = 0;
359         sp->shp_follow = sp->shp_uid;
360         sp->shp_rflags = 0;
361         sp->shp_rpath[0] = 0;
362         break;
363     case EF_PLANE:
364         pp = (struct plnstr *)unit;
365         pp->pln_range = pln_range_max(pp);
366         break;
367     case EF_LAND:
368         lp = (struct lndstr *)unit;
369         lp->lnd_retreat = morale_base;
370         lp->lnd_rflags = 0;
371         lp->lnd_rpath[0] = 0;
372         break;
373     case EF_NUKE:
374         break;
375     default:
376         CANT_REACH();
377     }
378 }