PocketMine-MP 5.15.1 git-5ef247620a7c6301a849b54e5ef1009217729fc8
pocketmine\world\format\io\data\JavaWorldData Class Reference
+ Inheritance diagram for pocketmine\world\format\io\data\JavaWorldData:
+ Collaboration diagram for pocketmine\world\format\io\data\JavaWorldData:

Public Member Functions

 getCompoundTag ()
 
 getDifficulty ()
 
 getGenerator ()
 
 getGeneratorOptions ()
 
 getLightningLevel ()
 
 getLightningTime ()
 
 getName ()
 
 getRainLevel ()
 
 getRainTime ()
 
 getSeed ()
 
 getSpawn ()
 
 getTime ()
 
 save ()
 
 setDifficulty (int $difficulty)
 
 setLightningLevel (float $level)
 
 setLightningTime (int $ticks)
 
 setName (string $value)
 
 setRainLevel (float $level)
 
 setRainTime (int $ticks)
 
 setSpawn (Vector3 $pos)
 
 setTime (int $value)
 

Static Public Member Functions

static generate (string $path, string $name, WorldCreationOptions $options, int $version=19133)
 

Protected Member Functions

 fix ()
 
 load ()
 

Static Protected Member Functions

static hackyFixForGeneratorClasspathInLevelDat (string $className)
 

Protected Attributes

CompoundTag $compoundTag
 
const TAG_GENERATOR_NAME = "generatorName"
 
const TAG_GENERATOR_OPTIONS = "generatorOptions"
 
const TAG_LEVEL_NAME = "LevelName"
 
const TAG_RANDOM_SEED = "RandomSeed"
 
const TAG_SPAWN_X = "SpawnX"
 
const TAG_SPAWN_Y = "SpawnY"
 
const TAG_SPAWN_Z = "SpawnZ"
 
const TAG_TIME = "Time"
 

Detailed Description

Definition at line 46 of file JavaWorldData.php.

Member Function Documentation

◆ fix()

pocketmine\world\format\io\data\JavaWorldData::fix ( )
protected
Exceptions
CorruptedWorldException
UnsupportedWorldFormatException

Reimplemented from pocketmine\world\format\io\data\BaseNbtWorldData.

Definition at line 116 of file JavaWorldData.php.

◆ generate()

static pocketmine\world\format\io\data\JavaWorldData::generate ( string  $path,
string  $name,
WorldCreationOptions  $options,
int  $version = 19133 
)
static

Definition at line 64 of file JavaWorldData.php.

◆ getCompoundTag()

pocketmine\world\format\io\data\BaseNbtWorldData::getCompoundTag ( )
inherited

Definition at line 109 of file BaseNbtWorldData.php.

◆ getDifficulty()

pocketmine\world\format\io\data\JavaWorldData::getDifficulty ( )

Returns the world difficulty. This will be one of the World constants.

Implements pocketmine\world\format\io\WorldData.

Definition at line 137 of file JavaWorldData.php.

◆ getGenerator()

pocketmine\world\format\io\data\BaseNbtWorldData::getGenerator ( )
inherited

Returns the generator name

Implements pocketmine\world\format\io\WorldData.

Definition at line 123 of file BaseNbtWorldData.php.

◆ getGeneratorOptions()

pocketmine\world\format\io\data\BaseNbtWorldData::getGeneratorOptions ( )
inherited

Implements pocketmine\world\format\io\WorldData.

Definition at line 127 of file BaseNbtWorldData.php.

◆ getLightningLevel()

pocketmine\world\format\io\data\JavaWorldData::getLightningLevel ( )
Returns
float 0.0 - 1.0

Implements pocketmine\world\format\io\WorldData.

Definition at line 169 of file JavaWorldData.php.

◆ getLightningTime()

pocketmine\world\format\io\data\JavaWorldData::getLightningTime ( )

Returns the time in ticks to the next lightning level change.

Implements pocketmine\world\format\io\WorldData.

Definition at line 161 of file JavaWorldData.php.

◆ getName()

pocketmine\world\format\io\data\BaseNbtWorldData::getName ( )
inherited

Implements pocketmine\world\format\io\WorldData.

Definition at line 115 of file BaseNbtWorldData.php.

◆ getRainLevel()

pocketmine\world\format\io\data\JavaWorldData::getRainLevel ( )
Returns
float 0.0 - 1.0

Implements pocketmine\world\format\io\WorldData.

Definition at line 153 of file JavaWorldData.php.

◆ getRainTime()

pocketmine\world\format\io\data\JavaWorldData::getRainTime ( )

Returns the time in ticks to the next rain level change.

Implements pocketmine\world\format\io\WorldData.

Definition at line 145 of file JavaWorldData.php.

◆ getSeed()

pocketmine\world\format\io\data\BaseNbtWorldData::getSeed ( )
inherited

Implements pocketmine\world\format\io\WorldData.

Definition at line 131 of file BaseNbtWorldData.php.

◆ getSpawn()

pocketmine\world\format\io\data\BaseNbtWorldData::getSpawn ( )
inherited

Implements pocketmine\world\format\io\WorldData.

Definition at line 146 of file BaseNbtWorldData.php.

◆ getTime()

pocketmine\world\format\io\data\BaseNbtWorldData::getTime ( )
inherited

Implements pocketmine\world\format\io\WorldData.

Definition at line 135 of file BaseNbtWorldData.php.

◆ hackyFixForGeneratorClasspathInLevelDat()

static pocketmine\world\format\io\data\BaseNbtWorldData::hackyFixForGeneratorClasspathInLevelDat ( string  $className)
staticprotectedinherited

Hack to fix worlds broken previously by older versions of PocketMine-MP which incorrectly saved classpaths of generators into level.dat on imported (not generated) worlds.

This should only have affected leveldb worlds as far as I know, because PC format worlds include the generatorName tag by default. However, MCPE leveldb ones didn't, and so they would get filled in with something broken.

This bug took a long time to get found because previously the generator manager would just return the default generator silently on failure to identify the correct generator, which caused lots of unexpected bugs.

Only classnames which were written into the level.dat from "fixing" the level data are included here. These are hardcoded to avoid problems fixing broken worlds in the future if these classes get moved, renamed or removed.

Parameters
string$classNameClassname saved in level.dat
Returns
null|string Name of the correct generator to replace the broken value

Definition at line 95 of file BaseNbtWorldData.php.

◆ load()

pocketmine\world\format\io\data\JavaWorldData::load ( )
protected
Exceptions
CorruptedWorldException
UnsupportedWorldFormatException

Reimplemented from pocketmine\world\format\io\data\BaseNbtWorldData.

Definition at line 92 of file JavaWorldData.php.

◆ save()

pocketmine\world\format\io\data\JavaWorldData::save ( )

Saves information about the world state, such as weather, time, etc.

Implements pocketmine\world\format\io\WorldData.

Definition at line 129 of file JavaWorldData.php.

◆ setDifficulty()

pocketmine\world\format\io\data\JavaWorldData::setDifficulty ( int  $difficulty)

Sets the world difficulty.

Implements pocketmine\world\format\io\WorldData.

Definition at line 141 of file JavaWorldData.php.

◆ setLightningLevel()

pocketmine\world\format\io\data\JavaWorldData::setLightningLevel ( float  $level)
Parameters
float$level0.0 - 1.0

Implements pocketmine\world\format\io\WorldData.

Definition at line 173 of file JavaWorldData.php.

◆ setLightningTime()

pocketmine\world\format\io\data\JavaWorldData::setLightningTime ( int  $ticks)

Sets the time in ticks to the next lightning level change.

Implements pocketmine\world\format\io\WorldData.

Definition at line 165 of file JavaWorldData.php.

◆ setName()

pocketmine\world\format\io\data\BaseNbtWorldData::setName ( string  $value)
inherited

Implements pocketmine\world\format\io\WorldData.

Definition at line 119 of file BaseNbtWorldData.php.

◆ setRainLevel()

pocketmine\world\format\io\data\JavaWorldData::setRainLevel ( float  $level)
Parameters
float$level0.0 - 1.0

Implements pocketmine\world\format\io\WorldData.

Definition at line 157 of file JavaWorldData.php.

◆ setRainTime()

pocketmine\world\format\io\data\JavaWorldData::setRainTime ( int  $ticks)

Sets the time in ticks to the next rain level change.

Implements pocketmine\world\format\io\WorldData.

Definition at line 149 of file JavaWorldData.php.

◆ setSpawn()

pocketmine\world\format\io\data\BaseNbtWorldData::setSpawn ( Vector3  $pos)
inherited

Implements pocketmine\world\format\io\WorldData.

Definition at line 150 of file BaseNbtWorldData.php.

◆ setTime()

pocketmine\world\format\io\data\BaseNbtWorldData::setTime ( int  $value)
inherited

Implements pocketmine\world\format\io\WorldData.

Definition at line 142 of file BaseNbtWorldData.php.

Member Data Documentation

◆ $compoundTag

CompoundTag pocketmine\world\format\io\data\BaseNbtWorldData::$compoundTag
protectedinherited

Definition at line 44 of file BaseNbtWorldData.php.

◆ TAG_GENERATOR_NAME

const pocketmine\world\format\io\data\BaseNbtWorldData::TAG_GENERATOR_NAME = "generatorName"
protectedinherited

Definition at line 36 of file BaseNbtWorldData.php.

◆ TAG_GENERATOR_OPTIONS

const pocketmine\world\format\io\data\BaseNbtWorldData::TAG_GENERATOR_OPTIONS = "generatorOptions"
protectedinherited

Definition at line 37 of file BaseNbtWorldData.php.

◆ TAG_LEVEL_NAME

const pocketmine\world\format\io\data\BaseNbtWorldData::TAG_LEVEL_NAME = "LevelName"
protectedinherited

Definition at line 35 of file BaseNbtWorldData.php.

◆ TAG_RANDOM_SEED

const pocketmine\world\format\io\data\BaseNbtWorldData::TAG_RANDOM_SEED = "RandomSeed"
protectedinherited

Definition at line 38 of file BaseNbtWorldData.php.

◆ TAG_SPAWN_X

const pocketmine\world\format\io\data\BaseNbtWorldData::TAG_SPAWN_X = "SpawnX"
protectedinherited

Definition at line 40 of file BaseNbtWorldData.php.

◆ TAG_SPAWN_Y

const pocketmine\world\format\io\data\BaseNbtWorldData::TAG_SPAWN_Y = "SpawnY"
protectedinherited

Definition at line 41 of file BaseNbtWorldData.php.

◆ TAG_SPAWN_Z

const pocketmine\world\format\io\data\BaseNbtWorldData::TAG_SPAWN_Z = "SpawnZ"
protectedinherited

Definition at line 42 of file BaseNbtWorldData.php.

◆ TAG_TIME

const pocketmine\world\format\io\data\BaseNbtWorldData::TAG_TIME = "Time"
protectedinherited

Definition at line 39 of file BaseNbtWorldData.php.


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