Public Member Functions
	__construct (Human $player, $contents=null)

	getSize ()

	setSize ($size)

	getHotbarSlotIndex ($index)

	setHotbarSlotIndex ($index, $slot)

	getHeldItemIndex ()

	setHeldItemIndex ($hotbarSlotIndex, $sendToHolder=true, $slotMapping=null)

	getItemInHand ()

	setItemInHand (Item $item)

	getHotbar ()

	getHeldItemSlot ()

	setHeldItemSlot ($slot)

	sendHeldItem ($target)

	onSlotChange ($index, $before, $send)

	getHotbarSize ()

	getArmorItem ($index)

	setArmorItem ($index, Item $item)

	damageArmor ($index, $cost)

	getHelmet ()

	getChestplate ()

	getLeggings ()

	getBoots ()

	setHelmet (Item $helmet)

	setChestplate (Item $chestplate)

	setLeggings (Item $leggings)

	setBoots (Item $boots)

	setItem ($index, Item $item, $send=true)

	clear ($index, $send=true)

	getArmorContents ()

	clearAll ($send=true)

	sendArmorContents ($target)

	setArmorContents (array $items)

	sendContents ($target)

	getHolder ()

Public Member Functions inherited from BaseInventory
	__construct (InventoryHolder $holder, InventoryType $type, array $items=[], $overrideSize=null, $overrideTitle=null)

	__destruct ()

	getSize ()

	getHotbarSize ()

	setSize ($size)

	getMaxStackSize ()

	getName ()

	getTitle ()

	getItem ($index)

	getContents ()

	setContents (array $items, $send=true)

	setItem ($index, Item $item, $send=true)

	contains (Item $item)

	slotContains ($slot, Item $item, $matchCount=false)

	all (Item $item)

	remove (Item $item, $send=true)

	first (Item $item)

	firstEmpty ()

	firstOccupied ()

	canAddItem (Item $item)

	clear ($index, $send=true)

	clearAll ($send=true)

	getViewers ()

	getHolder ()

	setMaxStackSize ($size)

	open (Player $who)

	close (Player $who)

	onOpen (Player $who)

	onClose (Player $who)

	onSlotChange ($index, $before, $send)

	processSlotChange (Transaction $transaction)

	sendContents ($target)

	sendSlot ($index, $target)

	getType ()

Public Member Functions inherited from Inventory
	setItem ($index, Item $item)

	addItem (... $slots)

	removeItem (... $slots)

	setContents (array $items)

	remove (Item $item)

	clear ($index)

	clearAll ()

Protected Attributes
	$itemInHandIndex = 0

	$hotbar

Protected Attributes inherited from BaseInventory
	$type

	$maxStackSize = Inventory::MAX_STACK

	$size

	$name

	$title

	$slots = []

	$viewers = []

	$holder

Additional Inherited Members
Data Fields inherited from Inventory
const	MAX_STACK = 64

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Human	$player,
			$contents = `null`
	)

PlayerInventory constructor.

Parameters

Human	$player
null	$contents

                                                                 {
         $this->hotbar = range(0, $this->getHotbarSize() - 1, 1);
         parent::__construct($player, InventoryType::get(InventoryType::PLAYER));
 
         if($contents !== null){
             if($contents instanceof ListTag){ //Saved data to be loaded into the inventory
                 foreach($contents as $item){
                     if($item["Slot"] >= 0 and $item["Slot"] < $this->getHotbarSize()){ //Hotbar
                         if(isset($item["TrueSlot"])){
 
                             //Valid slot was found, change the linkage to this slot
                             if(0 <= $item["TrueSlot"] and $item["TrueSlot"] < $this->getSize()){
                                 $this->hotbar[$item["Slot"]] = $item["TrueSlot"];
 
                             }elseif($item["TrueSlot"] < 0){ //Link to an empty slot (empty hand)
                                 $this->hotbar[$item["Slot"]] = -1;
                             }
                         }
                         /* If TrueSlot is not set, leave the slot index as its default which was filled in above
                          * This only overwrites slot indexes for valid links */
                     }elseif($item["Slot"] >= 100 and $item["Slot"] < 104){ //Armor
                         $this->setItem($this->getSize() + $item["Slot"] - 100, Item::nbtDeserialize($item), false);
                     }else{
                         $this->setItem($item["Slot"] - $this->getHotbarSize(), Item::nbtDeserialize($item), false);
                     }
                 }
             }else{
                 throw new \InvalidArgumentException("Expecting ListTag, received " . gettype($contents));
             }
         }
     }

Member Function Documentation

◆ clear()

clear	(	$index,
		$send = `true`
	)

Parameters

int	$index
bool	$send

Returns: bool

                                                {
         if(isset($this->slots[$index])){
             $item = Item::get(Item::AIR, 0, 0);
             $old = $this->slots[$index];
             if($index >= $this->getSize() and $index < $this->size){ //Armor change
                 Server::getInstance()->getPluginManager()->callEvent($ev = new EntityArmorChangeEvent($this->getHolder(), $old, $item, $index));
                 if($ev->isCancelled()){
                     if($index >= $this->size){
                         $this->sendArmorSlot($index, $this->getViewers());
                     }else{
                         $this->sendSlot($index, $this->getViewers());
                     }
                     return false;
                 }
                 $item = $ev->getNewItem();
             }else{
                 Server::getInstance()->getPluginManager()->callEvent($ev = new EntityInventoryChangeEvent($this->getHolder(), $old, $item, $index));
                 if($ev->isCancelled()){
                     if($index >= $this->size){
                         $this->sendArmorSlot($index, $this->getViewers());
                     }else{
                         $this->sendSlot($index, $this->getViewers());
                     }
                     return false;
                 }
                 $item = $ev->getNewItem();
             }
             if($item->getId() !== Item::AIR){
                 $this->slots[$index] = clone $item;
             }else{
                 unset($this->slots[$index]);
             }
 
             $this->onSlotChange($index, $old, $send);
         }
 
         return true;
     }

◆ clearAll()

clearAll ( $send = true )

                                           {
         $limit = $this->getSize() + 4;
         for($index = 0; $index < $limit; ++$index){
             $this->clear($index, false);
         }
         $this->hotbar = range(0, $this->getHotbarSize() - 1, 1);
         $this->sendContents($this->getViewers());
     }

◆ damageArmor()

damageArmor	(	$index,
		$cost
	)

Parameters

$index
$cost

                                               {
         $this->slots[$this->getSize() + $index]->useOn($this->slots[$this->getSize() + $index], $cost);
         if($this->slots[$this->getSize() + $index]->getDamage() >= $this->slots[$this->getSize() + $index]->getMaxDurability()){
             $this->setItem($this->getSize() + $index, Item::get(Item::AIR, 0, 0));
         }
         $this->sendArmorContents($this->getViewers());
     }

◆ getArmorContents()

getArmorContents ( )

Returns: Item[]

                                       {
         $armor = [];
 
         for($i = 0; $i < 4; ++$i){
             $armor[$i] = $this->getItem($this->getSize() + $i);
         }
 
         return $armor;
     }

◆ getArmorItem()

getArmorItem ( $index )

Parameters

$index

Returns: Item

                                         {
         return $this->getItem($this->getSize() + $index);
     }

◆ getBoots()

getBoots ( )

Returns: Item

                               {
         return $this->getItem($this->getSize() + 3);
     }

◆ getChestplate()

getChestplate ( )

Returns: Item

                                    {
         return $this->getItem($this->getSize() + 1);
     }

◆ getHeldItemIndex()

getHeldItemIndex ( )

Returns: int

Returns the index of the inventory slot the player is currently holding

                                       {
         return $this->itemInHandIndex;
     }

◆ getHeldItemSlot()

getHeldItemSlot ( )

Returns: int

Returns the inventory slot index of the currently equipped slot

                                      {
         return $this->getHotbarSlotIndex($this->itemInHandIndex);
     }

◆ getHelmet()

getHelmet ( )

Returns: Item

                                {
         return $this->getItem($this->getSize());
     }

◆ getHolder()

getHolder ( )

Returns: Human|Player

Implements Inventory.

                                {
         return parent::getHolder();
     }

◆ getHotbar()

getHotbar ( )

Returns: int[]

Returns an array of hotbar indices

                                {
         return $this->hotbar;
     }

◆ getHotbarSize()

getHotbarSize ( )

Returns: int

                                    {
         return 9;
     }

◆ getHotbarSlotIndex()

getHotbarSlotIndex ( $index )

Parameters

int $index

Returns: int

Returns the index of the inventory slot linked to the specified hotbar slot

                                               {
         return ($index >= 0 and $index < $this->getHotbarSize()) ? $this->hotbar[$index] : -1;
     }

◆ getItemInHand()

getItemInHand ( )

Returns: Item

Returns the item the player is currently holding

                                    {
         $item = $this->getItem($this->getHeldItemSlot());
         if($item instanceof Item){
             return $item;
         }else{
             return Item::get(Item::AIR, 0, 0);
         }
     }

◆ getLeggings()

getLeggings ( )

Returns: Item

                                  {
         return $this->getItem($this->getSize() + 2);
     }

◆ getSize()

getSize ( )

Returns: int

Implements Inventory.

                              {
         return parent::getSize() - 4; //Remove armor slots
     }

◆ onSlotChange()

onSlotChange	(	$index,
		$before,
		$send
	)

Parameters

int	$index
Item	$before
bool	$send

Implements Inventory.

                                                         {
         if($send){
             $holder = $this->getHolder();
             if(!$holder instanceof Player or !$holder->spawned){
                 return;
             }
 
             parent::onSlotChange($index, $before, $send);
         }
         if($index === $this->itemInHandIndex){
             $this->sendHeldItem($this->getHolder()->getViewers());
             if($send){
                 $this->sendHeldItem($this->getHolder());
             }
 
         }elseif($index >= $this->getSize()){ //Armour equipment
             $this->sendArmorSlot($index, $this->getViewers());
             $this->sendArmorSlot($index, $this->getHolder()->getViewers());
         }
     }

◆ sendArmorContents()

sendArmorContents ( $target )

Parameters

Player|Player[] $target

                                               {
         if($target instanceof Player){
             $target = [$target];
         }
 
         $armor = $this->getArmorContents();
 
         $pk = new MobArmorEquipmentPacket();
         $pk->eid = $this->getHolder()->getId();
         $pk->slots = $armor;
         $pk->encode();
         $pk->isEncoded = true;
 
         foreach($target as $player){
             if($player === $this->getHolder()){
                 $pk2 = new ContainerSetContentPacket();
                 $pk2->windowid = ContainerSetContentPacket::SPECIAL_ARMOR;
                 $pk2->slots = $armor;
                 $pk2->targetEid = $player->getId();
                 $player->dataPacket($pk2);
             }else{
                 $player->dataPacket($pk);
             }
         }
     }

◆ sendContents()

sendContents ( $target )

Parameters

Player|Player[] $target

Implements Inventory.

                                          {
         if($target instanceof Player){
             $target = [$target];
         }
 
         $pk = new ContainerSetContentPacket();
         $pk->slots = [];
         for($i = 0; $i < $this->getSize(); ++$i){ //Do not send armor by error here
             $pk->slots[$i] = $this->getItem($i);
         }
 
         //Because PE is stupid and shows 9 less slots than you send it, give it 9 dummy slots so it shows all the REAL slots.
         for($i = $this->getSize(); $i < $this->getSize() + $this->getHotbarSize(); ++$i){
             $pk->slots[$i] = Item::get(Item::AIR, 0, 0);
         }
 
         foreach($target as $player){
             $pk->hotbar = [];
             if($player === $this->getHolder()){
                 for($i = 0; $i < $this->getHotbarSize(); ++$i){
                     $index = $this->getHotbarSlotIndex($i);
                     $pk->hotbar[$i] = $index <= -1 ? -1 : $index + $this->getHotbarSize();
                 }
             }
             if(($id = $player->getWindowId($this)) === -1 or $player->spawned !== true){
                 $this->close($player);
                 continue;
             }
             $pk->windowid = $id;
             $pk->targetEid = $player->getId();
             $player->dataPacket(clone $pk);
         }
     }

◆ sendHeldItem()

sendHeldItem ( $target )

Parameters

Player|Player[] $target

                                          {
         $item = $this->getItemInHand();
 
         $pk = new MobEquipmentPacket();
         $pk->eid = $this->getHolder()->getId();
         $pk->item = $item;
         $pk->slot = $this->getHeldItemSlot();
         $pk->selectedSlot = $this->getHeldItemIndex();
         $pk->windowId = ContainerSetContentPacket::SPECIAL_INVENTORY;
 
         if(!is_array($target)){
             $target->dataPacket($pk);
             if($this->getHeldItemSlot() !== -1 and $target === $this->getHolder()){
                 $this->sendSlot($this->getHeldItemSlot(), $target);
             }
         }else{
             $this->getHolder()->getLevel()->getServer()->broadcastPacket($target, $pk);
             if($this->getHeldItemSlot() !== -1 and in_array($this->getHolder(), $target)){
                 $this->sendSlot($this->getHeldItemSlot(), $this->getHolder());
             }
         }
     }

◆ setArmorContents()

setArmorContents ( array $items )

Parameters

Item[] $items

                                                   {
         for($i = 0; $i < 4; ++$i){
             if(!isset($items[$i]) or !($items[$i] instanceof Item)){
                 $items[$i] = Item::get(Item::AIR, 0, 0);
             }
 
             if($items[$i]->getId() === Item::AIR){
                 $this->clear($this->getSize() + $i);
             }else{
                 $this->setItem($this->getSize() + $i, $items[$i]);
             }
         }
     }

◆ setArmorItem()

setArmorItem	(		$index,
		Item	$item
	)

Parameters

	$index
Item	$item

Returns: bool

                                                     {
         return $this->setItem($this->getSize() + $index, $item);
     }

◆ setBoots()

setBoots ( Item $boots )

Parameters

Item $boots

Returns: bool

                                          {
         return $this->setItem($this->getSize() + 3, $boots);
     }

◆ setChestplate()

setChestplate ( Item $chestplate )

Parameters

Item $chestplate

Returns: bool

                                                    {
         return $this->setItem($this->getSize() + 1, $chestplate);
     }

◆ setHeldItemIndex()

setHeldItemIndex	(	$hotbarSlotIndex,
		$sendToHolder = `true`,
		$slotMapping = `null`
	)

Parameters

int	$hotbarSlotIndex
bool	$sendToHolder
int	$slotMapping	Sets which hotbar slot the player is currently holding. Allows slot remapping as specified by a MobEquipmentPacket. DO NOT CHANGE SLOT MAPPING IN PLUGINS! This new implementation is fully compatible with older APIs. NOTE: Slot mapping is the raw slot index sent by MCPE, which will be between 9 and 44.

                                                                                                  {
         if($slotMapping !== null){
             //Get the index of the slot in the actual inventory
             $slotMapping -= $this->getHotbarSize();
         }
         if(0 <= $hotbarSlotIndex and $hotbarSlotIndex < $this->getHotbarSize()){
             $this->itemInHandIndex = $hotbarSlotIndex;
             if($slotMapping !== null){
                 /* Handle a hotbar slot mapping change. This allows PE to select different inventory slots.
                  * This is the only time slot mapping should ever be changed. */
 
                 if($slotMapping < 0 or $slotMapping >= $this->getSize()){
                     //Mapping was not in range of the inventory, set it to -1
                     //This happens if the client selected a blank slot (sends 255)
                     $slotMapping = -1;
                 }
 
                 $item = $this->getItem($slotMapping);
                 if($this->getHolder() instanceof Player){
                     Server::getInstance()->getPluginManager()->callEvent($ev = new PlayerItemHeldEvent($this->getHolder(), $item, $slotMapping, $hotbarSlotIndex));
                     if($ev->isCancelled()){
                         $this->sendHeldItem($this->getHolder());
                         $this->sendContents($this->getHolder());
                         return;
                     }
                 }
 
                 if(($key = array_search($slotMapping, $this->hotbar)) !== false and $slotMapping !== -1){
                     /* Do not do slot swaps if the slot was null
                      * Chosen slot is already linked to a hotbar slot, swap the two slots around.
                      * This will already have been done on the client-side so no changes need to be sent. */
                     $this->hotbar[$key] = $this->hotbar[$this->itemInHandIndex];
                 }
 
                 $this->hotbar[$this->itemInHandIndex] = $slotMapping;
             }
             $this->sendHeldItem($this->getHolder()->getViewers());
             if($sendToHolder){
                 $this->sendHeldItem($this->getHolder());
             }
         }
     }

◆ setHeldItemSlot()

setHeldItemSlot ( $slot )

Deprecated:

Parameters

int $slot

231 {

232 }

◆ setHelmet()

setHelmet ( Item $helmet )

Parameters

Item $helmet

Returns: bool

                                            {
         return $this->setItem($this->getSize(), $helmet);
     }

◆ setHotbarSlotIndex()

setHotbarSlotIndex	(	$index,
		$slot
	)

Deprecated:

Changes the linkage of the specified hotbar slot. This should never be done unless it is requested by the client.

Parameters

int	$index
int	$slot

                                                      {
         if($this->getHolder()->getServer()->getProperty("settings.deprecated-verbose") !== false){
             trigger_error("Do not attempt to change hotbar links in plugins!", E_USER_DEPRECATED);
         }
     }

◆ setItem()

setItem	(		$index,
		Item	$item,
			$send = `true`
	)

Parameters

int	$index
Item	$item
bool	$send

Returns: bool

                                                              {
         if($index < 0 or $index >= $this->size){
             return false;
         }elseif($item->getId() === 0 or $item->getCount() <= 0){
             return $this->clear($index, $send);
         }
 
         if($index >= $this->getSize()){ //Armor change
             Server::getInstance()->getPluginManager()->callEvent($ev = new EntityArmorChangeEvent($this->getHolder(), $this->getItem($index), $item, $index));
             if($ev->isCancelled() and $this->getHolder() instanceof Human){
                 $this->sendArmorSlot($index, $this->getViewers());
                 return false;
             }
             $item = $ev->getNewItem();
         }else{
             Server::getInstance()->getPluginManager()->callEvent($ev = new EntityInventoryChangeEvent($this->getHolder(), $this->getItem($index), $item, $index));
             if($ev->isCancelled()){
                 $this->sendSlot($index, $this->getViewers());
                 return false;
             }
             $item = $ev->getNewItem();
         }
 
 
         $old = $this->getItem($index);
         $this->slots[$index] = clone $item;
         $this->onSlotChange($index, $old, $send);
 
         return true;
     }

◆ setItemInHand()

setItemInHand ( Item $item )

Parameters

Item $item

Returns: bool

Sets the item in the inventory slot the player is currently holding.

                                              {
         return $this->setItem($this->getHeldItemSlot(), $item);
     }

◆ setLeggings()

setLeggings ( Item $leggings )

Parameters

Item $leggings

Returns: bool

                                                {
         return $this->setItem($this->getSize() + 2, $leggings);
     }

◆ setSize()

setSize ( $size )

Parameters

$size

                                   {
         parent::setSize($size + 4);
         $this->sendContents($this->getViewers());
     }

Field Documentation

◆ $hotbar

$hotbar

protected

◆ $itemInHandIndex

$itemInHandIndex = 0

protected

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

src/pocketmine/inventory/PlayerInventory.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clear()

◆ clearAll()

◆ damageArmor()

◆ getArmorContents()

◆ getArmorItem()

◆ getBoots()

◆ getChestplate()

◆ getHeldItemIndex()

◆ getHeldItemSlot()

◆ getHelmet()

◆ getHolder()

◆ getHotbar()

◆ getHotbarSize()

◆ getHotbarSlotIndex()

◆ getItemInHand()

◆ getLeggings()

◆ getSize()

◆ onSlotChange()

◆ sendArmorContents()

◆ sendContents()

◆ sendHeldItem()

◆ setArmorContents()

◆ setArmorItem()

◆ setBoots()

◆ setChestplate()

◆ setHeldItemIndex()

◆ setHeldItemSlot()

◆ setHelmet()

◆ setHotbarSlotIndex()

◆ setItem()

◆ setItemInHand()

◆ setLeggings()

◆ setSize()

Field Documentation

◆ $hotbar

◆ $itemInHandIndex