Files
PocketMine-MP/src/data/bedrock/block/convert/property/StringProperty.php
Dylan T. 7c521b456e Unify block serializers (#6769)
This has several advantages:

    Easier to implement new blocks (one less file to modify)
    Easier to adjust serialization of existing blocks
    Guaranteed consistency between serializers and deserializers
    Potentially, exposes more metadata for programmatic analysis, instead of having everything baked inside opaque Closures

There are some exceptions which still use the old approach: big dripleaf, cauldrons, mushroom stems, and pitcher crops. These all have multiple PM block types for a single ID, with relatively complex logic to select which to use. These weren't worth the effort to unify due to their small number. I may revisit this in the future, but I already spent a lot of brainpower on it.
2025-08-24 14:12:18 +01:00

51 lines
1.6 KiB
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\property;
/**
* @phpstan-template TBlock of object
* @phpstan-extends Property<TBlock>
*/
interface StringProperty extends Property{
/**
* @return string[]
* @phpstan-return list<string>
*/
public function getPossibleValues() : array;
/**
* TODO: These are only used for flattened IDs for now, we should expand their use to all properties
* in the future and remove the dependencies on BlockStateReader and BlockStateWriter
* @phpstan-param TBlock $block
*/
public function deserializePlain(object $block, string $raw) : void;
/**
* TODO: These are only used for flattened IDs for now, we should expand their use to all properties
* in the future and remove the dependencies on BlockStateReader and BlockStateWriter
* @phpstan-param TBlock $block
*/
public function serializePlain(object $block) : string;
}