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

protocol: added proper object wrappers for gamerules

Browse Source
This commit is contained in:
Dylan K. Taylor 2020-06-20 11:18:42 +01:00
parent d2089afbc3
commit d5db163208
9 changed files with 221 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/network/mcpe/handler/PreSpawnPacketHandler.php
View File

@ -29,6 +29,7 @@ use pocketmine\network\mcpe\convert\TypeConverter;
use pocketmine\network\mcpe\NetworkSession;
use pocketmine\network\mcpe\protocol\RequestChunkRadiusPacket;
use pocketmine\network\mcpe\protocol\StartGamePacket;
use pocketmine\network\mcpe\protocol\types\BoolGameRule;
use pocketmine\network\mcpe\protocol\types\DimensionIds;
use pocketmine\network\mcpe\StaticPacketCache;
use pocketmine\player\Player;
@ -76,6 +77,9 @@ class PreSpawnPacketHandler extends PacketHandler{
$pk->rainLevel = 0; //TODO: implement these properly
$pk->lightningLevel = 0;
$pk->commandsEnabled = true;
$pk->gameRules = [
"naturalregeneration" => new BoolGameRule(false) //Hack for client side regeneration
];
$pk->levelId = "";
$pk->worldName = $this->server->getMotd();
$pk->blockTable = RuntimeBlockMapping::getInstance()->getStartGamePaletteCache();

5
src/network/mcpe/protocol/GameRulesChangedPacket.php
View File

@ -26,13 +26,14 @@ namespace pocketmine\network\mcpe\protocol;
#include <rules/DataPacket.h>
use pocketmine\network\mcpe\protocol\serializer\PacketSerializer;
use pocketmine\network\mcpe\protocol\types\GameRule;
class GameRulesChangedPacket extends DataPacket implements ClientboundPacket{
public const NETWORK_ID = ProtocolInfo::GAME_RULES_CHANGED_PACKET;
/**
* @var mixed[][]
* @phpstan-var array<string, array{0: int, 1: bool|int|float}>
* @var GameRule[]
* @phpstan-var array<string, GameRule>
*/
public $gameRules = [];

10
src/network/mcpe/protocol/StartGamePacket.php
View File

@ -30,7 +30,7 @@ use pocketmine\nbt\tag\ListTag;
use pocketmine\network\mcpe\protocol\serializer\PacketSerializer;
use pocketmine\network\mcpe\protocol\types\CacheableNbt;
use pocketmine\network\mcpe\protocol\types\EducationEditionOffer;
use pocketmine\network\mcpe\protocol\types\GameRuleType;
use pocketmine\network\mcpe\protocol\types\GameRule;
use pocketmine\network\mcpe\protocol\types\GeneratorType;
use pocketmine\network\mcpe\protocol\types\MultiplayerGameVisibility;
use pocketmine\network\mcpe\protocol\types\PlayerPermissions;
@ -97,12 +97,10 @@ class StartGamePacket extends DataPacket implements ClientboundPacket{
/** @var bool */
public $isTexturePacksRequired = true;
/**
* @var mixed[][]
* @phpstan-var array<string, array{0: int, 1: bool|int|float}>
* @var GameRule[]
* @phpstan-var array<string, GameRule>
*/
public $gameRules = [ //TODO: implement this
"naturalregeneration" => [GameRuleType::BOOL, false] //Hack for client side regeneration
];
public $gameRules = [];
/** @var bool */
public $hasBonusChestEnabled = false;
/** @var bool */

60
src/network/mcpe/protocol/serializer/PacketSerializer.php
View File

@ -30,6 +30,7 @@ use pocketmine\nbt\NbtDataException;
use pocketmine\nbt\tag\CompoundTag;
use pocketmine\nbt\TreeRoot;
use pocketmine\network\mcpe\protocol\PacketDecodeException;
use pocketmine\network\mcpe\protocol\types\BoolGameRule;
use pocketmine\network\mcpe\protocol\types\command\CommandOriginData;
use pocketmine\network\mcpe\protocol\types\entity\Attribute;
use pocketmine\network\mcpe\protocol\types\entity\BlockPosMetadataProperty;
@ -44,7 +45,10 @@ use pocketmine\network\mcpe\protocol\types\entity\ShortMetadataProperty;
use pocketmine\network\mcpe\protocol\types\entity\StringMetadataProperty;
use pocketmine\network\mcpe\protocol\types\entity\Vec3MetadataProperty;
use pocketmine\network\mcpe\protocol\types\FixedItemIds;
use pocketmine\network\mcpe\protocol\types\FloatGameRule;
use pocketmine\network\mcpe\protocol\types\GameRule;
use pocketmine\network\mcpe\protocol\types\GameRuleType;
use pocketmine\network\mcpe\protocol\types\IntGameRule;
use pocketmine\network\mcpe\protocol\types\inventory\ItemStack;
use pocketmine\network\mcpe\protocol\types\PersonaPieceTintColor;
use pocketmine\network\mcpe\protocol\types\PersonaSkinPiece;
@ -533,12 +537,21 @@ class PacketSerializer extends BinaryStream{
$this->putByte((int) ($rotation / (360 / 256)));
}
private function readGameRule(int $type) : GameRule{
switch($type){
case GameRuleType::BOOL: return BoolGameRule::decode($this);
case GameRuleType::INT: return IntGameRule::decode($this);
case GameRuleType::FLOAT: return FloatGameRule::decode($this);
default:
throw new PacketDecodeException("Unknown gamerule type $type");
}
}
/**
* Reads gamerules
* TODO: implement this properly
*
* @return mixed[][], members are in the structure [name => [type, value]]
* @phpstan-return array<string, array{0: int, 1: bool|int|float}>
* @return GameRule[] game rule name => value
* @phpstan-return array<string, GameRule>
*
* @throws PacketDecodeException
* @throws BinaryDataException
@ -549,53 +562,24 @@ class PacketSerializer extends BinaryStream{
for($i = 0; $i < $count; ++$i){
$name = $this->getString();
$type = $this->getUnsignedVarInt();
$value = null;
switch($type){
case GameRuleType::BOOL:
$value = $this->getBool();
break;
case GameRuleType::INT:
$value = $this->getUnsignedVarInt();
break;
case GameRuleType::FLOAT:
$value = $this->getLFloat();
break;
default:
throw new PacketDecodeException("Unknown gamerule type $type");
}
$rules[$name] = [$type, $value];
$rules[$name] = $this->readGameRule($type);
}
return $rules;
}
/**
* Writes a gamerule array, members should be in the structure [name => [type, value]]
* TODO: implement this properly
* Writes a gamerule array
*
* @param mixed[][] $rules
*
* @phpstan-param array<string, array{0: int, 1: bool|int|float}> $rules
* @param GameRule[] $rules
* @phpstan-param array<string, GameRule> $rules
*/
public function putGameRules(array $rules) : void{
$this->putUnsignedVarInt(count($rules));
foreach($rules as $name => $rule){
$this->putString($name);
$this->putUnsignedVarInt($rule[0]);
switch($rule[0]){
case GameRuleType::BOOL:
$this->putBool($rule[1]);
break;
case GameRuleType::INT:
$this->putUnsignedVarInt($rule[1]);
break;
case GameRuleType::FLOAT:
$this->putLFloat($rule[1]);
break;
default:
throw new \InvalidArgumentException("Invalid gamerule type " . $rule[0]);
}
$this->putUnsignedVarInt($rule->getType());
$rule->encode($this);
}
}

52
src/network/mcpe/protocol/types/BoolGameRule.php Normal file
View File

@ -0,0 +1,52 @@
<?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\network\mcpe\protocol\types;
use pocketmine\network\mcpe\protocol\serializer\PacketSerializer;
final class BoolGameRule extends GameRule{
/** @var bool */
private $value;
public function __construct(bool $value){
$this->value = $value;
}
public function getType() : int{
return GameRuleType::BOOL;
}
public function getValue() : bool{
return $this->value;
}
public function encode(PacketSerializer $out) : void{
$out->putBool($this->value);
}
public static function decode(PacketSerializer $in) : self{
return new self($in->getBool());
}
}

51
src/network/mcpe/protocol/types/FloatGameRule.php Normal file
View File

@ -0,0 +1,51 @@
<?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\network\mcpe\protocol\types;
use pocketmine\network\mcpe\protocol\serializer\PacketSerializer;
final class FloatGameRule extends GameRule{
/** @var float */
private $value;
public function __construct(float $value){
$this->value = $value;
}
public function getType() : int{
return GameRuleType::FLOAT;
}
public function getValue() : float{
return $this->value;
}
public function encode(PacketSerializer $out) : void{
$out->putLFloat($this->value);
}
public static function decode(PacketSerializer $in) : self{
return new self($in->getLFloat());
}
}

33
src/network/mcpe/protocol/types/GameRule.php Normal file
View File

@ -0,0 +1,33 @@
<?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\network\mcpe\protocol\types;
use pocketmine\network\mcpe\protocol\serializer\PacketSerializer;
abstract class GameRule{
abstract public function getType() : int;
abstract public function encode(PacketSerializer $out) : void;
}

52
src/network/mcpe/protocol/types/IntGameRule.php Normal file
View File

@ -0,0 +1,52 @@
<?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\network\mcpe\protocol\types;
use pocketmine\network\mcpe\protocol\serializer\PacketSerializer;
final class IntGameRule extends GameRule{
/** @var int */
private $value;
public function __construct(int $value){
$this->value = $value;
}
public function getType() : int{
return GameRuleType::INT;
}
public function getValue() : int{
return $this->value;
}
public function encode(PacketSerializer $out) : void{
$out->putUnsignedVarInt($this->value);
}
public static function decode(PacketSerializer $in) : self{
return new self($in->getUnsignedVarInt());
}
}

15
tests/phpstan/configs/l7-baseline.neon
View File

@ -640,21 +640,6 @@ parameters:
count: 1
path: ../../../src/network/mcpe/encryption/EncryptionUtils.php
-
message: "#^Parameter \\#1 \\$v of method pocketmine\\\\utils\\\\BinaryStream\\:\\:putBool\\(\\) expects bool, bool\\|float\\|int given\\.$#"
count: 1
path: ../../../src/network/mcpe/protocol/serializer/PacketSerializer.php
-
message: "#^Parameter \\#1 \\$v of method pocketmine\\\\utils\\\\BinaryStream\\:\\:putUnsignedVarInt\\(\\) expects int, bool\\|float\\|int given\\.$#"
count: 1
path: ../../../src/network/mcpe/protocol/serializer/PacketSerializer.php
-
message: "#^Parameter \\#1 \\$v of method pocketmine\\\\utils\\\\BinaryStream\\:\\:putLFloat\\(\\) expects float, bool\\|float\\|int given\\.$#"
count: 1
path: ../../../src/network/mcpe/protocol/serializer/PacketSerializer.php
-
message: "#^Parameter \\#1 \\$x of method pocketmine\\\\network\\\\mcpe\\\\protocol\\\\serializer\\\\PacketSerializer\\:\\:putSignedBlockPosition\\(\\) expects int, float\\|int given\\.$#"
count: 1