* citadel.rc: changed the default for local_screen_dimensions to 1, since

[citadel.git] / citadel / techdoc / citadelapi.txt

diff --git a/citadel/techdoc/citadelapi.txt b/citadel/techdoc/citadelapi.txt
index db57448144ccfa697e796d6e0a3f786798a9f6ca..2a810bff14046023aa7a39a297a561e0474ce553 100644 (file)
--- a/citadel/techdoc/citadelapi.txt
+++ b/citadel/techdoc/citadelapi.txt
@@ -178,7 +178,8 @@ contain:
 unsigned create_room(char *new_room_name,
                      int new_room_type,
                      char *new_room_pass,
-                     int new_room_floor)
+                     int new_room_floor,
+                    int really_create)
 
  This function is used to create a new room.  new_room_name should be set to
 the desired name for the new room.  new_room_type should be set to 0 for a
@@ -188,6 +189,10 @@ a type 2 (passworded) room, new_room_pass should be set to the desired
 password.  new_room_floor should be set to the number of the floor upon which
 the new room should reside.
  
+ If the room is really to be created, set really_create to 1.  Otherwise, the
+caller may merely check to see if it's possible to create the room without
+actually creating it by setting really_create to 0.
+ 
  create_room() returns the flags associated with the new room (as in the
 data structure item quickroom.QRflags).  If the room cannot be created (for
 example, a room with the name already exists), it returns 0.