BaseNbtWorldData.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\world\format\io\data;
 
use pocketmine\math\Vector3;
use pocketmine\nbt\tag\CompoundTag;
use pocketmine\nbt\tag\IntTag;
use pocketmine\world\format\io\exception\CorruptedWorldException;
use pocketmine\world\format\io\exception\UnsupportedWorldFormatException;
use pocketmine\world\format\io\WorldData;
use function file_exists;
 
abstract class BaseNbtWorldData implements WorldData{
    protected const TAG_LEVEL_NAME = "LevelName";
    protected const TAG_GENERATOR_NAME = "generatorName";
    protected const TAG_GENERATOR_OPTIONS = "generatorOptions";
    protected const TAG_RANDOM_SEED = "RandomSeed";
    protected const TAG_TIME = "Time";
    protected const TAG_SPAWN_X = "SpawnX";
    protected const TAG_SPAWN_Y = "SpawnY";
    protected const TAG_SPAWN_Z = "SpawnZ";
 
    protected CompoundTag $compoundTag;
 
    public function __construct(
        protected string $dataPath
    ){
        if(!file_exists($this->dataPath)){
            throw new CorruptedWorldException("World data not found at $dataPath");
        }
 
        try{
            $this->compoundTag = $this->load();
        }catch(CorruptedWorldException $e){
            throw new CorruptedWorldException("Corrupted world data: " . $e->getMessage(), 0, $e);
        }
        $this->fix();
    }
 
    abstract protected function load() : CompoundTag;
 
    abstract protected function fix() : void;
 
    protected static function hackyFixForGeneratorClasspathInLevelDat(string $className) : ?string{
        //THESE ARE DELIBERATELY HARDCODED, DO NOT CHANGE!
        switch($className){
            case 'pocketmine\level\generator\normal\Normal':
                return "normal";
            case 'pocketmine\level\generator\Flat':
                return "flat";
        }
 
        return null;
    }
 
    public function getCompoundTag() : CompoundTag{
        return $this->compoundTag;
    }
 
    /* The below are common between PC and PE */
 
    public function getName() : string{
        return $this->compoundTag->getString(self::TAG_LEVEL_NAME);
    }
 
    public function setName(string $value) : void{
        $this->compoundTag->setString(self::TAG_LEVEL_NAME, $value);
    }
 
    public function getGenerator() : string{
        return $this->compoundTag->getString(self::TAG_GENERATOR_NAME, "DEFAULT");
    }
 
    public function getGeneratorOptions() : string{
        return $this->compoundTag->getString(self::TAG_GENERATOR_OPTIONS, "");
    }
 
    public function getSeed() : int{
        return $this->compoundTag->getLong(self::TAG_RANDOM_SEED);
    }
 
    public function getTime() : int{
        if(($timeTag = $this->compoundTag->getTag(self::TAG_TIME)) instanceof IntTag){ //some older PM worlds had this in the wrong format
            return $timeTag->getValue();
        }
        return $this->compoundTag->getLong(self::TAG_TIME, 0);
    }
 
    public function setTime(int $value) : void{
        $this->compoundTag->setLong(self::TAG_TIME, $value);
    }
 
    public function getSpawn() : Vector3{
        return new Vector3($this->compoundTag->getInt(self::TAG_SPAWN_X), $this->compoundTag->getInt(self::TAG_SPAWN_Y), $this->compoundTag->getInt(self::TAG_SPAWN_Z));
    }
 
    public function setSpawn(Vector3 $pos) : void{
        $this->compoundTag->setInt(self::TAG_SPAWN_X, $pos->getFloorX());
        $this->compoundTag->setInt(self::TAG_SPAWN_Y, $pos->getFloorY());
        $this->compoundTag->setInt(self::TAG_SPAWN_Z, $pos->getFloorZ());
    }
 
}