BaseTransaction Class Reference

Inheritance diagram for BaseTransaction:

Collaboration diagram for BaseTransaction:

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

Protected Attributes
	$inventory
	$slot
	$targetItem
	$creationTime
	$transactionType = Transaction::TYPE_NORMAL
	$failures = 0
	$wasSuccessful = false
	$achievements = []

Additional Inherited Members
Data Fields inherited from Transaction
const	TYPE_NORMAL = 0
const	TYPE_DROP_ITEM = 1

Constructor & Destructor Documentation

__construct	(		$inventory,
			$slot,
		Item	$targetItem,
			$achievements = [],
			$transactionType = Transaction::TYPE_NORMAL
	)

Parameters

Inventory	$inventory
int	$slot
Item	$targetItem
	string[]	$achievements
int	$transactionType

Member Function Documentation

execute

(

Player

$source

)

Parameters

Player

$source

Returns

bool

Handles transaction execution. Returns whether transaction was successful or not.

Implements Transaction.

getChange

(

)

Returns the change in inventory resulting from this transaction

Returns

array ("in" => items added to the inventory, "out" => items removed from the inventory) ]

getCreationTime

(

)

Returns

float

Implements Transaction.

getInventory

(

)

Returns

Inventory

Implements Transaction.

getSlot

(

)

Returns

int

Implements Transaction.

getTargetItem

(

)

Returns

Item

Implements Transaction.

sendSlotUpdate

(

Player

$source

)

Parameters

Player

$source

Sends a slot update to inventory viewers For successful transactions, update non-source viewers (source does not need updating) For failed transactions, update the source (non-source viewers will see nothing anyway)

---

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

• src/pocketmine/inventory/BaseTransaction.php