EntityItemPickupEvent
extends EntityEvent
in package
implements
Cancellable
Uses
CancellableTrait
Called when an entity picks up an item, arrow, etc.
Tags
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
- $entity : Entity
- $eventName : string|null
- $eventCallDepth : int
- $inventory : Inventory|null
- $isCancelled : bool
- $item : Item
- $origin : Entity
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- cancel() : void
- getEntity() : Entity
- getEventName() : string
- getInventory() : Inventory|null
- Inventory to which received items will be added.
- getItem() : Item
- Items to be received
- getOrigin() : Entity
- isCancelled() : bool
- setInventory() : void
- Change the inventory to which received items are added.
- setItem() : void
- Change the items to receive.
- uncancel() : void
Constants
MAX_EVENT_CALL_DEPTH
private
mixed
MAX_EVENT_CALL_DEPTH
= 50
Properties
$entity
protected
Entity
$entity
Tags
$eventName
protected
string|null
$eventName
= null
$eventCallDepth
private
static int
$eventCallDepth
= 1
$inventory
private
Inventory|null
$inventory
$isCancelled
private
bool
$isCancelled
= false
$item
private
Item
$item
$origin
private
Entity
$origin
Methods
__construct()
public
__construct(Entity $collector, Entity $origin, Item $item, Inventory|null $inventory) : 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 —getEntity()
public
getEntity() : Entity
Tags
Return values
Entity —getEventName()
public
final getEventName() : string
Return values
string —getInventory()
Inventory to which received items will be added.
public
getInventory() : Inventory|null
Return values
Inventory|null —getItem()
Items to be received
public
getItem() : Item
Return values
Item —getOrigin()
public
getOrigin() : Entity
Return values
Entity —isCancelled()
public
isCancelled() : bool
Return values
bool —setInventory()
Change the inventory to which received items are added.
public
setInventory(Inventory|null $inventory) : void
Parameters
- $inventory : Inventory|null
Return values
void —setItem()
Change the items to receive.
public
setItem(Item $item) : void
Parameters
- $item : Item
Return values
void —uncancel()
public
uncancel() : void