DropItemTransaction Class Reference

Public Member Functions
	__construct (Item $droppedItem)
	setSourceItem (Item $item)
	getInventory ()
	getSlot ()
	sendSlotUpdate (Player $source)
	getChange ()
	execute (Player $source)
Public Member Functions inherited from BaseTransaction
	__construct ($inventory, $slot, Item $targetItem, $achievements=[], $transactionType=Transaction::TYPE_NORMAL)
	getCreationTime ()
	getInventory ()
	getSlot ()
	getTargetItem ()
	getSourceItem ()
	setTargetItem (Item $item)
	getFailures ()
	addFailure ()
	succeeded ()
	setSuccess ($value=true)
	getTransactionType ()
	getAchievements ()
	hasAchievements ()
	addAchievement (string $achievementName)
	sendSlotUpdate (Player $source)
	getChange ()
	execute (Player $source)

Data Fields
const	TRANSACTION_TYPE = Transaction::TYPE_DROP_ITEM
Data Fields inherited from Transaction
const	TYPE_NORMAL = 0
const	TYPE_DROP_ITEM = 1

Protected Attributes
	$inventory = null
	$slot = null
	$sourceItem = null
Protected Attributes inherited from BaseTransaction
	$inventory
	$slot
	$targetItem
	$creationTime
	$transactionType = Transaction::TYPE_NORMAL
	$failures = 0
	$wasSuccessful = false
	$achievements = []

Constructor & Destructor Documentation

__construct()

__construct

(

Item

$droppedItem

)

Parameters

Item

$droppedItem

                                                  {
        $this->targetItem = $droppedItem;
    }

Member Function Documentation

execute()

execute

(

Player

$source

)

Parameters

Player

$source

Returns

bool

Implements Transaction.

                                            : bool{
        $droppedItem = $this->getTargetItem();
        if(!$source->getServer()->allowInventoryCheats and !$source->isCreative()){
            if(!$source->getFloatingInventory()->contains($droppedItem)){
                return false;
            }
            $source->getFloatingInventory()->removeItem($droppedItem);
        }
        $source->dropItem($droppedItem);
        return true;
    }

getChange()

getChange

(

)

Returns

array

                               {
        return ["in" => $this->getTargetItem(),
            "out" => null];
    }

getInventory()

getInventory

(

)

Returns

null

Implements Transaction.

                                  {
        return null;
    }

getSlot()

getSlot

(

)

Returns

null

Implements Transaction.

                             {
        return null;
    }

sendSlotUpdate()

sendSlotUpdate

(

Player

$source

)

Parameters

Player

$source

                                                  {
        //Nothing to update
    }

setSourceItem()

setSourceItem

(

Item

$item

)

Parameters

Item

$item

                                             {
        //Nothing to update
    }

Field Documentation

$inventory

$inventory = null

protected

$slot

$slot = null

protected

$sourceItem

$sourceItem = null

protected

TRANSACTION_TYPE

const TRANSACTION_TYPE = Transaction::TYPE_DROP_ITEM

---

The documentation for this class was generated from the following file:

• src/pocketmine/inventory/DropItemTransaction.php