BlockStateSerializerHelper.php

<?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\data\bedrock\block\convert;
 
use pocketmine\block\Button;
use pocketmine\block\Candle;
use pocketmine\block\ChemistryTable;
use pocketmine\block\Crops;
use pocketmine\block\Door;
use pocketmine\block\DoublePlant;
use pocketmine\block\FenceGate;
use pocketmine\block\FloorSign;
use pocketmine\block\Furnace;
use pocketmine\block\ItemFrame;
use pocketmine\block\Leaves;
use pocketmine\block\Liquid;
use pocketmine\block\RedMushroomBlock;
use pocketmine\block\Sapling;
use pocketmine\block\SimplePressurePlate;
use pocketmine\block\Slab;
use pocketmine\block\Stair;
use pocketmine\block\Stem;
use pocketmine\block\Torch;
use pocketmine\block\Trapdoor;
use pocketmine\block\utils\CopperOxidation;
use pocketmine\block\utils\SlabType;
use pocketmine\block\Wall;
use pocketmine\block\WallSign;
use pocketmine\block\Wood;
use pocketmine\data\bedrock\block\BlockStateNames;
use pocketmine\data\bedrock\block\BlockStateNames as StateNames;
use pocketmine\data\bedrock\block\BlockTypeNames as Ids;
use pocketmine\data\bedrock\block\convert\BlockStateWriter as Writer;
use pocketmine\data\bedrock\MushroomBlockTypeIdMap;
use pocketmine\math\Facing;
 
final class BlockStateSerializerHelper{
    public static function encodeButton(Button $block, Writer $out) : Writer{
        return $out
            ->writeFacingDirection($block->getFacing())
            ->writeBool(BlockStateNames::BUTTON_PRESSED_BIT, $block->isPressed());
    }
 
    public static function encodeCandle(Candle $block, Writer $out) : Writer{
        return $out
            ->writeBool(StateNames::LIT, $block->isLit())
            ->writeInt(StateNames::CANDLES, $block->getCount() - 1);
    }
 
    public static function encodeChemistryTable(ChemistryTable $block, Writer $out) : Writer{
        return $out
            ->writeLegacyHorizontalFacing(Facing::opposite($block->getFacing()));
    }
 
    public static function encodeCrops(Crops $block, Writer $out) : Writer{
        return $out->writeInt(BlockStateNames::GROWTH, $block->getAge());
    }
 
    public static function encodeTorch(Torch $block, Writer $out) : Writer{
        return $out
            ->writeTorchFacing($block->getFacing());
    }
 
    public static function encodeCauldron(string $liquid, int $fillLevel) : Writer{
        return Writer::create(Ids::CAULDRON)
            ->writeString(BlockStateNames::CAULDRON_LIQUID, $liquid)
            ->writeInt(BlockStateNames::FILL_LEVEL, $fillLevel);
    }
 
    public static function selectCopperId(CopperOxidation $oxidation, string $noneId, string $exposedId, string $weatheredId, string $oxidizedId) : string{
        return match($oxidation){
            CopperOxidation::NONE => $noneId,
            CopperOxidation::EXPOSED => $exposedId,
            CopperOxidation::WEATHERED => $weatheredId,
            CopperOxidation::OXIDIZED => $oxidizedId,
        };
    }
 
    public static function encodeDoor(Door $block, Writer $out) : Writer{
        return $out
            ->writeBool(BlockStateNames::UPPER_BLOCK_BIT, $block->isTop())
            //a door facing north is encoded as "east"
            ->writeCardinalHorizontalFacing(Facing::rotateY($block->getFacing(), clockwise: true))
            ->writeBool(BlockStateNames::DOOR_HINGE_BIT, $block->isHingeRight())
            ->writeBool(BlockStateNames::OPEN_BIT, $block->isOpen());
    }
 
    public static function encodeDoublePlant(DoublePlant $block, Writer $out) : Writer{
        return $out
            ->writeBool(BlockStateNames::UPPER_BLOCK_BIT, $block->isTop());
    }
 
    public static function encodeFenceGate(FenceGate $block, Writer $out) : Writer{
        return $out
            ->writeCardinalHorizontalFacing($block->getFacing())
            ->writeBool(BlockStateNames::IN_WALL_BIT, $block->isInWall())
            ->writeBool(BlockStateNames::OPEN_BIT, $block->isOpen());
    }
 
    public static function encodeFloorSign(FloorSign $block, Writer $out) : Writer{
        return $out
            ->writeInt(BlockStateNames::GROUND_SIGN_DIRECTION, $block->getRotation());
    }
 
    public static function encodeFurnace(Furnace $block, string $unlitId, string $litId) : Writer{
        return Writer::create($block->isLit() ? $litId : $unlitId)
            ->writeCardinalHorizontalFacing($block->getFacing());
    }
 
    public static function encodeItemFrame(ItemFrame $block, string $id) : Writer{
        return Writer::create($id)
            ->writeBool(StateNames::ITEM_FRAME_MAP_BIT, $block->hasMap())
            ->writeBool(StateNames::ITEM_FRAME_PHOTO_BIT, false)
            ->writeFacingDirection($block->getFacing());
    }
 
    public static function encodeLeaves(Leaves $block, Writer $out) : Writer{
        return $out
            ->writeBool(BlockStateNames::PERSISTENT_BIT, $block->isNoDecay())
            ->writeBool(BlockStateNames::UPDATE_BIT, $block->isCheckDecay());
    }
 
    public static function encodeLiquid(Liquid $block, string $stillId, string $flowingId) : Writer{
        return Writer::create($block->isStill() ? $stillId : $flowingId)
            ->writeInt(BlockStateNames::LIQUID_DEPTH, $block->getDecay() | ($block->isFalling() ? 0x8 : 0));
    }
 
    public static function encodeLog(Wood $block, string $unstrippedId, string $strippedId) : Writer{
        $out = $block->isStripped() ?
            Writer::create($strippedId) :
            Writer::create($unstrippedId);
        return $out
            ->writePillarAxis($block->getAxis());
    }
 
    public static function encodeMushroomBlock(RedMushroomBlock $block, Writer $out) : Writer{
        return $out
            ->writeInt(BlockStateNames::HUGE_MUSHROOM_BITS, MushroomBlockTypeIdMap::getInstance()->toId($block->getMushroomBlockType()));
    }
 
    public static function encodeQuartz(int $axis, Writer $out) : Writer{
        return $out
            ->writePillarAxis($axis); //this isn't needed for all types, but we have to write it anyway
    }
 
    public static function encodeSapling(Sapling $block, Writer $out) : Writer{
        return $out
            ->writeBool(BlockStateNames::AGE_BIT, $block->isReady());
    }
 
    public static function encodeSimplePressurePlate(SimplePressurePlate $block, Writer $out) : Writer{
        //TODO: not sure what the deal is here ... seems like a mojang bug / artifact of bad implementation?
        //best to keep this separate from weighted plates anyway...
        return $out
            ->writeInt(BlockStateNames::REDSTONE_SIGNAL, $block->isPressed() ? 15 : 0);
    }
 
    private static function encodeSingleSlab(Slab $block, string $id) : Writer{
        return Writer::create($id)
            ->writeSlabPosition($block->getSlabType());
    }
 
    private static function encodeDoubleSlab(Slab $block, string $id) : Writer{
        return Writer::create($id)
            //this is (intentionally) also written for double slabs (as zero) to maintain bug parity with MCPE
            ->writeSlabPosition(SlabType::BOTTOM);
    }
 
    public static function encodeSlab(Slab $block, string $singleId, string $doubleId) : Writer{
        return $block->getSlabType() === SlabType::DOUBLE ?
            self::encodeDoubleSlab($block, $doubleId) :
            self::encodeSingleSlab($block, $singleId);
    }
 
    public static function encodeStairs(Stair $block, Writer $out) : Writer{
        return $out
            ->writeBool(BlockStateNames::UPSIDE_DOWN_BIT, $block->isUpsideDown())
            ->writeWeirdoHorizontalFacing($block->getFacing());
    }
 
    public static function encodeStem(Stem $block, Writer $out) : Writer{
        //In PM, we use Facing::UP to indicate that the stem is not attached to a pumpkin/melon, since this makes the
        //most intuitive sense (the stem is pointing at the sky). However, Bedrock uses the DOWN state for this, which
        //is absurd, and I refuse to make our API similarly absurd.
        $facing = $block->getFacing();
        return self::encodeCrops($block, $out)
            ->writeFacingWithoutUp($facing === Facing::UP ? Facing::DOWN : $facing);
    }
 
    public static function encodeTrapdoor(Trapdoor $block, Writer $out) : Writer{
        return $out
            ->write5MinusHorizontalFacing($block->getFacing())
            ->writeBool(BlockStateNames::UPSIDE_DOWN_BIT, $block->isTop())
            ->writeBool(BlockStateNames::OPEN_BIT, $block->isOpen());
    }
 
    public static function encodeWall(Wall $block, Writer $out) : Writer{
        return $out
            ->writeBool(BlockStateNames::WALL_POST_BIT, $block->isPost())
            ->writeWallConnectionType(BlockStateNames::WALL_CONNECTION_TYPE_EAST, $block->getConnection(Facing::EAST))
            ->writeWallConnectionType(BlockStateNames::WALL_CONNECTION_TYPE_NORTH, $block->getConnection(Facing::NORTH))
            ->writeWallConnectionType(BlockStateNames::WALL_CONNECTION_TYPE_SOUTH, $block->getConnection(Facing::SOUTH))
            ->writeWallConnectionType(BlockStateNames::WALL_CONNECTION_TYPE_WEST, $block->getConnection(Facing::WEST));
    }
 
    public static function encodeWallSign(WallSign $block, Writer $out) : Writer{
        return $out
            ->writeHorizontalFacing($block->getFacing());
    }
}