[agd-cvs] server/doc/dfuns asctime,1.3,1.4 atoi,1.1,1.2 capitalize,1.1,1.2 clone_object,1.1,1.2 destruct,1.1,1.2 find_object,1.1,1.2 input_to,1.1,1.2 interactivep,1.1,1.2 load_object,1.1,1.2 lower_case,1.1,1.2 read_file,1.1,1.2

[Peep P. <so...@us...>]

Update of /cvsroot/agd/server/doc/dfuns
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8730

Modified Files:
	asctime atoi capitalize clone_object destruct find_object 
	input_to interactivep load_object lower_case read_file 
Log Message:
Wrote and changed some documentation.

Index: interactivep
===================================================================
RCS file: /cvsroot/agd/server/doc/dfuns/interactivep,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- interactivep	15 Mar 2004 18:40:19 -0000	1.1
+++ interactivep	28 Mar 2004 18:42:29 -0000	1.2
@@ -0,0 +1,5 @@
+int interactivep(object)
+
+Returns 1 if the object is interactive and can receive text, and 0 otherwise.
+This dfun's name is subject to change. Any ideas about the new name?
+Send to agd...@li....

Index: find_object
===================================================================
RCS file: /cvsroot/agd/server/doc/dfuns/find_object,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- find_object	15 Mar 2004 18:40:19 -0000	1.1
+++ find_object	28 Mar 2004 18:42:29 -0000	1.2
@@ -0,0 +1,7 @@
+object find_object(string) - find an object by file name
+
+Loops through all existing objects, and returns the one whose file
+name matches the argument.
+
+See also
+ destruct, load_object, clone_object

Index: load_object
===================================================================
RCS file: /cvsroot/agd/server/doc/dfuns/load_object,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- load_object	15 Mar 2004 18:40:19 -0000	1.1
+++ load_object	28 Mar 2004 18:42:29 -0000	1.2
@@ -0,0 +1,8 @@
+object load_object(string)
+
+Tries to load object from path as given by argument. If the object already
+exists, it's code will be recompiled; if it succeeds, the code for the object
+will be updated, otherwise nothing is changed.
+
+See also
+ clone_object, destruct, find_object

Index: lower_case
===================================================================
RCS file: /cvsroot/agd/server/doc/dfuns/lower_case,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- lower_case	19 Mar 2004 14:53:46 -0000	1.1
+++ lower_case	28 Mar 2004 18:42:29 -0000	1.2
@@ -1,3 +1,6 @@
 string lower_case(string)
 
 Returns the lower_case version of the string. Original will not be changed.
+
+See also
+ capitalize

Index: destruct
===================================================================
RCS file: /cvsroot/agd/server/doc/dfuns/destruct,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- destruct	15 Mar 2004 18:40:19 -0000	1.1
+++ destruct	28 Mar 2004 18:42:29 -0000	1.2
@@ -1,3 +1,7 @@
 void destruct(object ob)
 
-Marks the object for destruction. It will be removed from memory after all call_outs have finished.
+Marks the object for destruction. It will be removed from memory after all
+functions calls have finished.
+
+See also
+ clone_object, load_object, find_object

Index: atoi
===================================================================
RCS file: /cvsroot/agd/server/doc/dfuns/atoi,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- atoi	28 Mar 2004 17:56:16 -0000	1.1
+++ atoi	28 Mar 2004 18:42:29 -0000	1.2
@@ -0,0 +1,4 @@
+int atoi(string)
+
+Converts a string into an integer. If the string doesn't contain any
+numeric parts, 0 is returned.

Index: read_file
===================================================================
RCS file: /cvsroot/agd/server/doc/dfuns/read_file,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- read_file	28 Mar 2004 17:56:16 -0000	1.1
+++ read_file	28 Mar 2004 18:42:29 -0000	1.2
@@ -0,0 +1,3 @@
+string read_file(string path)
+
+Reads in the file give by path and returns the full contents.

Index: asctime
===================================================================
RCS file: /cvsroot/agd/server/doc/dfuns/asctime,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- asctime	28 Mar 2004 17:56:16 -0000	1.3
+++ asctime	28 Mar 2004 18:42:29 -0000	1.4
@@ -0,0 +1,7 @@
+string asctime(int)
+
+Takes the integer as time from Epoch, and returns current date as a string
+based on that.
+
+See also:
+ time, strftime

Index: input_to
===================================================================
RCS file: /cvsroot/agd/server/doc/dfuns/input_to,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- input_to	15 Mar 2004 18:40:19 -0000	1.1
+++ input_to	28 Mar 2004 18:42:29 -0000	1.2
@@ -0,0 +1,6 @@
+void input_to(string) - sets the input callback
+
+Sets the argument string as the function to be called if something
+is read from the player. Note that the callback is reset after the
+function is called once, so input_to must be called again if it's
+needed.

Index: clone_object
===================================================================
RCS file: /cvsroot/agd/server/doc/dfuns/clone_object,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- clone_object	15 Mar 2004 18:40:19 -0000	1.1
+++ clone_object	28 Mar 2004 18:42:29 -0000	1.2
@@ -1,3 +1,8 @@
 object clone_object(string|object ob)
 
-Clones the object ob and returns the new object.
+Clones the object ob and returns the new object. The new object
+will share the same code as the master object, it will only have it's
+own set of global variables.
+
+See also
+ load_object, find_object, destruct

Index: capitalize
===================================================================
RCS file: /cvsroot/agd/server/doc/dfuns/capitalize,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- capitalize	19 Mar 2004 14:53:46 -0000	1.1
+++ capitalize	28 Mar 2004 18:42:29 -0000	1.2
@@ -1,3 +1,7 @@
 string capitalize(string)
 
-Returns the string with the first character in upper case. Does not change the original.
+Returns the a copy of the string, with the first character changed
+to upper case. Does not modify the original.
+
+See also
+ lower_case