obj.h - expand documentation of obj->spe uses

Started out adding spe==2 for eggs but ended up changing other
things too.

FIXME?  The line "special for uball and amulet" baffles me:

    uball->spe is set to 1 during punishment (with an ambiguous
comment "special ball (see save)"), and back to 0 afterwards, but
otherwise seems to be unused.

    "and amulet" is ambiguous; it should either be "and the Amulet"
or "and amulets".  I assume it probably referred to the former but
it doesn't seem to be used for either kind as far as I can tell.
This commit is contained in:
PatR
2021-01-07 14:02:52 -08:00
parent bcf49b85c3
commit d625fca828

View File

@@ -1,4 +1,4 @@
/* NetHack 3.7 obj.h $NHDT-Date: 1604620981 2020/11/06 00:03:01 $ $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.79 $ */
/* NetHack 3.7 obj.h $NHDT-Date: 1610056944 2021/01/07 22:02:24 $ $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.83 $ */
/* Copyright (c) Stichting Mathematisch Centrum, Amsterdam, 1985. */
/*-Copyright (c) Michael Allison, 2006. */
/* NetHack may be freely redistributed. See license for details. */
@@ -42,13 +42,15 @@ struct obj {
#define SPE_LIM 99 /* abs(obj->spe) <= 99, cap for enchanted and charged
* objects (and others; named fruit index excepted) */
schar spe; /* quality of weapon, weptool, armor or ring (+ or -);
schar spe; /* quality of weapon, weptool, armor, or some rings (+ or -);
* number of charges for wand or charged tool ( >= -1 );
* number of candles attached to candelabrum;
* marks your eggs, tin variety and spinach tins;
* candy bar wrapper index;
* number of candles attached to candelabrum (0..7);
* marks spinach tins (1 iff corpsenm==NON_PM);
* marks tin variety (various: homemade, stir fried, &c);
* eggs laid by you (1), eggs upgraded with rojal jelly (2);
* Schroedinger's Box (1) or royal coffers for a court (2);
* tells which fruit a fruit is;
* named fruit index;
* candy bar wrapper index;
* special for uball and amulet;
* scroll of mail (normal==0, bones or wishing==1, written==2);
* splash of venom (normal==0, wishing==1);