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

Basic implementation of banners, including API to modify them with ease. (#1331)

Browse Source 
Banner crafting is NOT implemented yet.
This commit is contained in:
Sandertv 2017-11-15 12:10:46 +01:00 committed by Dylan K. Taylor
parent 0d2b171c2c
commit 2794df34ab
8 changed files with 719 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/pocketmine/block/BlockFactory.php
View File

@ -245,8 +245,8 @@ class BlockFactory{
self::registerBlock(new Coal());
self::registerBlock(new PackedIce());
self::registerBlock(new DoublePlant());
//TODO: STANDING_BANNER
//TODO: WALL_BANNER
self::registerBlock(new StandingBanner());
self::registerBlock(new WallBanner());
//TODO: DAYLIGHT_DETECTOR_INVERTED
self::registerBlock(new RedSandstone());
self::registerBlock(new RedSandstoneStairs());

109
src/pocketmine/block/StandingBanner.php Normal file
View File

@ -0,0 +1,109 @@
<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\block;
use pocketmine\item\ItemFactory;
use pocketmine\math\AxisAlignedBB;
use pocketmine\item\Item;
use pocketmine\item\Tool;
use pocketmine\level\Level;
use pocketmine\math\Vector3;
use pocketmine\Player;
use pocketmine\tile\Banner as TileBanner;
use pocketmine\tile\Tile;
class StandingBanner extends Transparent{
protected $id = self::STANDING_BANNER;
protected $itemId = Item::BANNER;
public function __construct(int $meta = 0){
$this->meta = $meta;
}
public function getHardness() : float{
return 1;
}
public function isSolid() : bool{
return false;
}
public function getName() : string{
return "Standing Banner";
}
protected function recalculateBoundingBox() : ?AxisAlignedBB{
return null;
}
public function place(Item $item, Block $blockReplace, Block $blockClicked, int $face, Vector3 $facePos, Player $player = null) : bool{
if($face !== Vector3::SIDE_DOWN){
if($face === Vector3::SIDE_UP and $player !== null){
$this->meta = floor((($player->yaw + 180) * 16 / 360) + 0.5) & 0x0f;
$this->getLevel()->setBlock($blockReplace, $this, true);
}else{
$this->meta = $face;
$this->getLevel()->setBlock($blockReplace, BlockFactory::get(Block::WALL_BANNER, $this->meta), true);
}
Tile::createTile(Tile::BANNER, $this->getLevel(), TileBanner::createNBT($this, $face, $item, $player));
return true;
}
return false;
}
public function onUpdate(int $type){
if($type === Level::BLOCK_UPDATE_NORMAL){
if($this->getSide(Vector3::SIDE_DOWN)->getId() === self::AIR){
$this->getLevel()->useBreakOn($this);
return Level::BLOCK_UPDATE_NORMAL;
}
}
return false;
}
public function getToolType() : int{
return Tool::TYPE_AXE;
}
public function getVariantBitmask() : int{
return 0;
}
public function getDrops(Item $item) : array{
$tile = $this->level->getTile($this);
$drop = ItemFactory::get(Item::BANNER, ($tile instanceof TileBanner ? $tile->getBaseColor() : 0));
if($tile instanceof TileBanner and ($patterns = $tile->namedtag->getListTag(TileBanner::TAG_PATTERNS)) !== null and $patterns->getCount() > 0){
$drop->setNamedTagEntry($patterns);
}
return [$drop];
}
}

45
src/pocketmine/block/WallBanner.php Normal file
View File

@ -0,0 +1,45 @@
<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\block;
use pocketmine\level\Level;
class WallBanner extends StandingBanner{
protected $id = self::WALL_BANNER;
public function getName() : string{
return "Wall Banner";
}
public function onUpdate(int $type){
if($type === Level::BLOCK_UPDATE_NORMAL){
if($this->getSide($this->meta ^ 0x01)->getId() === self::AIR){
$this->getLevel()->useBreakOn($this);
}
return Level::BLOCK_UPDATE_NORMAL;
}
return false;
}
}

251
src/pocketmine/item/Banner.php Normal file
View File

@ -0,0 +1,251 @@
<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\item;
use pocketmine\block\Block;
use pocketmine\block\BlockFactory;
use pocketmine\nbt\tag\CompoundTag;
use pocketmine\nbt\tag\IntTag;
use pocketmine\nbt\tag\ListTag;
use pocketmine\nbt\tag\StringTag;
use pocketmine\tile\Banner as TileBanner;
class Banner extends Item{
const TAG_BASE = TileBanner::TAG_BASE;
const TAG_PATTERNS = TileBanner::TAG_PATTERNS;
const TAG_PATTERN_COLOR = TileBanner::TAG_PATTERN_COLOR;
const TAG_PATTERN_NAME = TileBanner::TAG_PATTERN_NAME;
public function __construct(int $meta = 0){
$this->block = BlockFactory::get(Block::STANDING_BANNER);
parent::__construct(self::BANNER, $meta, "Banner");
}
public function getMaxStackSize() : int{
return 16;
}
/**
* Returns the color of the banner base.
*
* @return int
*/
public function getBaseColor() : int{
return $this->getNamedTag()->getInt(self::TAG_BASE, 0);
}
/**
* Sets the color of the banner base.
* Banner items have to be resent to see the changes in the inventory.
*
* @param int $color
*/
public function setBaseColor(int $color) : void{
$namedTag = $this->getNamedTag();
$namedTag->setInt(self::TAG_BASE, $color & 0x0f);
$this->setNamedTag($namedTag);
}
/**
* Applies a new pattern on the banner with the given color.
* Banner items have to be resent to see the changes in the inventory.
*
* @param string $pattern
* @param int $color
*
* @return int ID of pattern.
*/
public function addPattern(string $pattern, int $color) : int{
$patternId = 0;
if($this->getPatternCount() !== 0){
$patternId = max($this->getPatternIds()) + 1;
}
$patternsTag = $this->getNamedTag()->getListTag(self::TAG_PATTERNS);
assert($patternsTag !== null);
$patternsTag[$patternId] = new CompoundTag("", [
new IntTag(self::TAG_PATTERN_COLOR, $color & 0x0f),
new StringTag(self::TAG_PATTERN_NAME, $pattern)
]);
$this->setNamedTagEntry($patternsTag);
return $patternId;
}
/**
* Returns whether a pattern with the given ID exists on the banner or not.
*
* @param int $patternId
*
* @return bool
*/
public function patternExists(int $patternId) : bool{
$this->correctNBT();
return isset($this->getNamedTag()->getListTag(self::TAG_PATTERNS)[$patternId]);
}
/**
* Returns the data of a pattern with the given ID.
*
* @param int $patternId
*
* @return array
*/
public function getPatternData(int $patternId) : array{
if(!$this->patternExists($patternId)){
return [];
}
$patternsTag = $this->getNamedTag()->getListTag(self::TAG_PATTERNS);
assert($patternsTag !== null);
$pattern = $patternsTag[$patternId];
assert($pattern instanceof CompoundTag);
return [
self::TAG_PATTERN_COLOR => $pattern->getInt(self::TAG_PATTERN_COLOR),
self::TAG_PATTERN_NAME => $pattern->getString(self::TAG_PATTERN_NAME)
];
}
/**
* Changes the pattern of a previously existing pattern.
* Banner items have to be resent to see the changes in the inventory.
*
* @param int $patternId
* @param string $pattern
* @param int $color
*
* @return bool indicating success.
*/
public function changePattern(int $patternId, string $pattern, int $color) : bool{
if(!$this->patternExists($patternId)){
return false;
}
$patternsTag = $this->getNamedTag()->getListTag(self::TAG_PATTERNS);
assert($patternsTag !== null);
$patternsTag[$patternId] = new CompoundTag("", [
new IntTag(self::TAG_PATTERN_COLOR, $color & 0x0f),
new StringTag(self::TAG_PATTERN_NAME, $pattern)
]);
$this->setNamedTagEntry($patternsTag);
return true;
}
/**
* Deletes a pattern from the banner with the given ID.
* Banner items have to be resent to see the changes in the inventory.
*
* @param int $patternId
*
* @return bool indicating whether the pattern existed or not.
*/
public function deletePattern(int $patternId) : bool{
if(!$this->patternExists($patternId)){
return false;
}
$patternsTag = $this->getNamedTag()->getListTag(self::TAG_PATTERNS);
if($patternsTag instanceof ListTag){
unset($patternsTag[$patternId]);
$this->setNamedTagEntry($patternsTag);
}
return true;
}
/**
* Deletes the top most pattern of the banner.
* Banner items have to be resent to see the changes in the inventory.
*
* @return bool indicating whether the banner was empty or not.
*/
public function deleteTopPattern() : bool{
$keys = $this->getPatternIds();
if(empty($keys)){
return false;
}
return $this->deletePattern(max($keys));
}
/**
* Deletes the bottom pattern of the banner.
* Banner items have to be resent to see the changes in the inventory.
*
* @return bool indicating whether the banner was empty or not.
*/
public function deleteBottomPattern() : bool{
$keys = $this->getPatternIds();
if(empty($keys)){
return false;
}
return $this->deletePattern(min($keys));
}
/**
* Returns an array containing all pattern IDs
*
* @return array
*/
public function getPatternIds() : array{
$this->correctNBT();
$keys = array_keys((array) ($this->getNamedTag()->getListTag(self::TAG_PATTERNS) ?? []));
return array_filter($keys, function($key){
return is_numeric($key);
}, ARRAY_FILTER_USE_KEY);
}
/**
* Returns the total count of patterns on this banner.
*
* @return int
*/
public function getPatternCount() : int{
return count($this->getPatternIds());
}
public function correctNBT() : void{
$tag = $this->getNamedTag();
if(!$tag->hasTag(self::TAG_BASE, IntTag::class)){
$tag->setInt(self::TAG_BASE, 0);
}
if(!$tag->hasTag(self::TAG_PATTERNS, ListTag::class)){
$tag->setTag(new ListTag(self::TAG_PATTERNS));
}
$this->setNamedTag($tag);
}
public function getFuelTime() : int{
return 300;
}
}

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

@ -225,7 +225,7 @@ class ItemFactory{
//TODO: COMMAND_BLOCK_MINECART
//TODO: ELYTRA
self::registerItem(new Item(Item::SHULKER_SHELL, 0, "Shulker Shell"));
//TODO: BANNER
self::registerItem(new Banner());
//TODO: TOTEM

5
src/pocketmine/nbt/tag/ListTag.php
View File

@ -109,6 +109,11 @@ class ListTag extends NamedTag implements \ArrayAccess, \Countable{
return isset($this->{$offset});
}
/**
* @param int $offset
*
* @return CompoundTag|ListTag|mixed
*/
public function offsetGet($offset){
if(isset($this->{$offset}) and $this->{$offset} instanceof Tag){
if($this->{$offset} instanceof \ArrayAccess){

304
src/pocketmine/tile/Banner.php Normal file
View File

@ -0,0 +1,304 @@
<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\tile;
use pocketmine\item\Item;
use pocketmine\level\Level;
use pocketmine\math\Vector3;
use pocketmine\nbt\tag\CompoundTag;
use pocketmine\nbt\tag\IntTag;
use pocketmine\nbt\tag\ListTag;
use pocketmine\nbt\tag\StringTag;
use pocketmine\Player;
class Banner extends Spawnable implements Nameable{
use NameableTrait;
const TAG_BASE = "Base";
const TAG_PATTERNS = "Patterns";
const TAG_PATTERN_COLOR = "Color";
const TAG_PATTERN_NAME = "Pattern";
const PATTERN_BOTTOM_STRIPE = "bs";
const PATTERN_TOP_STRIPE = "ts";
const PATTERN_LEFT_STRIPE = "ls";
const PATTERN_RIGHT_STRIPE = "rs";
const PATTERN_CENTER_STRIPE = "cs";
const PATTERN_MIDDLE_STRIPE = "ms";
const PATTERN_DOWN_RIGHT_STRIPE = "drs";
const PATTERN_DOWN_LEFT_STRIPE = "dls";
const PATTERN_SMALL_STRIPES = "ss";
const PATTERN_DIAGONAL_CROSS = "cr";
const PATTERN_SQUARE_CROSS = "sc";
const PATTERN_LEFT_OF_DIAGONAL = "ld";
const PATTERN_RIGHT_OF_UPSIDE_DOWN_DIAGONAL = "rud";
const PATTERN_LEFT_OF_UPSIDE_DOWN_DIAGONAL = "lud";
const PATTERN_RIGHT_OF_DIAGONAL = "rd";
const PATTERN_VERTICAL_HALF_LEFT = "vh";
const PATTERN_VERTICAL_HALF_RIGHT = "vhr";
const PATTERN_HORIZONTAL_HALF_TOP = "hh";
const PATTERN_HORIZONTAL_HALF_BOTTOM = "hhb";
const PATTERN_BOTTOM_LEFT_CORNER = "bl";
const PATTERN_BOTTOM_RIGHT_CORNER = "br";
const PATTERN_TOP_LEFT_CORNER = "tl";
const PATTERN_TOP_RIGHT_CORNER = "tr";
const PATTERN_BOTTOM_TRIANGLE = "bt";
const PATTERN_TOP_TRIANGLE = "tt";
const PATTERN_BOTTOM_TRIANGLE_SAWTOOTH = "bts";
const PATTERN_TOP_TRIANGLE_SAWTOOTH = "tts";
const PATTERN_MIDDLE_CIRCLE = "mc";
const PATTERN_MIDDLE_RHOMBUS = "mr";
const PATTERN_BORDER = "bo";
const PATTERN_CURLY_BORDER = "cbo";
const PATTERN_BRICK = "bri";
const PATTERN_GRADIENT = "gra";
const PATTERN_GRADIENT_UPSIDE_DOWN = "gru";
const PATTERN_CREEPER = "cre";
const PATTERN_SKULL = "sku";
const PATTERN_FLOWER = "flo";
const PATTERN_MOJANG = "moj";
const COLOR_BLACK = 0;
const COLOR_RED = 1;
const COLOR_GREEN = 2;
const COLOR_BROWN = 3;
const COLOR_BLUE = 4;
const COLOR_PURPLE = 5;
const COLOR_CYAN = 6;
const COLOR_LIGHT_GRAY = 7;
const COLOR_GRAY = 8;
const COLOR_PINK = 9;
const COLOR_LIME = 10;
const COLOR_YELLOW = 11;
const COLOR_LIGHT_BLUE = 12;
const COLOR_MAGENTA = 13;
const COLOR_ORANGE = 14;
const COLOR_WHITE = 15;
public function __construct(Level $level, CompoundTag $nbt){
if(!$nbt->hasTag(self::TAG_BASE, IntTag::class)){
$nbt->setInt(self::TAG_BASE, 0);
}
if(!$nbt->hasTag(self::TAG_PATTERNS, ListTag::class)){
$nbt->setTag(new ListTag(self::TAG_PATTERNS));
}
parent::__construct($level, $nbt);
}
public function addAdditionalSpawnData(CompoundTag $nbt) : void{
$nbt->setTag($this->namedtag->getTag(self::TAG_PATTERNS));
$nbt->setTag($this->namedtag->getTag(self::TAG_BASE));
}
/**
* Returns the color of the banner base.
*
* @return int
*/
public function getBaseColor() : int{
return $this->namedtag->getInt(self::TAG_BASE, 0);
}
/**
* Sets the color of the banner base.
*
* @param int $color
*/
public function setBaseColor(int $color) : void{
$this->namedtag->setInt(self::TAG_BASE, $color & 0x0f);
$this->onChanged();
}
/**
* Returns an array containing all pattern IDs
*
* @return array
*/
public function getPatternIds() : array{
$keys = array_keys((array) $this->namedtag->getTag(self::TAG_PATTERNS));
return array_filter($keys, function(string $key){
return is_numeric($key);
}, ARRAY_FILTER_USE_KEY);
}
/**
* Applies a new pattern on the banner with the given color.
*
* @param string $pattern
* @param int $color
*
* @return int ID of pattern.
*/
public function addPattern(string $pattern, int $color) : int{
$patternId = 0;
if($this->getPatternCount() !== 0){
$patternId = max($this->getPatternIds()) + 1;
}
$list = $this->namedtag->getListTag(self::TAG_PATTERNS);
assert($list !== null);
$list[$patternId] = new CompoundTag("", [
new IntTag(self::TAG_PATTERN_COLOR, $color & 0x0f),
new StringTag(self::TAG_PATTERN_NAME, $pattern)
]);
$this->onChanged();
return $patternId;
}
/**
* Returns whether a pattern with the given ID exists on the banner or not.
*
* @param int $patternId
*
* @return bool
*/
public function patternExists(int $patternId) : bool{
return isset($this->namedtag->getListTag(self::TAG_PATTERNS)[$patternId]);
}
/**
* Returns the data of a pattern with the given ID.
*
* @param int $patternId
*
* @return array
*/
public function getPatternData(int $patternId) : array{
if(!$this->patternExists($patternId)){
return [];
}
$list = $this->namedtag->getListTag(self::TAG_PATTERNS);
assert($list instanceof ListTag);
$patternTag = $list[$patternId];
assert($patternTag instanceof CompoundTag);
return [
self::TAG_PATTERN_COLOR => $patternTag->getInt(self::TAG_PATTERN_COLOR),
self::TAG_PATTERN_NAME => $patternTag->getString(self::TAG_PATTERN_NAME)
];
}
/**
* Changes the pattern of a previously existing pattern.
*
* @param int $patternId
* @param string $pattern
* @param int $color
*
* @return bool indicating success.
*/
public function changePattern(int $patternId, string $pattern, int $color) : bool{
if(!$this->patternExists($patternId)){
return false;
}
$list = $this->namedtag->getListTag(self::TAG_PATTERNS);
assert($list instanceof ListTag);
$list[$patternId] = new CompoundTag("", [
new IntTag(self::TAG_PATTERN_COLOR, $color & 0x0f),
new StringTag(self::TAG_PATTERN_NAME, $pattern)
]);
$this->onChanged();
return true;
}
/**
* Deletes a pattern from the banner with the given ID.
*
* @param int $patternId
*
* @return bool indicating whether the pattern existed or not.
*/
public function deletePattern(int $patternId) : bool{
if(!$this->patternExists($patternId)){
return false;
}
$list = $this->namedtag->getListTag(self::TAG_PATTERNS);
if($list !== null){
unset($list[$patternId]);
}
$this->onChanged();
return true;
}
/**
* Deletes the top most pattern of the banner.
*
* @return bool indicating whether the banner was empty or not.
*/
public function deleteTopPattern() : bool{
$keys = $this->getPatternIds();
if(empty($keys)){
return false;
}
return $this->deletePattern(max($keys));
}
/**
* Deletes the bottom pattern of the banner.
*
* @return bool indicating whether the banner was empty or not.
*/
public function deleteBottomPattern() : bool{
$keys = $this->getPatternIds();
if(empty($keys)){
return false;
}
return $this->deletePattern(min($keys));
}
/**
* Returns the total count of patterns on this banner.
*
* @return int
*/
public function getPatternCount() : int{
return count($this->getPatternIds());
}
protected static function createAdditionalNBT(CompoundTag $nbt, Vector3 $pos, ?int $face = null, ?Item $item = null, ?Player $player = null) : void{
$nbt->setInt(self::TAG_BASE, $item !== null ? $item->getDamage() & 0x0f : 0);
if($item !== null){
if($item->getNamedTag()->hasTag(self::TAG_PATTERNS, ListTag::class)){
$nbt->setTag($item->getNamedTag()->getListTag(self::TAG_PATTERNS));
}
if($item->hasCustomName()){
$nbt->setString("CustomName", $item->getCustomName());
}
}
}
public function getDefaultName() : string{
return "Banner";
}
}

2
src/pocketmine/tile/Tile.php
View File

@ -59,6 +59,7 @@ abstract class Tile extends Position{
const SIGN = "Sign";
const SKULL = "Skull";
const BED = "Bed";
const BANNER = "Banner";
/** @var int */
public static $tileCount = 1;
@ -84,6 +85,7 @@ abstract class Tile extends Position{
protected $timings;
public static function init(){
self::registerTile(Banner::class);
self::registerTile(Bed::class);
self::registerTile(Chest::class);
self::registerTile(EnchantTable::class);