Update help file for @atrlock
authorAri Johnson <ari@theari.com>
Wed, 4 May 2011 14:56:14 +0000 (10:56 -0400)
committerAri Johnson <ari@theari.com>
Wed, 4 May 2011 14:56:14 +0000 (10:56 -0400)
fixes #29

game/txt/hlp/cobra_cmd.hlp

index 93af3918815f2f12f9f420faf386a1d6f4faf072..7071aea1ae0bcd26ef7c89bd207a374a5a869c7f 100644 (file)
@@ -355,16 +355,17 @@ See also: @tel, ACTION LISTS
 See also: @atrlock, ATTRIBUTES, NON-STANDARD ATTRIBUTES
 
 & @atrlock
-  @atrlock[/read/write] <object>/<attribute> = <key>.
+  @atrlock[/write] <object>/<attribute> = <key>
 
-  Locks an attribute's read or write lock to a specified 
-  'lock key'.
-
-  TODO: Detailed Explanations on Read & Write Locks.
+  Lock the specified attribute to the given key, which should be a normal
+  boolexp suitable for using with @lock.  If the /write switch is given, then
+  set the write-lock on the attribute.  Otherwise, set the read-lock.  If no
+  key is given, then the lock will be cleared.
 
+  An object that passes the read-lock can read the attribute's value.  An
+  object that passes the write-lock can set the attribute's value.
 
 See also: @atrchown, ATTRIBUTES, NON-STANDARD ATTRIBUTES, LOCKING
-
 & @asuccess
   @asuccess <object> = <action list>