Add Verbs and Actions
authorJason Self <j@jxself.org>
Sun, 2 Jun 2019 16:31:43 +0000 (09:31 -0700)
committerJason Self <j@jxself.org>
Sun, 2 Jun 2019 16:31:43 +0000 (09:31 -0700)
informqr/informqr.md

index 40a9fadb490523c262f647afef6d9aaa6b836287..490805c78ad3b363cad486536ac0a46135c637e5 100644 (file)
@@ -520,4 +520,61 @@ To assign to one of 32 'low string' variables:
 
     string N "string";
     Lowstring string_var "string";
-    string N string_var;
\ No newline at end of file
+    string N string_var;
+
+Verbs and Actions
+-----------------
+
+To specify a new verb:
+
+    Verb 'verb ' 'verb ' ... 'verb '
+         * token token ... token -> action
+         * token token ... token -> action
+         ...
+         * token token ... token -> action;
+
+where instead "`Verb`" can be "`Verb meta`", "*action*" can be
+"`action reverse`"; *tokens* are optional and each is one of:
+
+  ----------------- ----------------------------------------------
+  'word'            that literal word
+  'w1'/'w2'/...     any one of those literal words
+  attribute         an object with that attribute
+  creature          an object with `animate` attribute
+  held              an object held by the player
+  noun              an object in scope
+  noun=`routine`    an object for which *routine* returns `true`
+  scope=`routine`   an object in this re-definition of scope
+  multiheld         one or more objects held by the player
+  multi             one or more objects in scope
+  multiexcept       as multi, omitting the specified object
+  multiinside       as multi, omitting those in specified object
+  topic             any text
+  number            any number
+  routine           a general parsing routine
+  ----------------- ----------------------------------------------
+
+To add synonyms to an existing verb:
+
+    Verb 'verb ' 'verb ' ... = 'existing_verb';
+
+To modify an existing verb:
+
+    Extend 'existing_verb ' last
+         * token token ... token –> action
+         * token token ... token –> action
+         ...
+         * token token ... token –> action ;
+
+where instead "`Extend`" can be "`Extend only`" and "`last`" can be
+omitted, or changed to "`first`" or "`replace`"
+
+To explicitly trigger a defined action (both *noun* and *second* are
+optional, depending on the action):
+
+    <action noun second>;
+
+To explicitly trigger a defined action, then return `true` from the
+current routine:
+
+    <<action noun second >>;
\ No newline at end of file