BaseTransaction Class Reference

Public Member Functions
	__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)

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()

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

Parameters

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

                                                                                                                                   {
        $this->inventory = $inventory;
        $this->slot = (int) $slot;
        $this->targetItem = clone $targetItem;
        $this->creationTime = microtime(true);
        $this->transactionType = $transactionType;
        $this->achievements = $achievements;
    }

Member Function Documentation

addAchievement()

addAchievement

(

string

$achievementName

)

Parameters

string

$achievementName

                                                           {
        $this->achievements[] = $achievementName;
    }

addFailure()

addFailure

(

)

                                {
        $this->failures++;
    }

execute()

execute

(

Player

$source

)

Parameters

Player

$source

Returns

bool

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

Implements Transaction.

                                            : bool{
        if($this->getInventory()->processSlotChange($this)){ //This means that the transaction should be handled the normal way
            if(!$source->getServer()->allowInventoryCheats and !$source->isCreative()){
                $change = $this->getChange();

                if($change === null){ //No changes to make, ignore this transaction
                    return true;
                }

                /* Verify that we have the required items */
                if($change["out"] instanceof Item){
                    if(!$this->getInventory()->slotContains($this->getSlot(), $change["out"])){
                        return false;
                    }
                }
                if($change["in"] instanceof Item){
                    if(!$source->getFloatingInventory()->contains($change["in"])){
                        return false;
                    }
                }

                /* All checks passed, make changes to floating inventory
                 * This will not be reached unless all requirements are met */
                if($change["out"] instanceof Item){
                    $source->getFloatingInventory()->addItem($change["out"]);
                }
                if($change["in"] instanceof Item){
                    $source->getFloatingInventory()->removeItem($change["in"]);
                }
            }
            $this->getInventory()->setItem($this->getSlot(), $this->getTargetItem(), false);
        }

        /* Process transaction achievements, like getting iron from a furnace */
        foreach($this->achievements as $achievement){
            $source->awardAchievement($achievement);
        }

        return true;
    }

getAchievements()

getAchievements

(

)

Returns

array|string|[]

                                     {
        return $this->achievements;
    }

getChange()

getChange

(

)

Returns the change in inventory resulting from this transaction

Returns

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

                               {
        $sourceItem = $this->getInventory()->getItem($this->slot);

        if($sourceItem->equals($this->targetItem, true, true, true)){
            //This should never happen, somehow a change happened where nothing changed
            return null;

        }elseif($sourceItem->equals($this->targetItem)){ //Same item, change of count
            $item = clone $sourceItem;
            $countDiff = $this->targetItem->getCount() - $sourceItem->getCount();
            $item->setCount(abs($countDiff));

            if($countDiff < 0){     //Count decreased
                return ["in" => null,
                    "out" => $item];
            }elseif($countDiff > 0){ //Count increased
                return [
                    "in" => $item,
                    "out" => null];
            }else{
                //Should be impossible (identical items and no count change)
                //This should be caught by the first condition even if it was possible
                return null;
            }
        }elseif($sourceItem->getId() !== Item::AIR and $this->targetItem->getId() === Item::AIR){
            //Slot emptied (item removed)
            return ["in" => null,
                "out" => clone $sourceItem];

        }elseif($sourceItem->getId() === Item::AIR and $this->targetItem->getId() !== Item::AIR){
            //Slot filled (item added)
            return ["in" => $this->getTargetItem(),
                "out" => null];

        }else{
            //Some other slot change - an item swap (tool damage changes will be ignored as they are processed server-side before any change is sent by the client
            return ["in" => $this->getTargetItem(),
                "out" => clone $sourceItem];
        }
    }

getCreationTime()

getCreationTime

(

)

Returns

float|mixed

Implements Transaction.

                                     {
        return $this->creationTime;
    }

getFailures()

getFailures

(

)

Returns

int

                                 {
        return $this->failures;
    }

getInventory()

getInventory

(

)

Returns

Inventory

Implements Transaction.

                                  {
        return $this->inventory;
    }

getSlot()

getSlot

(

)

Returns

int

Implements Transaction.

                             {
        return $this->slot;
    }

getSourceItem()

getSourceItem

(

)

Returns

Item

Implements Transaction.

                                   {
        return clone $this->inventory->getItem($this->slot);
    }

getTargetItem()

getTargetItem

(

)

Returns

Item

Implements Transaction.

                                   {
        return clone $this->targetItem;
    }

getTransactionType()

getTransactionType

(

)

Returns

int

                                        {
        return $this->transactionType;
    }

hasAchievements()

hasAchievements

(

)

Returns

bool

                                     {
        return count($this->achievements) !== 0;
    }

sendSlotUpdate()

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)

                                                  {
        if($this->getInventory() instanceof TemporaryInventory){
            return;
        }

        if($this->wasSuccessful){
            $targets = $this->getInventory()->getViewers();
            unset($targets[spl_object_hash($source)]);
        }else{
            $targets = [$source];
        }
        $this->inventory->sendSlot($this->slot, $targets);
    }

setSuccess()

setSuccess

(

$value = true

)

Parameters

bool

$value

                                             {
        $this->wasSuccessful = $value;
    }

setTargetItem()

setTargetItem

(

Item

$item

)

Parameters

Item

$item

                                             {
        $this->targetItem = clone $item;
    }

succeeded()

succeeded

(

)

Returns

bool

                               {
        return $this->wasSuccessful;
    }

Field Documentation

$achievements

$achievements = []

protected

$creationTime

$creationTime

protected

$failures

$failures = 0

protected

$inventory

$inventory

protected

$slot

$slot

protected

$targetItem

$targetItem

protected

$transactionType

$transactionType = Transaction::TYPE_NORMAL

protected

$wasSuccessful

$wasSuccessful = false

protected

---

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

• src/pocketmine/inventory/BaseTransaction.php