/*
* Empire - A multi-player, client/server Internet based war game.
- * Copyright (C) 1986-2015, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ * Copyright (C) 1986-2020, Dave Pare, Jeff Bailey, Thomas Ruschak,
* Ken Stevens, Steve McClure, Markus Armbruster
*
* Empire is free software: you can redistribute it and/or modify
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
-#include "file.h"
#include "unit.h"
struct clink {
* Cargo lists
*
* Persistent game state encodes "who carries what" by storing the
- * carrier uid in the cargo. Cargo lists augment that: they store
+ * carrier UID in the cargo. Cargo lists augment that: they store
* lists of cargo for each carrier.
*
* clink[TYPE] points to an array of cargo list links. The array has
* EF_NUKE. Other slots of clink[] and nclink[] are unused and remain
* zero.
*
- * clink[TYPE][UID].next is the uid of the next unit of the same type
+ * clink[TYPE][UID].next is the UID of the next unit of the same type
* in the same carrier, -1 if none.
*
- * clink[TYPE][UID].head[CARGO-EF_PLANE] is the uid of the first unit
+ * clink[TYPE][UID].head[CARGO-EF_PLANE] is the UID of the first unit
* of type CARGO carried by this unit, -1 if none. The next unit, if
* any, is clink[CARGO][clink[TYPE][UID].head[CARGO-EF_PLANE]].next,
* and so forth.
static int nclink[EF_NUKE + 1];
/*
- * Return pointer to CL's cargo list head for file type TYPE.
+ * Return pointer to @cl's cargo list head for file type @type.
*/
static int *
clink_headp(struct clink *cl, int type)
}
/*
- * Initialize cargo list link CL to empty.
+ * Initialize cargo list link @cl to empty.
*/
static void
clink_init(struct clink *cl)
}
/*
- * Check whether *UIDP is a valid uid for file type TYPE.
+ * Check whether *@uidp is a valid UID for file type @type.
*/
static void
clink_check1(int *uidp, int type)
}
/*
- * Check validity of cargo lists for file type TYPE.
+ * Check validity of cargo lists for file type @type.
*/
static void
clink_check(int type)
}
/*
- * Add to CL's cargo list for type TYPE the uid UID.
- * UID must not be on any cargo list already.
+ * Add to @cl's cargo list for type @type the UID @uid.
+ * @uid must not be on any cargo list already.
*/
static void
clink_add(struct clink *cl, int type, int uid)
}
/*
- * Remove from CL's cargo list for type TYPE the uid UID.
- * UID must be on that cargo list.
+ * Remove from @cl's cargo list for type @type the UID @uid.
+ * @uid must be on that cargo list.
*/
static void
clink_rem(struct clink *cl, int type, int uid)
}
/*
- * Update cargo lists for a change of CARGO's carrier.
- * Carrier is of type TYPE, and changes from uid OLD to NEW.
- * Negative uids mean no carrier.
+ * Update cargo lists for a change of @cargo's carrier.
+ * Carrier is of type @type, and changes from UID @old to @new.
+ * Negative UIDs mean no carrier.
*/
void
unit_carrier_change(struct empobj *cargo, int type, int old, int new)
}
/*
- * Update cargo lists for a change of PP's carrier.
- * Carrier is of type TYPE, and changes from uid OLD to NEW.
- * Negative uids mean no carrier.
+ * Update cargo lists for a change of @pp's carrier.
+ * Carrier is of type @type, and changes from UID @old to @new.
+ * Negative UIDs mean no carrier.
*/
void
pln_carrier_change(struct plnstr *pp, int type, int old, int new)
}
/*
- * Update cargo lists for a change of LP's carrier.
- * Carrier is of type TYPE, and changes from uid OLD to NEW.
- * Negative uids mean no carrier.
+ * Update cargo lists for a change of @lp's carrier.
+ * Carrier is of type @type, and changes from UID @old to @new.
+ * Negative UIDs mean no carrier.
*/
void
lnd_carrier_change(struct lndstr *lp, int type, int old, int new)
}
/*
- * Update cargo lists for a change of NP's carrier.
- * Carrier is of type TYPE, and changes from uid OLD to NEW.
- * Negative uids mean no carrier.
+ * Update cargo lists for a change of @np's carrier.
+ * Carrier is of type @type, and changes from UID @old to @new.
+ * Negative UIDs mean no carrier.
*/
void
nuk_carrier_change(struct nukstr *np, int type, int old, int new)
}
/*
- * Resize clink[TYPE] to match ef_nelem(TYPE).
+ * Resize clink[@type] to match ef_nelem(@type).
* Return 0 on success, -1 on error.
* This is the struct empfile onresize callback for units.
*/
}
/*
- * Find first unit on a carrier's cargo list for file type CARGO_TYPE.
- * Search carrier UID of type TYPE.
- * Return first unit's uid, or -1 if the carrier isn't carrying such
+ * Find first unit on a carrier's cargo list for file type @cargo_type.
+ * Search carrier @uid of type @type.
+ * Return first unit's UID, or -1 if the carrier isn't carrying such
* units.
*/
int
}
/*
- * Find the next unit on a cargo list for file type CARGO_TYPE.
- * Get the unit after CARGO_UID.
- * Return its uid, or -1 if there are no more on this list.
+ * Find the next unit on a cargo list for file type @cargo_type.
+ * Get the unit after @cargo_uid.
+ * Return its UID, or -1 if there are no more on this list.
*/
int
unit_cargo_next(int cargo_type, int cargo_uid)
}
/*
- * If SP carries planes, return the uid of the first one, else -1.
+ * If @sp carries planes, return the UID of the first one, else -1.
*/
int
pln_first_on_ship(struct shpstr *sp)
}
/*
- * If LP carries planes, return the uid of the first one, else -1.
+ * If @lp carries planes, return the UID of the first one, else -1.
*/
int
pln_first_on_land(struct lndstr *lp)
}
/*
- * Find the next plane on the same carrier as plane#UID.
- * Return its uid, or -1 if there are no more.
+ * Find the next plane on the same carrier as plane#@uid.
+ * Return its UID, or -1 if there are no more.
*/
int
pln_next_on_unit(int uid)
}
/*
- * If SP carries land units, return the uid of the first one, else -1.
+ * If @sp carries land units, return the UID of the first one, else -1.
*/
int
lnd_first_on_ship(struct shpstr *sp)
}
/*
- * If SP carries land units, return the uid of the first one, else -1.
+ * If @lp carries land units, return the UID of the first one, else -1.
*/
int
lnd_first_on_land(struct lndstr *lp)
}
/*
- * Find the next land unit on the same carrier as land#UID.
- * Return its uid, or -1 if there are no more.
+ * Find the next land unit on the same carrier as land#@uid.
+ * Return its UID, or -1 if there are no more.
*/
int
lnd_next_on_unit(int uid)
}
/*
- * If PP carries a nuke, return its uid, else -1.
+ * If @pp carries a nuke, return its UID, else -1.
*/
int
nuk_on_plane(struct plnstr *pp)
}
/*
- * Return length of a carrier's cargo list for file type CARGO_TYPE.
+ * Return length of a carrier's cargo list for file type @cargo_type.
+ * Use carrier @uid of type @type.
*/
int
unit_cargo_count(int type, int uid, int cargo_type)
}
/*
- * Return number of land units loaded on SP.
+ * Return number of land units loaded on @sp.
*/
int
shp_nland(struct shpstr *sp)
}
/*
- * Return number of land units loaded on LP.
+ * Return number of land units loaded on @lp.
*/
int
lnd_nland(struct lndstr *lp)
projects / empserver / blobdiff