Documentation polishing.

[open-adventure.git] / advent.h

diff --git a/advent.h b/advent.h
index 35dd8e0feb9f885c6e82a3d4b2f4d03b959ac3c7..e638e8424eb8d743f08dc6e45c6d971cad59436a 100644 (file)
--- a/advent.h
+++ b/advent.h
@@ -54,17 +54,23 @@
 #define OUTSID(LOC)  (CNDBIT(LOC, COND_ABOVE) || FOREST(LOC))
 #define INDEEP(LOC)  ((LOC) >= LOC_MISTHALL && !OUTSID(LOC))
 #define BUG(x)       bug(x, #x)
+#define MOTION_WORD(n)  ((n) + 0)
+#define OBJECT_WORD(n)  ((n) + 1000)
+#define ACTION_WORD(n)  ((n) + 2000)
+#define SPECIAL_WORD(n) ((n) + 3000)
+#define PROMOTE_WORD(n) ((n) + 1000)
+#define DEMOTE_WORD(n)  ((n) - 1000)
 
 enum bugtype {
-   SPECIAL_TRAVEL_500_GT_L_GT_300_EXCEEDS_GOTO_LIST,
-   VOCABULARY_TYPE_N_OVER_1000_NOT_BETWEEN_0_AND_3,
-   INTRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,
-   TRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,
-   CONDITIONAL_TRAVEL_ENTRY_WITH_NO_ALTERATION,
-   LOCATION_HAS_NO_TRAVEL_ENTRIES,
-   HINT_NUMBER_EXCEEDS_GOTO_LIST,
-   SPEECHPART_NOT_TRANSITIVE_OR_INTRANSITIVE_OR_UNKNOWN,
-   ACTION_RETURNED_PHASE_CODE_BEYOND_END_OF_SWITCH,
+    SPECIAL_TRAVEL_500_GT_L_GT_300_EXCEEDS_GOTO_LIST,
+    VOCABULARY_TYPE_N_OVER_1000_NOT_BETWEEN_0_AND_3,
+    INTRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,
+    TRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,
+    CONDITIONAL_TRAVEL_ENTRY_WITH_NO_ALTERATION,
+    LOCATION_HAS_NO_TRAVEL_ENTRIES,
+    HINT_NUMBER_EXCEEDS_GOTO_LIST,
+    SPEECHPART_NOT_TRANSITIVE_OR_INTRANSITIVE_OR_UNKNOWN,
+    ACTION_RETURNED_PHASE_CODE_BEYOND_END_OF_SWITCH,
 };
 
 enum speaktype {touch, look, hear, study, change};
@@ -78,19 +84,19 @@ enum speechpart {unknown, intransitive, transitive};
  * The values don't matter, but perturb their order at your peril.
  */
 enum phase_codes {
-  GO_TERMINATE,
-  GO_MOVE,
-  GO_TOP,
-  GO_CLEAROBJ,
-  GO_CHECKHINT,
-  GO_CHECKFOO,
-  GO_DIRECTION,
-  GO_LOOKUP,
-  GO_WORD2,
-  GO_SPECIALS,
-  GO_UNKNOWN,
-  GO_ACTION,
-  GO_DWARFWAKE,
+    GO_TERMINATE,
+    GO_MOVE,
+    GO_TOP,
+    GO_CLEAROBJ,
+    GO_CHECKHINT,
+    GO_CHECKFOO,
+    GO_DIRECTION,
+    GO_LOOKUP,
+    GO_WORD2,
+    GO_SPECIALS,
+    GO_UNKNOWN,
+    GO_ACTION,
+    GO_DWARFWAKE,
 };
 
 typedef long token_t;  // word token - someday this will be char[TOKLEN+1]
@@ -110,7 +116,15 @@ struct game_t {
     bool closng;                 // whether it's closing time yet
     long conds;                  // min value for cond(loc) if loc has any hints
     long detail;
+
+    /*  dflag controls the level of activation of dwarves:
+     * 0       No dwarf stuff yet (wait until reaches Hall Of Mists)
+     * 1       Reached Hall Of Mists, but hasn't met first dwarf
+     * 2       Met first dwarf, others start moving, no knives thrown yet
+     * 3       A knife has been thrown (first set always misses)
+     * 3+      Dwarves are mad (increases their accuracy) */
     long dflag;
+
     long dkill;
     long dtotal;
     long foobar;                 // current progress in saying "FEE FIE FOE FOO".
@@ -136,16 +150,16 @@ struct game_t {
     bool wzdark;                 // whether the loc he's leaving was dark
     char zzword[6];              // randomly generated magic word from bird
     bool blooded;                // has player drunk of dragon's blood?
-    long abbrev[NLOCATIONS + 1]; 
+    long abbrev[NLOCATIONS + 1];
     long atloc[NLOCATIONS + 1];
-    long dseen[NDWARVES + 1];
-    long dloc[NDWARVES + 1];
-    long odloc[NDWARVES + 1];
+    long dseen[NDWARVES + 1];    // true if dwarf has seen him
+    long dloc[NDWARVES + 1];     // location of dwarves, initially hard-wired in
+    long odloc[NDWARVES + 1];    // prior loc of each dwarf, initially garbage
     long fixed[NOBJECTS + 1];
     long link[NOBJECTS * 2 + 1];
     long place[NOBJECTS + 1];
-    long hinted[NHINTS];
-    long hintlc[NHINTS];
+    long hinted[NHINTS];         // hintlc[i] is how long he's been at LOC with cond bit i
+    long hintlc[NHINTS];         // hinted[i] is true iff hint i has been used.
     long prop[NOBJECTS + 1];
 };
 
@@ -159,7 +173,7 @@ struct command_t {
 
 extern struct game_t game;
 extern FILE *logfp;
-extern bool oldstyle, editline, prompt;
+extern bool oldstyle, prompt;
 
 extern char* xstrdup(const char* s);
 extern void* xmalloc(size_t size);
@@ -202,7 +216,7 @@ extern int savefile(FILE *, long);
 extern int suspend(void);
 extern int resume(void);
 extern int restore(FILE *);
-extern void initialise(void);
+extern long initialise(void);
 extern int action(struct command_t *command);
 
 /* Alas, declaring this static confuses the coverage analyzer */