From: Ari Johnson <ari@theari.com>
Date: Wed, 4 May 2011 14:56:14 +0000 (-0400)
Subject: Update help file for @atrlock
X-Git-Url: https://git.theari.com/?a=commitdiff_plain;h=4218719d77ad1f9a56810838b1c9b1016edbaa7f;p=cobramush.git

Update help file for @atrlock

fixes #29
---

diff --git a/game/txt/hlp/cobra_cmd.hlp b/game/txt/hlp/cobra_cmd.hlp
index 374657a..c686239 100644
--- a/game/txt/hlp/cobra_cmd.hlp
+++ b/game/txt/hlp/cobra_cmd.hlp
@@ -359,16 +359,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>