BaseLevelProvider Class Reference

Public Member Functions
	__construct (Level $level, string $path)
	getPath ()
	getServer ()
	getLevel ()
	getName ()
	getTime ()
	setTime ($value)
	getSeed ()
	setSeed ($value)
	getSpawn ()
	setSpawn (Vector3 $pos)
	doGarbageCollection ()
	getLevelData ()
	saveLevelData ()
	requestChunkTask (int $x, int $z)
Public Member Functions inherited from LevelProvider
	getWorldHeight ()
	getGenerator ()
	getGeneratorOptions ()
	getChunk (int $chunkX, int $chunkZ, bool $create=false)
	setChunk (int $chunkX, int $chunkZ, Chunk $chunk)
	saveChunk (int $chunkX, int $chunkZ)
	saveChunks ()
	loadChunk (int $chunkX, int $chunkZ, bool $create=false)
	unloadChunk (int $chunkX, int $chunkZ, bool $safe=true)
	unloadChunks ()
	isChunkLoaded (int $chunkX, int $chunkZ)
	isChunkGenerated (int $chunkX, int $chunkZ)
	isChunkPopulated (int $chunkX, int $chunkZ)
	getLoadedChunks ()
	close ()

Protected Attributes
	$level
	$path
	$levelData
	$asyncChunkRequest = false

Additional Inherited Members
Static Public Member Functions inherited from LevelProvider
static	getProviderName ()
static	isValid (string $path)
static	generate (string $path, string $name, $seed, string $generator, array $options=[])

Constructor & Destructor Documentation

__construct()

__construct	(	Level	$level,
		string	$path
	)

BaseLevelProvider constructor.

Parameters

Level	$level
string	$path

Implements LevelProvider.

                                                           {
        $this->level = $level;
        $this->path = $path;
        if(!file_exists($this->path)){
            mkdir($this->path, 0777, true);
        }
        $nbt = new NBT(NBT::BIG_ENDIAN);
        $nbt->readCompressed(file_get_contents($this->getPath() . "level.dat"));
        $levelData = $nbt->getData();
        if($levelData->Data instanceof CompoundTag){
            $this->levelData = $levelData->Data;
        }else{
            throw new LevelException("Invalid level.dat");
        }

        if(!isset($this->levelData->generatorName)){
            $this->levelData->generatorName = new StringTag("generatorName", Generator::getGenerator("DEFAULT"));
        }

        if(!isset($this->levelData->generatorOptions)){
            $this->levelData->generatorOptions = new StringTag("generatorOptions", "");
        }
        $this->asyncChunkRequest = (bool) $this->level->getServer()->getProperty("chunk-sending.async-chunk-request", false);
    }

Member Function Documentation

doGarbageCollection()

doGarbageCollection

(

)

Implements LevelProvider.

                                         {

    }

getLevel()

getLevel

(

)

Returns

Level

Implements LevelProvider.

                              {
        return $this->level;
    }

getLevelData()

getLevelData

(

)

Returns

CompoundTag

                                   : CompoundTag{
        return $this->levelData;
    }

getName()

getName

(

)

Returns

string

Implements LevelProvider.

                              : string{
        return (string) $this->levelData["LevelName"];
    }

getPath()

getPath

(

)

Returns

string

Implements LevelProvider.

                              : string{
        return $this->path;
    }

getSeed()

getSeed

(

)

Returns

mixed|null

Implements LevelProvider.

                             {
        return $this->levelData["RandomSeed"];
    }

getServer()

getServer

(

)

Returns

                               {
        return $this->level->getServer();
    }

getSpawn()

getSpawn

(

)

Returns

Vector3

Implements LevelProvider.

                               : Vector3{
        return new Vector3((float) $this->levelData["SpawnX"], (float) $this->levelData["SpawnY"], (float) $this->levelData["SpawnZ"]);
    }

getTime()

getTime

(

)

Returns

mixed|null

Implements LevelProvider.

                             {
        return $this->levelData["Time"];
    }

requestChunkTask()

requestChunkTask	(	int	$x,
		int	$z
	)

Parameters

int	$x
int	$z

Returns

null|ChunkRequestTask

Implements LevelProvider.

                                                    {
        $chunk = $this->getChunk($x, $z, false);
        if(!($chunk instanceof Chunk)){
            throw new ChunkException("Invalid Chunk sent");
        }

        if($this->asyncChunkRequest){
            return new ChunkRequestTask($this->level, $chunk);
        }

        //non-async, call the callback directly with serialized data
        $this->getLevel()->chunkRequestCallback($x, $z, $chunk->networkSerialize());

        return null;
    }

saveLevelData()

saveLevelData

(

)

                                   {
        $nbt = new NBT(NBT::BIG_ENDIAN);
        $nbt->setData(new CompoundTag("", [
            "Data" => $this->levelData
        ]));
        $buffer = $nbt->writeCompressed();
        file_put_contents($this->getPath() . "level.dat", $buffer);
    }

setSeed()

setSeed

(

$value

)

Parameters

int | string

$value

Implements LevelProvider.

                                   {
        $this->levelData->RandomSeed = new LongTag("RandomSeed", (int) $value);
    }

setSpawn()

setSpawn

(

Vector3

$pos

)

Parameters

Vector3

$pos

Implements LevelProvider.

                                          {
        $this->levelData->SpawnX = new IntTag("SpawnX", (int) $pos->x);
        $this->levelData->SpawnY = new IntTag("SpawnY", (int) $pos->y);
        $this->levelData->SpawnZ = new IntTag("SpawnZ", (int) $pos->z);
    }

setTime()

setTime

(

$value

)

Parameters

int | string

$value

Implements LevelProvider.

                                   {
        $this->levelData->Time = new LongTag("Time", $value);
    }

Field Documentation

$asyncChunkRequest

$asyncChunkRequest = false

protected

$level

$level

protected

$levelData

$levelData

protected

$path

$path

protected

---

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

• src/pocketmine/level/format/io/BaseLevelProvider.php