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

Public Member Functions

 __construct (Player $player, private Item $item, private Vector3 $directionVector)
 
 call ()
 
 getDirectionVector ()
 
 getEventName ()
 
 getItem ()
 
 getPlayer ()
 
 isCancelled ()
 

Static Public Member Functions

static hasHandlers ()
 

Protected Attributes

string $eventName = null
 
Player $player
 

Detailed Description

Called when a player uses its held item, for example when throwing a projectile.

Definition at line 35 of file PlayerItemUseEvent.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\event\player\PlayerItemUseEvent::__construct ( Player  $player,
private Item  $item,
private Vector3  $directionVector 
)

Definition at line 38 of file PlayerItemUseEvent.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.

◆ getDirectionVector()

pocketmine\event\player\PlayerItemUseEvent::getDirectionVector ( )

Returns the direction the player is aiming when activating this item. Used for projectile direction.

Definition at line 56 of file PlayerItemUseEvent.php.

◆ getEventName()

pocketmine\event\Event::getEventName ( )
finalinherited

Definition at line 40 of file Event.php.

◆ getItem()

pocketmine\event\player\PlayerItemUseEvent::getItem ( )

Returns the item used.

Definition at line 49 of file PlayerItemUseEvent.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.

◆ isCancelled()

pocketmine\event\Cancellable::isCancelled ( )
inherited

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
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: