props subsystem
[mudsync.git] / mudsync / gameobj.scm
index 64c79f1397b67e34175dd6d6798261401786b49c..6011be2fccc1d07ecf2004f8b7c26c08f89e8359 100644 (file)
@@ -43,6 +43,7 @@
             slot-ref-maybe-runcheck
             val-or-run
 
+            build-props
             dyn-ref
 
             ;; Some of the more common commands
@@ -52,6 +53,7 @@
 ;;; Gameobj
 ;;; =======
 
+(define build-props build-rmeta-slot)
 
 ;;; *all* game components that talk to players should somehow
 ;;; derive from this class.
@@ -78,6 +80,7 @@
   (desc #:init-value #f
         #:init-keyword #:desc)
 
+  ;; @@: Maybe commands should be renamed to verbs, I dunno
   ;; Commands we can handle
   (commands #:allocation #:each-subclass
             #:init-thunk (build-commands
                                                       '("in" "inside" "on"))))))
 
   ;; Commands we can handle by being something's container
-  (container-commands #:allocation #:each-subclass
-                      #:init-thunk (build-commands))
+  ;;   dominant version (goes before everything)
+  (container-dom-commands #:allocation #:each-subclass
+                          #:init-thunk (build-commands))
+  ;;   subordinate version (goes after everything)
+  (container-sub-commands #:allocation #:each-subclass
+                          #:init-thunk (build-commands))
 
   ;; Commands we can handle by being contained by something else
   (contained-commands #:allocation #:each-subclass
                       (build-commands
                        ("drop" ((direct-command cmd-drop #:obvious? #f)))))
 
+  ;; The extremely squishy concept of "props"... properties!
+  ;; These are flags, etc etc of various types.  This is a hashq table.
+  ;; These have upsides and downsides, but the big upside is that you can
+  ;; query a "prop" of a prospective gameobj without knowing what type of
+  ;; gameobj that is, and not fear some kind of breakage.
+  ;;
+  ;; props by default only have a 'get-prop read-only action handler;
+  ;; any coordination of setting a prop between actors must be
+  ;; added to that actor, to keep things from getting out of control.
+  (props #:init-thunk make-hash-table
+         #:init-keyword #:props)
+  ;; gameobjs may inherit an initial list of these via the
+  ;; initial-props slot, which must always have its
+  ;; #:allocation #:each-subclass and use (build-props) for the
+  ;; #:init-thunk.
+  ;; The vanilla gameobj has no props, on purpose.
+  (initial-props #:allocation #:each-subclass
+                 #:init-thunk (build-props '()))
+
   ;; Most objects are generally visible by default
   (invisible? #:init-value #f
               #:init-keyword #:invisible?)
             ;; Commands for co-occupants
             (get-commands gameobj-get-commands)
             ;; Commands for participants in a room
-            (get-container-commands gameobj-get-container-commands)
+            (get-container-dom-commands gameobj-get-container-dom-commands)
+            (get-container-sub-commands gameobj-get-container-sub-commands)
             ;; Commands for inventory items, etc (occupants of the gameobj commanding)
             (get-contained-commands gameobj-get-contained-commands)
 
             (get-name gameobj-get-name)
             (set-name! gameobj-act-set-name!)
             (get-desc gameobj-get-desc)
+            (get-prop gameobj-act-get-prop)
             (goes-by gameobj-act-goes-by)
             (visible-name gameobj-visible-name)
             (self-destruct gameobj-act-self-destruct)
          (replace-step actor occupants))
        replace-steps))))
 
-;; @@: This could be kind of a messy way of doing gameobj-act-init
-;;   stuff.  If only we had generic methods :(
+(define (gameobj-setup-props gameobj)
+  (define class (class-of gameobj))
+  (define props (slot-ref gameobj 'props))
+  (maybe-build-rmeta-slot-cache! class 'initial-props
+                                 eq? hashq-set! hashq-ref)
+  ;; Kind of a kludge... we read through the rmeta-slot-cache
+  ;; and use that to build up the table
+  (hash-for-each
+   (lambda (key value)
+     (when (not (hashq-ref props key value)) ; don't override init'ed instance values
+       (hashq-set! props key value)))
+   (rmeta-slot-cache (class-slot-ref class 'initial-props))))
+
+;; TODO: Use the *init* action?
+;;   We could also use a generic method if they didn't have
+;;   what I'm pretty sure is O(n) dispatch in GOOPS...
 (define* (gameobj-act-init actor message #:key replace)
-  "Your most basic game object init procedure.
-Assists in its replacement of occupants if necessary and nothing else."
+  "Your most basic game object init procedure."
+  (gameobj-setup-props actor)
   (run-replacement actor replace gameobj-replace-steps*))
 
+(define* (gameobj-get-prop gameobj key #:optional dflt)
+  (hashq-ref (slot-ref gameobj 'props) key dflt))
+
+(define* (gameobj-set-prop! gameobj key val)
+  (hashq-set! (slot-ref gameobj 'props) key val))
+
+(define* (gameobj-act-get-prop actor message key #:optional dflt)
+  (gameobj-get-prop actor key dflt))
+
 (define (gameobj-goes-by gameobj)
   "Find the name we go by.  Defaults to #:name if nothing else provided."
   (cond ((slot-ref gameobj 'goes-by) =>
@@ -224,10 +275,16 @@ Assists in its replacement of occupants if necessary and nothing else."
            #:commands candidate-commands
            #:goes-by (gameobj-goes-by actor)))
 
-(define* (gameobj-get-container-commands actor message #:key verb)
-  "Get commands as the container / room of message's sender"
+(define* (gameobj-get-container-dom-commands actor message #:key verb)
+  "Get (dominant) commands as the container / room of message's sender"
   (define candidate-commands
-    (get-candidate-commands actor 'container-commands verb))
+    (get-candidate-commands actor 'container-dom-commands verb))
+  (<-reply message #:commands candidate-commands))
+
+(define* (gameobj-get-container-sub-commands actor message #:key verb)
+  "Get (subordinate) commands as the container / room of message's sender"
+  (define candidate-commands
+    (get-candidate-commands actor 'container-sub-commands verb))
   (<-reply message #:commands candidate-commands))
 
 (define* (gameobj-get-contained-commands actor message #:key verb)
@@ -308,13 +365,15 @@ and whos-asking, and see if we should just return it or run it."
 (define* (gameobj-act-set-name! actor message val)
   (slot-set! actor 'name val))
 
+(define* (gameobj-desc actor #:key whos-looking)
+  (match (slot-ref actor 'desc)
+    ((? procedure? desc-proc)
+     (desc-proc actor whos-looking))
+    (desc desc)))
+
 (define* (gameobj-get-desc actor message #:key whos-looking)
-  (define desc-text
-    (match (slot-ref actor 'desc)
-      ((? procedure? desc-proc)
-       (desc-proc actor whos-looking))
-      (desc desc)))
-  (<-reply message desc-text))
+  "This is the action equivalent of the gameobj-desc getter"
+  (<-reply message (gameobj-desc actor #:whos-looking whos-looking)))
 
 (define (gameobj-visible-to-player? gameobj whos-looking)
   "Check to see whether we're visible to the player or not.