mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-08-29 22:45:00 +00:00
Code Issues Projects Releases Wiki Activity

Block: reduce method placement chaos

Browse Source
This commit is contained in:
Dylan K. Taylor 2023-03-02 16:23:40 +00:00
parent 7c974a12e1
commit cbb58d3e0d
No known key found for this signature in database
GPG Key ID: 8927471A91CAFD3D
1 changed files with 42 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
src/block/Block.php
View File

@ -105,6 +105,15 @@ class Block{
return $this->fallbackName; return $this->fallbackName;
} }
/**
* Returns a type ID that identifies this type of block. This does not include information like facing, open/closed,
* powered/unpowered, etc.
*/
public function getTypeId() : int{
return $this->idInfo->getBlockTypeId();
}
/** /**
* @internal * @internal
* *
@ -117,6 +126,39 @@ class Block{
return ($this->getTypeId() << self::INTERNAL_STATE_DATA_BITS) | $this->computeStateData(); return ($this->getTypeId() << self::INTERNAL_STATE_DATA_BITS) | $this->computeStateData();
} }
/**
* Returns whether the given block has an equivalent type to this one. This compares the type IDs.
*/
public function isSameType(Block $other) : bool{
return $this->getTypeId() === $other->getTypeId();
}
/**
* Returns whether the given block has the same type and properties as this block.
*/
public function isSameState(Block $other) : bool{
return $this->getStateId() === $other->getStateId();
}
/**
* @return string[]
*/
public function getTypeTags() : array{
return $this->typeInfo->getTypeTags();
}
/**
* Returns whether this block type has the given type tag. Type tags are used as a dynamic way to tag blocks as
* having certain properties, allowing type checks which are more dynamic than hardcoding a bunch of IDs or a bunch
* of instanceof checks.
*
* For example, grass blocks, dirt, farmland, podzol and mycelium are all dirt-like blocks, and support the
* placement of blocks like flowers, so they have a common tag which allows them to be identified as such.
*/
public function hasTypeTag(string $tag) : bool{
return $this->typeInfo->hasTypeTag($tag);
}
/** /**
* Returns the block as an item. * Returns the block as an item.
* State information such as facing, powered/unpowered, open/closed, etc., is discarded. * State information such as facing, powered/unpowered, open/closed, etc., is discarded.
@ -272,47 +314,6 @@ class Block{
} }
} }
/**
* Returns a type ID that identifies this type of block. This does not include information like facing, open/closed,
* powered/unpowered, etc.
*/
public function getTypeId() : int{
return $this->idInfo->getBlockTypeId();
}
/**
* Returns whether the given block has an equivalent type to this one. This compares the type IDs.
*/
public function isSameType(Block $other) : bool{
return $this->getTypeId() === $other->getTypeId();
}
/**
* Returns whether the given block has the same type and properties as this block.
*/
public function isSameState(Block $other) : bool{
return $this->getStateId() === $other->getStateId();
}
/**
* @return string[]
*/
public function getTypeTags() : array{
return $this->typeInfo->getTypeTags();
}
/**
* Returns whether this block type has the given type tag. Type tags are used as a dynamic way to tag blocks as
* having certain properties, allowing type checks which are more dynamic than hardcoding a bunch of IDs or a bunch
* of instanceof checks.
*
* For example, grass blocks, dirt, farmland, podzol and mycelium are all dirt-like blocks, and support the
* placement of blocks like flowers, so they have a common tag which allows them to be identified as such.
*/
public function hasTypeTag(string $tag) : bool{
return $this->typeInfo->hasTypeTag($tag);
}
/** /**
* AKA: Block->isPlaceable * AKA: Block->isPlaceable
*/ */