pocketmine\world\format\io\WritableWorldProvider Interface Reference

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

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

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

Detailed Description

Definition at line 26 of file WritableWorldProvider.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.

getWorldData()

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

inherited

Returns information about the world

Implemented in pocketmine\world\format\io\BaseWorldProvider.

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.

saveChunk()

pocketmine\world\format\io\WritableWorldProvider::saveChunk	(	int	$chunkX,
		int	$chunkZ,
		ChunkData	$chunkData,
		int	$dirtyFlags
	)

Saves a chunk (usually to disk).

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

---

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

• WritableWorldProvider.php