McRegion Class Reference

Inheritance diagram for McRegion:

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

Static Public Member Functions
static	getProviderName ()
static	getProviderOrder ()
static	usesChunkSection ()
static	isValid ($path)
static	generate ($path, $name, $seed, $generator, array $options=[])
static	getRegionIndex ($chunkX, $chunkZ, &$x, &$z)
static	createChunkSection ($Y)

Protected Member Functions
	getRegion ($x, $z)
	loadRegion ($x, $z)

Protected Attributes
	$regions = []
	$chunks = []
Protected Attributes inherited from BaseLevelProvider
	$level
	$path
	$levelData

Additional Inherited Members
Data Fields inherited from LevelProvider
const	ORDER_YZX = 0
const	ORDER_ZXY = 1

Member Function Documentation

static createChunkSection (   $Y )

static

Parameters

$Y

0-7

Returns

ChunkSection

Implements LevelProvider.

static generate (   $path,   $name,   $seed,   $generator, array  $options = []  )

static

Generate the needed files in the path given

Parameters

string	$path
string	$name
int	$seed
string	$generator
	array[]	$options

Implements LevelProvider.

getChunk	(		$chunkX,
			$chunkZ,
			$create = false
	)

Parameters

int	$chunkX
int	$chunkZ
bool	$create

Returns

Chunk

Implements LevelProvider.

getGenerator

(

)

Returns the generator name

Returns

string

Implements LevelProvider.

getGeneratorOptions

(

)

Returns

array

Implements LevelProvider.

getLoadedChunks

(

)

Returns

FullChunk|Chunk[]

Implements LevelProvider.

static getProviderName ( )

static

Returns the full provider name, like "anvil" or "mcregion", will be used to find the correct format.

Returns

string

Implements LevelProvider.

static getProviderOrder ( )

static

Returns

int

Implements LevelProvider.

getRegion (   $x,   $z  )

protected

Parameters

$x
$z

Returns

RegionLoader

isChunkGenerated	(		$X,
			$Z
	)

Parameters

int	$X
int	$Z

Returns

bool

Implements LevelProvider.

isChunkLoaded	(		$X,
			$Z
	)

Parameters

int	$X
int	$Z

Returns

bool

Implements LevelProvider.

isChunkPopulated	(		$X,
			$Z
	)

Parameters

int	$X
int	$Z

Returns

bool

Implements LevelProvider.

static isValid (   $path )

static

Tells if the path is a valid level. This must tell if the current format supports opening the files in the directory

Parameters

string

$path

Returns

true

Implements LevelProvider.

loadChunk	(		$X,
			$Z,
			$create = false
	)

Parameters

int	$X
int	$Z
bool	$create

Returns

bool

Implements LevelProvider.

requestChunkTask	(		$x,
			$z
	)

Requests a MC: PE network chunk to be sent

Parameters

int	$x
int	$z

Returns

|null

Implements LevelProvider.

saveChunk	(		$X,
			$Z
	)

Parameters

int	$X
int	$Z

Implements LevelProvider.

setChunk	(		$chunkX,
			$chunkZ,
		FullChunk	$chunk
	)

Parameters

int	$chunkX
int	$chunkZ
FullChunk	$chunk

Returns

mixed

Implements LevelProvider.

unloadChunk	(		$X,
			$Z,
			$safe = true
	)

Parameters

int	$X
int	$Z
bool	$safe

Returns

bool

Implements LevelProvider.

static usesChunkSection ( )

static

Returns

bool

Implements LevelProvider.

---

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

• /Users/Kids/Desktop/Doxygen/pocketmine/level/format/mcregion/McRegion.php