mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-09-06 17:59:48 +00:00
Code Issues Projects Releases Wiki Activity

Remove network-serialized item NBT from API layer, item NBT is now retained for the lifetime of the stack

Browse Source
This commit is contained in:
Dylan K. Taylor
2018-10-27 15:26:01 +01:00
parent d2513ff908
commit 9bb3c93285
7 changed files with 66 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
src/pocketmine/item/Item.php
View File

@ -81,14 +81,14 @@ class Item implements ItemIds, \JsonSerializable{
*
* This function redirects to {@link ItemFactory#get}.
*
* @param int $id
* @param int $meta
* @param int $count
* @param CompoundTag|string $tags
* @param int $id
* @param int $meta
* @param int $count
* @param CompoundTag $tags
*
* @return Item
*/
public static function get(int $id, int $meta = 0, int $count = 1, $tags = "") : Item{
public static function get(int $id, int $meta = 0, int $count = 1, ?CompoundTag $tags = null) : Item{
return ItemFactory::get($id, $meta, $count, $tags);
}
@ -170,10 +170,8 @@ class Item implements ItemIds, \JsonSerializable{
protected $id;
/** @var int */
protected $meta;
/** @var string */
private $tags = "";
/** @var CompoundTag|null */
private $cachedNBT = null;
private $nbt = null;
/** @var int */
protected $count = 1;
/** @var string */
@ -199,40 +197,6 @@ class Item implements ItemIds, \JsonSerializable{
$this->name = $name;
}
/**
* Sets the Item's NBT
*
* @param CompoundTag|string $tags
*
* @return Item
*/
public function setCompoundTag($tags) : Item{
if($tags instanceof CompoundTag){
$this->setNamedTag($tags);
}else{
$this->tags = (string) $tags;
$this->cachedNBT = null;
}
return $this;
}
/**
* Returns the serialized NBT of the Item
* @return string
*/
public function getCompoundTag() : string{
return $this->tags;
}
/**
* Returns whether this Item has a non-empty NBT.
* @return bool
*/
public function hasCompoundTag() : bool{
return $this->tags !== "";
}
/**
* @return bool
*/
@ -537,6 +501,14 @@ class Item implements ItemIds, \JsonSerializable{
$this->setNamedTag($tag);
}
/**
* Returns whether this Item has a non-empty NBT.
* @return bool
*/
public function hasNamedTag() : bool{
return $this->nbt !== null and $this->nbt->count() > 0;
}
/**
* Returns a tree of Tag objects representing the Item's NBT. If the item does not have any NBT, an empty CompoundTag
* object is returned to allow the caller to manipulate and apply back to the item.
@ -544,11 +516,7 @@ class Item implements ItemIds, \JsonSerializable{
* @return CompoundTag
*/
public function getNamedTag() : CompoundTag{
if(!$this->hasCompoundTag() and $this->cachedNBT === null){
$this->cachedNBT = new CompoundTag();
}
return $this->cachedNBT ?? ($this->cachedNBT = self::parseCompoundTag($this->tags));
return $this->nbt ?? ($this->nbt = new CompoundTag());
}
/**
@ -563,8 +531,7 @@ class Item implements ItemIds, \JsonSerializable{
return $this->clearNamedTag();
}
$this->cachedNBT = $tag;
$this->tags = self::writeCompoundTag($tag);
$this->nbt = clone $tag;
return $this;
}
@ -574,7 +541,8 @@ class Item implements ItemIds, \JsonSerializable{
* @return Item
*/
public function clearNamedTag() : Item{
return $this->setCompoundTag("");
$this->nbt = null;
return $this;
}
/**
@ -817,9 +785,7 @@ class Item implements ItemIds, \JsonSerializable{
final public function equals(Item $item, bool $checkDamage = true, bool $checkCompound = true) : bool{
if($this->id === $item->getId() and (!$checkDamage or $this->getDamage() === $item->getDamage())){
if($checkCompound){
if($item->getCompoundTag() === $this->getCompoundTag()){
return true;
}elseif($this->hasCompoundTag() and $item->hasCompoundTag()){
if($this->hasNamedTag() and $item->hasNamedTag()){
//Serialized NBT didn't match, check the cached object tree.
return $this->getNamedTag()->equals($item->getNamedTag());
}
@ -846,7 +812,7 @@ class Item implements ItemIds, \JsonSerializable{
* @return string
*/
final public function __toString() : string{
return "Item " . $this->name . " (" . $this->id . ":" . ($this->hasAnyDamageValue() ? "?" : $this->getDamage()) . ")x" . $this->count . ($this->hasCompoundTag() ? " tags:0x" . bin2hex($this->getCompoundTag()) : "");
return "Item " . $this->name . " (" . $this->id . ":" . ($this->hasAnyDamageValue() ? "?" : $this->getDamage()) . ")x" . $this->count . ($this->hasNamedTag() ? " tags:0x" . self::writeCompoundTag($this->nbt) : "");
}
/**
@ -867,8 +833,8 @@ class Item implements ItemIds, \JsonSerializable{
$data["count"] = $this->getCount();
}
if($this->hasCompoundTag()){
$data["nbt_b64"] = base64_encode($this->getCompoundTag());
if($this->hasNamedTag()){
$data["nbt_b64"] = base64_encode(self::writeCompoundTag($this->getNamedTag()));
}
return $data;
@ -893,10 +859,7 @@ class Item implements ItemIds, \JsonSerializable{
$nbt = base64_decode($data["nbt_b64"], true);
}
return ItemFactory::get(
(int) $data["id"],
(int) ($data["damage"] ?? 0),
(int) ($data["count"] ?? 1),
(string) $nbt
(int) $data["id"], (int) ($data["damage"] ?? 0), (int) ($data["count"] ?? 1), $nbt !== "" ? self::parseCompoundTag($nbt) : null
);
}
@ -915,7 +878,7 @@ class Item implements ItemIds, \JsonSerializable{
new ShortTag("Damage", $this->getDamage())
]);
if($this->hasCompoundTag()){
if($this->hasNamedTag()){
$itemNBT = clone $this->getNamedTag();
$itemNBT->setName("tag");
$result->setTag($itemNBT);
@ -970,6 +933,8 @@ class Item implements ItemIds, \JsonSerializable{
}
public function __clone(){
$this->cachedNBT = null;
if($this->nbt !== null){
$this->nbt = clone $this->nbt;
}
}
}

20
src/pocketmine/item/ItemFactory.php
View File

@ -324,19 +324,15 @@ class ItemFactory{
/**
* Returns an instance of the Item with the specified id, meta, count and NBT.
*
* @param int $id
* @param int $meta
* @param int $count
* @param CompoundTag|string $tags
* @param int $id
* @param int $meta
* @param int $count
* @param CompoundTag $tags
*
* @return Item
* @throws \TypeError
* @throws \InvalidArgumentException
*/
public static function get(int $id, int $meta = 0, int $count = 1, $tags = "") : Item{
if(!is_string($tags) and !($tags instanceof CompoundTag)){
throw new \TypeError("`tags` argument must be a string or CompoundTag instance, " . (is_object($tags) ? "instance of " . get_class($tags) : gettype($tags)) . " given");
}
public static function get(int $id, int $meta = 0, int $count = 1, ?CompoundTag $tags = null) : Item{
/** @var Item $item */
$item = null;
if($meta !== -1){
@ -357,7 +353,9 @@ class ItemFactory{
}
$item->setCount($count);
$item->setCompoundTag($tags);
if($tags !== null){
$item->setNamedTag($tags);
}
return $item;
}