Documentation

BlockItemPickupEvent extends BlockEvent
in package
implements Cancellable Uses CancellableTrait

Called when a block picks up an item, arrow, etc.

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
$block  : Block
$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
getBlock()  : Block
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

$eventName

protected string|null $eventName = null

$eventCallDepth

private static int $eventCallDepth = 1

Methods

call()

Calls event handlers registered for this event.

public call() : void
Tags
throws
RuntimeException

if event call recursion reaches the max depth limit

Return values
void

getEventName()

public final getEventName() : string
Return values
string

setInventory()

Change the inventory to which received items are added.

public setInventory(Inventory|null $inventory) : void
Parameters
$inventory : Inventory|null
Return values
void

Search results