Chest Class Reference

Public Member Functions
	__construct (Level $level, CompoundTag $nbt)
	close ()
	saveNBT ()
	getSize ()
	getItem ($index)
	setItem ($index, Item $item)
	getInventory ()
	getRealInventory ()
	getDoubleInventory ()
	getName ()
	hasName ()
	setName ($str)
	isPaired ()
	getPair ()
	pairWith (Chest $tile)
	unpair ()
	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)
	checkPairing ()
Protected Member Functions inherited from Spawnable
	onChanged ()

Protected Attributes
	$inventory
	$doubleInventory = null
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
	)

Chest constructor.

Parameters

Level	$level
CompoundTag	$nbt

                                                               {
        parent::__construct($level, $nbt);
        $this->inventory = new ChestInventory($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));
        }
    }

Member Function Documentation

checkPairing()

checkPairing ( )

protected

                                     {
        if($this->isPaired() and !$this->getLevel()->isChunkLoaded($this->namedtag->pairx->getValue() >> 4, $this->namedtag->pairz->getValue() >> 4)){
            //paired to a tile in an unloaded chunk
            $this->doubleInventory = null;

        }elseif(($pair = $this->getPair()) instanceof Chest){
            if(!$pair->isPaired()){
                $pair->createPair($this);
                $pair->checkPairing();
            }
            if($this->doubleInventory === null){
                if(($p = $pair->getDoubleInventory()) instanceof DoubleChestInventory){
                    $this->doubleInventory = $p;
                }else{
                    if(($pair->x + ($pair->z << 15)) > ($this->x + ($this->z << 15))){ //Order them correctly
                        $this->doubleInventory = new DoubleChestInventory($pair, $this);
                    }else{
                        $this->doubleInventory = new DoubleChestInventory($this, $pair);
                    }
                }
            }
        }else{
            $this->doubleInventory = null;
            unset($this->namedtag->pairx, $this->namedtag->pairz);
        }
    }

close()

close

(

)

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

            foreach($this->getInventory()->getViewers() as $player){
                $player->removeWindow($this->getRealInventory());
            }
            parent::close();
        }
    }

getDoubleInventory()

getDoubleInventory

(

)

Returns

DoubleChestInventory|null

                                        {
        return $this->doubleInventory;
    }

getInventory()

getInventory

(

)

Returns

ChestInventory|DoubleChestInventory

Implements InventoryHolder.

                                  {
        if($this->isPaired() and $this->doubleInventory === null){
            $this->checkPairing();
        }
        return $this->doubleInventory instanceof DoubleChestInventory ? $this->doubleInventory : $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() : "Chest";
    }

getPair()

getPair

(

)

Returns

Chest

                             {
        if($this->isPaired()){
            $tile = $this->getLevel()->getTile(new Vector3((int) $this->namedtag["pairx"], $this->y, (int) $this->namedtag["pairz"]));
            if($tile instanceof Chest){
                return $tile;
            }
        }

        return null;
    }

getRealInventory()

getRealInventory

(

)

Returns

ChestInventory

                                      {
        return $this->inventory;
    }

getSize()

getSize

(

)

Returns

int

Implements Container.

                             {
        return 27;
    }

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

                                      {
        if($this->isPaired()){
            $c = new CompoundTag("", [
                new StringTag("id", Tile::CHEST),
                new IntTag("x", (int) $this->x),
                new IntTag("y", (int) $this->y),
                new IntTag("z", (int) $this->z),
                new IntTag("pairx", (int) $this->namedtag["pairx"]),
                new IntTag("pairz", (int) $this->namedtag["pairz"])
            ]);
        }else{
            $c = new CompoundTag("", [
                new StringTag("id", Tile::CHEST),
                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;
        }

        return $c;
    }

hasName()

hasName

(

)

Returns

bool

Implements Nameable.

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

isPaired()

isPaired

(

)

Returns

bool

                              {
        if(!isset($this->namedtag->pairx) or !isset($this->namedtag->pairz)){
            return false;
        }

        return true;
    }

pairWith()

pairWith

(

Chest

$tile

)

Parameters

Chest

$tile

Returns

bool

                                         {
        if($this->isPaired() or $tile->isPaired()){
            return false;
        }

        $this->createPair($tile);

        $this->spawnToAll();
        $tile->spawnToAll();
        $this->checkPairing();

        return true;
    }

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;
    }

setName()

setName

(

$str

)

Parameters

void

$str

Implements Nameable.

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

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

unpair()

unpair

(

)

Returns

bool

                            {
        if(!$this->isPaired()){
            return false;
        }

        $tile = $this->getPair();
        unset($this->namedtag->pairx, $this->namedtag->pairz);

        $this->spawnToAll();

        if($tile instanceof Chest){
            unset($tile->namedtag->pairx, $tile->namedtag->pairz);
            $tile->checkPairing();
            $tile->spawnToAll();
        }
        $this->checkPairing();

        return true;
    }

Field Documentation

$doubleInventory

$doubleInventory = null

protected

$inventory

$inventory

protected

---

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

• src/pocketmine/tile/Chest.php