1 /*
2  * Copyright (c) 2021 ScalaQuest Team.
3  *
4  * This file is part of ScalaQuest, and is distributed under the terms of the MIT License as
5  * described in the file LICENSE in the ScalaQuest distribution's top directory.
6  */
7 
8 package io.github.scalaquest.core.model.behaviorBased.commons.groundBehaviors.impl
9 
10 import io.github.scalaquest.core.model.behaviorBased.BehaviorBasedModel
11 import io.github.scalaquest.core.model.behaviorBased.commons.actioning.CActions.Inspect
12 import io.github.scalaquest.core.model.behaviorBased.commons.pushing.CMessagesExt
13 import io.github.scalaquest.core.model.behaviorBased.commons.reactions.CReactionsExt
14 import io.github.scalaquest.core.model.behaviorBased.simple.impl.StateUtilsExt
15 
16 /**
17  * The trait makes possible to mix into a [[BehaviorBasedModel]] the <b>InspectableLocation
18  * GroundBehavior</b>.
19  */
20 trait InspectableLocationExt
21   extends BehaviorBasedModel
22   with CMessagesExt
23   with CReactionsExt
24   with StateUtilsExt {
25 
26   /**
27    * A <b>GroundBehavior</b> that enables the possibility to describe the location.
28    */
29   abstract class InspectableLocation extends GroundBehavior {
30 
31     /**
32      * A <b>Reaction</b> that communicates to the user a description of the current location.
33      * @return
34      *   A <b>Reaction</b> that communicates to the user a description of the current location.
35      */
36     def inspectLocation: Reaction
37   }
38 
39   /**
40    * A standard implementation for <b>InspectableLocation</b>.
41    * @param onInspectExtra
42    *   <b>Reaction</b> to be executed when the player successfully inspect the location. It can be
43    *   omitted.
44    */
45   case class SimpleInspectableLocation(onInspectExtra: Reaction = Reaction.empty)
46     extends InspectableLocation {
47 
48     override def triggers: GroundTriggers = { case (Inspect, _) => inspectLocation }
49 
50     override def inspectLocation: Reaction =
51       for {
52         s1 <- Reaction.empty
53         _ <- CReactions.addMessage(
54           CMessages.Inspected(s1.location, s1.locationItems, s1.location.neighbors(s1))
55         )
56         s2 <- onInspectExtra
57       } yield s2
58   }
59 
60   /**
61    * Companion object for <b>InspectableLocation</b>.
62    */
63   object InspectableLocation {
64 
65     /**
66      * Shortcut for the standard implementation.
67      * @param onInspectExtra
68      *   <b>Reaction</b> to be executed when the player successfully inspect the location. It can be
69      *   omitted.
70      * @return
71      *   the instance of <b>InspectableLocation</b>.
72      */
73     def apply(onInspectExtra: Reaction = Reaction.empty): InspectableLocation =
74       SimpleInspectableLocation(onInspectExtra)
75   }
76 }