pocketmine\world\format\io\BaseWorldProvider Class Reference

Inheritance diagram for pocketmine\world\format\io\BaseWorldProvider:

Collaboration diagram for pocketmine\world\format\io\BaseWorldProvider:

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

Protected Member Functions
	loadLevelData ()
	palettizeLegacySubChunkFromColumn (string $idArray, string $metaArray, int $yOffset, \Logger $logger)
	palettizeLegacySubChunkXZY (string $idArray, string $metaArray, \Logger $logger)
	palettizeLegacySubChunkYZX (string $idArray, string $metaArray, \Logger $logger)

Protected Attributes
BlockDataUpgrader	$blockDataUpgrader
BlockStateDeserializer	$blockStateDeserializer
BlockStateSerializer	$blockStateSerializer
WorldData	$worldData

Detailed Description

Definition at line 38 of file BaseWorldProvider.php.

Constructor & Destructor Documentation

__construct()

pocketmine\world\format\io\BaseWorldProvider::__construct	(	protected string	$path,
		protected \Logger	$logger
	)

Definition at line 45 of file BaseWorldProvider.php.

Member Function Documentation

calculateChunkCount()

pocketmine\world\format\io\WorldProvider::calculateChunkCount ( )

inherited

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

Implemented in pocketmine\world\format\io\leveldb\LevelDB, and pocketmine\world\format\io\region\RegionWorldProvider.

close()

pocketmine\world\format\io\WorldProvider::close ( )

inherited

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

Implemented in pocketmine\world\format\io\leveldb\LevelDB, and pocketmine\world\format\io\region\RegionWorldProvider.

doGarbageCollection()

pocketmine\world\format\io\WorldProvider::doGarbageCollection ( )

inherited

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

Implemented in pocketmine\world\format\io\leveldb\LevelDB, and pocketmine\world\format\io\region\RegionWorldProvider.

getAllChunks()

pocketmine\world\format\io\WorldProvider::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

Implemented in pocketmine\world\format\io\leveldb\LevelDB, and pocketmine\world\format\io\region\RegionWorldProvider.

getPath()

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

(

)

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 116 of file BaseWorldProvider.php.

getWorldData()

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

(

)

Returns information about the world

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 120 of file BaseWorldProvider.php.

getWorldMaxY()

pocketmine\world\format\io\WorldProvider::getWorldMaxY ( )

inherited

Gets the build height limit of this world

Implemented in pocketmine\world\format\io\leveldb\LevelDB, pocketmine\world\format\io\region\Anvil, pocketmine\world\format\io\region\McRegion, and pocketmine\world\format\io\region\PMAnvil.

getWorldMinY()

pocketmine\world\format\io\WorldProvider::getWorldMinY ( )

inherited

Returns the lowest buildable Y coordinate of this world

Implemented in pocketmine\world\format\io\leveldb\LevelDB, pocketmine\world\format\io\region\Anvil, pocketmine\world\format\io\region\McRegion, and pocketmine\world\format\io\region\PMAnvil.

loadChunk()

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

inherited

Loads a chunk (usually from disk storage) and returns it. If the chunk does not exist, null is returned.

Exceptions

CorruptedChunkException

Implemented in pocketmine\world\format\io\leveldb\LevelDB, and pocketmine\world\format\io\region\RegionWorldProvider.

loadLevelData()

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

abstractprotected

Exceptions

CorruptedWorldException
UnsupportedWorldFormatException

Reimplemented in pocketmine\world\format\io\leveldb\LevelDB, and pocketmine\world\format\io\region\RegionWorldProvider.

palettizeLegacySubChunkFromColumn()

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

protected

Definition at line 112 of file BaseWorldProvider.php.

palettizeLegacySubChunkXZY()

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

protected

Definition at line 104 of file BaseWorldProvider.php.

palettizeLegacySubChunkYZX()

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

protected

Definition at line 108 of file BaseWorldProvider.php.

Member Data Documentation

$blockDataUpgrader

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

protected

Definition at line 42 of file BaseWorldProvider.php.

$blockStateDeserializer

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

protected

Definition at line 41 of file BaseWorldProvider.php.

$blockStateSerializer

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

protected

Definition at line 43 of file BaseWorldProvider.php.

$worldData

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

protected

Definition at line 39 of file BaseWorldProvider.php.

---

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

• BaseWorldProvider.php