Add User-defined constants
authorJason Self <j@jxself.org>
Sun, 2 Jun 2019 22:43:04 +0000 (15:43 -0700)
committerJason Self <j@jxself.org>
Sun, 2 Jun 2019 22:43:04 +0000 (15:43 -0700)
inflibqr/inflibqr.md

index 67fdb4e8a262d6b9b0a488a471491864e2fa8b65..3735567affae10c58f6844163ecc7da9927eb03b 100644 (file)
@@ -47,4 +47,53 @@ Library constants
 
 In addition to the standard constants `true` (1), `false` (0) and
 `nothing` (0), the Library defines `NULL` (-1) for an action, property
 
 In addition to the standard constants `true` (1), `false` (0) and
 `nothing` (0), the Library defines `NULL` (-1) for an action, property
-or pronoun whose current value is undefined.
\ No newline at end of file
+or pronoun whose current value is undefined.
+
+User-defined constants
+----------------------
+
+Some constants control features rather than represent values.
+
+AMUSING_PROVIDED - Activates the `Amusing` entry_point.
+
+DEATH_MENTION_UNDO - Offers "UNDO the last move" when the game is
+over.
+
+DEBUG - Activates the debug commands.
+
+Headline = "*string*" - **Mandatory**: the game style, copyright
+information, etc.
+
+MANUAL_PRONOUNS - Pronouns reflect only objects mentioned by the
+player.
+
+MAX_CARRIED = *expr* - Maximum number of direct possessions that the
+player can carry (default 100).
+
+MAX_SCORE = *expr* - Maximum game score (default 0).
+
+MAX_TIMERS = *expr* - Maximum number of active timers/daemons
+(default 32).
+
+NO_PLACES - The "`OBJECTS`" and "`PLACES`" verbs are not allowed.
+
+NUMBER_TASKS = *expr* - Number of `scored` tasks to be performed
+(default 1).
+
+OBJECT_SCORE = *expr* - For taking a `scored` object for the first
+time (default 4).
+
+ROOM_SCORE = *expr* - For visiting a `scored` room for the first time
+(default 5).
+
+SACK_OBJECT = *object* - A `container` object where the game places
+held objects.
+
+Story = "*string*" - **Mandatory**: the name of the story.
+
+TASKS_PROVIDED - Activates the task scoring system.
+
+USE_MODULES - Activates linking with pre-compiled library modules.
+
+WITHOUT_DIRECTIONS - De-activates standard compass directions (bar
+"IN" and "OUT"). Place alternative directions in the compass.
\ No newline at end of file