Water/Thirst system improvements and modifications

assets/prefabs/blocks/waterCupSource.prefab

@@ -4,6 +4,6 @@
     },
     "InteractionTarget": {},
     "UnbreathableBlock": {},
-    "WellSource": {},
+    "WellBlock": {},
     "Network": {}
 }

assets/prefabs/buildings/marketPlace.prefab

@@ -12,7 +12,8 @@
        "waffles" : 10,
        "Blueberry": 1,
        "Raspberry": 1,
-       "Strawberry": 1
+       "Strawberry": 1,
+       "emptyCup" : 1
      },
      "productionInterval" : 100
     },

assets/prefabs/buildings/templates/wellTemplate.prefab

@@ -9,6 +9,7 @@
             { "blockType": "CoreAssets:Cobblestone", "region": { "min": [-1, 0, -2], "size": [1, 1, 1]}},
             { "blockType": "CoreAssets:Cobblestone", "region": { "min": [1, 0, -2], "size": [1, 1, 1]}},
             { "blockType": "CoreAssets:Cobblestone", "region": { "min": [-1, 0, -1], "size": [3, 1, 1]}},
+            { "blockType": "CoreAssets:Cobblestone", "region": { "min": [0, 0, -2], "size": [1, 1, 1]}},
             { "blockType": "CoreAssets:Cobblestone:engine:stair.BACK", "region": { "min": [0, 1, -1], "size": [1, 1, 1]}},
             { "blockType": "CoreAssets:Cobblestone:engine:stair.FRONT", "region": { "min": [0, 1, -3], "size": [1, 1, 1]}},
             { "blockType": "CoreAssets:Cobblestone:engine:stair.LEFT", "region": { "min": [-1, 1, -2], "size": [1, 1, 1]}},
@@ -25,7 +26,7 @@
             { "blockType": "engine:air", "region": { "min": [0, 2, -3], "size": [1, 2, 1]}},
             { "blockType": "engine:air", "region": { "min": [-1, 2, -2], "size": [3, 2, 1]}},
             { "blockType": "engine:air", "region": { "min": [0, 2, -1], "size": [1, 2, 1]}},
-            { "blockType": "MetalRenegades:waterCupSource", "region":  { "min":  [0, 0, -2], "size":  [1, 2, 1]}}
+            { "blockType": "MetalRenegades:waterCupSource", "region":  { "min":  [0, 1, -2], "size":  [1, 1, 1]}}
         ]
     }
 }

assets/prefabs/buildings/well.prefab

@@ -9,5 +9,9 @@
     },
     "SimpleSource": {
         "needType": "WATER"
+    },
+    "WellSource": {
+        "refillsLeft": 5,
+        "capacity": 5
     }
 }

assets/prefabs/items/emptyCup.prefab

@@ -0,0 +1,15 @@
+{
+    "parent": "engine:iconItem",
+    "DisplayName": {
+        "name": "Empty Cup"
+    },
+    "Item": {
+        "stackId": "MetalRenegades:emptyCup",
+        "icon" : "MetalRenegades:emptyCup",
+        "cooldownTime": 500,
+        "maxStackSize": 1
+    },
+    "WaterCup": {
+        "filled": false
+    }
+}

assets/prefabs/items/filledCup.prefab

@@ -0,0 +1,18 @@
+{
+    "parent": "engine:iconItem",
+    "DisplayName": {
+        "name": "Filled Cup"
+    },
+    "Item": {
+        "stackId": "MetalRenegades:filledCup",
+        "icon" : "MetalRenegades:filledCup",
+        "cooldownTime": 500,
+        "maxStackSize": 1
+    },
+    "Drink": {
+        "filling": 100
+    },
+    "WaterCup": {
+        "filled": true
+    }
+}

deltas/engine/prefabs/player.prefab

@@ -14,5 +14,8 @@
       { "uri": "CoreAdvancedAssets:gun", "quantity": 1 },
       { "uri": "CoreAssets:Torch", "quantity": 99 }
     ]
+  },
+  "Thirst": {
+     "maxWaterCapacity": 200
   }
 }

src/main/java/org/terasology/metalrenegades/economy/ui/MarketItemBuilder.java

@@ -30,6 +30,12 @@ public final class MarketItemBuilder {
     private static boolean isInitialised = false;
 
     private static void initialise() {
+        details.put("emptyCup", new MarketItem(
+                "emptyCup",
+                "A container to hold refreshing water from wells.",
+                25
+        ));
+
         details.put("waffles", new MarketItem(
                 "waffles",
                 "Hot and fresh waffles.",

src/main/java/org/terasology/metalrenegades/interaction/component/WaterCupComponent.java

@@ -0,0 +1,17 @@
+// Copyright 2020 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+package org.terasology.metalrenegades.interaction.component;
+
+import org.terasology.entitySystem.Component;
+
+/**
+ * Component describing the status of particular water cup.
+ */
+public class WaterCupComponent implements Component {
+
+    /**
+     * True if the cup contains water, false otherwise.
+     */
+    public boolean filled;
+
+}

src/main/java/org/terasology/metalrenegades/interaction/component/WellBlockComponent.java

@@ -0,0 +1,12 @@
+// Copyright 2020 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+package org.terasology.metalrenegades.interaction.component;
+
+import org.terasology.entitySystem.Component;
+
+/**
+ * Indicates a water source block inside of a well entity, which the player interacts with to gather water.
+ */
+public class WellBlockComponent implements Component {
+
+}

src/main/java/org/terasology/metalrenegades/interaction/component/WellSourceComponent.java

@@ -1,25 +1,22 @@
-/*
- * Copyright 2018 MovingBlocks
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+// Copyright 2020 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
 package org.terasology.metalrenegades.interaction.component;
 
 import org.terasology.entitySystem.Component;
 
 /**
- * Indicates a water cup source block, to be used inside wells.
+ * Indicates a water well entity, that the player can drink from.
  */
 public class WellSourceComponent implements Component {
 
+    /**
+     * The number of water refills remaining in this well. Replenishes after a certain period of time.
+     */
+    public int refillsLeft;
+
+    /**
+     * The maximum number of refills that this well can have.
+     */
+    public int capacity;
+
 }

src/main/java/org/terasology/metalrenegades/interaction/events/CupFilledEvent.java

@@ -0,0 +1,36 @@
+// Copyright 2020 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+package org.terasology.metalrenegades.interaction.events;
+
+import org.terasology.entitySystem.entity.EntityRef;
+import org.terasology.entitySystem.event.Event;
+
+/**
+ * Fires when a cup item is filled from a well.
+ */
+public class CupFilledEvent implements Event {
+
+    /**
+     * The entity gathering the water. Assumed to be a player entity.
+     */
+    private final EntityRef gatheringCharacter;
+
+    /**
+     * The new cup item given to the player upon refilling.
+     */
+    private final EntityRef cupItem;
+
+    public CupFilledEvent(EntityRef gatheringCharacter, EntityRef cupItem) {
+        this.gatheringCharacter = gatheringCharacter;
+        this.cupItem = cupItem;
+    }
+
+    public EntityRef getGatheringCharacter() {
+        return gatheringCharacter;
+    }
+
+    public EntityRef getCupItem() {
+        return cupItem;
+    }
+
+}

src/main/java/org/terasology/metalrenegades/interaction/events/WellDrinkEvent.java

@@ -0,0 +1,26 @@
+// Copyright 2020 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+package org.terasology.metalrenegades.interaction.events;
+
+import org.terasology.entitySystem.entity.EntityRef;
+import org.terasology.entitySystem.event.Event;
+
+/**
+ * Fires when a player drinks directly from a well.
+ */
+public class WellDrinkEvent implements Event {
+
+    /**
+     * The entity drinking the water. Assumed to be a player entity.
+     */
+    private final EntityRef gatheringCharacter;
+
+    public WellDrinkEvent(EntityRef gatheringCharacter) {
+        this.gatheringCharacter = gatheringCharacter;
+    }
+
+    public EntityRef getGatheringCharacter() {
+        return gatheringCharacter;
+    }
+
+}

src/main/java/org/terasology/metalrenegades/interaction/events/WellRefilledEvent.java

@@ -0,0 +1,11 @@
+// Copyright 2020 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+package org.terasology.metalrenegades.interaction.events;
+
+import org.terasology.entitySystem.event.Event;
+
+/**
+ * Fires when a well gains one more refill.
+ */
+public class WellRefilledEvent implements Event {
+}

src/main/java/org/terasology/metalrenegades/interaction/systems/WellTooltipSystem.java

@@ -0,0 +1,73 @@
+// Copyright 2020 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+package org.terasology.metalrenegades.interaction.systems;
+
+import org.terasology.entitySystem.entity.EntityManager;
+import org.terasology.entitySystem.entity.EntityRef;
+import org.terasology.entitySystem.event.ReceiveEvent;
+import org.terasology.entitySystem.systems.BaseComponentSystem;
+import org.terasology.entitySystem.systems.RegisterMode;
+import org.terasology.entitySystem.systems.RegisterSystem;
+import org.terasology.logic.nameTags.NameTagComponent;
+import org.terasology.metalrenegades.interaction.component.WellSourceComponent;
+import org.terasology.metalrenegades.interaction.events.CupFilledEvent;
+import org.terasology.metalrenegades.interaction.events.WellDrinkEvent;
+import org.terasology.metalrenegades.interaction.events.WellRefilledEvent;
+import org.terasology.registry.In;
+import org.terasology.rendering.nui.Color;
+import org.terasology.world.time.WorldTimeEvent;
+
+/**
+ * Adds tooltips to wells about the number of thirst refills available.
+ */
+@RegisterSystem(value = RegisterMode.AUTHORITY)
+public class WellTooltipSystem extends BaseComponentSystem {
+
+    @In
+    private EntityManager entityManager;
+
+    @ReceiveEvent
+    public void onWorldTimeEvent(WorldTimeEvent worldTimeEvent, EntityRef entityRef) {
+        for (EntityRef waterSource : entityManager.getEntitiesWith(WellSourceComponent.class)) {
+            if (waterSource.hasComponent(NameTagComponent.class)) {
+                continue;
+            }
+
+            NameTagComponent nameTagComponent = new NameTagComponent();
+            waterSource.addComponent(nameTagComponent);
+            updateNameTag(waterSource);
+        }
+    }
+
+    @ReceiveEvent(components = {WellSourceComponent.class, NameTagComponent.class})
+    public void onCupFilled(CupFilledEvent cupFilledEvent, EntityRef wellEntity) {
+        updateNameTag(wellEntity);
+    }
+
+    @ReceiveEvent(components = {WellSourceComponent.class, NameTagComponent.class})
+    public void onWellDrink(WellDrinkEvent wellDrinkEvent, EntityRef wellEntity) {
+        updateNameTag(wellEntity);
+    }
+
+    @ReceiveEvent(components = {WellSourceComponent.class, NameTagComponent.class})
+    public void onWellRefill(WellRefilledEvent wellRefilledEvent, EntityRef wellEntity) {
+        updateNameTag(wellEntity);
+    }
+
+    /**
+     * Updates the name tag above a well entity to show the number of remaining water refills.
+     *
+     * @param wellEntity The well entity to update.
+     */
+    private void updateNameTag(EntityRef wellEntity) {
+        WellSourceComponent wellSourceComponent = wellEntity.getComponent(WellSourceComponent.class);
+        NameTagComponent nameTagComponent = wellEntity.getComponent(NameTagComponent.class);
+
+        nameTagComponent.text = String.format("Drinks: %d/%d", wellSourceComponent.refillsLeft, wellSourceComponent.capacity);
+        nameTagComponent.textColor = Color.BLUE;
+        nameTagComponent.yOffset = 2f;
+        nameTagComponent.scale = 1f;
+        wellEntity.saveComponent(nameTagComponent);
+    }
+
+}