Inheritance diagram for pocketmine\world\format\io\WorldProvider: Collaboration diagram for pocketmine\world\format\io\WorldProvider:Public Member Functions | |
| calculateChunkCount () | |
| close () | |
| doGarbageCollection () | |
| getAllChunks (bool $skipCorrupted=false, ?\Logger $logger=null) | |
| getPath () | |
| getWorldData () | |
| getWorldMaxY () | |
| getWorldMinY () | |
| loadChunk (int $chunkX, int $chunkZ) | |
Detailed Description
Definition at line 28 of file WorldProvider.php.
Member Function Documentation
◆ calculateChunkCount()
| pocketmine\world\format\io\WorldProvider::calculateChunkCount | ( | ) |
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 | ( | ) |
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 | ( | ) |
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 |
||
| ) |
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 | ( | ) |
Returns information about the world
Implemented in pocketmine\world\format\io\BaseWorldProvider.
◆ getWorldMaxY()
| pocketmine\world\format\io\WorldProvider::getWorldMaxY | ( | ) |
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 | ( | ) |
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 | ||
| ) |
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.
The documentation for this interface was generated from the following file:
