Public Member Functions
	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	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 = "mcr"

Protected Member Functions
	getRegion (int $x, int $z)

	loadRegion (int $x, int $z)

Protected Attributes
	$regions = []

	$chunks = []

Protected Attributes inherited from BaseLevelProvider
	$level

	$path

	$levelData

	$asyncChunkRequest = false

Member Function Documentation

◆ close()

close ( )

Implements LevelProvider.

                            {
         $this->unloadChunks();
         foreach($this->regions as $index => $region){
             $region->close();
             unset($this->regions[$index]);
         }
         $this->level = null;
     }

◆ doGarbageCollection()

doGarbageCollection ( )

Implements LevelProvider.

                                          {
         $limit = time() - 300;
         foreach($this->regions as $index => $region){
             if($region->lastUsed <= $limit){
                 $region->close();
                 unset($this->regions[$index]);
             }
         }
     }

◆ generate()

static generate	(	string	$path,
		string	$name,
			$seed,
		string	$generator,
		array	$options = `[]`
	)

static

Parameters

string	$path
string	$name
int \| string	$seed
string	$generator
array	$options

Implements LevelProvider.

                                                                                                               {
         if(!file_exists($path)){
             mkdir($path, 0777, true);
         }
 
         if(!file_exists($path . "/region")){
             mkdir($path . "/region", 0777);
         }
         //TODO, add extra details
         $levelData = new CompoundTag("Data", [
             "hardcore" => new ByteTag("hardcore", 0),
             "initialized" => new ByteTag("initialized", 1),
             "GameType" => new IntTag("GameType", 0),
             "generatorVersion" => new IntTag("generatorVersion", 1), //2 in MCPE
             "SpawnX" => new IntTag("SpawnX", 128),
             "SpawnY" => new IntTag("SpawnY", 70),
             "SpawnZ" => new IntTag("SpawnZ", 128),
             "version" => new IntTag("version", 19133),
             "DayTime" => new IntTag("DayTime", 0),
             "LastPlayed" => new LongTag("LastPlayed", microtime(true) * 1000),
             "RandomSeed" => new LongTag("RandomSeed", $seed),
             "SizeOnDisk" => new LongTag("SizeOnDisk", 0),
             "Time" => new LongTag("Time", 0),
             "generatorName" => new StringTag("generatorName", Generator::getGeneratorName($generator)),
             "generatorOptions" => new StringTag("generatorOptions", isset($options["preset"]) ? $options["preset"] : ""),
             "LevelName" => new StringTag("LevelName", $name),
             "GameRules" => new CompoundTag("GameRules", [])
         ]);
         $nbt = new NBT(NBT::BIG_ENDIAN);
         $nbt->setData(new CompoundTag("", [
             "Data" => $levelData
         ]));
         $buffer = $nbt->writeCompressed();
         file_put_contents($path . "level.dat", $buffer);
     }

◆ getChunk()

getChunk	(	int	$chunkX,
		int	$chunkZ,
		bool	$create = `false`
	)

Parameters

int	$chunkX
int	$chunkZ
bool	$create

Returns: null|Chunk

Implements LevelProvider.

                                                                             {
         $index = Level::chunkHash($chunkX, $chunkZ);
         if(isset($this->chunks[$index])){
             return $this->chunks[$index];
         }else{
             $this->loadChunk($chunkX, $chunkZ, $create);
 
             return $this->chunks[$index] ?? null;
         }
     }

◆ getEmptyChunk()

getEmptyChunk	(	int	$chunkX,
		int	$chunkZ
	)

Parameters

int	$chunkX
int	$chunkZ

Returns: Chunk

                                                            {
         return Chunk::getEmptyChunk($chunkX, $chunkZ);
     }

◆ getGenerator()

getGenerator ( )

Returns: string

Implements LevelProvider.

                                    : string{
         return (string) $this->levelData["generatorName"];
     }

◆ getGeneratorOptions()

getGeneratorOptions ( )

Returns: array

Implements LevelProvider.

                                           : array{
         return ["preset" => $this->levelData["generatorOptions"]];
     }

◆ getLoadedChunks()

getLoadedChunks ( )

Returns: array

Implements LevelProvider.

                                       : array{
         return $this->chunks;
     }

◆ getProviderName()

static getProviderName ( )

static

Returns: string

Implements LevelProvider.

                                              : string{
         return "mcregion";
     }

◆ getRegion()

getRegion	(	int	$x,
		int	$z
	)

protected

Parameters

int	$x
int	$z

Returns: RegionLoader

                                                 {
         return $this->regions[Level::chunkHash($x, $z)] ?? null;
     }

◆ getRegionIndex()

static getRegionIndex	(	int	$chunkX,
		int	$chunkZ,
		&	$x,
		&	$z
	)

static

Parameters

int	$chunkX
int	$chunkZ
int	&$x
int	&$z

                                                                              {
         $x = $chunkX >> 5;
         $z = $chunkZ >> 5;
     }

◆ getWorldHeight()

getWorldHeight ( )

Returns: int

Implements LevelProvider.

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

◆ isChunkGenerated()

isChunkGenerated	(	int	$chunkX,
		int	$chunkZ
	)

Parameters

int	$chunkX
int	$chunkZ

Returns: bool

Implements LevelProvider.

                                                                : bool{
         if(($region = $this->getRegion($chunkX >> 5, $chunkZ >> 5)) !== null){
             return $region->chunkExists($chunkX - $region->getX() * 32, $chunkZ - $region->getZ() * 32) and $this->getChunk($chunkX - $region->getX() * 32, $chunkZ - $region->getZ() * 32, true)->isGenerated();
         }
 
         return false;
     }

◆ isChunkLoaded()

isChunkLoaded	(	int	$chunkX,
		int	$chunkZ
	)

Parameters

int	$chunkX
int	$chunkZ

Returns: bool

Implements LevelProvider.

                                                             : bool{
         return isset($this->chunks[Level::chunkHash($chunkX, $chunkZ)]);
     }

◆ isChunkPopulated()

isChunkPopulated	(	int	$chunkX,
		int	$chunkZ
	)

Parameters

int	$chunkX
int	$chunkZ

Returns: bool

Implements LevelProvider.

                                                                : bool{
         $chunk = $this->getChunk($chunkX, $chunkZ);
         if($chunk !== null){
             return $chunk->isPopulated();
         }else{
             return false;
         }
     }

◆ isValid()

static isValid ( string $path )

static

Parameters

string $path

Returns: bool

Implements LevelProvider.

                                                  : bool{
         $isValid = (file_exists($path . "/level.dat") and is_dir($path . "/region/"));
 
         if($isValid){
             $files = glob($path . "/region/*.mc*");
             if(empty($files)){ //possible glob() issue on some systems
                 $files = array_filter(scandir($path . "/region/"), function($file){
                     return substr($file, strrpos($file, ".") + 1, 2) === "mc"; //region file
                 });
             }
 
             foreach($files as $f){
                 if(substr($f, strrpos($f, ".") + 1) !== static::REGION_FILE_EXTENSION){
                     $isValid = false;
                     break;
                 }
             }
         }
 
         return $isValid;
     }

◆ loadChunk()

loadChunk	(	int	$chunkX,
		int	$chunkZ,
		bool	$create = `false`
	)

Parameters

int	$chunkX
int	$chunkZ
bool	$create

Returns: bool

PhpStrictTypeCheckingInspection

Implements LevelProvider.

                                                                               : bool{
         $index = Level::chunkHash($chunkX, $chunkZ);
         if(isset($this->chunks[$index])){
             return true;
         }
         $regionX = $regionZ = null;
         self::getRegionIndex($chunkX, $chunkZ, $regionX, $regionZ);
         $this->loadRegion($regionX, $regionZ);
         $this->level->timings->syncChunkLoadDataTimer->startTiming();
         $chunk = $this->getRegion($regionX, $regionZ)->readChunk($chunkX - $regionX * 32, $chunkZ - $regionZ * 32);
         if($chunk === null and $create){
             $chunk = $this->getEmptyChunk($chunkX, $chunkZ);
         }
         $this->level->timings->syncChunkLoadDataTimer->stopTiming();
 
         if($chunk !== null){
             $this->chunks[$index] = $chunk;
             return true;
         }else{
             return false;
         }
     }

◆ loadRegion()

loadRegion	(	int	$x,
		int	$z
	)

protected

Parameters

int	$x
int	$z

                                                  {
         if(!isset($this->regions[$index = Level::chunkHash($x, $z)])){
             $this->regions[$index] = new RegionLoader($this, $x, $z, static::REGION_FILE_EXTENSION);
         }
     }

◆ nbtDeserialize()

nbtDeserialize ( string $data )

Parameters

string $data

Returns: Chunk|null

                                                 {
         $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 = [];
             $fullIds = isset($chunk->Blocks) ? $chunk->Blocks->getValue() : str_repeat("\x00", 32768);
             $fullData = isset($chunk->Data) ? $chunk->Data->getValue() : (str_repeat("\x00", 16384));
             $fullSkyLight = isset($chunk->SkyLight) ? $chunk->SkyLight->getValue() : str_repeat("\xff", 16384);
             $fullBlockLight = isset($chunk->BlockLight) ? $chunk->BlockLight->getValue() : (str_repeat("\x00", 16384));
 
             for($y = 0; $y < 8; ++$y){
                 $offset = ($y << 4);
                 $ids = "";
                 for($i = 0; $i < 256; ++$i){
                     $ids .= substr($fullIds, $offset, 16);
                     $offset += 128;
                 }
                 $data = "";
                 $offset = ($y << 3);
                 for($i = 0; $i < 256; ++$i){
                     $data .= substr($fullData, $offset, 8);
                     $offset += 64;
                 }
                 $skyLight = "";
                 $offset = ($y << 3);
                 for($i = 0; $i < 256; ++$i){
                     $skyLight .= substr($fullSkyLight, $offset, 8);
                     $offset += 64;
                 }
                 $blockLight = "";
                 $offset = ($y << 3);
                 for($i = 0; $i < 256; ++$i){
                     $blockLight .= substr($fullBlockLight, $offset, 8);
                     $offset += 64;
                 }
                 $subChunks[$y] = new SubChunk($ids, $data, $skyLight, $blockLight);
             }
 
             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 = "";
             }
 
             $heightMap = [];
             if(isset($chunk->HeightMap)){
                 if($chunk->HeightMap instanceof ByteArrayTag){
                     $heightMap = array_values(unpack("C*", $chunk->HeightMap->getValue()));
                 }elseif($chunk->HeightMap instanceof IntArrayTag){
                     $heightMap = $chunk->HeightMap->getValue(); #blameshoghicp
                 }
             }
 
             $result = new Chunk(
                 $chunk["xPos"],
                 $chunk["zPos"],
                 $subChunks,
                 isset($chunk->Entities) ? $chunk->Entities->getValue() : [],
                 isset($chunk->TileEntities) ? $chunk->TileEntities->getValue() : [],
                 $biomeIds,
                 $heightMap
             );
             $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", 0); //guess
         $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());
 
         $ids = "";
         $data = "";
         $skyLight = "";
         $blockLight = "";
         $subChunks = $chunk->getSubChunks();
         for($x = 0; $x < 16; ++$x){
             for($z = 0; $z < 16; ++$z){
                 for($y = 0; $y < 8; ++$y){
                     $subChunk = $subChunks[$y];
                     $ids .= $subChunk->getBlockIdColumn($x, $z);
                     $data .= $subChunk->getBlockDataColumn($x, $z);
                     $skyLight .= $subChunk->getSkyLightColumn($x, $z);
                     $blockLight .= $subChunk->getBlockLightColumn($x, $z);
                 }
             }
         }
 
         $nbt->Blocks = new ByteArrayTag("Blocks", $ids);
         $nbt->Data = new ByteArrayTag("Data", $data);
         $nbt->SkyLight = new ByteArrayTag("SkyLight", $skyLight);
         $nbt->BlockLight = new ByteArrayTag("BlockLight", $blockLight);
 
         $nbt->Biomes = new ByteArrayTag("Biomes", $chunk->getBiomeIdArray());
         $nbt->HeightMap = new ByteArrayTag("HeightMap", pack("C*", ...$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);
     }

◆ saveChunk()

saveChunk	(	int	$chunkX,
		int	$chunkZ
	)

Parameters

int	$chunkX
int	$chunkZ

Returns: bool

Implements LevelProvider.

                                                         : bool{
         if($this->isChunkLoaded($chunkX, $chunkZ)){
             $chunk = $this->getChunk($chunkX, $chunkZ);
             if(!$chunk->isGenerated()){
                 throw new \InvalidStateException("Cannot save un-generated chunk");
             }
             $this->getRegion($chunkX >> 5, $chunkZ >> 5)->writeChunk($chunk);
 
             return true;
         }
 
         return false;
     }

◆ saveChunks()

saveChunks ( )

Implements LevelProvider.

                                 {
         foreach($this->chunks as $chunk){
             $this->saveChunk($chunk->getX(), $chunk->getZ());
         }
     }

◆ setChunk()

setChunk	(	int	$chunkX,
		int	$chunkZ,
		Chunk	$chunk
	)

Parameters

int	$chunkX
int	$chunkZ
Chunk	$chunk

Implements LevelProvider.

                                                                     {
         self::getRegionIndex($chunkX, $chunkZ, $regionX, $regionZ);
         $this->loadRegion($regionX, $regionZ);
 
         $chunk->setX($chunkX);
         $chunk->setZ($chunkZ);
 
 
         if(isset($this->chunks[$index = Level::chunkHash($chunkX, $chunkZ)]) and $this->chunks[$index] !== $chunk){
             $this->unloadChunk($chunkX, $chunkZ, false);
         }
 
         $this->chunks[$index] = $chunk;
     }

◆ unloadChunk()

unloadChunk	(	int	$chunkX,
		int	$chunkZ,
		bool	$safe = `true`
	)

Parameters

int	$chunkX
int	$chunkZ
bool	$safe

Returns: bool

Implements LevelProvider.

                                                                              : bool{
         $chunk = $this->chunks[$index = Level::chunkHash($chunkX, $chunkZ)] ?? null;
         if($chunk instanceof Chunk and $chunk->unload($safe)){
             unset($this->chunks[$index]);
             return true;
         }
 
         return false;
     }

◆ unloadChunks()

unloadChunks ( )

Implements LevelProvider.

                                   {
         foreach($this->chunks as $chunk){
             $this->unloadChunk($chunk->getX(), $chunk->getZ(), false);
         }
         $this->chunks = [];
     }

Field Documentation

◆ $chunks

$chunks = []

protected

◆ $regions

$regions = []

protected

◆ REGION_FILE_EXTENSION

const REGION_FILE_EXTENSION = "mcr"

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

src/pocketmine/level/format/io/region/McRegion.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ close()

◆ doGarbageCollection()

◆ generate()

◆ getChunk()

◆ getEmptyChunk()

◆ getGenerator()

◆ getGeneratorOptions()

◆ getLoadedChunks()

◆ getProviderName()

◆ getRegion()

◆ getRegionIndex()

◆ getWorldHeight()

◆ isChunkGenerated()

◆ isChunkLoaded()

◆ isChunkPopulated()

◆ isValid()

◆ loadChunk()

◆ loadRegion()

◆ nbtDeserialize()

◆ nbtSerialize()

◆ saveChunk()

◆ saveChunks()

◆ setChunk()

◆ unloadChunk()

◆ unloadChunks()

Field Documentation

◆ $chunks

◆ $regions

◆ REGION_FILE_EXTENSION