PocketMine-MP 5.17.1 git-df4ada81e5d74a14046f27cf44a37dcee69d657e
pocketmine\event\player\PlayerEntityInteractEvent Class Reference
+ Inheritance diagram for pocketmine\event\player\PlayerEntityInteractEvent:
+ Collaboration diagram for pocketmine\event\player\PlayerEntityInteractEvent:

Public Member Functions

 __construct (Player $player, private Entity $entity, private Vector3 $clickPos)
 call ()
 getClickPosition ()
 getEntity ()
 getEventName ()
 getPlayer ()
 isCancelled ()

Static Public Member Functions

static hasHandlers ()

Protected Attributes

string $eventName = null
Player $player

Detailed Description

Called when a player interacts with an entity (e.g. shearing a sheep, naming a mob using a nametag).

Definition at line 35 of file PlayerEntityInteractEvent.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\event\player\PlayerEntityInteractEvent::__construct ( Player  $player,
private Entity  $entity,
private Vector3  $clickPos 

Definition at line 38 of file PlayerEntityInteractEvent.php.

Member Function Documentation

◆ call()

pocketmine\event\Event::call ( )

Calls event handlers registered for this event.


RuntimeException if event call recursion reaches the max depth limit

Definition at line 49 of file Event.php.

◆ getClickPosition()

pocketmine\event\player\PlayerEntityInteractEvent::getClickPosition ( )

Returns the absolute coordinates of the click. This is usually on the surface of the entity's hitbox.

Definition at line 53 of file PlayerEntityInteractEvent.php.

◆ getEntity()

pocketmine\event\player\PlayerEntityInteractEvent::getEntity ( )

Definition at line 46 of file PlayerEntityInteractEvent.php.

◆ getEventName()

pocketmine\event\Event::getEventName ( )

Definition at line 40 of file Event.php.

◆ getPlayer()

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

Definition at line 35 of file PlayerEvent.php.

◆ hasHandlers()

static pocketmine\event\Event::hasHandlers ( )

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.

◆ isCancelled()

pocketmine\event\Cancellable::isCancelled ( )

Returns whether this instance of the event is currently cancelled.

If it is cancelled, only downstream handlers that declare @handleCancelled will be called with this event.

Member Data Documentation

◆ $eventName

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

Definition at line 38 of file Event.php.

◆ $player

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

Definition at line 33 of file PlayerEvent.php.

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