better take/drop
[mudsync.git] / mudsync / gameobj.scm
index 7abb448db99f608352b70a99b0003539f477e41b..65ddc296262c7d2a767e53db858330170d4aed3d 100644 (file)
@@ -25,6 +25,7 @@
   #:use-module (8sync agenda)
   #:use-module (8sync rmeta-slot)
   #:use-module (srfi srfi-1)
+  #:use-module (ice-9 control)
   #:use-module (ice-9 format)
   #:use-module (ice-9 match)
   #:use-module (oop goops)
             slot-ref-maybe-runcheck
             val-or-run
 
-            dyn-ref))
+            dyn-ref
+
+            ;; Some of the more common commands
+            cmd-take cmd-drop
+            cmd-take-from cmd-put-in))
 
 ;;; Gameobj
 ;;; =======
   ;; Commands we can handle
   (commands #:allocation #:each-subclass
             #:init-thunk (build-commands
-                          ("take" ((direct-command cmd-take #:obvious? #f)))))
+                          ("take" ((direct-command cmd-take)
+                                   (prep-indir-command cmd-take-from
+                                                       '("from" "out of"))))
+                          ("put" ((prep-indir-command cmd-put-in
+                                                      '("in" "inside" "on"))))))
 
   ;; Commands we can handle by being something's container
   (container-commands #:allocation #:each-subclass
                        ("drop" ((direct-command cmd-drop #:obvious? #f)))))
 
   ;; Most objects are generally visible by default
-  (generally-visible #:init-value #t
-                     #:init-keyword #:generally-visible)
-  ;; @@: Would be preferable to be using generic methods for this...
-  ;;   Hopefully we can port this to Guile 2.2 soon...
+  (invisible? #:init-value #f
+              #:init-keyword #:invisible?)
+  ;; TODO: Fold this into a procedure in invisible? similar
+  ;;   to take-me? and etc
   (visible-to-player?
    #:init-value (wrap-apply gameobj-visible-to-player?))
 
-  ;; Can be a boolean or a procedure accepting two arguments
-  ;; (thing-actor whos-acting)
-  (takeable #:init-value #f
-            #:init-keyword #:takeable)
-  ;; Can be a boolean or a procedure accepting two arguments
-  ;; (thing-actor whos-dropping)
-  (dropable #:init-value #t
-            #:init-keyword #:dropable)
+  ;; Can be a boolean or a procedure accepting
+  ;; (gameobj whos-acting #:key from)
+  (take-me? #:init-value #f
+            #:init-keyword #:take-me?)
+  ;; Can be a boolean or a procedure accepting
+  ;; (gameobj whos-acting where)
+  (drop-me? #:init-value #t
+            #:init-keyword #:drop-me?)
+  ;; Can be a boolean or a procedure accepting
+  ;; (gameobj whos-acting take-what)
+  (take-from-me? #:init-value #f
+                 #:init-keyword #:take-from-me?)
+  ;; Can be a boolean or a procedure accepting
+  ;; (gameobj whos-acting put-what)
+  (put-in-me? #:init-value #f
+              #:init-keyword #:put-in-me?)
 
   ;; TODO: Remove this and use actor-alive? instead.
   ;; Set this on self-destruct
             (self-destruct gameobj-act-self-destruct)
             (tell gameobj-tell-no-op)
             (assist-replace gameobj-act-assist-replace)
-            (ok-to-drop-here? (const #t)) ; ok to drop by default
+            (ok-to-drop-here? (lambda (gameobj message . _)
+                                (<-reply message #t))) ; ok to drop by default
+            (ok-to-be-taken-from? gameobj-ok-to-be-taken-from)
+            (ok-to-be-put-in? gameobj-ok-to-be-put-in)
 
             ;; Common commands
             (cmd-take cmd-take)
+            (cmd-take-from cmd-take-from)
+            (cmd-put-in cmd-put-in)
             (cmd-drop cmd-drop))))
 
 
@@ -256,8 +278,7 @@ Assists in its replacement of occupants if necessary and nothing else."
   "Get all present occupants of the room."
   (define occupants
     (gameobj-occupants actor #:exclude exclude))
-
-  (<-reply message #:occupants occupants))
+  (<-reply message occupants))
 
 (define (gameobj-act-get-loc actor message)
   (<-reply message (slot-ref actor 'loc)))
@@ -281,12 +302,12 @@ Assists in its replacement of occupants if necessary and nothing else."
   "Action routine to set the location."
   (gameobj-set-loc! actor loc))
 
-(define (slot-ref-maybe-runcheck gameobj slot whos-asking)
+(define (slot-ref-maybe-runcheck gameobj slot whos-asking . other-args)
   "Do a slot-ref on gameobj, evaluating it including ourselves
 and whos-asking, and see if we should just return it or run it."
   (match (slot-ref gameobj slot)
     ((? procedure? slot-val-proc)
-     (slot-val-proc gameobj whos-asking))
+     (apply slot-val-proc gameobj whos-asking other-args))
     (anything-else anything-else)))
 
 (define gameobj-get-name (simple-slot-getter 'name))
@@ -305,7 +326,7 @@ and whos-asking, and see if we should just return it or run it."
 (define (gameobj-visible-to-player? gameobj whos-looking)
   "Check to see whether we're visible to the player or not.
 By default, this is whether or not the generally-visible flag is set."
-  (slot-ref gameobj 'generally-visible))
+  (not (slot-ref gameobj 'invisible?)))
 
 (define* (gameobj-visible-name actor message #:key whos-looking)
   ;; Are we visible?
@@ -340,22 +361,30 @@ By default, this is whether or not the generally-visible flag is set."
 (define gameobj-tell-no-op
   (const 'no-op))
 
-(define (gameobj-replace-data-occupants actor)
+(define (gameobj-replace-data-occupants gameobj)
   "The general purpose list of replacement data"
   (list #:occupants (hash-map->list (lambda (occupant _) occupant)
-                                    (slot-ref actor 'occupants))))
+                                    (slot-ref gameobj 'occupants))))
 
-(define (gameobj-replace-data* actor)
+(define (gameobj-replace-data* gameobj)
   ;; For now, just call gameobj-replace-data-occupants.
   ;; But there may be more in the future!
-  (gameobj-replace-data-occupants actor))
+  (gameobj-replace-data-occupants gameobj))
 
 ;; So sad that objects must assist in their replacement ;_;
 ;; But that's life in a live hacked game!
-(define (gameobj-act-assist-replace actor message)
+(define (gameobj-act-assist-replace gameobj message)
   "Vanilla method for assisting in self-replacement for live hacking"
   (apply <-reply message
-         (gameobj-replace-data* actor)))
+         (gameobj-replace-data* gameobj)))
+
+(define (gameobj-ok-to-be-taken-from gameobj message whos-acting)
+  (<-reply message (slot-ref-maybe-runcheck gameobj 'take-me?
+                                            whos-acting #:from #t)))
+
+(define (gameobj-ok-to-be-put-in gameobj message whos-acting where)
+  (<-reply message (slot-ref-maybe-runcheck gameobj 'drop-me?
+                                            whos-acting where)))
 
 \f
 ;;; Utilities every gameobj has
@@ -386,7 +415,7 @@ By default, this is whether or not the generally-visible flag is set."
     (mbody-val (<-wait player 'get-loc)))
   (define our-name (slot-ref gameobj 'name))
   (define self-should-take
-    (slot-ref-maybe-runcheck gameobj 'takeable player))
+    (slot-ref-maybe-runcheck gameobj 'take-me? player))
   ;; @@: Is there any reason to allow the room to object in the way
   ;;   that there is for dropping?  It doesn't seem like it.
   ;; TODO: Allow gameobj to customize
@@ -414,9 +443,9 @@ By default, this is whether or not the generally-visible flag is set."
     (mbody-val (<-wait player 'get-loc)))
   (define our-name (slot-ref gameobj 'name))
   (define should-drop
-    (slot-ref-maybe-runcheck gameobj 'dropable player))
+    (slot-ref-maybe-runcheck gameobj 'drop-me? player))
   (define (room-objection-to-drop)
-    (mbody-receive (drop-ok? #:key why-not) ; does the room object to dropping?
+    (mbody-receive (drop-ok? #:key why-not) ; does the room object to dropping?
         (<-wait player-loc 'ok-to-drop-here? player (actor-id gameobj))
       (and (not drop-ok?)
            ;; Either give the specified reason, or give a boilerplate one
@@ -448,3 +477,142 @@ By default, this is whether or not the generally-visible flag is set."
                        player-name
                        our-name)
         #:exclude player))))
+
+;; @@: Moving this to a container subclass/mixin could allow a lot more
+;;   customization of take out / put in phrases
+(define* (cmd-take-from gameobj message
+                        #:key direct-obj indir-obj preposition)
+  (define player (message-from message))
+  (define player-name
+    (mbody-val (<-wait player 'get-name)))
+  (define player-loc
+    (mbody-val (<-wait player 'get-loc)))
+  (define our-name (slot-ref gameobj 'name))
+  ;; We need to check if we even have such a thing
+  (define this-thing
+    (call/ec
+     (lambda (return)
+       (for-each (lambda (occupant)
+                   (mbody-receive (_ #:key goes-by)
+                       (<-wait occupant 'goes-by)
+                     (when (member direct-obj goes-by)
+                       (return occupant))))
+                 (gameobj-occupants gameobj))
+       ;; nothing found
+       #f)))
+  (define (this-thing-name)
+    (mbody-val (<-wait this-thing 'get-name)))
+  (define (should-take-from-me)
+    (and this-thing
+         (slot-ref-maybe-runcheck gameobj 'take-from-me? player this-thing)))
+  (define (default-objection)
+    `("Unfortunately, it doesn't seem like you can take "
+      (this-thing-name) " " preposition " " our-name "."))
+
+  (define (this-thing-objection)
+    (mbody-receive (_ taken-ok? #:key why-not) ; does the object object to being removed?
+        (<-wait this-thing 'ok-to-be-taken-from? player) ; @@ no need to supply from where
+      (and (not taken-ok?)
+           ;; Either give the specified reason, or give a boilerplate one
+           (or why-not
+               (default-objection)))))
+  (cond
+   ;; Wait, aren't we going to check (should-take-from-me) later?
+   ;; Well yes, but this checks if there's a #f as the value, which
+   ;; is a much clearer indication that this doesn't take *anything*.
+   ((not (slot-ref gameobj 'take-from-me?))
+    (<- player 'tell
+        #:text `("It's not really clear how to take something " ,preposition
+                 " " ,our-name ".")))
+
+   ;; Unfortunately this does leak information about what is contained
+   ;; by us.  Maybe not what's wanted in all circumstances.
+   ((not this-thing)
+    (<- player 'tell
+        #:text `("You don't see any such " ,direct-obj " to take from "
+                 ,our-name ".")))
+   ;; A particular objection to taking this thing.
+   ;; We should allow customizing the reason here, which could be
+   ;; provided by the 'ok-to-be-taken-from? slot.
+   ((not (should-take-from-me))
+    (<- player 'tell
+        #:text (default-objection)))
+   ;; the thing we wsant to take itself has objected...
+   ((this-thing-objection) =>
+    (lambda (objection)
+      (<- player 'tell
+          #:text objection)))
+   ;; looks like we can take it
+   (else
+    ;; Wait to announce to the player just in case settting the location
+    ;; errors out or something.  Maybe it's overthinking things, I dunno.
+    (<-wait this-thing 'set-loc! #:loc player)
+    (<- player 'tell
+        #:text `("You take " ,(this-thing-name) " from "
+                 ,our-name "."))
+    (<- player-loc 'tell-room
+        #:text `(,player-name " takes " ,(this-thing-name) " from "
+                              ,our-name ".")
+        #:exclude player))))
+
+(define* (cmd-put-in gameobj message
+                     #:key direct-obj indir-obj preposition)
+  (define player (message-from message))
+  (define player-name
+    (mbody-val (<-wait player 'get-name)))
+  (define player-loc
+    (mbody-val (<-wait player 'get-loc)))
+  (define our-name (slot-ref gameobj 'name))
+  ;; We need to check if we even have such a thing
+  (define this-thing
+    (call/ec
+     (lambda (return)
+       (for-each (lambda (occupant)
+                   (mbody-receive (_ #:key goes-by)
+                       (<-wait occupant 'goes-by)
+                     (when (member direct-obj goes-by)
+                       (return occupant))))
+                 (mbody-val (<-wait player 'get-occupants)))
+       ;; nothing found
+       #f)))
+  (define (this-thing-name)
+    (mbody-val (<-wait this-thing 'get-name)))
+  (define (should-put-in-me)
+    (and this-thing
+         (slot-ref-maybe-runcheck gameobj 'put-in-me? player this-thing)))
+  (define (default-objection)
+    `("As much as you'd like to, it doesn't seem like you can put "
+      ,(this-thing-name) " " ,preposition " " ,our-name "."))
+  (define (this-thing-objection)
+    (mbody-receive (_ put-in-ok? #:key why-not) ; does the object object to being moved?
+        (<-wait this-thing 'ok-to-be-put-in? player (actor-id gameobj))
+      (and (not put-in-ok?)
+           ;; Either give the specified reason, or give a boilerplate one
+           (or why-not (default-objection)))))
+  (cond
+   ;; Is it not there, or maybe we won't allow it to be taken?
+   ((not this-thing)
+    (<- (message-from message) 'tell
+        #:text `("You don't seem to have any such " ,direct-obj " to put "
+                 ,preposition " " ,our-name ".")))
+
+   ((or (not (should-put-in-me)))
+    (<- (message-from message) 'tell
+        #:text (default-objection)))
+   ;; the thing we wsant to take itself has objected...
+   ((this-thing-objection) =>
+    (lambda (objection)
+      (<- (message-from message) 'tell
+          #:text objection)))
+   ;; looks like we can take it
+   (else
+    ;; Wait to announce to the player just in case settting the location
+    ;; errors out or something.  Maybe it's overthinking things, I dunno.
+    (<-wait this-thing 'set-loc! #:loc (actor-id gameobj))
+    (<- player 'tell
+        #:text `("You put " ,(this-thing-name) " " ,preposition " "
+                 ,our-name "."))
+    (<- player-loc 'tell-room
+        #:text `(,player-name " puts " ,(this-thing-name) " " ,preposition " "
+                              ,our-name ".")
+        #:exclude player))))