Update documentation for atrlock()
authorAri Johnson <ari@theari.com>
Tue, 12 Apr 2011 22:42:18 +0000 (18:42 -0400)
committerAri Johnson <ari@theari.com>
Tue, 12 Apr 2011 22:42:18 +0000 (18:42 -0400)
fixes #23

game/txt/hlp/cobra_func.hlp

index 36886f8e7271bde0322a456ce103695268bbf259..dddf948b6c578d7febb97460bb9cd550c4339166 100644 (file)
 
   See HELP CTU() for more on the angle type.
 & ATRLOCK()
-  atrlock(<object>/<attrib>[, <on|off>])
+  atrlock(<object>/<attrib>[, <boolexp>])
 
   When given a single object/attribute pair as an argument, returns 1
   if the attribute is locked, 0 if unlocked, and #-1 if the attribute
   doesn't exist or can't be read by the function's caller.
 
-  When given a second argument of "on" (or "off"), attempts to lock
-  (unlock) the specified attribute, as per @atrlock.
+  When given a second argument, set the readlock on the attribute to the
+  given boolexp.
 & ATRMODTIME()
   atrmodtime(<object>/<attrib>)