Public Member Functions
	__construct (Level $level, CompoundTag $nbt)

	close ()

	activate ()

	deactivate ()

	canUpdate ()

	resetCooldownTicks ()

	onUpdate ()

	getInventory ()

	getSize ()

	getItem ($index)

	setItem ($index, Item $item)

	saveNBT ()

	getName ()

	hasName ()

	setName ($str)

	hasLock ()

	setLock (string $itemName="")

	checkLock (string $key)

	getSpawnCompound ()

Public Member Functions inherited from Spawnable
	spawnTo (Player $player)

	__construct (Level $level, CompoundTag $nbt)

	spawnToAll ()

	getSpawnCompound ()

	updateCompoundTag (CompoundTag $nbt, Player $player)

Public Member Functions inherited from Tile
	getSaveId ()

	__construct (Level $level, CompoundTag $nbt)

	getId ()

	saveNBT ()

	getBlock ()

	onUpdate ()

	scheduleUpdate ()

	__destruct ()

	close ()

	getName ()

Public Member Functions inherited from Position
	__construct ($x=0, $y=0, $z=0, Level $level=null)

	asPosition ()

	add ($x, $y=0, $z=0)

	getLevel ()

	setLevel (Level $level=null)

	isValid ()

	getSide ($side, $step=1)

	__toString ()

	setComponents ($x, $y, $z)

	fromObjectAdd (Vector3 $pos, $x, $y, $z)

Public Member Functions inherited from Vector3
	__construct ($x=0, $y=0, $z=0)

	getX ()

	getY ()

	getZ ()

	getFloorX ()

	getFloorY ()

	getFloorZ ()

	getRight ()

	getUp ()

	getForward ()

	getSouth ()

	getWest ()

	add ($x, $y=0, $z=0)

	subtract ($x=0, $y=0, $z=0)

	multiply ($number)

	divide ($number)

	ceil ()

	floor ()

	round ()

	abs ()

	getSide ($side, $step=1)

	asVector3 ()

	distance (Vector3 $pos)

	distanceSquared (Vector3 $pos)

	maxPlainDistance ($x=0, $z=0)

	length ()

	lengthSquared ()

	normalize ()

	dot (Vector3 $v)

	cross (Vector3 $v)

	equals (Vector3 $v)

	getIntermediateWithXValue (Vector3 $v, $x)

	getIntermediateWithYValue (Vector3 $v, $y)

	getIntermediateWithZValue (Vector3 $v, $z)

	setComponents ($x, $y, $z)

	fromObjectAdd (Vector3 $pos, $x, $y, $z)

	__toString ()

Protected Member Functions
	getSlotIndex ($index)

Protected Member Functions inherited from Spawnable
	onChanged ()

Protected Attributes
	$inventory

	$isLocked = false

	$isPowered = false

Protected Attributes inherited from Tile
	$lastUpdate

	$server

	$timings

Additional Inherited Members
Static Public Member Functions inherited from Tile
static	init ()

static	createTile ($type, Level $level, CompoundTag $nbt,... $args)

static	registerTile ($className)

Static Public Member Functions inherited from Position
static	fromObject (Vector3 $pos, Level $level=null)

Static Public Member Functions inherited from Vector3
static	getOppositeSide ($side)

static	createRandomDirection (Random $random)

Data Fields inherited from Tile
const	BREWING_STAND = "BrewingStand"

const	CHEST = "Chest"

const	DL_DETECTOR = "DayLightDetector"

const	ENCHANT_TABLE = "EnchantTable"

const	FLOWER_POT = "FlowerPot"

const	FURNACE = "Furnace"

const	MOB_SPAWNER = "MobSpawner"

const	SIGN = "Sign"

const	SKULL = "Skull"

const	ITEM_FRAME = "ItemFrame"

const	DISPENSER = "Dispenser"

const	DROPPER = "Dropper"

const	CAULDRON = "Cauldron"

const	HOPPER = "Hopper"

const	BEACON = "Beacon"

const	ENDER_CHEST = "EnderChest"

const	BED = "Bed"

const	DAY_LIGHT_DETECTOR = "DLDetector"

	$chunk

	$name

	$id

	$x

	$y

	$z

	$attach

	$metadata

	$closed = false

	$namedtag

	$tickTimer

Data Fields inherited from Position
	$level = null

Data Fields inherited from Vector3
const	SIDE_DOWN = 0

const	SIDE_UP = 1

const	SIDE_NORTH = 2

const	SIDE_SOUTH = 3

const	SIDE_WEST = 4

const	SIDE_EAST = 5

	$x

	$y

	$z

Static Public Attributes inherited from Tile
static	$tileCount = 1

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Level	$level,
		CompoundTag	$nbt
	)

Hopper constructor.

Parameters

Level	$level
CompoundTag	$nbt

                                                                {
         if(!isset($nbt->TransferCooldown) or !($nbt->TransferCooldown instanceof IntTag)){
             $nbt->TransferCooldown = new IntTag("TransferCooldown", 0);
         }
 
         parent::__construct($level, $nbt);
 
         $this->inventory = new HopperInventory($this);
 
         if(!isset($this->namedtag->Items) or !($this->namedtag->Items instanceof ListTag)){
             $this->namedtag->Items = new ListTag("Items", []);
             $this->namedtag->Items->setTagType(NBT::TAG_Compound);
         }
 
         for($i = 0; $i < $this->getSize(); ++$i){
             $this->inventory->setItem($i, $this->getItem($i));
         }
 
         $this->scheduleUpdate();
     }

Member Function Documentation

◆ activate()

activate ( )

                               {
         $this->isPowered = true;
     }

◆ canUpdate()

canUpdate ( )

Returns: bool

                                {
         return $this->namedtag->TransferCooldown->getValue() === 0 and !$this->isPowered;
     }

◆ checkLock()

checkLock ( string $key )

Parameters

string $key

Returns: bool

                                           {
         return $this->namedtag->Lock->getValue() === $key;
     }

◆ close()

close ( )

                            {
         if($this->closed === false){
             foreach($this->getInventory()->getViewers() as $player){
                 $player->removeWindow($this->getInventory());
             }
             parent::close();
         }
     }

◆ deactivate()

deactivate ( )

                                 {
         $this->isPowered = false;
     }

◆ getInventory()

getInventory ( )

Returns: HopperInventory

Implements InventoryHolder.

                                   {
         return $this->inventory;
     }

◆ getItem()

getItem ( $index )

This method should not be used by plugins, use the Inventory

Parameters

int $index

Returns: Item

Implements Container.

                                    {
         $i = $this->getSlotIndex($index);
         if($i < 0){
             return Item::get(Item::AIR, 0, 0);
         }else{
             return Item::nbtDeserialize($this->namedtag->Items[$i]);
         }
     }

◆ getName()

getName ( )

Returns: string

Implements Nameable.

                               : string{
         return isset($this->namedtag->CustomName) ? $this->namedtag->CustomName->getValue() : "Hopper";
     }

◆ getSize()

getSize ( )

Returns: int

Implements Container.

                              {
         return 5;
     }

◆ getSlotIndex()

getSlotIndex ( $index )

protected

Parameters

$index

Returns: int

                                            {
         foreach($this->namedtag->Items as $i => $slot){
             if((int) $slot["Slot"] === (int) $index){
                 return (int) $i;
             }
         }
 
         return -1;
     }

◆ getSpawnCompound()

getSpawnCompound ( )

Returns: CompoundTag

                                       {
         $c = new CompoundTag("", [
             new StringTag("id", Tile::HOPPER),
             new IntTag("x", (int) $this->x),
             new IntTag("y", (int) $this->y),
             new IntTag("z", (int) $this->z)
         ]);
 
         if($this->hasName()){
             $c->CustomName = $this->namedtag->CustomName;
         }
         if($this->hasLock()){
             $c->Lock = $this->namedtag->Lock;
         }
 
         return $c;
     }

◆ hasLock()

hasLock ( )

Returns: bool

                              {
         return isset($this->namedtag->Lock);
     }

◆ hasName()

hasName ( )

Returns: bool

Implements Nameable.

                              {
         return isset($this->namedtag->CustomName);
     }

◆ onUpdate()

onUpdate ( )

Returns: bool

                               {
         if(!($this->getBlock() instanceof HopperBlock)){
             return false;
         }
         //Pickup dropped items
         //This can happen at any time regardless of cooldown
         $area = clone $this->getBlock()->getBoundingBox(); //Area above hopper to draw items from
         $area->maxY = ceil($area->maxY) + 1; //Account for full block above, not just 1 + 5/8
         foreach($this->getLevel()->getChunkEntities($this->getBlock()->x >> 4, $this->getBlock()->z >> 4) as $entity){
             if(!($entity instanceof DroppedItem) or !$entity->isAlive()){
                 continue;
             }
             if(!$entity->boundingBox->intersectsWith($area)){
                 continue;
             }
 
             $item = $entity->getItem();
             if(!$item instanceof Item){
                 continue;
             }
             if($item->getCount() < 1){
                 $entity->kill();
                 continue;
             }
 
             if($this->inventory->canAddItem($item)){
                 $this->inventory->addItem($item);
                 $entity->kill();
             }
         }
 
         if(!$this->canUpdate()){ //Hoppers only update CONTENTS every 8th tick
             $this->namedtag->TransferCooldown->setValue($this->namedtag->TransferCooldown->getValue() - 1);
             return true;
         }
 
         //Suck items from above tile inventories
         $source = $this->getLevel()->getTile($this->getBlock()->getSide(Vector3::SIDE_UP));
         if($source instanceof Tile and $source instanceof InventoryHolder){
             $inventory = $source->getInventory();
             $item = clone $inventory->getItem($inventory->firstOccupied());
             $item->setCount(1);
             if($this->inventory->canAddItem($item)){
                 $this->inventory->addItem($item);
                 $inventory->removeItem($item);
                 $this->resetCooldownTicks();
                 if($source instanceof Hopper){
                     $source->resetCooldownTicks();
                 }
             }
         }
 
         //Feed item into target inventory
         //Do not do this if there's a hopper underneath this hopper, to follow vanilla behaviour
         if(!($this->getLevel()->getTile($this->getBlock()->getSide(Vector3::SIDE_DOWN)) instanceof Hopper)){
             $target = $this->getLevel()->getTile($this->getBlock()->getSide($this->getBlock()->getDamage()));
             if($target instanceof Tile and $target instanceof InventoryHolder){
                 $inv = $target->getInventory();
                 foreach($this->inventory->getContents() as $item){
                     if($item->getId() === Item::AIR or $item->getCount() < 1){
                         continue;
                     }
                     $targetItem = clone $item;
                     $targetItem->setCount(1);
 
                     if($inv->canAddItem($targetItem)){
                         $inv->addItem($targetItem);
                         $this->inventory->removeItem($targetItem);
                         $this->resetCooldownTicks();
                         if($target instanceof Hopper){
                             $target->resetCooldownTicks();
                         }
                         break;
                     }
 
                 }
             }
         }
 
         return true;
     }

◆ resetCooldownTicks()

resetCooldownTicks ( )

                                         {
         $this->namedtag->TransferCooldown->setValue(8);
     }

◆ saveNBT()

saveNBT ( )

                              {
         $this->namedtag->Items = new ListTag("Items", []);
         $this->namedtag->Items->setTagType(NBT::TAG_Compound);
         for($index = 0; $index < $this->getSize(); ++$index){
             $this->setItem($index, $this->inventory->getItem($index));
         }
     }

◆ setItem()

setItem	(		$index,
		Item	$item
	)

This method should not be used by plugins, use the Inventory

Parameters

int	$index
Item	$item

Returns: bool

Implements Container.

                                                {
         $i = $this->getSlotIndex($index);
 
         if($item->getId() === Item::AIR or $item->getCount() <= 0){
             if($i >= 0){
                 unset($this->namedtag->Items[$i]);
             }
         }elseif($i < 0){
             for($i = 0; $i <= $this->getSize(); ++$i){
                 if(!isset($this->namedtag->Items[$i])){
                     break;
                 }
             }
             $this->namedtag->Items[$i] = $item->nbtSerialize($index);
         }else{
             $this->namedtag->Items[$i] = $item->nbtSerialize($index);
         }
 
         return true;
     }

◆ setLock()

setLock ( string $itemName = "" )

Parameters

string $itemName

                                                   {
         if($itemName === ""){
             unset($this->namedtag->Lock);
             return;
         }
         $this->namedtag->Lock = new StringTag("Lock", $itemName);
     }

◆ setName()

setName ( $str )

Parameters

void $str

Implements Nameable.

                                  {
         if($str === ""){
             unset($this->namedtag->CustomName);
             return;
         }
         $this->namedtag->CustomName = new StringTag("CustomName", $str);
     }

Field Documentation

◆ $inventory

$inventory

protected

◆ $isLocked

$isLocked = false

protected

◆ $isPowered

$isPowered = false

protected

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

src/pocketmine/tile/Hopper.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activate()

◆ canUpdate()

◆ checkLock()

◆ close()

◆ deactivate()

◆ getInventory()

◆ getItem()

◆ getName()

◆ getSize()

◆ getSlotIndex()

◆ getSpawnCompound()

◆ hasLock()

◆ hasName()

◆ onUpdate()

◆ resetCooldownTicks()

◆ saveNBT()

◆ setItem()

◆ setLock()

◆ setName()

Field Documentation

◆ $inventory

◆ $isLocked

◆ $isPowered