pocketmine\world\format\io\region\PMAnvil Class Reference

Inheritance diagram for pocketmine\world\format\io\region\PMAnvil:

Collaboration diagram for pocketmine\world\format\io\region\PMAnvil:

Public Member Functions
	calculateChunkCount ()
	close ()
	doGarbageCollection ()
	getAllChunks (bool $skipCorrupted=false, ?\Logger $logger=null)
	getPath ()
	getWorldData ()
	getWorldMaxY ()
	getWorldMinY ()
	loadChunk (int $chunkX, int $chunkZ)

Static Public Member Functions
static	getRegionIndex (int $chunkX, int $chunkZ, &$regionX, &$regionZ)
static	isValid (string $path)

Protected Member Functions
	deserializeChunk (string $data, \Logger $logger)
	deserializeSubChunk (CompoundTag $subChunk, PalettedBlockArray $biomes3d, \Logger $logger)
	getRegion (int $regionX, int $regionZ)
	loadLevelData ()
	loadRegion (int $regionX, int $regionZ)
	palettizeLegacySubChunkFromColumn (string $idArray, string $metaArray, int $yOffset, \Logger $logger)
	palettizeLegacySubChunkXZY (string $idArray, string $metaArray, \Logger $logger)
	palettizeLegacySubChunkYZX (string $idArray, string $metaArray, \Logger $logger)
	pathToRegion (int $regionX, int $regionZ)
	unloadRegion (int $regionX, int $regionZ)

Static Protected Member Functions
static	getCompoundList (string $context, ListTag $list)
static	getPcWorldFormatVersion ()
static	getRegionFileExtension ()
static	readFixedSizeByteArray (CompoundTag $chunk, string $tagName, int $length)

Protected Attributes
BlockDataUpgrader	$blockDataUpgrader
BlockStateDeserializer	$blockStateDeserializer
BlockStateSerializer	$blockStateSerializer
array	$regions = []
WorldData	$worldData

Detailed Description

This format is exactly the same as the PC Anvil format, with the only difference being that the stored data order is XZY instead of YZX for more performance loading and saving worlds.

Definition at line 35 of file PMAnvil.php.

Member Function Documentation

calculateChunkCount()

pocketmine\world\format\io\region\RegionWorldProvider::calculateChunkCount ( )

inherited

Returns the number of chunks in the provider. Used for world conversion time estimations.

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 252 of file RegionWorldProvider.php.

close()

pocketmine\world\format\io\region\RegionWorldProvider::close ( )

inherited

Performs cleanups necessary when the world provider is closed and no longer needed.

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 147 of file RegionWorldProvider.php.

deserializeChunk()

pocketmine\world\format\io\region\RegionWorldProvider::deserializeChunk ( string $data, \Logger $logger )

abstractprotectedinherited

Exceptions

CorruptedChunkException

Reimplemented in pocketmine\world\format\io\region\McRegion.

deserializeSubChunk()

pocketmine\world\format\io\region\PMAnvil::deserializeSubChunk ( CompoundTag $subChunk, PalettedBlockArray $biomes3d, \Logger $logger )

protected

Definition at line 38 of file PMAnvil.php.

doGarbageCollection()

pocketmine\world\format\io\region\RegionWorldProvider::doGarbageCollection ( )

inherited

Performs garbage collection in the world provider, such as cleaning up regions in Region-based worlds.

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 87 of file RegionWorldProvider.php.

getAllChunks()

pocketmine\world\format\io\region\RegionWorldProvider::getAllChunks ( bool $skipCorrupted = false, ?\Logger $logger = null )

inherited

Returns a generator which yields all the chunks in this world.

Returns

\Generator|LoadedChunkData[] @phpstan-return \Generator<array{int, int}, LoadedChunkData, void, void>

Exceptions

CorruptedChunkException

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 221 of file RegionWorldProvider.php.

References Logger\error().

Here is the call graph for this function:

getCompoundList()

static pocketmine\world\format\io\region\RegionWorldProvider::getCompoundList ( string $context, ListTag $list )

staticprotectedinherited

Returns

CompoundTag[] @phpstan-return list<CompoundTag>

Exceptions

CorruptedChunkException

Definition at line 165 of file RegionWorldProvider.php.

getPath()

pocketmine\world\format\io\BaseWorldProvider::getPath ( )

inherited

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 118 of file BaseWorldProvider.php.

getPcWorldFormatVersion()

static pocketmine\world\format\io\region\PMAnvil::getPcWorldFormatVersion ( )

staticprotected

Returns the storage version as per Minecraft PC world formats.

Reimplemented from pocketmine\world\format\io\region\RegionWorldProvider.

Definition at line 50 of file PMAnvil.php.

getRegion()

pocketmine\world\format\io\region\RegionWorldProvider::getRegion ( int $regionX, int $regionZ )

protectedinherited

Definition at line 110 of file RegionWorldProvider.php.

getRegionFileExtension()

static pocketmine\world\format\io\region\PMAnvil::getRegionFileExtension ( )

staticprotected

Returns the file extension used for regions in this region-based format.

Reimplemented from pocketmine\world\format\io\region\RegionWorldProvider.

Definition at line 46 of file PMAnvil.php.

getRegionIndex()

static pocketmine\world\format\io\region\RegionWorldProvider::getRegionIndex ( int $chunkX, int $chunkZ, & $regionX, & $regionZ )

staticinherited

Parameters

int | null	$regionX	reference parameter
int | null	$regionZ	reference parameter @phpstan-param-out int $regionX @phpstan-param-out int $regionZ

TODO: make this private

Definition at line 105 of file RegionWorldProvider.php.

getWorldData()

pocketmine\world\format\io\BaseWorldProvider::getWorldData ( )

inherited

Returns information about the world

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 122 of file BaseWorldProvider.php.

getWorldMaxY()

pocketmine\world\format\io\region\PMAnvil::getWorldMaxY

(

)

Gets the build height limit of this world

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 58 of file PMAnvil.php.

getWorldMinY()

pocketmine\world\format\io\region\PMAnvil::getWorldMinY

(

)

Returns the lowest buildable Y coordinate of this world

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 54 of file PMAnvil.php.

isValid()

static pocketmine\world\format\io\region\RegionWorldProvider::isValid ( string $path )

staticinherited

Definition at line 58 of file RegionWorldProvider.php.

loadChunk()

pocketmine\world\format\io\region\RegionWorldProvider::loadChunk ( int $chunkX, int $chunkZ )

inherited

Exceptions

CorruptedChunkException

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 191 of file RegionWorldProvider.php.

loadLevelData()

pocketmine\world\format\io\region\RegionWorldProvider::loadLevelData ( )

protectedinherited

Exceptions

CorruptedWorldException
UnsupportedWorldFormatException

Reimplemented from pocketmine\world\format\io\BaseWorldProvider.

Definition at line 83 of file RegionWorldProvider.php.

loadRegion()

pocketmine\world\format\io\region\RegionWorldProvider::loadRegion ( int $regionX, int $regionZ )

protectedinherited

Definition at line 121 of file RegionWorldProvider.php.

palettizeLegacySubChunkFromColumn()

pocketmine\world\format\io\BaseWorldProvider::palettizeLegacySubChunkFromColumn ( string $idArray, string $metaArray, int $yOffset, \Logger $logger )

protectedinherited

Definition at line 114 of file BaseWorldProvider.php.

palettizeLegacySubChunkXZY()

pocketmine\world\format\io\BaseWorldProvider::palettizeLegacySubChunkXZY ( string $idArray, string $metaArray, \Logger $logger )

protectedinherited

Definition at line 106 of file BaseWorldProvider.php.

palettizeLegacySubChunkYZX()

pocketmine\world\format\io\BaseWorldProvider::palettizeLegacySubChunkYZX ( string $idArray, string $metaArray, \Logger $logger )

protectedinherited

Definition at line 110 of file BaseWorldProvider.php.

pathToRegion()

pocketmine\world\format\io\region\RegionWorldProvider::pathToRegion ( int $regionX, int $regionZ )

protectedinherited

Returns the path to a specific region file based on its X/Z coordinates

Definition at line 117 of file RegionWorldProvider.php.

readFixedSizeByteArray()

static pocketmine\world\format\io\region\RegionWorldProvider::readFixedSizeByteArray ( CompoundTag $chunk, string $tagName, int $length )

staticprotectedinherited

Definition at line 173 of file RegionWorldProvider.php.

unloadRegion()

pocketmine\world\format\io\region\RegionWorldProvider::unloadRegion ( int $regionX, int $regionZ )

protectedinherited

Definition at line 140 of file RegionWorldProvider.php.

Member Data Documentation

$blockDataUpgrader

BlockDataUpgrader pocketmine\world\format\io\BaseWorldProvider::$blockDataUpgrader

protectedinherited

Definition at line 42 of file BaseWorldProvider.php.

$blockStateDeserializer

BlockStateDeserializer pocketmine\world\format\io\BaseWorldProvider::$blockStateDeserializer

protectedinherited

Definition at line 41 of file BaseWorldProvider.php.

$blockStateSerializer

BlockStateSerializer pocketmine\world\format\io\BaseWorldProvider::$blockStateSerializer

protectedinherited

Definition at line 43 of file BaseWorldProvider.php.

$regions

array pocketmine\world\format\io\region\RegionWorldProvider::$regions = []

protectedinherited

Definition at line 81 of file RegionWorldProvider.php.

$worldData

WorldData pocketmine\world\format\io\BaseWorldProvider::$worldData

protectedinherited

Definition at line 39 of file BaseWorldProvider.php.

---

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

• PMAnvil.php