PlayerItemUseEvent
extends PlayerEvent
in package
implements
Cancellable
Uses
CancellableTrait
Called when a player uses its held item, for example when throwing a projectile.
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
- $directionVector : Vector3
- $eventCallDepth : int
- $isCancelled : bool
- $item : Item
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- cancel() : void
- getDirectionVector() : Vector3
- Returns the direction the player is aiming when activating this item. Used for projectile direction.
- getEventName() : string
- getItem() : Item
- Returns the item used.
- 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
$directionVector
private
Vector3
$directionVector
$eventCallDepth
private
static int
$eventCallDepth
= 1
$isCancelled
private
bool
$isCancelled
= false
$item
private
Item
$item
Methods
__construct()
public
__construct(Player $player, Item $item, Vector3 $directionVector) : 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 —getDirectionVector()
Returns the direction the player is aiming when activating this item. Used for projectile direction.
public
getDirectionVector() : Vector3
Return values
Vector3 —getEventName()
public
final getEventName() : string
Return values
string —getItem()
Returns the item used.
public
getItem() : Item
Return values
Item —getPlayer()
public
getPlayer() : Player
Return values
Player —isCancelled()
public
isCancelled() : bool
Return values
bool —uncancel()
public
uncancel() : void