feat: Implement Brewing (#4413)

The following API constants have been added:
- tile\BrewingStand::BREW_TIME_TICKS
The following public API methods have been added:
- utils\BrewingStandSlot->getSlotNumber() : int
- CraftingManager->getPotionTypeRecipes() : array<string, array<string, PotionTypeRecipe>>
- CraftingManager->getPotionContainerChangeRecipes() : array<int, array<string, PotionContainerChangeRecipe>>
- CraftingManager->registerPotionTypeRecipe(PotionTypeRecipe $recipe) : void
- CraftingManager->registerPotionContainerChangeRecipe(PotionContainerChangeRecipe $recipe) : void
The following classes have been added:
- BrewingRecipe
- PotionTypeRecipe
- PotionContainerChangeRecipe
- BrewItemEvent
- BrewingFuelUseEvent
- PotionFinishBrewingSound

src/block/BrewingStand.php

@@ -125,6 +125,24 @@ class BrewingStand extends Transparent{
 	}
 
 	public function onScheduledUpdate() : void{
-		//TODO
+		$brewing = $this->position->getWorld()->getTile($this->position);
+		if($brewing instanceof TileBrewingStand){
+			if($brewing->onUpdate()){
+				$this->position->getWorld()->scheduleDelayedBlockUpdate($this->position, 1);
+			}
+
+			$changed = false;
+			foreach(BrewingStandSlot::getAll() as $slot){
+				$occupied = !$brewing->getInventory()->isSlotEmpty($slot->getSlotNumber());
+				if($occupied !== $this->hasSlot($slot)){
+					$this->setSlot($slot, $occupied);
+					$changed = true;
+				}
+			}
+
+			if($changed){
+				$this->position->getWorld()->setBlock($this->position, $this);
+			}
+		}
 	}
 }

src/block/tile/BrewingStand.php

@@ -24,16 +24,29 @@ declare(strict_types=1);
 namespace pocketmine\block\tile;
 
 use pocketmine\block\inventory\BrewingStandInventory;
+use pocketmine\crafting\BrewingRecipe;
+use pocketmine\event\block\BrewingFuelUseEvent;
+use pocketmine\event\block\BrewItemEvent;
 use pocketmine\inventory\CallbackInventoryListener;
 use pocketmine\inventory\Inventory;
+use pocketmine\item\Item;
+use pocketmine\item\VanillaItems;
 use pocketmine\math\Vector3;
 use pocketmine\nbt\tag\CompoundTag;
+use pocketmine\network\mcpe\protocol\ContainerSetDataPacket;
+use pocketmine\player\Player;
+use pocketmine\world\sound\PotionFinishBrewingSound;
 use pocketmine\world\World;
+use function array_map;
+use function count;
 
 class BrewingStand extends Spawnable implements Container, Nameable{
-
+	use NameableTrait {
+		addAdditionalSpawnData as addNameSpawnData;
+	}
 	use ContainerTrait;
-	use NameableTrait;
+
+	public const BREW_TIME_TICKS = 400; // Brew time in ticks
 
 	private const TAG_BREW_TIME = "BrewTime"; //TAG_Short
 	private const TAG_BREW_TIME_PE = "CookTime"; //TAG_Short
@@ -41,15 +54,11 @@ class BrewingStand extends Spawnable implements Container, Nameable{
 	private const TAG_REMAINING_FUEL_TIME = "Fuel"; //TAG_Byte
 	private const TAG_REMAINING_FUEL_TIME_PE = "FuelAmount"; //TAG_Short
 
-	/** @var BrewingStandInventory */
-	private $inventory;
+	private BrewingStandInventory $inventory;
 
-	/** @var int */
-	private $brewTime = 0;
-	/** @var int */
-	private $maxFuelTime = 0;
-	/** @var int */
-	private $remainingFuelTime = 0;
+	private int $brewTime = 0;
+	private int $maxFuelTime = 0;
+	private int $remainingFuelTime = 0;
 
 	public function __construct(World $world, Vector3 $pos){
 		parent::__construct($world, $pos);
@@ -83,6 +92,14 @@ class BrewingStand extends Spawnable implements Container, Nameable{
 		$nbt->setShort(self::TAG_REMAINING_FUEL_TIME_PE, $this->remainingFuelTime);
 	}
 
+	protected function addAdditionalSpawnData(CompoundTag $nbt) : void{
+		$this->addNameSpawnData($nbt);
+
+		$nbt->setShort(self::TAG_BREW_TIME_PE, $this->brewTime);
+		$nbt->setShort(self::TAG_MAX_FUEL_TIME, $this->maxFuelTime);
+		$nbt->setShort(self::TAG_REMAINING_FUEL_TIME_PE, $this->remainingFuelTime);
+	}
+
 	public function getDefaultName() : string{
 		return "Brewing Stand";
 	}
@@ -108,4 +125,135 @@ class BrewingStand extends Spawnable implements Container, Nameable{
 	public function getRealInventory(){
 		return $this->inventory;
 	}
+
+	private function checkFuel(Item $item) : void{
+		$ev = new BrewingFuelUseEvent($this);
+		if(!$item->equals(VanillaItems::BLAZE_POWDER(), true, false)){
+			$ev->cancel();
+		}
+
+		$ev->call();
+		if($ev->isCancelled()){
+			return;
+		}
+
+		$item->pop();
+		$this->inventory->setItem(BrewingStandInventory::SLOT_FUEL, $item);
+
+		$this->maxFuelTime = $this->remainingFuelTime = $ev->getFuelTime();
+	}
+
+	/**
+	 * @return BrewingRecipe[]
+	 * @phpstan-return array<int, BrewingRecipe>
+	 */
+	private function getBrewableRecipes() : array{
+		if($this->inventory->getItem(BrewingStandInventory::SLOT_INGREDIENT)->isNull()){
+			return [];
+		}
+
+		$recipes = [];
+		foreach([BrewingStandInventory::SLOT_BOTTLE_LEFT, BrewingStandInventory::SLOT_BOTTLE_MIDDLE, BrewingStandInventory::SLOT_BOTTLE_RIGHT] as $slot){
+			$input = $this->inventory->getItem($slot);
+			if($input->isNull()){
+				continue;
+			}
+
+			if(($recipe = $this->position->getWorld()->getServer()->getCraftingManager()->matchBrewingRecipe($input, $this->inventory->getItem(BrewingStandInventory::SLOT_INGREDIENT))) !== null){
+				$recipes[$slot] = $recipe;
+			}
+		}
+
+		return $recipes;
+	}
+
+	public function onUpdate() : bool{
+		if($this->closed){
+			return false;
+		}
+
+		$this->timings->startTiming();
+
+		$prevBrewTime = $this->brewTime;
+		$prevRemainingFuelTime = $this->remainingFuelTime;
+		$prevMaxFuelTime = $this->maxFuelTime;
+
+		$ret = false;
+
+		$fuel = $this->inventory->getItem(BrewingStandInventory::SLOT_FUEL);
+		$ingredient = $this->inventory->getItem(BrewingStandInventory::SLOT_INGREDIENT);
+
+		$recipes = $this->getBrewableRecipes();
+		$canBrew = count($recipes) !== 0;
+
+		if($this->remainingFuelTime <= 0 && $canBrew){
+			$this->checkFuel($fuel);
+		}
+
+		if($this->remainingFuelTime > 0){
+			if($canBrew){
+				if($this->brewTime === 0){
+					$this->brewTime = self::BREW_TIME_TICKS;
+					--$this->remainingFuelTime;
+				}
+
+				--$this->brewTime;
+
+				if($this->brewTime <= 0){
+					$anythingBrewed = false;
+					foreach($recipes as $slot => $recipe){
+						$input = $this->inventory->getItem($slot);
+						$output = $recipe->getResultFor($input);
+						if($output === null){
+							continue;
+						}
+
+						$ev = new BrewItemEvent($this, $slot, $input, $output, $recipe);
+						$ev->call();
+						if($ev->isCancelled()){
+							continue;
+						}
+
+						$this->inventory->setItem($slot, $ev->getResult());
+						$anythingBrewed = true;
+					}
+
+					if($anythingBrewed){
+						$this->position->getWorld()->addSound($this->position->add(0.5, 0.5, 0.5), new PotionFinishBrewingSound());
+					}
+
+					$ingredient->pop();
+					$this->inventory->setItem(BrewingStandInventory::SLOT_INGREDIENT, $ingredient);
+
+					$this->brewTime = 0;
+				}else{
+					$ret = true;
+				}
+			}else{
+				$this->brewTime = 0;
+			}
+		}else{
+			$this->brewTime = $this->remainingFuelTime = $this->maxFuelTime = 0;
+		}
+
+		$viewers = array_map(fn(Player $p) => $p->getNetworkSession()->getInvManager(), $this->inventory->getViewers());
+		foreach($viewers as $v){
+			if($v === null){
+				continue;
+			}
+			if($prevBrewTime !== $this->brewTime){
+				$v->syncData($this->inventory, ContainerSetDataPacket::PROPERTY_BREWING_STAND_BREW_TIME, $this->brewTime);
+			}
+			if($prevRemainingFuelTime !== $this->remainingFuelTime){
+				$v->syncData($this->inventory, ContainerSetDataPacket::PROPERTY_BREWING_STAND_FUEL_AMOUNT, $this->remainingFuelTime);
+			}
+			if($prevMaxFuelTime !== $this->maxFuelTime){
+				$v->syncData($this->inventory, ContainerSetDataPacket::PROPERTY_BREWING_STAND_FUEL_TOTAL, $this->maxFuelTime);
+			}
+		}
+
+		$this->timings->stopTiming();
+
+		return $ret;
+	}
 }

src/block/utils/BrewingStandSlot.php

@@ -23,6 +23,7 @@ declare(strict_types=1);
 
 namespace pocketmine\block\utils;
 
+use pocketmine\block\inventory\BrewingStandInventory;
 use pocketmine\utils\EnumTrait;
 
 /**
@@ -36,13 +37,24 @@ use pocketmine\utils\EnumTrait;
  * @method static BrewingStandSlot SOUTHWEST()
  */
 final class BrewingStandSlot{
-	use EnumTrait;
+	use EnumTrait {
+		__construct as Enum___construct;
+	}
 
 	protected static function setup() : void{
 		self::registerAll(
-			new self("east"),
-			new self("northwest"),
-			new self("southwest")
+			new self("east", BrewingStandInventory::SLOT_BOTTLE_LEFT),
+			new self("northwest", BrewingStandInventory::SLOT_BOTTLE_MIDDLE),
+			new self("southwest", BrewingStandInventory::SLOT_BOTTLE_RIGHT)
 		);
 	}
+
+	private function __construct(string $enumName, private int $slotNumber){
+		$this->Enum___construct($enumName);
+	}
+
+	/**
+	 * Returns the brewing stand inventory slot number associated with this visual slot.
+	 */
+	public function getSlotNumber() : int{ return $this->slotNumber; }
 }