Anvil Class Reference

Public Member Functions
	nbtSerialize (Chunk $chunk)
	nbtDeserialize (string $data)
	getWorldHeight ()
Public Member Functions inherited from McRegion
	nbtSerialize (Chunk $chunk)
	nbtDeserialize (string $data)
	getWorldHeight ()
	getGenerator ()
	getGeneratorOptions ()
	getChunk (int $chunkX, int $chunkZ, bool $create=false)
	setChunk (int $chunkX, int $chunkZ, Chunk $chunk)
	saveChunk (int $chunkX, int $chunkZ)
	saveChunks ()
	loadChunk (int $chunkX, int $chunkZ, bool $create=false)
	unloadChunk (int $chunkX, int $chunkZ, bool $safe=true)
	unloadChunks ()
	isChunkLoaded (int $chunkX, int $chunkZ)
	isChunkGenerated (int $chunkX, int $chunkZ)
	isChunkPopulated (int $chunkX, int $chunkZ)
	getLoadedChunks ()
	doGarbageCollection ()
	getEmptyChunk (int $chunkX, int $chunkZ)
	close ()
Public Member Functions inherited from BaseLevelProvider
	__construct (Level $level, string $path)
	getPath ()
	getServer ()
	getLevel ()
	getName ()
	getTime ()
	setTime ($value)
	getSeed ()
	setSeed ($value)
	getSpawn ()
	setSpawn (Vector3 $pos)
	doGarbageCollection ()
	getLevelData ()
	saveLevelData ()
	requestChunkTask (int $x, int $z)

Static Public Member Functions
static	getProviderName ()
Static Public Member Functions inherited from McRegion
static	getProviderName ()
static	isValid (string $path)
static	generate (string $path, string $name, $seed, string $generator, array $options=[])
static	getRegionIndex (int $chunkX, int $chunkZ, &$x, &$z)

Data Fields
const	REGION_FILE_EXTENSION = "mca"
Data Fields inherited from McRegion
const	REGION_FILE_EXTENSION = "mcr"

Additional Inherited Members
Protected Member Functions inherited from McRegion
	getRegion (int $x, int $z)
	loadRegion (int $x, int $z)
Protected Attributes inherited from McRegion
	$regions = []
	$chunks = []
Protected Attributes inherited from BaseLevelProvider
	$level
	$path
	$levelData
	$asyncChunkRequest = false

Member Function Documentation

getProviderName()

static getProviderName ( )

static

Returns

string

Implements LevelProvider.

                                             : string{
        return "anvil";
    }

getWorldHeight()

getWorldHeight

(

)

Returns

int

Implements LevelProvider.

                                     : int{
        //TODO: add world height options
        return 256;
    }

nbtDeserialize()

nbtDeserialize

(

string

$data

)

Parameters

string

$data

Returns

null|Chunk

                                                {
        $nbt = new NBT(NBT::BIG_ENDIAN);
        try{
            $nbt->readCompressed($data, ZLIB_ENCODING_DEFLATE);

            $chunk = $nbt->getData();

            if(!isset($chunk->Level) or !($chunk->Level instanceof CompoundTag)){
                throw new ChunkException("Invalid NBT format");
            }

            $chunk = $chunk->Level;

            $subChunks = [];
            if($chunk->Sections instanceof ListTag){
                foreach($chunk->Sections as $subChunk){
                    if($subChunk instanceof CompoundTag){
                        $subChunks[$subChunk->Y->getValue()] = new SubChunk(
                            ChunkUtils::reorderByteArray($subChunk->Blocks->getValue()),
                            ChunkUtils::reorderNibbleArray($subChunk->Data->getValue()),
                            ChunkUtils::reorderNibbleArray($subChunk->SkyLight->getValue(), "\xff"),
                            ChunkUtils::reorderNibbleArray($subChunk->BlockLight->getValue())
                        );
                    }
                }
            }

            if(isset($chunk->BiomeColors)){
                $biomeIds = ChunkUtils::convertBiomeColors($chunk->BiomeColors->getValue()); //Convert back to original format
            }elseif(isset($chunk->Biomes)){
                $biomeIds = $chunk->Biomes->getValue();
            }else{
                $biomeIds = "";
            }

            $result = new Chunk(
                $chunk["xPos"],
                $chunk["zPos"],
                $subChunks,
                isset($chunk->Entities) ? $chunk->Entities->getValue() : [],
                isset($chunk->TileEntities) ? $chunk->TileEntities->getValue() : [],
                $biomeIds,
                isset($chunk->HeightMap) ? $chunk->HeightMap->getValue() : []
            );
            $result->setLightPopulated(isset($chunk->LightPopulated) ? ((bool) $chunk->LightPopulated->getValue()) : false);
            $result->setPopulated(isset($chunk->TerrainPopulated) ? ((bool) $chunk->TerrainPopulated->getValue()) : false);
            $result->setGenerated(true);
            return $result;
        }catch(\Throwable $e){
            MainLogger::getLogger()->logException($e);
            return null;
        }
    }

nbtSerialize()

nbtSerialize

(

Chunk

$chunk

)

Parameters

Chunk

$chunk

Returns

string

                                               : string{
        $nbt = new CompoundTag("Level", []);
        $nbt->xPos = new IntTag("xPos", $chunk->getX());
        $nbt->zPos = new IntTag("zPos", $chunk->getZ());

        $nbt->V = new ByteTag("V", 1);
        $nbt->LastUpdate = new LongTag("LastUpdate", 0); //TODO
        $nbt->InhabitedTime = new LongTag("InhabitedTime", 0); //TODO
        $nbt->TerrainPopulated = new ByteTag("TerrainPopulated", $chunk->isPopulated());
        $nbt->LightPopulated = new ByteTag("LightPopulated", $chunk->isLightPopulated());

        $nbt->Sections = new ListTag("Sections", []);
        $nbt->Sections->setTagType(NBT::TAG_Compound);
        $subChunks = -1;
        foreach($chunk->getSubChunks() as $y => $subChunk){
            if($subChunk->isEmpty()){
                continue;
            }
            $nbt->Sections[++$subChunks] = new CompoundTag(null, [
                "Y" => new ByteTag("Y", $y),
                "Blocks" => new ByteArrayTag("Blocks", ChunkUtils::reorderByteArray($subChunk->getBlockIdArray())), //Generic in-memory chunks are currently always XZY
                "Data" => new ByteArrayTag("Data", ChunkUtils::reorderNibbleArray($subChunk->getBlockDataArray())),
                "SkyLight" => new ByteArrayTag("SkyLight", ChunkUtils::reorderNibbleArray($subChunk->getSkyLightArray(), "\xff")),
                "BlockLight" => new ByteArrayTag("BlockLight", ChunkUtils::reorderNibbleArray($subChunk->getBlockLightArray()))
            ]);
        }

        $nbt->Biomes = new ByteArrayTag("Biomes", $chunk->getBiomeIdArray());
        $nbt->HeightMap = new IntArrayTag("HeightMap", $chunk->getHeightMapArray());

        $entities = [];

        foreach($chunk->getEntities() as $entity){
            if(!($entity instanceof Player) and !$entity->closed){
                $entity->saveNBT();
                $entities[] = $entity->namedtag;
            }
        }

        $nbt->Entities = new ListTag("Entities", $entities);
        $nbt->Entities->setTagType(NBT::TAG_Compound);

        $tiles = [];
        foreach($chunk->getTiles() as $tile){
            $tile->saveNBT();
            $tiles[] = $tile->namedtag;
        }

        $nbt->TileEntities = new ListTag("TileEntities", $tiles);
        $nbt->TileEntities->setTagType(NBT::TAG_Compound);

        //TODO: TileTicks

        $writer = new NBT(NBT::BIG_ENDIAN);
        $nbt->setName("Level");
        $writer->setData(new CompoundTag("", ["Level" => $nbt]));

        return $writer->writeCompressed(ZLIB_ENCODING_DEFLATE, RegionLoader::$COMPRESSION_LEVEL);
    }

Field Documentation

REGION_FILE_EXTENSION

const REGION_FILE_EXTENSION = "mca"

---

The documentation for this class was generated from the following file:

• src/pocketmine/level/format/io/region/Anvil.php