PocketMine-MP 5.27.1 git-9af3cde03fabbe4129c79e46dc87ffa0fff446e6
Loading...
Searching...
No Matches
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
67 public static function fixTextBlob(string $blob) : array{
68 return array_slice(array_pad(explode("\n", $blob, limit: 5), 4, ""), 0, 4);
69 }
70
71 protected SignText $text;
72 private bool $waxed = false;
73
74 protected ?int $editorEntityRuntimeId = null;
75
76 public function __construct(World $world, Vector3 $pos){
77 $this->text = new SignText();
78 parent::__construct($world, $pos);
79 }
80
81 private function readTextTag(CompoundTag $nbt, bool $lightingBugResolved) : void{
82 $baseColor = new Color(0, 0, 0);
83 $glowingText = false;
84 if(($baseColorTag = $nbt->getTag(self::TAG_TEXT_COLOR)) instanceof IntTag){
85 $baseColor = Color::fromARGB(Binary::unsignInt($baseColorTag->getValue()));
86 }
87 if($lightingBugResolved && ($glowingTextTag = $nbt->getTag(self::TAG_GLOWING_TEXT)) instanceof ByteTag){
88 //both of these must be 1 - if only one is set, it's a leftover from 1.16.210 experimental features
89 //see https://bugs.mojang.com/browse/MCPE-117835
90 $glowingText = $glowingTextTag->getValue() !== 0;
91 }
92 $this->text = SignText::fromBlob(mb_scrub($nbt->getString(self::TAG_TEXT_BLOB), 'UTF-8'), $baseColor, $glowingText);
93 }
94
95 public function readSaveData(CompoundTag $nbt) : void{
96 $frontTextTag = $nbt->getTag(self::TAG_FRONT_TEXT);
97 if($frontTextTag instanceof CompoundTag){
98 $this->readTextTag($frontTextTag, true);
99 }elseif($nbt->getTag(self::TAG_TEXT_BLOB) instanceof StringTag){ //MCPE 1.2 save format
100 $lightingBugResolved = false;
101 if(($lightingBugResolvedTag = $nbt->getTag(self::TAG_LEGACY_BUG_RESOLVE)) instanceof ByteTag){
102 $lightingBugResolved = $lightingBugResolvedTag->getValue() !== 0;
103 }
104 $this->readTextTag($nbt, $lightingBugResolved);
105 }else{
106 $text = [];
107 for($i = 0; $i < SignText::LINE_COUNT; ++$i){
108 $textKey = sprintf(self::TAG_TEXT_LINE, $i + 1);
109 if(($lineTag = $nbt->getTag($textKey)) instanceof StringTag){
110 $text[$i] = mb_scrub($lineTag->getValue(), 'UTF-8');
111 }
112 }
113 $this->text = new SignText($text);
114 }
115 $this->waxed = $nbt->getByte(self::TAG_WAXED, 0) !== 0;
116 }
117
118 protected function writeSaveData(CompoundTag $nbt) : void{
119 $nbt->setTag(self::TAG_FRONT_TEXT, CompoundTag::create()
120 ->setString(self::TAG_TEXT_BLOB, implode("\n", $this->text->getLines()))
121 ->setInt(self::TAG_TEXT_COLOR, Binary::signInt($this->text->getBaseColor()->toARGB()))
122 ->setByte(self::TAG_GLOWING_TEXT, $this->text->isGlowing() ? 1 : 0)
123 ->setByte(self::TAG_PERSIST_FORMATTING, 1)
124 );
125 $nbt->setTag(self::TAG_BACK_TEXT, CompoundTag::create()
126 ->setString(self::TAG_TEXT_BLOB, "")
127 ->setInt(self::TAG_TEXT_COLOR, Binary::signInt(0xff_00_00_00))
128 ->setByte(self::TAG_GLOWING_TEXT, 0)
129 ->setByte(self::TAG_PERSIST_FORMATTING, 1)
130 );
131
132 $nbt->setByte(self::TAG_WAXED, $this->waxed ? 1 : 0);
133 }
134
135 public function getText() : SignText{
136 return $this->text;
137 }
138
139 public function setText(SignText $text) : void{
140 $this->text = $text;
141 }
142
143 public function isWaxed() : bool{ return $this->waxed; }
144
145 public function setWaxed(bool $waxed) : void{ $this->waxed = $waxed; }
146
157 public function getEditorEntityRuntimeId() : ?int{ return $this->editorEntityRuntimeId; }
158
159 public function setEditorEntityRuntimeId(?int $editorEntityRuntimeId) : void{
160 $this->editorEntityRuntimeId = $editorEntityRuntimeId;
161 }
162
163 protected function addAdditionalSpawnData(CompoundTag $nbt) : void{
164 $nbt->setTag(self::TAG_FRONT_TEXT, CompoundTag::create()
165 ->setString(self::TAG_TEXT_BLOB, implode("\n", $this->text->getLines()))
166 ->setInt(self::TAG_TEXT_COLOR, Binary::signInt($this->text->getBaseColor()->toARGB()))
167 ->setByte(self::TAG_GLOWING_TEXT, $this->text->isGlowing() ? 1 : 0)
168 ->setByte(self::TAG_PERSIST_FORMATTING, 1) //TODO: not sure what this is used for
169 );
170 //TODO: this is not yet used by the server, but needed to rollback any client-side changes to the back text
171 $nbt->setTag(self::TAG_BACK_TEXT, CompoundTag::create()
172 ->setString(self::TAG_TEXT_BLOB, "")
173 ->setInt(self::TAG_TEXT_COLOR, Binary::signInt(0xff_00_00_00))
174 ->setByte(self::TAG_GLOWING_TEXT, 0)
175 ->setByte(self::TAG_PERSIST_FORMATTING, 1)
176 );
177 $nbt->setByte(self::TAG_WAXED, $this->waxed ? 1 : 0);
178 $nbt->setLong(self::TAG_LOCKED_FOR_EDITING_BY, $this->editorEntityRuntimeId ?? -1);
179 }
180}
addAdditionalSpawnData(CompoundTag $nbt)
Definition Sign.php:163
writeSaveData(CompoundTag $nbt)
Definition Sign.php:118
static fixTextBlob(string $blob)
Definition Sign.php:67
static fromBlob(string $blob, ?Color $baseColor=null, bool $glowing=false)
Definition SignText.php:81
setByte(string $name, int $value)
setLong(string $name, int $value)
setTag(string $name, Tag $tag)