Extract glow lichen multi face logic into traits (#6396)

This will be useful for future block additions

src/block/GlowLichen.php

@@ -24,60 +24,20 @@ declare(strict_types=1);
 namespace pocketmine\block;
 
 use pocketmine\block\utils\BlockEventHelper;
+use pocketmine\block\utils\MultiAnySupportTrait;
 use pocketmine\block\utils\SupportType;
-use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Fertilizer;
 use pocketmine\item\Item;
 use pocketmine\math\AxisAlignedBB;
 use pocketmine\math\Facing;
 use pocketmine\math\Vector3;
 use pocketmine\player\Player;
-use pocketmine\world\BlockTransaction;
 use pocketmine\world\World;
-use function array_key_first;
 use function count;
 use function shuffle;
 
 class GlowLichen extends Transparent{
-
+	use MultiAnySupportTrait;
-	/** @var int[] */
-	protected array $faces = [];
-
-	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
-		$w->facingFlags($this->faces);
-	}
-
-	/** @return int[] */
-	public function getFaces() : array{ return $this->faces; }
-
-	public function hasFace(int $face) : bool{
-		return isset($this->faces[$face]);
-	}
-
-	/**
-	 * @param int[] $faces
-	 * @return $this
-	 */
-	public function setFaces(array $faces) : self{
-		$uniqueFaces = [];
-		foreach($faces as $face){
-			Facing::validate($face);
-			$uniqueFaces[$face] = $face;
-		}
-		$this->faces = $uniqueFaces;
-		return $this;
-	}
-
-	/** @return $this */
-	public function setFace(int $face, bool $value) : self{
-		Facing::validate($face);
-		if($value){
-			$this->faces[$face] = $face;
-		}else{
-			unset($this->faces[$face]);
-		}
-		return $this;
-	}
 
 	public function getLightLevel() : int{
 		return 7;
@@ -102,39 +62,11 @@ class GlowLichen extends Transparent{
 		return true;
 	}
 
-	public function place(BlockTransaction $tx, Item $item, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, ?Player $player = null) : bool{
+	/**
-		$this->faces = $blockReplace instanceof GlowLichen ? $blockReplace->faces : [];
+	 * @return int[]
-		$availableFaces = $this->getAvailableFaces();
+	 */
-
+	protected function getInitialPlaceFaces(Block $blockReplace) : array{
-		if(count($availableFaces) === 0){
+		return $blockReplace instanceof GlowLichen ? $blockReplace->faces : [];
-			return false;
-		}
-
-		$opposite = Facing::opposite($face);
-		$placedFace = isset($availableFaces[$opposite]) ? $opposite : array_key_first($availableFaces);
-		$this->faces[$placedFace] = $placedFace;
-
-		return parent::place($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player);
-	}
-
-	public function onNearbyBlockChange() : void{
-		$changed = false;
-
-		foreach($this->faces as $face){
-			if($this->getAdjacentSupportType($face) !== SupportType::FULL){
-				unset($this->faces[$face]);
-				$changed = true;
-			}
-		}
-
-		if($changed){
-			$world = $this->position->getWorld();
-			if(count($this->faces) === 0){
-				$world->useBreakOn($this->position);
-			}else{
-				$world->setBlock($this->position, $this);
-			}
-		}
 	}
 
 	private function getSpreadBlock(Block $replace, int $spreadFace) : ?Block{
@@ -261,17 +193,4 @@ class GlowLichen extends Transparent{
 	public function getFlammability() : int{
 		return 100;
 	}
-
-	/**
-	 * @return array<int, int> $faces
-	 */
-	private function getAvailableFaces() : array{
-		$faces = [];
-		foreach(Facing::ALL as $face){
-			if(!$this->hasFace($face) && $this->getAdjacentSupportType($face) === SupportType::FULL){
-				$faces[$face] = $face;
-			}
-		}
-		return $faces;
-	}
 }

src/block/utils/MultiAnyFacingTrait.php

@@ -0,0 +1,72 @@
+<?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\utils;
+
+use pocketmine\data\runtime\RuntimeDataDescriber;
+use pocketmine\math\Facing;
+
+/**
+ * Used by blocks that can have multiple target faces in the area of one solid block, such as covering three sides of a corner.
+ */
+trait MultiAnyFacingTrait{
+
+	/** @var int[] */
+	protected array $faces = [];
+
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
+		$w->facingFlags($this->faces);
+	}
+
+	/** @return int[] */
+	public function getFaces() : array{ return $this->faces; }
+
+	public function hasFace(int $face) : bool{
+		return isset($this->faces[$face]);
+	}
+
+	/**
+	 * @param int[] $faces
+	 * @return $this
+	 */
+	public function setFaces(array $faces) : self{
+		$uniqueFaces = [];
+		foreach($faces as $face){
+			Facing::validate($face);
+			$uniqueFaces[$face] = $face;
+		}
+		$this->faces = $uniqueFaces;
+		return $this;
+	}
+
+	/** @return $this */
+	public function setFace(int $face, bool $value) : self{
+		Facing::validate($face);
+		if($value){
+			$this->faces[$face] = $face;
+		}else{
+			unset($this->faces[$face]);
+		}
+		return $this;
+	}
+}

src/block/utils/MultiAnySupportTrait.php

@@ -0,0 +1,96 @@
+<?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\utils;
+
+use pocketmine\block\Block;
+use pocketmine\item\Item;
+use pocketmine\math\Facing;
+use pocketmine\math\Vector3;
+use pocketmine\player\Player;
+use pocketmine\world\BlockTransaction;
+use function array_key_first;
+use function count;
+
+/**
+ * Used by blocks that have multiple support requirements in the area of one solid block, such as covering three sides of a corner.
+ * Prevents placement if support isn't available and automatically destroys a block side if it's support is removed.
+ */
+trait MultiAnySupportTrait{
+	use MultiAnyFacingTrait;
+
+	/**
+	 * Returns a list of faces that block should already have when placed.
+	 *
+	 * @return int[]
+	 */
+	abstract protected function getInitialPlaceFaces(Block $blockReplace) : array;
+
+	public function place(BlockTransaction $tx, Item $item, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, ?Player $player = null) : bool{
+		$this->faces = $this->getInitialPlaceFaces($blockReplace);
+		$availableFaces = $this->getAvailableFaces();
+
+		if(count($availableFaces) === 0){
+			return false;
+		}
+
+		$opposite = Facing::opposite($face);
+		$placedFace = isset($availableFaces[$opposite]) ? $opposite : array_key_first($availableFaces);
+		$this->faces[$placedFace] = $placedFace;
+
+		return parent::place($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player);
+	}
+
+	public function onNearbyBlockChange() : void{
+		$changed = false;
+
+		foreach($this->faces as $face){
+			if($this->getAdjacentSupportType($face) !== SupportType::FULL){
+				unset($this->faces[$face]);
+				$changed = true;
+			}
+		}
+
+		if($changed){
+			$world = $this->position->getWorld();
+			if(count($this->faces) === 0){
+				$world->useBreakOn($this->position);
+			}else{
+				$world->setBlock($this->position, $this);
+			}
+		}
+	}
+
+	/**
+	 * @return array<int, int> $faces
+	 */
+	private function getAvailableFaces() : array{
+		$faces = [];
+		foreach(Facing::ALL as $face){
+			if(!$this->hasFace($face) && $this->getAdjacentSupportType($face) === SupportType::FULL){
+				$faces[$face] = $face;
+			}
+		}
+		return $faces;
+	}
+}