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

Refactored entity metadata handling into its own class, with type-safe methods (#1876)

Browse Source 
This includes several other changes, including:
- SLOT data properties now accept items directly
- POS data properties now accept floored Vector3s (in future this will be block positions) or null for 0,0,0
- VECTOR3F data properties now accept Vector3s or null for 0,0,0
This commit is contained in:
Dylan K. Taylor
2018-01-20 10:52:14 +00:00
committed by GitHub
parent 8f928915d9
commit 2eb6e075ae
11 changed files with 364 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
src/pocketmine/entity/Entity.php
View File

@ -338,16 +338,8 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
/** @var int */
protected $id;
protected $dataProperties = [
self::DATA_FLAGS => [self::DATA_TYPE_LONG, 0],
self::DATA_AIR => [self::DATA_TYPE_SHORT, 400],
self::DATA_MAX_AIR => [self::DATA_TYPE_SHORT, 400],
self::DATA_NAMETAG => [self::DATA_TYPE_STRING, ""],
self::DATA_LEAD_HOLDER_EID => [self::DATA_TYPE_LONG, -1],
self::DATA_SCALE => [self::DATA_TYPE_FLOAT, 1]
];
protected $changedDataProperties = [];
/** @var DataPropertyManager */
protected $propertyManager;
public $passenger = null;
public $vehicle = null;
@ -524,12 +516,20 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
$this->fallDistance = $this->namedtag->getFloat("FallDistance", 0.0);
$this->propertyManager = new DataPropertyManager();
$this->propertyManager->setLong(self::DATA_FLAGS, 0);
$this->propertyManager->setShort(self::DATA_MAX_AIR, 400);
$this->propertyManager->setString(self::DATA_NAMETAG, "");
$this->propertyManager->setLong(self::DATA_LEAD_HOLDER_EID, -1);
$this->propertyManager->setFloat(self::DATA_SCALE, 1);
$this->fireTicks = $this->namedtag->getShort("Fire", 0);
if($this->isOnFire()){
$this->setGenericFlag(self::DATA_FLAG_ONFIRE);
}
$this->setDataProperty(self::DATA_AIR, self::DATA_TYPE_SHORT, $this->namedtag->getShort("Air", 300), false);
$this->propertyManager->setShort(self::DATA_AIR, $this->namedtag->getShort("Air", 300));
$this->onGround = $this->namedtag->getByte("OnGround", 0) !== 0;
$this->invulnerable = $this->namedtag->getByte("Invulnerable", 0) !== 0;
@ -553,7 +553,7 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
* @return string
*/
public function getNameTag(){
return $this->getDataProperty(self::DATA_NAMETAG);
return $this->propertyManager->getString(self::DATA_NAMETAG);
}
/**
@ -575,7 +575,7 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
* @param string $name
*/
public function setNameTag($name){
$this->setDataProperty(self::DATA_NAMETAG, self::DATA_TYPE_STRING, $name);
$this->propertyManager->setString(self::DATA_NAMETAG, $name);
}
/**
@ -596,7 +596,7 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
* @return float
*/
public function getScale() : float{
return $this->getDataProperty(self::DATA_SCALE);
return $this->propertyManager->getFloat(self::DATA_SCALE);
}
/**
@ -611,7 +611,7 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
$this->recalculateBoundingBox();
$this->setDataProperty(self::DATA_SCALE, self::DATA_TYPE_FLOAT, $value);
$this->propertyManager->setFloat(self::DATA_SCALE, $value);
}
public function getBoundingBox(){
@ -706,7 +706,7 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
* @return int|null
*/
public function getOwningEntityId(){
return $this->getDataProperty(self::DATA_OWNER_EID);
return $this->propertyManager->getLong(self::DATA_OWNER_EID);
}
/**
@ -731,11 +731,11 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
*/
public function setOwningEntity(Entity $owner = null){
if($owner === null){
$this->removeDataProperty(self::DATA_OWNER_EID);
$this->propertyManager->removeProperty(self::DATA_OWNER_EID);
}elseif($owner->closed){
throw new \InvalidArgumentException("Supplied owning entity is garbage and cannot be used");
}else{
$this->setDataProperty(self::DATA_OWNER_EID, self::DATA_TYPE_LONG, $owner->getId());
$this->propertyManager->setLong(self::DATA_OWNER_EID, $owner->getId());
}
}
@ -744,7 +744,7 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
* @return int|null
*/
public function getTargetEntityId(){
return $this->getDataProperty(self::DATA_TARGET_EID);
return $this->propertyManager->getLong(self::DATA_TARGET_EID);
}
/**
@ -771,11 +771,11 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
*/
public function setTargetEntity(Entity $target = null){
if($target === null){
$this->removeDataProperty(self::DATA_TARGET_EID);
$this->propertyManager->removeProperty(self::DATA_TARGET_EID);
}elseif($target->closed){
throw new \InvalidArgumentException("Supplied target entity is garbage and cannot be used");
}else{
$this->setDataProperty(self::DATA_TARGET_EID, self::DATA_TYPE_LONG, $target->getId());
$this->propertyManager->setLong(self::DATA_TARGET_EID, $target->getId());
}
}
@ -841,7 +841,7 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
$this->namedtag->setFloat("FallDistance", $this->fallDistance);
$this->namedtag->setShort("Fire", $this->fireTicks);
$this->namedtag->setShort("Air", $this->getDataProperty(self::DATA_AIR));
$this->namedtag->setShort("Air", $this->propertyManager->getShort(self::DATA_AIR));
$this->namedtag->setByte("OnGround", $this->onGround ? 1 : 0);
$this->namedtag->setByte("Invulnerable", $this->invulnerable ? 1 : 0);
}
@ -971,9 +971,10 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
$this->justCreated = false;
if(count($this->changedDataProperties) > 0){
$this->sendData($this->hasSpawned, $this->changedDataProperties);
$this->changedDataProperties = [];
$changedProperties = $this->propertyManager->getDirty();
if(!empty($changedProperties)){
$this->sendData($this->hasSpawned, $changedProperties);
$this->propertyManager->clearDirtyProperties();
}
$hasUpdate = false;
@ -1899,7 +1900,7 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
$pk->yaw = $this->yaw;
$pk->pitch = $this->pitch;
$pk->attributes = $this->attributeMap->getAll();
$pk->metadata = $this->dataProperties;
$pk->metadata = $this->propertyManager->getAll();
$player->dataPacket($pk);
}
@ -2001,49 +2002,6 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
}
}
/**
* @param int $id
* @param int $type
* @param mixed $value
* @param bool $send
*
* @return bool
*/
public function setDataProperty(int $id, int $type, $value, bool $send = true) : bool{
if($this->getDataProperty($id) !== $value){
$this->dataProperties[$id] = [$type, $value];
if($send){
$this->changedDataProperties[$id] = $this->dataProperties[$id]; //This will be sent on the next tick
}
return true;
}
return false;
}
/**
* @param int $id
*
* @return mixed
*/
public function getDataProperty(int $id){
return isset($this->dataProperties[$id]) ? $this->dataProperties[$id][1] : null;
}
public function removeDataProperty(int $id){
unset($this->dataProperties[$id]);
}
/**
* @param int $id
*
* @return int|null
*/
public function getDataPropertyType(int $id){
return isset($this->dataProperties[$id]) ? $this->dataProperties[$id][0] : null;
}
/**
* @param int $propertyId
* @param int $flagId
@ -2052,9 +2010,9 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
*/
public function setDataFlag(int $propertyId, int $flagId, bool $value = true, int $propertyType = self::DATA_TYPE_LONG){
if($this->getDataFlag($propertyId, $flagId) !== $value){
$flags = (int) $this->getDataProperty($propertyId);
$flags = (int) $this->propertyManager->getPropertyValue($propertyId, $propertyType);
$flags ^= 1 << $flagId;
$this->setDataProperty($propertyId, $propertyType, $flags);
$this->propertyManager->setPropertyValue($propertyId, $propertyType, $flags);
}
}
@ -2065,7 +2023,7 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
* @return bool
*/
public function getDataFlag(int $propertyId, int $flagId) : bool{
return (((int) $this->getDataProperty($propertyId)) & (1 << $flagId)) > 0;
return (((int) $this->propertyManager->getPropertyValue($propertyId, -1)) & (1 << $flagId)) > 0;
}
/**
@ -2099,7 +2057,7 @@ abstract class Entity extends Location implements Metadatable, EntityIds{
$pk = new SetEntityDataPacket();
$pk->entityRuntimeId = $this->getId();
$pk->metadata = $data ?? $this->dataProperties;
$pk->metadata = $data ?? $this->propertyManager->getAll();
foreach($player as $p){
if($p === $this){