PocketMine-MP 5.15.1 git-fb9a74e8799c71ed8292cfa53abe7a4c9204629d
Sign.php
1<?php
2
3/*
4 *
5 * ____ _ _ __ __ _ __ __ ____
6 * | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
7 * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
8 * | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
9 * |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
10 *
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * @author PocketMine Team
17 * @link http://www.pocketmine.net/
18 *
19 *
20 */
21
22declare(strict_types=1);
23
24namespace pocketmine\block\tile;
25
35use function array_pad;
36use function array_slice;
37use function explode;
38use function implode;
39use function mb_scrub;
40use function sprintf;
41
46class Sign extends Spawnable{
47 public const TAG_TEXT_BLOB = "Text";
48 public const TAG_TEXT_LINE = "Text%d"; //sprintf()able
49 public const TAG_TEXT_COLOR = "SignTextColor";
50 public const TAG_GLOWING_TEXT = "IgnoreLighting";
51 public const TAG_PERSIST_FORMATTING = "PersistFormatting"; //TAG_Byte
56 public const TAG_LEGACY_BUG_RESOLVE = "TextIgnoreLegacyBugResolved";
57
58 public const TAG_FRONT_TEXT = "FrontText"; //TAG_Compound
59 public const TAG_BACK_TEXT = "BackText"; //TAG_Compound
60 public const TAG_WAXED = "IsWaxed"; //TAG_Byte
61 public const TAG_LOCKED_FOR_EDITING_BY = "LockedForEditingBy"; //TAG_Long
62
66 public static function fixTextBlob(string $blob) : array{
67 return array_slice(array_pad(explode("\n", $blob), 4, ""), 0, 4);
68 }
69
70 protected SignText $text;
71 private bool $waxed = false;
72
73 protected ?int $editorEntityRuntimeId = null;
74
75 public function __construct(World $world, Vector3 $pos){
76 $this->text = new SignText();
77 parent::__construct($world, $pos);
78 }
79
80 private function readTextTag(CompoundTag $nbt, bool $lightingBugResolved) : void{
81 $baseColor = new Color(0, 0, 0);
82 $glowingText = false;
83 if(($baseColorTag = $nbt->getTag(self::TAG_TEXT_COLOR)) instanceof IntTag){
84 $baseColor = Color::fromARGB(Binary::unsignInt($baseColorTag->getValue()));
85 }
86 if($lightingBugResolved && ($glowingTextTag = $nbt->getTag(self::TAG_GLOWING_TEXT)) instanceof ByteTag){
87 //both of these must be 1 - if only one is set, it's a leftover from 1.16.210 experimental features
88 //see https://bugs.mojang.com/browse/MCPE-117835
89 $glowingText = $glowingTextTag->getValue() !== 0;
90 }
91 $this->text = SignText::fromBlob(mb_scrub($nbt->getString(self::TAG_TEXT_BLOB), 'UTF-8'), $baseColor, $glowingText);
92 }
93
94 public function readSaveData(CompoundTag $nbt) : void{
95 $frontTextTag = $nbt->getTag(self::TAG_FRONT_TEXT);
96 if($frontTextTag instanceof CompoundTag){
97 $this->readTextTag($frontTextTag, true);
98 }elseif($nbt->getTag(self::TAG_TEXT_BLOB) instanceof StringTag){ //MCPE 1.2 save format
99 $lightingBugResolved = false;
100 if(($lightingBugResolvedTag = $nbt->getTag(self::TAG_LEGACY_BUG_RESOLVE)) instanceof ByteTag){
101 $lightingBugResolved = $lightingBugResolvedTag->getValue() !== 0;
102 }
103 $this->readTextTag($nbt, $lightingBugResolved);
104 }else{
105 $text = [];
106 for($i = 0; $i < SignText::LINE_COUNT; ++$i){
107 $textKey = sprintf(self::TAG_TEXT_LINE, $i + 1);
108 if(($lineTag = $nbt->getTag($textKey)) instanceof StringTag){
109 $text[$i] = mb_scrub($lineTag->getValue(), 'UTF-8');
110 }
111 }
112 $this->text = new SignText($text);
113 }
114 $this->waxed = $nbt->getByte(self::TAG_WAXED, 0) !== 0;
115 }
116
117 protected function writeSaveData(CompoundTag $nbt) : void{
118 $nbt->setTag(self::TAG_FRONT_TEXT, CompoundTag::create()
119 ->setString(self::TAG_TEXT_BLOB, implode("\n", $this->text->getLines()))
120 ->setInt(self::TAG_TEXT_COLOR, Binary::signInt($this->text->getBaseColor()->toARGB()))
121 ->setByte(self::TAG_GLOWING_TEXT, $this->text->isGlowing() ? 1 : 0)
122 ->setByte(self::TAG_PERSIST_FORMATTING, 1)
123 );
124 $nbt->setTag(self::TAG_BACK_TEXT, CompoundTag::create()
125 ->setString(self::TAG_TEXT_BLOB, "")
126 ->setInt(self::TAG_TEXT_COLOR, Binary::signInt(0xff_00_00_00))
127 ->setByte(self::TAG_GLOWING_TEXT, 0)
128 ->setByte(self::TAG_PERSIST_FORMATTING, 1)
129 );
130
131 $nbt->setByte(self::TAG_WAXED, $this->waxed ? 1 : 0);
132 }
133
134 public function getText() : SignText{
135 return $this->text;
136 }
137
138 public function setText(SignText $text) : void{
139 $this->text = $text;
140 }
141
142 public function isWaxed() : bool{ return $this->waxed; }
143
144 public function setWaxed(bool $waxed) : void{ $this->waxed = $waxed; }
145
156 public function getEditorEntityRuntimeId() : ?int{ return $this->editorEntityRuntimeId; }
157
158 public function setEditorEntityRuntimeId(?int $editorEntityRuntimeId) : void{
159 $this->editorEntityRuntimeId = $editorEntityRuntimeId;
160 }
161
162 protected function addAdditionalSpawnData(CompoundTag $nbt) : void{
163 $nbt->setTag(self::TAG_FRONT_TEXT, CompoundTag::create()
164 ->setString(self::TAG_TEXT_BLOB, implode("\n", $this->text->getLines()))
165 ->setInt(self::TAG_TEXT_COLOR, Binary::signInt($this->text->getBaseColor()->toARGB()))
166 ->setByte(self::TAG_GLOWING_TEXT, $this->text->isGlowing() ? 1 : 0)
167 ->setByte(self::TAG_PERSIST_FORMATTING, 1) //TODO: not sure what this is used for
168 );
169 //TODO: this is not yet used by the server, but needed to rollback any client-side changes to the back text
170 $nbt->setTag(self::TAG_BACK_TEXT, CompoundTag::create()
171 ->setString(self::TAG_TEXT_BLOB, "")
172 ->setInt(self::TAG_TEXT_COLOR, Binary::signInt(0xff_00_00_00))
173 ->setByte(self::TAG_GLOWING_TEXT, 0)
174 ->setByte(self::TAG_PERSIST_FORMATTING, 1)
175 );
176 $nbt->setByte(self::TAG_WAXED, $this->waxed ? 1 : 0);
177 $nbt->setLong(self::TAG_LOCKED_FOR_EDITING_BY, $this->editorEntityRuntimeId ?? -1);
178 }
179}
const TAG_LEGACY_BUG_RESOLVE
Definition: Sign.php:56
addAdditionalSpawnData(CompoundTag $nbt)
Definition: Sign.php:162
writeSaveData(CompoundTag $nbt)
Definition: Sign.php:117
static fixTextBlob(string $blob)
Definition: Sign.php:66
static fromBlob(string $blob, ?Color $baseColor=null, bool $glowing=false)
Definition: SignText.php:77
static fromARGB(int $code)
Definition: Color.php:101
setByte(string $name, int $value)
setLong(string $name, int $value)
setTag(string $name, Tag $tag)