pocketmine\event\world\ChunkLoadEvent Class Reference

Inheritance diagram for pocketmine\event\world\ChunkLoadEvent:

Collaboration diagram for pocketmine\event\world\ChunkLoadEvent:

Public Member Functions
	__construct (World $world, int $chunkX, int $chunkZ, Chunk $chunk, private bool $newChunk)
	call ()
	getChunk ()
	getChunkX ()
	getChunkZ ()
	getEventName ()
	getWorld ()
	isNewChunk ()

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null

Detailed Description

Called when a Chunk is loaded or newly created by the world generator.

Definition at line 32 of file ChunkLoadEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\world\ChunkLoadEvent::__construct	(	World	$world,
		int	$chunkX,
		int	$chunkZ,
		Chunk	$chunk,
		private bool	$newChunk )

Definition at line 33 of file ChunkLoadEvent.php.

Member Function Documentation

call()

pocketmine\event\Event::call ( )

inherited

Calls event handlers registered for this event.

Exceptions

RuntimeException if event call recursion reaches the max depth limit

Definition at line 49 of file Event.php.

getChunk()

pocketmine\event\world\ChunkEvent::getChunk ( )

inherited

Definition at line 42 of file ChunkEvent.php.

getChunkX()

pocketmine\event\world\ChunkEvent::getChunkX ( )

inherited

Definition at line 46 of file ChunkEvent.php.

getChunkZ()

pocketmine\event\world\ChunkEvent::getChunkZ ( )

inherited

Definition at line 48 of file ChunkEvent.php.

getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.php.

getWorld()

pocketmine\event\world\WorldEvent::getWorld ( )

inherited

Definition at line 35 of file WorldEvent.php.

hasHandlers()

static pocketmine\event\Event::hasHandlers ( )

staticinherited

Returns whether the current class context has any registered global handlers. This can be used in hot code paths to avoid unnecessary event object creation.

Usage: SomeEventClass::hasHandlers()

Definition at line 77 of file Event.php.

isNewChunk()

pocketmine\event\world\ChunkLoadEvent::isNewChunk

(

)

Returns whether the chunk is newly generated. If false, the chunk was loaded from storage.

Definition at line 47 of file ChunkLoadEvent.php.

Member Data Documentation

$eventName

string pocketmine\event\Event::$eventName = null

protectedinherited

Definition at line 38 of file Event.php.

---

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

• ChunkLoadEvent.php