PlayerEntityInteractEvent
extends PlayerEvent
in package
implements
Cancellable
Uses
CancellableTrait
Called when a player interacts with an entity (e.g. shearing a sheep, naming a mob using a nametag).
Interfaces, Classes, Traits and Enums
- Cancellable
- This interface is implemented by an Event subclass if and only if it can be cancelled.
Table of Contents
- MAX_EVENT_CALL_DEPTH = 50
- $eventName : string|null
- $player : Player
- $clickPos : Vector3
- $entity : Entity
- $eventCallDepth : int
- $isCancelled : bool
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- cancel() : void
- getClickPosition() : Vector3
- Returns the absolute coordinates of the click. This is usually on the surface of the entity's hitbox.
- getEntity() : Entity
- getEventName() : string
- getPlayer() : Player
- isCancelled() : bool
- uncancel() : void
Constants
MAX_EVENT_CALL_DEPTH
private
mixed
MAX_EVENT_CALL_DEPTH
= 50
Properties
$eventName
protected
string|null
$eventName
= null
$player
protected
Player
$player
$clickPos
private
Vector3
$clickPos
$entity
private
Entity
$entity
$eventCallDepth
private
static int
$eventCallDepth
= 1
$isCancelled
private
bool
$isCancelled
= false
Methods
__construct()
public
__construct(Player $player, Entity $entity, Vector3 $clickPos) : mixed
Parameters
Return values
mixed —call()
Calls event handlers registered for this event.
public
call() : void
Tags
Return values
void —cancel()
public
cancel() : void
Return values
void —getClickPosition()
Returns the absolute coordinates of the click. This is usually on the surface of the entity's hitbox.
public
getClickPosition() : Vector3
Return values
Vector3 —getEntity()
public
getEntity() : Entity
Return values
Entity —getEventName()
public
final getEventName() : string
Return values
string —getPlayer()
public
getPlayer() : Player
Return values
Player —isCancelled()
public
isCancelled() : bool
Return values
bool —uncancel()
public
uncancel() : void