PocketMine-MP 5.14.2 git-50e2c469a547a16a23b2dc691e70a51d34e29395
pocketmine\event\player\PlayerViewDistanceChangeEvent Class Reference
+ Inheritance diagram for pocketmine\event\player\PlayerViewDistanceChangeEvent:
+ Collaboration diagram for pocketmine\event\player\PlayerViewDistanceChangeEvent:

Public Member Functions

 __construct (Player $player, protected int $oldDistance, protected int $newDistance)
 
 call ()
 
 getEventName ()
 
 getNewDistance ()
 
 getOldDistance ()
 
 getPlayer ()
 

Static Public Member Functions

static hasHandlers ()
 

Protected Attributes

string $eventName = null
 
Player $player
 

Detailed Description

Called when a player requests a different viewing distance than the current one.

Definition at line 31 of file PlayerViewDistanceChangeEvent.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\event\player\PlayerViewDistanceChangeEvent::__construct ( Player  $player,
protected int  $oldDistance,
protected int  $newDistance 
)

Definition at line 32 of file PlayerViewDistanceChangeEvent.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.

◆ getEventName()

pocketmine\event\Event::getEventName ( )
finalinherited

Definition at line 40 of file Event.php.

◆ getNewDistance()

pocketmine\event\player\PlayerViewDistanceChangeEvent::getNewDistance ( )

Returns the new view radius, measured in chunks.

Definition at line 43 of file PlayerViewDistanceChangeEvent.php.

◆ getOldDistance()

pocketmine\event\player\PlayerViewDistanceChangeEvent::getOldDistance ( )

Returns the old view radius, measured in chunks. A value of -1 means that the player has just connected and did not have a view distance before this event.

Definition at line 51 of file PlayerViewDistanceChangeEvent.php.

◆ getPlayer()

pocketmine\event\player\PlayerEvent::getPlayer ( )
inherited

Definition at line 35 of file PlayerEvent.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.

Member Data Documentation

◆ $eventName

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

Definition at line 38 of file Event.php.

◆ $player

Player pocketmine\event\player\PlayerEvent::$player
protectedinherited

Definition at line 33 of file PlayerEvent.php.


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