141 private const INCOMING_PACKET_BATCH_PER_TICK = 2;
142 private const INCOMING_PACKET_BATCH_BUFFER_TICKS = 100;
144 private const INCOMING_GAME_PACKETS_PER_TICK = 2;
145 private const INCOMING_GAME_PACKETS_BUFFER_TICKS = 100;
150 private \PrefixedLogger $logger;
151 private ?
Player $player =
null;
153 private ?
int $ping =
null;
157 private bool $connected =
true;
158 private bool $disconnectGuard =
false;
159 private bool $loggedIn =
false;
160 private bool $authenticated =
false;
161 private int $connectTime;
162 private ?
CompoundTag $cachedOfflinePlayerData =
null;
170 private array $sendBuffer = [];
175 private array $sendBufferAckPromises = [];
178 private \SplQueue $compressedQueue;
179 private bool $forceAsyncCompression =
true;
180 private bool $enableCompression =
false;
182 private int $nextAckReceiptId = 0;
187 private array $ackPromisesByReceiptId = [];
197 public function __construct(
209 $this->logger = new \PrefixedLogger($this->
server->getLogger(), $this->getLogPrefix());
211 $this->compressedQueue = new \SplQueue();
215 $this->connectTime = time();
216 $this->packetBatchLimiter =
new PacketRateLimiter(
"Packet Batches", self::INCOMING_PACKET_BATCH_PER_TICK, self::INCOMING_PACKET_BATCH_BUFFER_TICKS);
217 $this->gamePacketLimiter =
new PacketRateLimiter(
"Game Packets", self::INCOMING_GAME_PACKETS_PER_TICK, self::INCOMING_GAME_PACKETS_BUFFER_TICKS);
221 $this->onSessionStartSuccess(...)
224 $this->manager->add($this);
225 $this->logger->info($this->
server->getLanguage()->translate(KnownTranslationFactory::pocketmine_network_session_open()));
228 private function getLogPrefix() :
string{
229 return "NetworkSession: " . $this->getDisplayName();
232 public function getLogger() : \
Logger{
233 return $this->logger;
236 private function onSessionStartSuccess() :
void{
237 $this->logger->debug(
"Session start handshake completed, awaiting login packet");
238 $this->flushGamePacketQueue();
239 $this->enableCompression =
true;
245 $this->logger->info($this->
server->getLanguage()->translate(KnownTranslationFactory::pocketmine_network_session_playerName(TextFormat::AQUA . $info->getUsername() . TextFormat::RESET)));
246 $this->logger->setPrefix($this->getLogPrefix());
247 $this->manager->markLoginReceived($this);
249 $this->setAuthenticationStatus(...)
253 protected function createPlayer() :
void{
254 $this->
server->createPlayer($this, $this->info, $this->authenticated, $this->cachedOfflinePlayerData)->onCompletion(
255 $this->onPlayerCreated(...),
258 $this->disconnectWithError(
259 reason:
"Failed to create player",
260 disconnectScreenMessage: KnownTranslationFactory::pocketmine_disconnect_error_internal()
266 private function onPlayerCreated(
Player $player) :
void{
267 if(!$this->isConnected()){
271 $this->player = $player;
272 if(!$this->
server->addOnlinePlayer($player)){
278 $effectManager = $this->player->getEffects();
279 $effectManager->getEffectAddHooks()->add($effectAddHook =
function(
EffectInstance $effect,
bool $replacesOldEffect) :
void{
280 $this->entityEventBroadcaster->onEntityEffectAdded([$this], $this->player, $effect, $replacesOldEffect);
282 $effectManager->getEffectRemoveHooks()->add($effectRemoveHook =
function(
EffectInstance $effect) :
void{
283 $this->entityEventBroadcaster->onEntityEffectRemoved([$this], $this->player, $effect);
285 $this->disposeHooks->add(
static function() use ($effectManager, $effectAddHook, $effectRemoveHook) :
void{
286 $effectManager->getEffectAddHooks()->remove($effectAddHook);
287 $effectManager->getEffectRemoveHooks()->remove($effectRemoveHook);
290 $permissionHooks = $this->player->getPermissionRecalculationCallbacks();
291 $permissionHooks->add($permHook =
function() :
void{
292 $this->logger->debug(
"Syncing available commands and abilities/permissions due to permission recalculation");
293 $this->syncAbilities($this->player);
294 $this->syncAvailableCommands();
296 $this->disposeHooks->add(
static function() use ($permissionHooks, $permHook) :
void{
297 $permissionHooks->remove($permHook);
299 $this->beginSpawnSequence();
302 public function getPlayer() : ?
Player{
303 return $this->player;
306 public function getPlayerInfo() : ?
PlayerInfo{
310 public function isConnected() :
bool{
311 return $this->connected && !$this->disconnectGuard;
314 public function getIp() :
string{
318 public function getPort() :
int{
322 public function getDisplayName() :
string{
323 return $this->info !==
null ? $this->info->getUsername() : $this->ip .
" " . $this->port;
336 public function updatePing(
int $ping) : void{
340 public function getHandler() : ?PacketHandler{
341 return $this->handler;
344 public function setHandler(?PacketHandler $handler) : void{
345 if($this->connected){
346 $this->handler = $handler;
347 if($this->handler !==
null){
348 $this->handler->setUp();
357 if(!$this->connected){
361 Timings::$playerNetworkReceive->startTiming();
363 $this->packetBatchLimiter->decrement();
365 if($this->cipher !==
null){
366 Timings::$playerNetworkReceiveDecrypt->startTiming();
368 $payload = $this->cipher->decrypt($payload);
369 }
catch(DecryptionException $e){
370 $this->logger->debug(
"Encrypted packet: " . base64_encode($payload));
371 throw PacketHandlingException::wrap($e,
"Packet decryption error");
373 Timings::$playerNetworkReceiveDecrypt->stopTiming();
377 if(strlen($payload) < 1){
378 throw new PacketHandlingException(
"No bytes in payload");
381 if($this->enableCompression){
382 $compressionType = ord($payload[0]);
383 $compressed = substr($payload, 1);
384 if($compressionType === CompressionAlgorithm::NONE){
385 $decompressed = $compressed;
386 }elseif($compressionType === $this->compressor->getNetworkId()){
387 Timings::$playerNetworkReceiveDecompress->startTiming();
389 $decompressed = $this->compressor->decompress($compressed);
390 }
catch(DecompressionException $e){
391 $this->logger->debug(
"Failed to decompress packet: " . base64_encode($compressed));
392 throw PacketHandlingException::wrap($e,
"Compressed packet batch decode error");
394 Timings::$playerNetworkReceiveDecompress->stopTiming();
397 throw new PacketHandlingException(
"Packet compressed with unexpected compression type $compressionType");
400 $decompressed = $payload;
404 $stream =
new BinaryStream($decompressed);
405 foreach(PacketBatch::decodeRaw($stream) as $buffer){
406 $this->gamePacketLimiter->decrement();
407 $packet = $this->packetPool->getPacket($buffer);
408 if($packet ===
null){
409 $this->logger->debug(
"Unknown packet: " . base64_encode($buffer));
410 throw new PacketHandlingException(
"Unknown packet received");
413 $this->handleDataPacket($packet, $buffer);
414 }
catch(PacketHandlingException $e){
415 $this->logger->debug($packet->getName() .
": " . base64_encode($buffer));
416 throw PacketHandlingException::wrap($e,
"Error processing " . $packet->getName());
418 if(!$this->isConnected()){
420 $this->logger->debug(
"Aborting batch processing due to server-side disconnection");
424 }
catch(PacketDecodeException|BinaryDataException $e){
425 $this->logger->logException($e);
426 throw PacketHandlingException::wrap($e,
"Packet batch decode error");
429 Timings::$playerNetworkReceive->stopTiming();
441 $timings = Timings::getReceiveDataPacketTimings($packet);
442 $timings->startTiming();
445 if(DataPacketDecodeEvent::hasHandlers()){
448 if($ev->isCancelled()){
453 $decodeTimings = Timings::getDecodeDataPacketTimings($packet);
454 $decodeTimings->startTiming();
456 $stream = PacketSerializer::decoder($buffer, 0);
458 $packet->decode($stream);
459 }
catch(PacketDecodeException $e){
460 throw PacketHandlingException::wrap($e);
462 if(!$stream->feof()){
463 $remains = substr($stream->getBuffer(), $stream->getOffset());
464 $this->logger->debug(
"Still " . strlen($remains) .
" bytes unread in " . $packet->getName() .
": " . bin2hex($remains));
467 $decodeTimings->stopTiming();
470 if(DataPacketReceiveEvent::hasHandlers()){
471 $ev =
new DataPacketReceiveEvent($this, $packet);
473 if($ev->isCancelled()){
477 $handlerTimings = Timings::getHandleDataPacketTimings($packet);
478 $handlerTimings->startTiming();
480 if($this->handler ===
null || !$packet->handle($this->handler)){
481 $this->logger->debug(
"Unhandled " . $packet->getName() .
": " . base64_encode($stream->getBuffer()));
484 $handlerTimings->stopTiming();
487 $timings->stopTiming();
491 public function handleAckReceipt(
int $receiptId) : void{
492 if(!$this->connected){
495 if(isset($this->ackPromisesByReceiptId[$receiptId])){
496 $promises = $this->ackPromisesByReceiptId[$receiptId];
497 unset($this->ackPromisesByReceiptId[$receiptId]);
498 foreach($promises as $promise){
499 $promise->resolve(
true);
507 private function sendDataPacketInternal(ClientboundPacket $packet,
bool $immediate, ?PromiseResolver $ackReceiptResolver) : bool{
508 if(!$this->connected){
512 if(!$this->loggedIn && !$packet->canBeSentBeforeLogin()){
513 throw new \InvalidArgumentException(
"Attempted to send " . get_class($packet) .
" to " . $this->getDisplayName() .
" too early");
516 $timings = Timings::getSendDataPacketTimings($packet);
517 $timings->startTiming();
519 if(DataPacketSendEvent::hasHandlers()){
520 $ev = new DataPacketSendEvent([$this], [$packet]);
522 if($ev->isCancelled()){
525 $packets = $ev->getPackets();
527 $packets = [$packet];
530 if($ackReceiptResolver !==
null){
531 $this->sendBufferAckPromises[] = $ackReceiptResolver;
533 foreach($packets as $evPacket){
534 $this->addToSendBuffer(self::encodePacketTimed(PacketSerializer::encoder(), $evPacket));
537 $this->flushGamePacketQueue();
542 $timings->stopTiming();
546 public function sendDataPacket(ClientboundPacket $packet,
bool $immediate =
false) : bool{
547 return $this->sendDataPacketInternal($packet, $immediate, null);
557 if(!$this->sendDataPacketInternal($packet, $immediate, $resolver)){
567 public static function encodePacketTimed(PacketSerializer $serializer, ClientboundPacket $packet) : string{
568 $timings =
Timings::getEncodeDataPacketTimings($packet);
569 $timings->startTiming();
571 $packet->encode($serializer);
572 return $serializer->getBuffer();
574 $timings->stopTiming();
581 public function addToSendBuffer(
string $buffer) : void{
582 $this->sendBuffer[] = $buffer;
585 private function flushGamePacketQueue() : void{
586 if(count($this->sendBuffer) > 0){
587 Timings::$playerNetworkSend->startTiming();
590 if($this->forceAsyncCompression){
594 $stream =
new BinaryStream();
595 PacketBatch::encodeRaw($stream, $this->sendBuffer);
597 if($this->enableCompression){
598 $batch = $this->
server->prepareBatch($stream->getBuffer(), $this->compressor, $syncMode, Timings::$playerNetworkSendCompressSessionBuffer);
600 $batch = $stream->getBuffer();
602 $this->sendBuffer = [];
603 $ackPromises = $this->sendBufferAckPromises;
604 $this->sendBufferAckPromises = [];
607 $this->queueCompressedNoGamePacketFlush($batch, networkFlush:
true, ackPromises: $ackPromises);
609 Timings::$playerNetworkSend->stopTiming();
614 public function getBroadcaster() : PacketBroadcaster{ return $this->broadcaster; }
616 public function getEntityEventBroadcaster() : EntityEventBroadcaster{ return $this->entityEventBroadcaster; }
618 public function getCompressor() : Compressor{
619 return $this->compressor;
622 public function getTypeConverter() : TypeConverter{ return $this->typeConverter; }
624 public function queueCompressed(CompressBatchPromise|
string $payload,
bool $immediate =
false) : void{
625 Timings::$playerNetworkSend->startTiming();
629 $this->flushGamePacketQueue();
630 $this->queueCompressedNoGamePacketFlush($payload, $immediate);
632 Timings::$playerNetworkSend->stopTiming();
641 private function queueCompressedNoGamePacketFlush(CompressBatchPromise|
string $batch,
bool $networkFlush =
false, array $ackPromises = []) : void{
642 Timings::$playerNetworkSend->startTiming();
644 $this->compressedQueue->enqueue([$batch, $ackPromises, $networkFlush]);
645 if(is_string($batch)){
646 $this->flushCompressedQueue();
648 $batch->onResolve(
function() :
void{
649 if($this->connected){
650 $this->flushCompressedQueue();
655 Timings::$playerNetworkSend->stopTiming();
659 private function flushCompressedQueue() : void{
660 Timings::$playerNetworkSend->startTiming();
662 while(!$this->compressedQueue->isEmpty()){
664 [$current, $ackPromises, $networkFlush] = $this->compressedQueue->bottom();
665 if(is_string($current)){
666 $this->compressedQueue->dequeue();
667 $this->sendEncoded($current, $networkFlush, $ackPromises);
669 }elseif($current->hasResult()){
670 $this->compressedQueue->dequeue();
671 $this->sendEncoded($current->getResult(), $networkFlush, $ackPromises);
679 Timings::$playerNetworkSend->stopTiming();
687 private function sendEncoded(
string $payload,
bool $immediate, array $ackPromises) : void{
688 if($this->cipher !== null){
689 Timings::$playerNetworkSendEncrypt->startTiming();
690 $payload = $this->cipher->encrypt($payload);
691 Timings::$playerNetworkSendEncrypt->stopTiming();
694 if(count($ackPromises) > 0){
695 $ackReceiptId = $this->nextAckReceiptId++;
696 $this->ackPromisesByReceiptId[$ackReceiptId] = $ackPromises;
698 $ackReceiptId =
null;
700 $this->sender->send($payload, $immediate, $ackReceiptId);
706 private function tryDisconnect(\Closure $func, Translatable|
string $reason) : void{
707 if($this->connected && !$this->disconnectGuard){
708 $this->disconnectGuard =
true;
710 $this->disconnectGuard =
false;
711 $this->flushGamePacketQueue();
712 $this->sender->close(
"");
713 foreach($this->disposeHooks as $callback){
716 $this->disposeHooks->clear();
717 $this->setHandler(
null);
718 $this->connected =
false;
720 $ackPromisesByReceiptId = $this->ackPromisesByReceiptId;
721 $this->ackPromisesByReceiptId = [];
722 foreach($ackPromisesByReceiptId as $resolvers){
723 foreach($resolvers as $resolver){
727 $sendBufferAckPromises = $this->sendBufferAckPromises;
728 $this->sendBufferAckPromises = [];
729 foreach($sendBufferAckPromises as $resolver){
733 $this->logger->info($this->
server->getLanguage()->translate(KnownTranslationFactory::pocketmine_network_session_close($reason)));
741 private function dispose() : void{
742 $this->invManager = null;
745 private function sendDisconnectPacket(Translatable|
string $message) : void{
746 if($message instanceof Translatable){
747 $translated = $this->
server->getLanguage()->translate($message);
749 $translated = $message;
751 $this->sendDataPacket(DisconnectPacket::create(0, $translated,
""));
761 $this->tryDisconnect(function() use ($reason, $disconnectScreenMessage, $notify) : void{
763 $this->sendDisconnectPacket($disconnectScreenMessage ?? $reason);
765 if($this->player !==
null){
766 $this->player->onPostDisconnect($reason,
null);
771 public function disconnectWithError(Translatable|
string $reason, Translatable|
string|
null $disconnectScreenMessage =
null) : void{
772 $errorId = implode(
"-", str_split(bin2hex(random_bytes(6)), 4));
775 reason: KnownTranslationFactory::pocketmine_disconnect_error($reason, $errorId)->prefix(TextFormat::RED),
776 disconnectScreenMessage: KnownTranslationFactory::pocketmine_disconnect_error($disconnectScreenMessage ?? $reason, $errorId),
780 public function disconnectIncompatibleProtocol(
int $protocolVersion) : void{
781 $this->tryDisconnect(
782 function() use ($protocolVersion) : void{
783 $this->sendDataPacket(PlayStatusPacket::create($protocolVersion < ProtocolInfo::CURRENT_PROTOCOL ? PlayStatusPacket::LOGIN_FAILED_CLIENT : PlayStatusPacket::LOGIN_FAILED_SERVER), true);
785 KnownTranslationFactory::pocketmine_disconnect_incompatibleProtocol((
string) $protocolVersion)
794 $this->tryDisconnect(
function() use ($ip, $port, $reason) :
void{
795 $this->sendDataPacket(TransferPacket::create($ip, $port,
false),
true);
796 if($this->player !==
null){
797 $this->player->onPostDisconnect($reason,
null);
806 $this->tryDisconnect(function() use ($disconnectScreenMessage) : void{
807 $this->sendDisconnectPacket($disconnectScreenMessage);
816 $this->tryDisconnect(function() use ($reason) : void{
817 if($this->player !== null){
818 $this->player->onPostDisconnect($reason,
null);
823 private function setAuthenticationStatus(
bool $authenticated,
bool $authRequired,
Translatable|
string|
null $error, ?
string $clientPubKey) : void{
824 if(!$this->connected){
828 if($authenticated && !($this->info instanceof XboxLivePlayerInfo)){
829 $error =
"Expected XUID but none found";
830 }elseif($clientPubKey ===
null){
831 $error =
"Missing client public key";
836 $this->disconnectWithError(
837 reason: KnownTranslationFactory::pocketmine_disconnect_invalidSession($error),
838 disconnectScreenMessage: KnownTranslationFactory::pocketmine_disconnect_error_authentication()
844 $this->authenticated = $authenticated;
846 if(!$this->authenticated){
848 $this->disconnect(
"Not authenticated", KnownTranslationFactory::disconnectionScreen_notAuthenticated());
851 if($this->info instanceof XboxLivePlayerInfo){
852 $this->logger->warning(
"Discarding unexpected XUID for non-authenticated player");
853 $this->info = $this->info->withoutXboxData();
856 $this->logger->debug(
"Xbox Live authenticated: " . ($this->authenticated ?
"YES" :
"NO"));
858 $checkXUID = $this->
server->getConfigGroup()->getPropertyBool(YmlServerProperties::PLAYER_VERIFY_XUID,
true);
859 $myXUID = $this->info instanceof XboxLivePlayerInfo ? $this->info->getXuid() :
"";
860 $kickForXUIDMismatch =
function(
string $xuid) use ($checkXUID, $myXUID) : bool{
861 if($checkXUID && $myXUID !== $xuid){
862 $this->logger->debug(
"XUID mismatch: expected '$xuid', but got '$myXUID'");
867 $this->disconnect(
"XUID does not match (possible impersonation attempt)");
873 foreach($this->manager->getSessions() as $existingSession){
874 if($existingSession === $this){
877 $info = $existingSession->getPlayerInfo();
878 if($info !==
null && (strcasecmp($info->getUsername(), $this->info->getUsername()) === 0 || $info->getUuid()->equals($this->info->getUuid()))){
879 if($kickForXUIDMismatch($info instanceof XboxLivePlayerInfo ? $info->getXuid() :
"")){
882 $ev =
new PlayerDuplicateLoginEvent($this, $existingSession, KnownTranslationFactory::disconnectionScreen_loggedinOtherLocation(),
null);
884 if($ev->isCancelled()){
885 $this->disconnect($ev->getDisconnectReason(), $ev->getDisconnectScreenMessage());
889 $existingSession->disconnect($ev->getDisconnectReason(), $ev->getDisconnectScreenMessage());
895 $this->cachedOfflinePlayerData = $this->
server->getOfflinePlayerData($this->info->getUsername());
897 $recordedXUID = $this->cachedOfflinePlayerData !==
null ? $this->cachedOfflinePlayerData->getTag(Player::TAG_LAST_KNOWN_XUID) :
null;
898 if(!($recordedXUID instanceof StringTag)){
899 $this->logger->debug(
"No previous XUID recorded, no choice but to trust this player");
900 }elseif(!$kickForXUIDMismatch($recordedXUID->getValue())){
901 $this->logger->debug(
"XUID match");
905 if(EncryptionContext::$ENABLED){
906 $this->
server->getAsyncPool()->submitTask(
new PrepareEncryptionTask($clientPubKey,
function(
string $encryptionKey,
string $handshakeJwt) :
void{
907 if(!$this->connected){
910 $this->sendDataPacket(ServerToClientHandshakePacket::create($handshakeJwt),
true);
912 $this->cipher = EncryptionContext::fakeGCM($encryptionKey);
914 $this->setHandler(
new HandshakePacketHandler($this->onServerLoginSuccess(...)));
915 $this->logger->debug(
"Enabled encryption");
918 $this->onServerLoginSuccess();
922 private function onServerLoginSuccess() : void{
923 $this->loggedIn = true;
925 $this->sendDataPacket(PlayStatusPacket::create(PlayStatusPacket::LOGIN_SUCCESS));
927 $this->logger->debug(
"Initiating resource packs phase");
929 $packManager = $this->
server->getResourcePackManager();
930 $resourcePacks = $packManager->getResourceStack();
932 foreach($resourcePacks as $resourcePack){
933 $key = $packManager->getPackEncryptionKey($resourcePack->getPackId());
935 $keys[$resourcePack->getPackId()] = $key;
938 $event =
new PlayerResourcePackOfferEvent($this->info, $resourcePacks, $keys, $packManager->resourcePacksRequired());
940 $this->setHandler(
new ResourcePacksPacketHandler($this, $event->getResourcePacks(), $event->getEncryptionKeys(), $event->mustAccept(),
function() :
void{
941 $this->createPlayer();
945 private function beginSpawnSequence() : void{
946 $this->setHandler(new PreSpawnPacketHandler($this->
server, $this->player, $this, $this->invManager));
947 $this->player->setNoClientPredictions();
949 $this->logger->debug(
"Waiting for chunk radius request");
952 public function notifyTerrainReady() : void{
953 $this->logger->debug(
"Sending spawn notification, waiting for spawn response");
954 $this->sendDataPacket(PlayStatusPacket::create(PlayStatusPacket::PLAYER_SPAWN));
955 $this->setHandler(
new SpawnResponsePacketHandler($this->onClientSpawnResponse(...)));
958 private function onClientSpawnResponse() : void{
959 $this->logger->debug(
"Received spawn response, entering in-game phase");
960 $this->player->setNoClientPredictions(
false);
961 $this->player->doFirstSpawn();
962 $this->forceAsyncCompression =
false;
963 $this->setHandler(
new InGamePacketHandler($this->player, $this, $this->invManager));
966 public function onServerDeath(Translatable|
string $deathMessage) : void{
967 if($this->handler instanceof InGamePacketHandler){
968 $this->setHandler(
new DeathPacketHandler($this->player, $this, $this->invManager ??
throw new AssumptionFailedError(), $deathMessage));
972 public function onServerRespawn() : void{
973 $this->entityEventBroadcaster->syncAttributes([$this], $this->player, $this->player->getAttributeMap()->getAll());
974 $this->player->sendData(
null);
976 $this->syncAbilities($this->player);
977 $this->invManager->syncAll();
978 $this->setHandler(
new InGamePacketHandler($this->player, $this, $this->invManager));
981 public function syncMovement(Vector3 $pos, ?
float $yaw =
null, ?
float $pitch =
null,
int $mode = MovePlayerPacket::MODE_NORMAL) : void{
982 if($this->player !== null){
983 $location = $this->player->getLocation();
984 $yaw = $yaw ?? $location->getYaw();
985 $pitch = $pitch ?? $location->getPitch();
987 $this->sendDataPacket(MovePlayerPacket::simple(
988 $this->player->getId(),
989 $this->player->getOffsetPosition($pos),
994 $this->player->onGround,
999 if($this->handler instanceof InGamePacketHandler){
1000 $this->handler->forceMoveSync =
true;
1005 public function syncViewAreaRadius(
int $distance) : void{
1006 $this->sendDataPacket(ChunkRadiusUpdatedPacket::create($distance));
1009 public function syncViewAreaCenterPoint(Vector3 $newPos,
int $viewDistance) : void{
1010 $this->sendDataPacket(NetworkChunkPublisherUpdatePacket::create(BlockPosition::fromVector3($newPos), $viewDistance * 16, []));
1013 public function syncPlayerSpawnPoint(Position $newSpawn) : void{
1014 $newSpawnBlockPosition = BlockPosition::fromVector3($newSpawn);
1016 $this->sendDataPacket(SetSpawnPositionPacket::playerSpawn($newSpawnBlockPosition, DimensionIds::OVERWORLD, $newSpawnBlockPosition));
1019 public function syncWorldSpawnPoint(Position $newSpawn) : void{
1020 $this->sendDataPacket(SetSpawnPositionPacket::worldSpawn(BlockPosition::fromVector3($newSpawn), DimensionIds::OVERWORLD));
1023 public function syncGameMode(GameMode $mode,
bool $isRollback =
false) : void{
1024 $this->sendDataPacket(SetPlayerGameTypePacket::create($this->typeConverter->coreGameModeToProtocol($mode)));
1025 if($this->player !==
null){
1026 $this->syncAbilities($this->player);
1027 $this->syncAdventureSettings();
1029 if(!$isRollback && $this->invManager !==
null){
1030 $this->invManager->syncCreative();
1034 public function syncAbilities(Player $for) : void{
1035 $isOp = $for->hasPermission(DefaultPermissions::ROOT_OPERATOR);
1039 AbilitiesLayer::ABILITY_ALLOW_FLIGHT => $for->getAllowFlight(),
1040 AbilitiesLayer::ABILITY_FLYING => $for->isFlying(),
1041 AbilitiesLayer::ABILITY_NO_CLIP => !$for->hasBlockCollision(),
1042 AbilitiesLayer::ABILITY_OPERATOR => $isOp,
1043 AbilitiesLayer::ABILITY_TELEPORT => $for->hasPermission(DefaultPermissionNames::COMMAND_TELEPORT_SELF),
1044 AbilitiesLayer::ABILITY_INVULNERABLE => $for->isCreative(),
1045 AbilitiesLayer::ABILITY_MUTED =>
false,
1046 AbilitiesLayer::ABILITY_WORLD_BUILDER =>
false,
1047 AbilitiesLayer::ABILITY_INFINITE_RESOURCES => !$for->hasFiniteResources(),
1048 AbilitiesLayer::ABILITY_LIGHTNING =>
false,
1049 AbilitiesLayer::ABILITY_BUILD => !$for->isSpectator(),
1050 AbilitiesLayer::ABILITY_MINE => !$for->isSpectator(),
1051 AbilitiesLayer::ABILITY_DOORS_AND_SWITCHES => !$for->isSpectator(),
1052 AbilitiesLayer::ABILITY_OPEN_CONTAINERS => !$for->isSpectator(),
1053 AbilitiesLayer::ABILITY_ATTACK_PLAYERS => !$for->isSpectator(),
1054 AbilitiesLayer::ABILITY_ATTACK_MOBS => !$for->isSpectator(),
1055 AbilitiesLayer::ABILITY_PRIVILEGED_BUILDER =>
false,
1059 new AbilitiesLayer(AbilitiesLayer::LAYER_BASE, $boolAbilities, $for->getFlightSpeedMultiplier(), 1, 0.1),
1061 if(!$for->hasBlockCollision()){
1067 $layers[] = new AbilitiesLayer(AbilitiesLayer::LAYER_SPECTATOR, [
1068 AbilitiesLayer::ABILITY_FLYING => true,
1069 ], null, null, null);
1072 $this->sendDataPacket(UpdateAbilitiesPacket::create(
new AbilitiesData(
1073 $isOp ? CommandPermissions::OPERATOR : CommandPermissions::NORMAL,
1074 $isOp ? PlayerPermissions::OPERATOR : PlayerPermissions::MEMBER,
1080 public function syncAdventureSettings() : void{
1081 if($this->player === null){
1082 throw new \LogicException(
"Cannot sync adventure settings for a player that is not yet created");
1085 $this->sendDataPacket(UpdateAdventureSettingsPacket::create(
1086 noAttackingMobs:
false,
1087 noAttackingPlayers:
false,
1088 worldImmutable:
false,
1090 autoJump: $this->player->hasAutoJump()
1094 public function syncAvailableCommands() : void{
1096 foreach($this->
server->getCommandMap()->getCommands() as $command){
1097 if(isset($commandData[$command->getLabel()]) || $command->getLabel() ===
"help" || !$command->testPermissionSilent($this->player)){
1101 $lname = strtolower($command->getLabel());
1102 $aliases = $command->getAliases();
1104 if(count($aliases) > 0){
1105 if(!in_array($lname, $aliases,
true)){
1107 $aliases[] = $lname;
1109 $aliasObj =
new CommandEnum(ucfirst($command->getLabel()) .
"Aliases", $aliases);
1112 $description = $command->getDescription();
1113 $data =
new CommandData(
1115 $description instanceof Translatable ? $this->player->getLanguage()->translate($description) : $description,
1120 new CommandOverload(chaining:
false, parameters: [CommandParameter::standard(
"args", AvailableCommandsPacket::ARG_TYPE_RAWTEXT, 0,
true)])
1122 chainedSubCommandData: []
1125 $commandData[$command->getLabel()] = $data;
1128 $this->sendDataPacket(AvailableCommandsPacket::create($commandData, [], [], []));
1137 $language = $this->player->getLanguage();
1139 return [$language->translateString($message->getText(), $parameters,
"pocketmine."), $parameters];
1142 public function onChatMessage(
Translatable|
string $message) : void{
1144 if(!$this->
server->isLanguageForced()){
1145 $this->sendDataPacket(TextPacket::translation(...$this->prepareClientTranslatableMessage($message)));
1147 $this->sendDataPacket(TextPacket::raw($this->player->getLanguage()->translate($message)));
1150 $this->sendDataPacket(TextPacket::raw($message));
1154 public function onJukeboxPopup(Translatable|
string $message) : void{
1156 if($message instanceof Translatable){
1157 if(!$this->server->isLanguageForced()){
1158 [$message, $parameters] = $this->prepareClientTranslatableMessage($message);
1160 $message = $this->player->getLanguage()->translate($message);
1163 $this->sendDataPacket(TextPacket::jukeboxPopup($message, $parameters));
1166 public function onPopup(
string $message) : void{
1167 $this->sendDataPacket(TextPacket::popup($message));
1170 public function onTip(
string $message) : void{
1171 $this->sendDataPacket(TextPacket::tip($message));
1174 public function onFormSent(
int $id, Form $form) : bool{
1175 return $this->sendDataPacket(ModalFormRequestPacket::create($id, json_encode($form, JSON_THROW_ON_ERROR)));
1178 public function onCloseAllForms() : void{
1179 $this->sendDataPacket(ClientboundCloseFormPacket::create());
1185 private function sendChunkPacket(
string $chunkPacket, \Closure $onCompletion, World $world) : void{
1186 $world->timings->syncChunkSend->startTiming();
1188 $this->queueCompressed($chunkPacket);
1191 $world->timings->syncChunkSend->stopTiming();
1201 $world = $this->player->getLocation()->getWorld();
1202 $promiseOrPacket = ChunkCache::getInstance($world, $this->compressor)->request($chunkX, $chunkZ);
1203 if(is_string($promiseOrPacket)){
1204 $this->sendChunkPacket($promiseOrPacket, $onCompletion, $world);
1207 $promiseOrPacket->onResolve(
1210 if(!$this->isConnected()){
1213 $currentWorld = $this->player->getLocation()->getWorld();
1214 if($world !== $currentWorld || ($status = $this->player->getUsedChunkStatus($chunkX, $chunkZ)) ===
null){
1215 $this->logger->debug(
"Tried to send no-longer-active chunk $chunkX $chunkZ in world " . $world->getFolderName());
1218 if($status !== UsedChunkStatus::REQUESTED_SENDING){
1225 $this->sendChunkPacket($promise->getResult(), $onCompletion, $world);
1230 public function stopUsingChunk(
int $chunkX,
int $chunkZ) : void{
1234 public function onEnterWorld() : void{
1235 if($this->player !== null){
1236 $world = $this->player->getWorld();
1237 $this->syncWorldTime($world->getTime());
1238 $this->syncWorldDifficulty($world->getDifficulty());
1239 $this->syncWorldSpawnPoint($world->getSpawnLocation());
1244 public function syncWorldTime(
int $worldTime) : void{
1245 $this->sendDataPacket(SetTimePacket::create($worldTime));
1248 public function syncWorldDifficulty(
int $worldDifficulty) : void{
1249 $this->sendDataPacket(SetDifficultyPacket::create($worldDifficulty));
1252 public function getInvManager() : ?InventoryManager{
1253 return $this->invManager;
1261 return
PlayerListEntry::createAdditionEntry($player->getUniqueId(), $player->getId(), $player->getDisplayName(), $this->typeConverter->getSkinAdapter()->toSkinData($player->getSkin()), $player->getXuid());
1265 public function onPlayerAdded(
Player $p) : void{
1266 $this->sendDataPacket(PlayerListPacket::add([PlayerListEntry::createAdditionEntry($p->getUniqueId(), $p->getId(), $p->getDisplayName(), $this->typeConverter->getSkinAdapter()->toSkinData($p->getSkin()), $p->getXuid())]));
1269 public function onPlayerRemoved(
Player $p) : void{
1270 if($p !== $this->player){
1271 $this->sendDataPacket(PlayerListPacket::remove([PlayerListEntry::createRemovalEntry($p->
getUniqueId())]));
1275 public function onTitle(
string $title) : void{
1276 $this->sendDataPacket(SetTitlePacket::title($title));
1279 public function onSubTitle(
string $subtitle) : void{
1280 $this->sendDataPacket(SetTitlePacket::subtitle($subtitle));
1283 public function onActionBar(
string $actionBar) : void{
1284 $this->sendDataPacket(SetTitlePacket::actionBarMessage($actionBar));
1287 public function onClearTitle() : void{
1288 $this->sendDataPacket(SetTitlePacket::clearTitle());
1291 public function onResetTitleOptions() : void{
1292 $this->sendDataPacket(SetTitlePacket::resetTitleOptions());
1295 public function onTitleDuration(
int $fadeIn,
int $stay,
int $fadeOut) : void{
1296 $this->sendDataPacket(SetTitlePacket::setAnimationTimes($fadeIn, $stay, $fadeOut));
1299 public function onToastNotification(
string $title,
string $body) : void{
1300 $this->sendDataPacket(ToastRequestPacket::create($title, $body));
1303 public function onOpenSignEditor(Vector3 $signPosition,
bool $frontSide) : void{
1304 $this->sendDataPacket(OpenSignPacket::create(BlockPosition::fromVector3($signPosition), $frontSide));
1307 public function onItemCooldownChanged(Item $item,
int $ticks) : void{
1308 $this->sendDataPacket(PlayerStartItemCooldownPacket::create(
1309 GlobalItemDataHandlers::getSerializer()->serializeType($item)->getName(),
1314 public function tick() : void{
1315 if(!$this->isConnected()){
1320 if($this->info ===
null){
1321 if(time() >= $this->connectTime + 10){
1322 $this->disconnectWithError(KnownTranslationFactory::pocketmine_disconnect_error_loginTimeout());
1328 if($this->player !==
null){
1329 $this->player->doChunkRequests();
1331 $dirtyAttributes = $this->player->getAttributeMap()->needSend();
1332 $this->entityEventBroadcaster->syncAttributes([$this], $this->player, $dirtyAttributes);
1333 foreach($dirtyAttributes as $attribute){
1336 $attribute->markSynchronized();
1339 Timings::$playerNetworkSendInventorySync->startTiming();
1341 $this->invManager?->flushPendingUpdates();
1343 Timings::$playerNetworkSendInventorySync->stopTiming();
1346 $this->flushGamePacketQueue();