Some docstrings on gameobj

[mudsync.git] / mudsync / gameobj.scm

diff --git a/mudsync/gameobj.scm b/mudsync/gameobj.scm
index bb4c8520628ba0a0b4dcb56f9babfb86564b9a64..1d120072380ad17d49b276c016beba8a729ace47 100644 (file)
--- a/mudsync/gameobj.scm
+++ b/mudsync/gameobj.scm
@@ -61,11 +61,11 @@
 (define-class <gameobj> (<actor>)
   ;; location id
   (loc #:init-value #f
-       #:accessor gameobj-loc)
+       #:getter gameobj-loc)
   
   ;; Uses a hash table like a set (values ignored)
   (occupants #:init-thunk make-hash-table
-             #:accessor gameobj-occupants)
+             #:getter gameobj-occupants)
 
   ;; game master id
   (gm #:init-keyword #:gm
@@ -133,6 +133,7 @@
    commands))
 
 (define-mhandler (gameobj-get-commands actor message verb)
+  "Get commands a co-occupant of the room might execute for VERB"
   (define filtered-commands
     (filter-commands (val-or-run (slot-ref actor 'commands))
                      verb))
@@ -141,19 +142,23 @@
            #:goes-by (gameobj-goes-by actor)))
 
 (define-mhandler (gameobj-get-container-commands actor message verb)
+  "Get commands as the container / room of message's sender"
   (define filtered-commands
     (filter-commands (val-or-run (slot-ref actor 'container-commands))
                      verb))
   (<-reply actor message #:commands filtered-commands))
 
 (define-mhandler (gameobj-add-occupant! actor message who)
+  "Add an actor to our list of present occupants"
   (hash-set! (slot-ref actor 'occupants)
              who #t))
 
 (define-mhandler (gameobj-remove-occupant! actor message who)
+  "Remove an occupant from the room."
   (hash-remove! (slot-ref actor 'occupants) who))
 
 (define-mhandler (gameobj-get-occupants actor message)
+  "Get all present occupants of the room."
   (define occupants
     (hash-map->list (lambda (key val) key)
                     (gameobj-occupants actor)))
@@ -163,11 +168,12 @@
 
 ;; @@: Should it really be #:id ?  Maybe #:loc-id or #:loc?
 (define-mhandler (gameobj-set-loc! actor message loc)
+  "Set the location of this object."
   (define old-loc (gameobj-loc actor))
   (format #t "DEBUG: Location set to ~s for ~s\n"
           loc (actor-id-actor actor))
 
-  (set! (gameobj-loc actor) loc)
+  (slot-set! actor 'loc loc)
   ;; Change registation of where we currently are
   (if loc
       (<-wait actor loc 'add-occupant! #:who (actor-id actor)))