Added help for @invformat
authorAri Johnson <ari@cobramush.org>
Wed, 21 Feb 2007 00:33:01 +0000 (00:33 +0000)
committerAri Johnson <ari@cobramush.org>
Wed, 21 Feb 2007 00:33:01 +0000 (00:33 +0000)
game/txt/hlp/cobra_cmd.hlp

index 0867a2281b29baa372efe9df1718de7d24dbb076..884c36b02869567666d2afbc0120513fd8599c76 100644 (file)
@@ -699,6 +699,19 @@ See also: @create
   for example. More complex things are, obviously, possible.
  
   See also: @exitformat, @nameformat, @descformat
+& @invformat
+  @invformat <object> [=<format>]
+
+  Replaces the usual "You are carrying:" format when an object uses the
+  "inventory" command, by a player-specified format. This is evaluated
+  as if it were a description or other similar message on the object.
+  The objects carried are passed as a dbref list in %0.
+
+  One could change the format to 'You've got: Object1 Object2 Object3'
+  through '@invformat me = You've got: [iter(%0,name(##))]',
+  for example. More complex things are, obviously, possible.
+
+  See also: inventory
 & @descformat
   @descformat <object> [=<text>]