PocketMine-MP 5.15.1 git-5ef247620a7c6301a849b54e5ef1009217729fc8
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
pocketmine\world\format\io\region\RegionWorldProvider Class Reference
+ Inheritance diagram for pocketmine\world\format\io\region\RegionWorldProvider:
+ Collaboration diagram for pocketmine\world\format\io\region\RegionWorldProvider:

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)
 
 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

Definition at line 49 of file RegionWorldProvider.php.

Member Function Documentation

◆ calculateChunkCount()

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

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

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 251 of file RegionWorldProvider.php.

◆ close()

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

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

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 140 of file RegionWorldProvider.php.

◆ deserializeChunk()

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

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

◆ doGarbageCollection()

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

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 82 of file RegionWorldProvider.php.

◆ getAllChunks()

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

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 220 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 
)
staticprotected
Returns
CompoundTag[]
Exceptions
CorruptedChunkException

Definition at line 156 of file RegionWorldProvider.php.

◆ getPath()

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

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 116 of file BaseWorldProvider.php.

◆ getPcWorldFormatVersion()

static pocketmine\world\format\io\region\RegionWorldProvider::getPcWorldFormatVersion ( )
staticabstractprotected

Returns the storage version as per Minecraft PC world formats.

Reimplemented in pocketmine\world\format\io\region\Anvil, pocketmine\world\format\io\region\McRegion, and pocketmine\world\format\io\region\PMAnvil.

◆ getRegion()

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

Definition at line 103 of file RegionWorldProvider.php.

◆ getRegionFileExtension()

static pocketmine\world\format\io\region\RegionWorldProvider::getRegionFileExtension ( )
staticabstractprotected

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

Reimplemented in pocketmine\world\format\io\region\Anvil, pocketmine\world\format\io\region\McRegion, and pocketmine\world\format\io\region\PMAnvil.

◆ getRegionIndex()

static pocketmine\world\format\io\region\RegionWorldProvider::getRegionIndex ( int  $chunkX,
int  $chunkZ,
&  $regionX,
&  $regionZ 
)
static
Parameters
int$regionXreference parameter
int$regionZreference parameter @phpstan-param-out int $regionX @phpstan-param-out int $regionZ

Definition at line 98 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 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.

◆ isValid()

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

Definition at line 61 of file RegionWorldProvider.php.

◆ loadChunk()

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

Implements pocketmine\world\format\io\WorldProvider.

Definition at line 192 of file RegionWorldProvider.php.

◆ loadLevelData()

pocketmine\world\format\io\region\RegionWorldProvider::loadLevelData ( )
protected
Exceptions
CorruptedWorldException
UnsupportedWorldFormatException

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

Definition at line 78 of file RegionWorldProvider.php.

◆ loadRegion()

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

Definition at line 114 of file RegionWorldProvider.php.

◆ palettizeLegacySubChunkFromColumn()

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

Definition at line 112 of file BaseWorldProvider.php.

◆ palettizeLegacySubChunkXZY()

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

Definition at line 104 of file BaseWorldProvider.php.

◆ palettizeLegacySubChunkYZX()

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

Definition at line 108 of file BaseWorldProvider.php.

◆ pathToRegion()

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

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

Definition at line 110 of file RegionWorldProvider.php.

◆ readFixedSizeByteArray()

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

Definition at line 174 of file RegionWorldProvider.php.

◆ unloadRegion()

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

Definition at line 133 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 = []
protected

Definition at line 76 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: