Implemented waterlogging

src/block/BaseCoral.php

@@ -26,14 +26,20 @@
 use pocketmine\block\utils\BlockEventHelper;
 use pocketmine\block\utils\CoralMaterial;
 use pocketmine\block\utils\CoralTypeTrait;
+use pocketmine\block\utils\CoveredByWater;
+use pocketmine\block\utils\CoveredByWaterTrait;
 use pocketmine\block\utils\SupportType;
 use pocketmine\item\Item;
 use function mt_rand;
 
-abstract class BaseCoral extends Transparent implements CoralMaterial{
+abstract class BaseCoral extends CoveredFlowable implements CoralMaterial, CoveredByWater{
 	use CoralTypeTrait;
+	use CoveredByWaterTrait{
+		onNearbyBlockChange as onWaterBlockChange;
+	}
 
 	public function onNearbyBlockChange() : void{
+		$this->onWaterBlockChange();
 		if(!$this->dead){
 			$this->position->getWorld()->scheduleDelayedBlockUpdate($this->position, mt_rand(40, 200));
 		}
@@ -56,18 +62,7 @@ public function isAffectedBySilkTouch() : bool{
 	public function isSolid() : bool{ return false; }
 
 	protected function isCoveredWithWater() : bool{
-		$world = $this->position->getWorld();
-
-		$hasWater = false;
-		foreach($this->position->sides() as $vector3){
-			if($world->getBlock($vector3) instanceof Water){
-				$hasWater = true;
-				break;
-			}
-		}
-
-		//TODO: check water inside the block itself (not supported on the API yet)
-		return $hasWater;
+		return $this->waterCover !== null;
 	}
 
 	protected function recalculateCollisionBoxes() : array{ return []; }

src/block/Block.php

@@ -387,6 +387,7 @@ public function writeStateToWorld() : void{
 			throw new AssumptionFailedError("World::setBlock() should have loaded the chunk before calling this method");
 		}
 		$chunk->setBlockStateId($this->position->x & Chunk::COORD_MASK, $this->position->y, $this->position->z & Chunk::COORD_MASK, $this->getStateId());
+		$chunk->setDisplacedBlockStateId($this->position->x & Chunk::COORD_MASK, $this->position->y, $this->position->z & Chunk::COORD_MASK, $this->getDisplacedBlock()?->getStateId() ?? self::EMPTY_STATE_ID);
 
 		$tileType = $this->idInfo->getTileClass();
 		$oldTile = $world->getTile($this->position);
@@ -408,6 +409,15 @@ public function writeStateToWorld() : void{
 		}
 	}
 
+	/**
+	 * @internal
+	 * Returns a block which has been displaced by another block to the second layer.
+	 * Used in waterlogging and snowlogging.
+	 */
+	public function getDisplacedBlock() : ?Block{
+		return null;
+	}
+
 	/**
 	 * Returns whether this block can be placed when obtained as an item.
 	 */
@@ -487,7 +497,7 @@ public function onBreak(Item $item, ?Player $player = null, array &$returnedItem
 		if(($t = $world->getTile($this->position)) !== null){
 			$t->onBlockDestroyed();
 		}
-		$world->setBlock($this->position, VanillaBlocks::AIR());
+		$world->setBlock($this->position, $this->getDisplacedBlock() ?? VanillaBlocks::AIR());
 		return true;
 	}
 
@@ -520,6 +530,17 @@ public function onScheduledUpdate() : void{
 
 	}
 
+	/**
+	 * @internal
+	 * Similar to onScheduledUpdate(), but called for "displaced" blocks (e.g. water),
+	 * placed at the same position with their owning blocks.
+	 *
+	 * This is internal and used only in things such as waterlogging, plugins should NOT use this.
+	 */
+	public function onDisplacedScheduledUpdate() : void{
+		//NOOP
+	}
+
 	/**
 	 * Do actions when interacted by Item. Returns if it has done anything
 	 *
@@ -623,6 +644,10 @@ final public function getPosition() : Position{
 	final public function position(World $world, int $x, int $y, int $z) : void{
 		$this->position = new Position($x, $y, $z, $world);
 		$this->collisionBoxes = null;
+
+		if(($block = $this->getDisplacedBlock()) !== null){
+			$block->position($world, $x, $y, $z);
+		}
 	}
 
 	/**

src/block/BrewingStand.php

@@ -25,6 +25,8 @@
 
 use pocketmine\block\tile\BrewingStand as TileBrewingStand;
 use pocketmine\block\utils\BrewingStandSlot;
+use pocketmine\block\utils\CoveredByWater;
+use pocketmine\block\utils\CoveredByWaterTrait;
 use pocketmine\block\utils\SupportType;
 use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
@@ -36,7 +38,8 @@
 use function array_key_exists;
 use function spl_object_id;
 
-class BrewingStand extends Transparent{
+class BrewingStand extends Transparent implements CoveredByWater{
+	use CoveredByWaterTrait;
 
 	/**
 	 * @var BrewingStandSlot[]

src/block/Button.php

@@ -25,6 +25,9 @@
 
 use pocketmine\block\utils\AnyFacing;
 use pocketmine\block\utils\AnyFacingTrait;
+use pocketmine\block\utils\CoveredByWater;
+use pocketmine\block\utils\CoveredByWaterTrait;
+use pocketmine\block\utils\SupportType;
 use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\math\Facing;
@@ -34,8 +37,12 @@
 use pocketmine\world\sound\RedstonePowerOffSound;
 use pocketmine\world\sound\RedstonePowerOnSound;
 
-abstract class Button extends Flowable implements AnyFacing{
+abstract class Button extends Transparent implements AnyFacing, CoveredByWater{
 	use AnyFacingTrait;
+	use CoveredByWaterTrait{
+		place as waterPlace;
+		onNearbyBlockChange as onWaterBlockChange;
+	}
 
 	protected bool $pressed = false;
 
@@ -55,7 +62,7 @@ public function setPressed(bool $pressed) : self{
 	public function place(BlockTransaction $tx, Item $item, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, ?Player $player = null) : bool{
 		if($this->canBeSupportedAt($blockReplace, $face)){
 			$this->facing = $face;
-			return parent::place($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player);
+			return $this->waterPlace($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player);
 		}
 		return false;
 	}
@@ -84,11 +91,21 @@ public function onScheduledUpdate() : void{
 	}
 
 	public function onNearbyBlockChange() : void{
+		$this->onWaterBlockChange();
+
 		if(!$this->canBeSupportedAt($this, $this->facing)){
 			$this->position->getWorld()->useBreakOn($this->position);
 		}
 	}
 
+	public function getSupportType(int $facing) : SupportType{
+		return SupportType::NONE;
+	}
+
+	protected function recalculateCollisionBoxes() : array{
+		return [];
+	}
+
 	private function canBeSupportedAt(Block $block, int $face) : bool{
 		return $block->getAdjacentSupportType(Facing::opposite($face))->hasCenterSupport();
 	}

src/block/Campfire.php

@@ -25,6 +25,8 @@
 
 use pocketmine\block\inventory\CampfireInventory;
 use pocketmine\block\tile\Campfire as TileCampfire;
+use pocketmine\block\utils\CoveredByWater;
+use pocketmine\block\utils\CoveredByWaterTrait;
 use pocketmine\block\utils\HorizontalFacing;
 use pocketmine\block\utils\HorizontalFacingTrait;
 use pocketmine\block\utils\Lightable;
@@ -61,13 +63,19 @@
 use function min;
 use function mt_rand;
 
-class Campfire extends Transparent implements Lightable, HorizontalFacing{
+class Campfire extends Transparent implements Lightable, HorizontalFacing, CoveredByWater{
 	use HorizontalFacingTrait{
 		HorizontalFacingTrait::describeBlockOnlyState as encodeFacingState;
 	}
 	use LightableTrait{
 		LightableTrait::describeBlockOnlyState as encodeLitState;
 	}
+	use CoveredByWaterTrait{
+		place as waterPlace;
+		readStateFromWorld as readWaterStateFromWorld;
+		onNearbyBlockChange as onWaterBlockChange;
+		onEntityInside as onWaterEntityInside;
+	}
 
 	private const UPDATE_INTERVAL_TICKS = 10;
 
@@ -90,6 +98,9 @@ protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 
 	public function readStateFromWorld() : Block{
 		parent::readStateFromWorld();
+
+		$this->readWaterStateFromWorld();
+
 		$tile = $this->position->getWorld()->getTile($this->position);
 		if($tile instanceof TileCampfire){
 			$this->inventory = $tile->getInventory();
@@ -179,22 +190,24 @@ public function place(BlockTransaction $tx, Item $item, Block $blockReplace, Blo
 			$this->facing = $player->getHorizontalFacing();
 		}
 		$this->lit = true;
-		return parent::place($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player);
+		return $this->waterPlace($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player);
 	}
 
 	public function onInteract(Item $item, int $face, Vector3 $clickVector, ?Player $player = null, array &$returnedItems = []) : bool{
 		if(!$this->lit){
-			if($item->getTypeId() === ItemTypeIds::FIRE_CHARGE){
-				$item->pop();
-				$this->ignite();
-				$this->position->getWorld()->addSound($this->position, new BlazeShootSound());
-				return true;
-			}elseif($item->getTypeId() === ItemTypeIds::FLINT_AND_STEEL || $item->hasEnchantment(VanillaEnchantments::FIRE_ASPECT())){
-				if($item instanceof Durable){
-					$item->applyDamage(1);
+			if($this->waterCover === null){
+				if($item->getTypeId() === ItemTypeIds::FIRE_CHARGE){
+					$item->pop();
+					$this->ignite();
+					$this->position->getWorld()->addSound($this->position, new BlazeShootSound());
+					return true;
+				}elseif($item->getTypeId() === ItemTypeIds::FLINT_AND_STEEL || $item->hasEnchantment(VanillaEnchantments::FIRE_ASPECT())){
+					if($item instanceof Durable){
+						$item->applyDamage(1);
+					}
+					$this->ignite();
+					return true;
 				}
-				$this->ignite();
-				return true;
 			}
 		}elseif($item instanceof Shovel){
 			$item->applyDamage(1);
@@ -215,13 +228,15 @@ public function onInteract(Item $item, int $face, Vector3 $clickVector, ?Player
 	}
 
 	public function onNearbyBlockChange() : void{
-		if($this->lit && $this->getSide(Facing::UP)->getTypeId() === BlockTypeIds::WATER){
+		$this->onWaterBlockChange();
+		if($this->lit && ($this->waterCover !== null || $this->getSide(Facing::UP)->getTypeId() === BlockTypeIds::WATER)){
 			$this->extinguish();
-			//TODO: Waterlogging
 		}
 	}
 
 	public function onEntityInside(Entity $entity) : bool{
+		$this->onWaterEntityInside($entity);
+
 		if(!$this->lit){
 			if($entity->isOnFire()){
 				$this->ignite();

src/block/Cauldron.php

@@ -25,6 +25,7 @@
 
 use pocketmine\block\tile\Cauldron as TileCauldron;
 use pocketmine\block\utils\SupportType;
+use pocketmine\block\utils\WaterCoverHelper;
 use pocketmine\item\Item;
 use pocketmine\item\ItemTypeIds;
 use pocketmine\item\Potion;
@@ -95,7 +96,8 @@ public function onInteract(Item $item, int $face, Vector3 $clickVector, ?Player
 
 	public function onNearbyBlockChange() : void{
 		$world = $this->position->getWorld();
-		if($world->getBlock($this->position->up())->getTypeId() === BlockTypeIds::WATER){
+		$block = $world->getBlock($this->position->up());
+		if(WaterCoverHelper::isWater($block)){
 			$cauldron = VanillaBlocks::WATER_CAULDRON()->setFillLevel(FillableCauldron::MAX_FILL_LEVEL);
 			$world->setBlock($this->position, $cauldron);
 			$world->addSound($this->position->add(0.5, 0.5, 0.5), $cauldron->getFillSound());

src/block/CoveredFlowable.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+ */
+
+declare(strict_types=1);
+
+namespace pocketmine\block;
+
+use pocketmine\block\utils\CoveredByWater;
+use pocketmine\math\Vector3;
+
+/**
+ * Flowable blocks that can be waterlogged.
+ */
+abstract class CoveredFlowable extends Flowable implements CoveredByWater{
+
+	public function canBePlacedAt(Block $blockReplace, Vector3 $clickVector, int $face, bool $isClickedBlock) : bool{
+		return
+			($this->canBeCovered() && $blockReplace instanceof Water && ($blockReplace->isSource() || $this->canBeCoveredByFlowing())) ||
+			parent::canBePlacedAt($blockReplace, $clickVector, $face, $isClickedBlock);
+	}
+}

src/block/Door.php

@@ -23,6 +23,8 @@
 
 namespace pocketmine\block;
 
+use pocketmine\block\utils\CoveredByWater;
+use pocketmine\block\utils\CoveredByWaterTrait;
 use pocketmine\block\utils\HorizontalFacing;
 use pocketmine\block\utils\HorizontalFacingTrait;
 use pocketmine\block\utils\SupportType;
@@ -35,8 +37,12 @@
 use pocketmine\world\BlockTransaction;
 use pocketmine\world\sound\DoorSound;
 
-class Door extends Transparent implements HorizontalFacing{
+class Door extends Transparent implements HorizontalFacing, CoveredByWater{
 	use HorizontalFacingTrait;
+	use CoveredByWaterTrait{
+		readStateFromWorld as readWaterStateFromWorld;
+		onNearbyBlockChange as onWaterBlockChange;
+	}
 
 	protected bool $top = false;
 	protected bool $hingeRight = false;
@@ -52,6 +58,8 @@ protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 	public function readStateFromWorld() : Block{
 		parent::readStateFromWorld();
 
+		$this->readWaterStateFromWorld();
+
 		$this->collisionBoxes = null;
 
 		//copy door properties from other half
@@ -106,6 +114,8 @@ public function getSupportType(int $facing) : SupportType{
 	}
 
 	public function onNearbyBlockChange() : void{
+		$this->onWaterBlockChange();
+
 		if(!$this->canBeSupportedAt($this) && !$this->getSide(Facing::DOWN) instanceof Door){ //Replace with common break method
 			$this->position->getWorld()->useBreakOn($this->position); //this will delete both halves if they exist
 		}
@@ -132,6 +142,13 @@ public function place(BlockTransaction $tx, Item $item, Block $blockReplace, Blo
 			$topHalf = clone $this;
 			$topHalf->top = true;
 
+			if($blockReplace instanceof Water && $blockReplace->isSource()){
+				$this->waterCover = clone $blockReplace;
+			}
+			if($blockUp instanceof Water && $blockUp->isSource()){
+				$topHalf->waterCover = clone $blockUp;
+			}
+
 			$tx->addBlock($blockReplace->position, $this)->addBlock($blockUp->position, $topHalf);
 			return true;
 		}