Water/Thirst system improvements and modifications

[AndyTechGuy]

This pull request includes some major changes to the way that the thirst need is restored by players. These should make it so the thirst need is a greater challenge for players to fulfill.

All Changes

• Wells can now be drunk from directly. This replenishes all of a player's thirst.
• Instead of being given a water cup when interacting with a well, empty water cups can be bought from the market, and filled with a well.
• Wells have a capacity of drinks, and the player will need to wait for a bit to drink again from this well when this limit is reached.
• Tooltips have been included to indicate the status of wells.

A full well, and an empty well.

Testing

• Travel out in the world until a city spawns. Find a well (3 by 3 structure with water in the middle)
• Look at the water and press 'e' with nothing in your hand. Your thirst (the blue bar above your hotbar) should replenish instantly.
• Wait a little longer until a marketplace spawns, and press 'e' on the white gooey character walking around. Buy the empty cup from the shop.
• Return to the well and press 'e' while looking at the water. The cup should fill with water. Drink it by right clicking, and it should become empty again.
• Interact with the well by pressing 'e' until the tooltip reads "Drinks: 0/5". After this point, no thirst should be refilled by interacting with it again.
• Wait for a while when a well isn't at full capacity. After a bit of time, the well should replenish, one drink at a time.

[skaldarnar]

I'll have a look at this later, but I'm already wondering whether we can split this up into smaller parts (for review)?

[skaldarnar]

I don't like that we copy-paste the cup icon around - we should find a way to share this between JS (ManualLabor?) and MetalRenegades. Please have a look at the discussion in Terasology/ManualLabor#31

[AndyTechGuy]

Yeah it would be very nice to be able to take some of the more useful parts of ManualLabor without needing to use the more complicated portions of that module. If the fluid containers portion of ML could be separated into it's own module that would be fantastic.

If I remember right I think that a lot of the texture assets in ManualLabor come from a Spritesheet (I had to crop it out of the sheet myself). I don't know how easy that would be to separate into different modules.

[skaldarnar]

We are using a shorter license header format now (should be automatically used with 2020.x IntelliJ when using the pure Gradle setup).

Suggested change

	/*
	* Copyright 2020 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

[AndyTechGuy]

I applied the headings change to this PRs files. I can't seem to get the new header to automatically apply to new files though, and I don't know where I would look to find this option.... I'm using IntelliJ 2020.1.2 Ultimate.

[skaldarnar]

I don't like that there are so many return statements in this method. However, the nesting is not very deep, so it's still well comprehensible...

[AndyTechGuy]

I did some rearranging of this method to make it look a bit cleaner, and removed a few of the return statements. There's still two of them though... Too many return statements is definitely something I'll be looking out for in the future.

[skaldarnar]

With a more functional approach to using Stream API this could be written as

Suggested change

	EntityRef wellEntity = null;
	for (EntityRef waterSource : entityManager.getEntitiesWith(WellSourceComponent.class)) {
	DynParcelRefComponent dynParcelRefComponent = waterSource.getComponent(DynParcelRefComponent.class);
	Rect2i parcelRect = dynParcelRefComponent.dynParcel.getShape();
	if (parcelRect.contains(blockLocation.x, blockLocation.z)) {
	wellEntity = waterSource;
	break;
	}
	}
	return wellEntity;
	return StreamSupport.stream(entityManager.getEntitiesWith(WellSourceComponent.class).spliterator(), false)
	.filter(waterSource -> containsLocation(waterSource, blockLocation))
	.findFirst()
	.orElse(EntityRef.NULL);

The method containsLocation probably needs a better name, but I don't fully get what is happening there to be honest 🙈

    private boolean containsLocation(EntityRef waterSource, Vector3i location) {
        DynParcelRefComponent dynParcelRefComponent = waterSource.getComponent(DynParcelRefComponent.class);
        Rect2i parcelRect = dynParcelRefComponent.dynParcel.getShape();
        return parcelRect.contains(location.x, location.z);
    }

[skaldarnar]

... or with using a Predicate<EntityRef>:

Suggested change

	EntityRef wellEntity = null;
	for (EntityRef waterSource : entityManager.getEntitiesWith(WellSourceComponent.class)) {
	DynParcelRefComponent dynParcelRefComponent = waterSource.getComponent(DynParcelRefComponent.class);
	Rect2i parcelRect = dynParcelRefComponent.dynParcel.getShape();
	if (parcelRect.contains(blockLocation.x, blockLocation.z)) {
	wellEntity = waterSource;
	break;
	}
	}
	return wellEntity;
	return StreamSupport.stream(entityManager.getEntitiesWith(WellSourceComponent.class).spliterator(), false)
	.filter(atLocation(blockLocation))
	.findFirst()
	.orElse(EntityRef.NULL);

and

    private Predicate<EntityRef> atLocation(Vector3i location) {
        return (waterSource) -> {
            DynParcelRefComponent dynParcelRefComponent = waterSource.getComponent(DynParcelRefComponent.class);
            Rect2i parcelRect = dynParcelRefComponent.dynParcel.getShape();
            return parcelRect.contains(location.x, location.z);
        };
    }

[AndyTechGuy]

Woah, the stream implementation looks really nice! I'm still not very well versed in using streams over ordinary loops, I'll need to do some research on that. 👍