Partial comparator implementation

this supports placement, toggling compare/subtract mode, simple stuff. No redstone functionality yet.
This is needed for blockstate mapping in blockfactory.

src/pocketmine/block/BlockFactory.php

@@ -30,6 +30,7 @@ use pocketmine\block\utils\PillarRotationTrait;
 use pocketmine\block\utils\TreeType;
 use pocketmine\item\ItemIds;
 use pocketmine\level\Position;
+use pocketmine\tile\Comparator;
 use function array_fill;
 use function array_filter;
 use function file_get_contents;
@@ -211,6 +212,7 @@ class BlockFactory{
 		self::register(new RedMushroom(new BID(Block::RED_MUSHROOM), "Red Mushroom"));
 		self::register(new RedMushroomBlock(new BID(Block::RED_MUSHROOM_BLOCK), "Red Mushroom Block"));
 		self::register(new Redstone(new BID(Block::REDSTONE_BLOCK), "Redstone Block"));
+		self::register(new RedstoneComparator(new BlockIdentifierFlattened(Block::UNPOWERED_COMPARATOR, Block::POWERED_COMPARATOR, 0, ItemIds::COMPARATOR, Comparator::class), "Redstone Comparator"));
 		self::register(new RedstoneLamp(new BlockIdentifierFlattened(Block::REDSTONE_LAMP, Block::LIT_REDSTONE_LAMP), "Redstone Lamp"));
 		self::register(new RedstoneOre(new BlockIdentifierFlattened(Block::REDSTONE_ORE, Block::LIT_REDSTONE_ORE), "Redstone Ore"));
 		self::register(new RedstoneRepeater(new BlockIdentifierFlattened(Block::UNPOWERED_REPEATER, Block::POWERED_REPEATER, 0, ItemIds::REPEATER), "Redstone Repeater"));

src/pocketmine/block/RedstoneComparator.php

@@ -0,0 +1,172 @@
+<?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\BlockDataValidator;
+use pocketmine\item\Item;
+use pocketmine\math\AxisAlignedBB;
+use pocketmine\math\Bearing;
+use pocketmine\math\Facing;
+use pocketmine\math\Vector3;
+use pocketmine\Player;
+use pocketmine\tile\Comparator;
+use function assert;
+
+class RedstoneComparator extends Flowable{
+	/** @var BlockIdentifierFlattened */
+	protected $idInfo;
+
+	/** @var int */
+	protected $facing = Facing::NORTH;
+	/** @var bool */
+	protected $isSubtractMode = false;
+	/** @var bool */
+	protected $powered = false;
+	/** @var int */
+	protected $signalStrength = 0;
+
+	public function __construct(BlockIdentifierFlattened $idInfo, string $name){
+		parent::__construct($idInfo, $name);
+	}
+
+	public function getId() : int{
+		return $this->powered ? $this->idInfo->getSecondId() : parent::getId();
+	}
+
+	public function readStateFromData(int $id, int $stateMeta) : void{
+		$this->facing = BlockDataValidator::readLegacyHorizontalFacing($stateMeta & 0x03);
+		$this->isSubtractMode = ($stateMeta & 0x04) !== 0;
+		$this->powered = ($id === $this->idInfo->getSecondId() or ($stateMeta & 0x08) !== 0);
+	}
+
+	public function writeStateToMeta() : int{
+		return Bearing::fromFacing($this->facing) | ($this->isSubtractMode ? 0x04 : 0) | ($this->powered ? 0x08 : 0);
+	}
+
+	public function getStateBitmask() : int{
+		return 0b1111;
+	}
+
+	public function readStateFromWorld() : void{
+		parent::readStateFromWorld();
+		$tile = $this->level->getTile($this);
+		if($tile instanceof Comparator){
+			$this->signalStrength = $tile->getSignalStrength();
+		}
+	}
+
+	public function writeStateToWorld() : void{
+		parent::writeStateToWorld();
+		$tile = $this->level->getTile($this);
+		assert($tile instanceof Comparator);
+		$tile->setSignalStrength($this->signalStrength);
+	}
+
+	/**
+	 * TODO: ad hoc, move to interface
+	 * @return int
+	 */
+	public function getFacing() : int{
+		return $this->facing;
+	}
+
+	/**
+	 * TODO: ad hoc, move to interface
+	 * @param int $facing
+	 */
+	public function setFacing(int $facing) : void{
+		$this->facing = $facing;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isSubtractMode() : bool{
+		return $this->isSubtractMode;
+	}
+
+	/**
+	 * @param bool $isSubtractMode
+	 */
+	public function setSubtractMode(bool $isSubtractMode) : void{
+		$this->isSubtractMode = $isSubtractMode;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isPowered() : bool{
+		return $this->powered;
+	}
+
+	/**
+	 * @param bool $powered
+	 */
+	public function setPowered(bool $powered) : void{
+		$this->powered = $powered;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getSignalStrength() : int{
+		return $this->signalStrength;
+	}
+
+	/**
+	 * @param int $signalStrength
+	 */
+	public function setSignalStrength(int $signalStrength) : void{
+		$this->signalStrength = $signalStrength;
+	}
+
+	protected function recalculateBoundingBox() : ?AxisAlignedBB{
+		return AxisAlignedBB::one()->trim(Facing::UP, 7 / 8);
+	}
+
+	public function place(Item $item, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, ?Player $player = null) : bool{
+		if(!$blockReplace->getSide(Facing::DOWN)->isTransparent()){
+			if($player !== null){
+				$this->facing = Facing::opposite($player->getHorizontalFacing());
+			}
+			return parent::place($item, $blockReplace, $blockClicked, $face, $clickVector, $player);
+		}
+
+		return false;
+	}
+
+	public function onInteract(Item $item, int $face, Vector3 $clickVector, ?Player $player = null) : bool{
+		$this->isSubtractMode = !$this->isSubtractMode;
+		$this->level->setBlock($this, $this);
+		return true;
+	}
+
+	public function onNearbyBlockChange() : void{
+		if($this->getSide(Facing::DOWN)->isTransparent()){
+			$this->level->useBreakOn($this);
+		}
+	}
+
+	//TODO: redstone functionality
+}

src/pocketmine/tile/Comparator.php

@@ -0,0 +1,60 @@
+<?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\tile;
+
+use pocketmine\block\RedstoneComparator;
+use pocketmine\nbt\tag\CompoundTag;
+
+/**
+ * @deprecated
+ * @see RedstoneComparator
+ */
+class Comparator extends Tile{
+	private const TAG_OUTPUT_SIGNAL = "OutputSignal"; //int
+
+	/** @var int */
+	protected $signalStrength = 0;
+
+	/**
+	 * @return int
+	 */
+	public function getSignalStrength() : int{
+		return $this->signalStrength;
+	}
+
+	/**
+	 * @param int $signalStrength
+	 */
+	public function setSignalStrength(int $signalStrength) : void{
+		$this->signalStrength = $signalStrength;
+	}
+
+	public function readSaveData(CompoundTag $nbt) : void{
+		$this->signalStrength = $nbt->getInt(self::TAG_OUTPUT_SIGNAL, 0, true);
+	}
+
+	protected function writeSaveData(CompoundTag $nbt) : void{
+		$nbt->setInt(self::TAG_OUTPUT_SIGNAL, $this->signalStrength);
+	}
+}

src/pocketmine/tile/TileFactory.php

@@ -49,6 +49,7 @@ final class TileFactory{
 		self::register(Banner::class, ["Banner", "minecraft:banner"]);
 		self::register(Bed::class, ["Bed", "minecraft:bed"]);
 		self::register(Chest::class, ["Chest", "minecraft:chest"]);
+		self::register(Comparator::class, ["Comparator", "minecraft:comparator"]);
 		self::register(EnchantTable::class, ["EnchantTable", "minecraft:enchanting_table"]);
 		self::register(EnderChest::class, ["EnderChest", "minecraft:ender_chest"]);
 		self::register(FlowerPot::class, ["FlowerPot", "minecraft:flower_pot"]);