2014-09-03 22:29:36 +00:00
|
|
|
|
2016-12-15 19:21:43 +00:00
|
|
|
// Protocol_1_8.h
|
2014-09-03 22:29:36 +00:00
|
|
|
|
|
|
|
|
/*
|
2016-12-15 19:21:43 +00:00
|
|
|
Declares the 1.8 protocol classes:
|
|
|
|
|
- cProtocol_1_8_0
|
2020-07-20 08:56:27 +00:00
|
|
|
- release 1.8 protocol (#47), also used by 1.8.1 to 1.8.9
|
2014-09-03 22:29:36 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
|
|
#include "Protocol.h"
|
|
|
|
|
#include "../ByteBuffer.h"
|
2020-08-12 08:54:36 +00:00
|
|
|
#include "../Registries/Statistics.h"
|
2014-09-03 22:29:36 +00:00
|
|
|
|
2018-08-29 00:51:25 +00:00
|
|
|
#include "../mbedTLS++/AesCfb128Decryptor.h"
|
|
|
|
|
#include "../mbedTLS++/AesCfb128Encryptor.h"
|
2014-09-08 17:24:33 +00:00
|
|
|
|
2021-01-11 16:39:43 +00:00
|
|
|
#include "CircularBufferCompressor.h"
|
|
|
|
|
#include "StringCompression.h"
|
|
|
|
|
|
2014-09-03 22:29:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2020-04-13 16:38:06 +00:00
|
|
|
class cProtocol_1_8_0:
|
2014-09-08 17:24:33 +00:00
|
|
|
public cProtocol
|
2014-09-03 22:29:36 +00:00
|
|
|
{
|
2020-04-13 16:38:06 +00:00
|
|
|
using Super = cProtocol;
|
2016-02-05 21:45:45 +00:00
|
|
|
|
2014-09-03 22:29:36 +00:00
|
|
|
public:
|
|
|
|
|
|
2020-09-18 12:17:09 +00:00
|
|
|
cProtocol_1_8_0(cClientHandle * a_Client, const AString & a_ServerAddress, State a_State);
|
2016-02-05 21:45:45 +00:00
|
|
|
|
2021-03-08 16:37:36 +00:00
|
|
|
/** Called to process them, when client sends some data.
|
|
|
|
|
The protocol uses the provided buffers for storage and processing, and must have exclusive access to them. */
|
|
|
|
|
virtual void DataReceived(cByteBuffer & a_Buffer, ContiguousByteBuffer && a_Data) override;
|
2014-09-03 22:29:36 +00:00
|
|
|
|
2014-09-08 17:24:33 +00:00
|
|
|
/** Sending stuff to clients (alphabetically sorted): */
|
1.9 / 1.9.2 / 1.9.3 / 1.9.4 protocol support (#3135)
* Semistable update to 15w31a
I'm going through snapshots in a sequential order since it should make things easier, and since protocol version history is written.
* Update to 15w34b protocol
Also, fix an issue with the Entity Equipment packet from the past version. Clients are able to connect and do stuff!
* Partially update to 15w35e
Chunk data doesn't work, but the client joins. I'm waiting to do chunk data because chunk data has an incomplete format until 15w36d.
* Add '/blk' debug command
This command lets one see what block they are looking at, and makes figuring out what's supposed to be where in a highly broken chunk possible.
* Fix CRLF normalization in CheckBasicStyle.lua
Normally, this doesn't cause an issue, but when running from cygwin, it detects the CR as whitespace and creates thousands of violations for every single line. Lua, when run on windows, will normalize automatically, but when run via cygwin, it won't.
The bug was simply that gsub was returning a replaced version, but not changing the parameter, so the replaced version was ignored.
* Update to 15w40b
This includes chunk serialization. Fully functional chunk serialization for 1.9.
I'm not completely happy with the chunk serialization as-is (correct use of palettes would be great), but cuberite also doesn't skip sending empty chunks so this performance optimization should probably come later. The creation of a full buffer is suboptimal, but it's the easiest way to implement this code.
* Write long-by-long rather than creating a buffer
This is a bit faster and should be equivalent. However, the code still doesn't look too good.
* Update to 15w41a protocol
This includes the new set passengers packet, which works off of the ridden entity, not the rider. That means, among other things, that information about the previously ridden vehicle is needed when detaching. So a new method with that info was added.
* Update to 15w45a
* 15w51b protocol
* Update to 1.9.0 protocol
Closes #3067. There are still a few things that need to be worked out (picking up items, effects, particles, and most importantly inventory), but in general this should work. I'll make a few more changes tomorrow to get the rest of the protocol set up, along with 1.9.1/1.9.2 (which did make a few changes). Chunks, however, _are_ working, along with most other parts of the game (placing/breaking blocks).
* Fix item pickup packet not working
That was a silly mistake, but at least it was an easy one.
* 1.9.2 protocol support
* Fix version info found in server list ping
Thus, the client reports that it can connect rather than saying that the server is out of date. This required creating separate classes for 1.9.1 and 1.9.2, unfortunately.
* Fix build errors generated by clang
These didn't happen in MSVC.
* Add protocol19x.cpp and protocol19x.h to CMakeLists
* Ignore warnings in protocol19x that are ignored in protocol18x
* Document BLOCK_FACE and DIG_STATUS constants
* Fix BLOCK_FACE links and add separate section for DIG_STATUS
* Fix bat animation and object spawning
The causes of both of these are explained in #3135, but the gist is that both were typos.
* Implement Use Item packet
This means that buckets, bows, fishing rods, and several other similar items now work when not looking at a block.
* Handle DIG_STATUS_SWAP_ITEM_IN_HAND
* Add support for spawn eggs and potions
The items are transformed from the 1.9 version to the 1.8 version when reading and transformed back when sending.
* Remove spammy potion debug logging
* Fix wolf collar color metadata
The wrong type was being used, causing several clientside issues (including the screen going black).
* Fix 1.9 chunk sending in the nether
The nether and the end don't send skylight.
* Fix clang build errors
* Fix water bottles becoming mundane potions
This happened because the can become splash potion bit got set incorrectly. Water bottles and mundane potions are only differentiated by the fact that water bottles have a metadata of 0, so setting that bit made it a mundane potion.
Also add missing break statements to the read item NBT switch, which would otherwise break items with custom names and also cause incorrect "Unimplemented NBT data when parsing!" logging.
* Copy Protocol18x as Protocol19x
Aditionally, method and class names have been swapped to clean up other diffs. This commit is only added to make the following diffs more readable; it doesn't make any other changes (beyond class names).
* Make thrown potions use the correct appearence
This was caused by potions now using metadata.
* Add missing api doc for cSplashPotionEntity::GetItem
* Fix compile error in SplashPotionEntity.cpp
* Fix fix of cSplashPotionEntity API doc
* Temporarilly disable fall damage particles
These were causing issues in 1.9 due to the changed effect ID.
* Properly send a kick packet when connecting with an invalid version
This means that the client no longer waits on the server screen with no indication whatsoever. However, right now the server list ping isn't implemented for unknown versions, so it'll only load "Old" on the ping.
I also added a GetVarIntSize method to cByteBuffer. This helps clean up part of the code here (and I think it could clean up other parts), but it may make sense for it to be moved elsewhere (or declared in a different way).
* Handle server list pings from unrecognized versions
This isn't the cleanest way of writing it (it feels odd to use ProtocolRecognizer to send packets, and the addition of m_InPingForUnrecognizedVersion feels like the wrong technique), but it works and I can't think of a better way (apart from creating a full separate protocol class to handle only the ping... which would be worse).
* Use cPacketizer for the disconnect packet
This also should fix clang build errors.
* Add 1.9.3 / 1.9.4 support
* Fix incorrect indentation in APIDesc
2016-05-14 19:12:42 +00:00
|
|
|
virtual void SendAttachEntity (const cEntity & a_Entity, const cEntity & a_Vehicle) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendBlockAction (int a_BlockX, int a_BlockY, int a_BlockZ, char a_Byte1, char a_Byte2, BLOCKTYPE a_BlockType) override;
|
2015-03-21 15:11:57 +00:00
|
|
|
virtual void SendBlockBreakAnim (UInt32 a_EntityID, int a_BlockX, int a_BlockY, int a_BlockZ, char a_Stage) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendBlockChange (int a_BlockX, int a_BlockY, int a_BlockZ, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta) override;
|
|
|
|
|
virtual void SendBlockChanges (int a_ChunkX, int a_ChunkZ, const sSetBlockVector & a_Changes) override;
|
2021-03-05 15:08:30 +00:00
|
|
|
virtual void SendBossBarAdd (UInt32 a_UniqueID, const cCompositeChat & a_Title, float a_FractionFilled, BossBarColor a_Color, BossBarDivisionType a_DivisionType, bool a_DarkenSky, bool a_PlayEndMusic, bool a_CreateFog) override;
|
|
|
|
|
virtual void SendBossBarRemove (UInt32 a_UniqueID) override;
|
|
|
|
|
virtual void SendBossBarUpdateFlags (UInt32 a_UniqueID, bool a_DarkenSky, bool a_PlayEndMusic, bool a_CreateFog) override;
|
|
|
|
|
virtual void SendBossBarUpdateHealth (UInt32 a_UniqueID, float a_FractionFilled) override;
|
|
|
|
|
virtual void SendBossBarUpdateStyle (UInt32 a_UniqueID, BossBarColor a_Color, BossBarDivisionType a_DivisionType) override;
|
|
|
|
|
virtual void SendBossBarUpdateTitle (UInt32 a_UniqueID, const cCompositeChat & a_Title) override;
|
2016-10-12 12:38:45 +00:00
|
|
|
virtual void SendCameraSetTo (const cEntity & a_Entity) override;
|
2015-09-20 22:07:53 +00:00
|
|
|
virtual void SendChat (const AString & a_Message, eChatType a_Type) override;
|
|
|
|
|
virtual void SendChat (const cCompositeChat & a_Message, eChatType a_Type, bool a_ShouldUseChatPrefixes) override;
|
2016-09-22 09:51:22 +00:00
|
|
|
virtual void SendChatRaw (const AString & a_MessageRaw, eChatType a_Type) override;
|
2021-01-11 16:39:43 +00:00
|
|
|
virtual void SendChunkData (ContiguousByteBufferView a_ChunkData) override;
|
2020-05-04 08:10:47 +00:00
|
|
|
virtual void SendCollectEntity (const cEntity & a_Collected, const cEntity & a_Collector, unsigned a_Count) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendDestroyEntity (const cEntity & a_Entity) override;
|
1.9 / 1.9.2 / 1.9.3 / 1.9.4 protocol support (#3135)
* Semistable update to 15w31a
I'm going through snapshots in a sequential order since it should make things easier, and since protocol version history is written.
* Update to 15w34b protocol
Also, fix an issue with the Entity Equipment packet from the past version. Clients are able to connect and do stuff!
* Partially update to 15w35e
Chunk data doesn't work, but the client joins. I'm waiting to do chunk data because chunk data has an incomplete format until 15w36d.
* Add '/blk' debug command
This command lets one see what block they are looking at, and makes figuring out what's supposed to be where in a highly broken chunk possible.
* Fix CRLF normalization in CheckBasicStyle.lua
Normally, this doesn't cause an issue, but when running from cygwin, it detects the CR as whitespace and creates thousands of violations for every single line. Lua, when run on windows, will normalize automatically, but when run via cygwin, it won't.
The bug was simply that gsub was returning a replaced version, but not changing the parameter, so the replaced version was ignored.
* Update to 15w40b
This includes chunk serialization. Fully functional chunk serialization for 1.9.
I'm not completely happy with the chunk serialization as-is (correct use of palettes would be great), but cuberite also doesn't skip sending empty chunks so this performance optimization should probably come later. The creation of a full buffer is suboptimal, but it's the easiest way to implement this code.
* Write long-by-long rather than creating a buffer
This is a bit faster and should be equivalent. However, the code still doesn't look too good.
* Update to 15w41a protocol
This includes the new set passengers packet, which works off of the ridden entity, not the rider. That means, among other things, that information about the previously ridden vehicle is needed when detaching. So a new method with that info was added.
* Update to 15w45a
* 15w51b protocol
* Update to 1.9.0 protocol
Closes #3067. There are still a few things that need to be worked out (picking up items, effects, particles, and most importantly inventory), but in general this should work. I'll make a few more changes tomorrow to get the rest of the protocol set up, along with 1.9.1/1.9.2 (which did make a few changes). Chunks, however, _are_ working, along with most other parts of the game (placing/breaking blocks).
* Fix item pickup packet not working
That was a silly mistake, but at least it was an easy one.
* 1.9.2 protocol support
* Fix version info found in server list ping
Thus, the client reports that it can connect rather than saying that the server is out of date. This required creating separate classes for 1.9.1 and 1.9.2, unfortunately.
* Fix build errors generated by clang
These didn't happen in MSVC.
* Add protocol19x.cpp and protocol19x.h to CMakeLists
* Ignore warnings in protocol19x that are ignored in protocol18x
* Document BLOCK_FACE and DIG_STATUS constants
* Fix BLOCK_FACE links and add separate section for DIG_STATUS
* Fix bat animation and object spawning
The causes of both of these are explained in #3135, but the gist is that both were typos.
* Implement Use Item packet
This means that buckets, bows, fishing rods, and several other similar items now work when not looking at a block.
* Handle DIG_STATUS_SWAP_ITEM_IN_HAND
* Add support for spawn eggs and potions
The items are transformed from the 1.9 version to the 1.8 version when reading and transformed back when sending.
* Remove spammy potion debug logging
* Fix wolf collar color metadata
The wrong type was being used, causing several clientside issues (including the screen going black).
* Fix 1.9 chunk sending in the nether
The nether and the end don't send skylight.
* Fix clang build errors
* Fix water bottles becoming mundane potions
This happened because the can become splash potion bit got set incorrectly. Water bottles and mundane potions are only differentiated by the fact that water bottles have a metadata of 0, so setting that bit made it a mundane potion.
Also add missing break statements to the read item NBT switch, which would otherwise break items with custom names and also cause incorrect "Unimplemented NBT data when parsing!" logging.
* Copy Protocol18x as Protocol19x
Aditionally, method and class names have been swapped to clean up other diffs. This commit is only added to make the following diffs more readable; it doesn't make any other changes (beyond class names).
* Make thrown potions use the correct appearence
This was caused by potions now using metadata.
* Add missing api doc for cSplashPotionEntity::GetItem
* Fix compile error in SplashPotionEntity.cpp
* Fix fix of cSplashPotionEntity API doc
* Temporarilly disable fall damage particles
These were causing issues in 1.9 due to the changed effect ID.
* Properly send a kick packet when connecting with an invalid version
This means that the client no longer waits on the server screen with no indication whatsoever. However, right now the server list ping isn't implemented for unknown versions, so it'll only load "Old" on the ping.
I also added a GetVarIntSize method to cByteBuffer. This helps clean up part of the code here (and I think it could clean up other parts), but it may make sense for it to be moved elsewhere (or declared in a different way).
* Handle server list pings from unrecognized versions
This isn't the cleanest way of writing it (it feels odd to use ProtocolRecognizer to send packets, and the addition of m_InPingForUnrecognizedVersion feels like the wrong technique), but it works and I can't think of a better way (apart from creating a full separate protocol class to handle only the ping... which would be worse).
* Use cPacketizer for the disconnect packet
This also should fix clang build errors.
* Add 1.9.3 / 1.9.4 support
* Fix incorrect indentation in APIDesc
2016-05-14 19:12:42 +00:00
|
|
|
virtual void SendDetachEntity (const cEntity & a_Entity, const cEntity & a_PreviousVehicle) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendDisconnect (const AString & a_Reason) override;
|
|
|
|
|
virtual void SendEditSign (int a_BlockX, int a_BlockY, int a_BlockZ) override; ///< Request the client to open up the sign editor for the sign (1.6+)
|
2021-04-09 22:17:01 +00:00
|
|
|
virtual void SendEntityAnimation (const cEntity & a_Entity, EntityAnimation a_Animation) override;
|
2018-08-26 14:52:39 +00:00
|
|
|
virtual void SendEntityEffect (const cEntity & a_Entity, int a_EffectID, int a_Amplifier, int a_Duration) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendEntityEquipment (const cEntity & a_Entity, short a_SlotNum, const cItem & a_Item) override;
|
|
|
|
|
virtual void SendEntityHeadLook (const cEntity & a_Entity) override;
|
|
|
|
|
virtual void SendEntityLook (const cEntity & a_Entity) override;
|
|
|
|
|
virtual void SendEntityMetadata (const cEntity & a_Entity) override;
|
2020-05-04 08:10:47 +00:00
|
|
|
virtual void SendEntityPosition (const cEntity & a_Entity) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendEntityProperties (const cEntity & a_Entity) override;
|
|
|
|
|
virtual void SendEntityVelocity (const cEntity & a_Entity) override;
|
2020-04-20 00:37:23 +00:00
|
|
|
virtual void SendExperience (void) override;
|
|
|
|
|
virtual void SendExperienceOrb (const cExpOrb & a_ExpOrb) override;
|
2020-09-12 18:57:44 +00:00
|
|
|
virtual void SendExplosion (Vector3f a_Position, float a_Power) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendGameMode (eGameMode a_GameMode) override;
|
|
|
|
|
virtual void SendHealth (void) override;
|
2018-07-22 22:23:33 +00:00
|
|
|
virtual void SendHeldItemChange (int a_ItemIndex) override;
|
2015-04-07 14:41:19 +00:00
|
|
|
virtual void SendHideTitle (void) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendInventorySlot (char a_WindowID, short a_SlotNum, const cItem & a_Item) override;
|
2015-07-29 15:04:03 +00:00
|
|
|
virtual void SendKeepAlive (UInt32 a_PingID) override;
|
2017-08-21 08:46:41 +00:00
|
|
|
virtual void SendLeashEntity (const cEntity & a_Entity, const cEntity & a_EntityLeashedTo) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendLogin (const cPlayer & a_Player, const cWorld & a_World) override;
|
|
|
|
|
virtual void SendLoginSuccess (void) override;
|
2015-06-30 14:50:15 +00:00
|
|
|
virtual void SendMapData (const cMap & a_Map, int a_DataStartX, int a_DataStartY) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendPaintingSpawn (const cPainting & a_Painting) override;
|
|
|
|
|
virtual void SendPlayerAbilities (void) override;
|
|
|
|
|
virtual void SendParticleEffect (const AString & a_ParticleName, float a_SrcX, float a_SrcY, float a_SrcZ, float a_OffsetX, float a_OffsetY, float a_OffsetZ, float a_ParticleData, int a_ParticleAmount) override;
|
2015-03-21 17:17:26 +00:00
|
|
|
virtual void SendParticleEffect (const AString & a_ParticleName, Vector3f a_Src, Vector3f a_Offset, float a_ParticleData, int a_ParticleAmount, std::array<int, 2> a_Data) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendPlayerListAddPlayer (const cPlayer & a_Player) override;
|
2021-02-03 23:33:17 +00:00
|
|
|
virtual void SendPlayerListHeaderFooter (const cCompositeChat & a_Header, const cCompositeChat & a_Footer) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendPlayerListRemovePlayer (const cPlayer & a_Player) override;
|
2021-03-05 15:08:30 +00:00
|
|
|
virtual void SendPlayerListUpdateDisplayName(const cPlayer & a_Player, const AString & a_CustomName) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendPlayerListUpdateGameMode (const cPlayer & a_Player) override;
|
2021-03-17 23:18:02 +00:00
|
|
|
virtual void SendPlayerListUpdatePing () override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendPlayerMoveLook (void) override;
|
|
|
|
|
virtual void SendPlayerPosition (void) override;
|
|
|
|
|
virtual void SendPlayerSpawn (const cPlayer & a_Player) override;
|
2021-01-11 16:39:43 +00:00
|
|
|
virtual void SendPluginMessage (const AString & a_Channel, ContiguousByteBufferView a_Message) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendRemoveEntityEffect (const cEntity & a_Entity, int a_EffectID) override;
|
2015-04-07 14:41:19 +00:00
|
|
|
virtual void SendResetTitle (void) override;
|
2020-04-07 21:23:54 +00:00
|
|
|
virtual void SendResourcePack (const AString & a_ResourcePackUrl) override;
|
2016-08-27 06:37:54 +00:00
|
|
|
virtual void SendRespawn (eDimension a_Dimension) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendSoundEffect (const AString & a_SoundName, double a_X, double a_Y, double a_Z, float a_Volume, float a_Pitch) override;
|
|
|
|
|
virtual void SendScoreboardObjective (const AString & a_Name, const AString & a_DisplayName, Byte a_Mode) override;
|
|
|
|
|
virtual void SendScoreUpdate (const AString & a_Objective, const AString & a_Player, cObjective::Score a_Score, Byte a_Mode) override;
|
|
|
|
|
virtual void SendDisplayObjective (const AString & a_Objective, cScoreboard::eDisplaySlot a_Display) override;
|
2015-04-07 14:41:19 +00:00
|
|
|
virtual void SendSetSubTitle (const cCompositeChat & a_SubTitle) override;
|
|
|
|
|
virtual void SendSetRawSubTitle (const AString & a_SubTitle) override;
|
|
|
|
|
virtual void SendSetTitle (const cCompositeChat & a_Title) override;
|
|
|
|
|
virtual void SendSetRawTitle (const AString & a_Title) override;
|
2015-11-23 23:39:19 +00:00
|
|
|
virtual void SendSoundParticleEffect (const EffectID a_EffectID, int a_SrcX, int a_SrcY, int a_SrcZ, int a_Data) override;
|
2020-04-20 19:46:04 +00:00
|
|
|
virtual void SendSpawnEntity (const cEntity & a_Entity) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendSpawnMob (const cMonster & a_Mob) override;
|
|
|
|
|
virtual void SendStatistics (const cStatManager & a_Manager) override;
|
|
|
|
|
virtual void SendTabCompletionResults (const AStringVector & a_Results) override;
|
|
|
|
|
virtual void SendThunderbolt (int a_BlockX, int a_BlockY, int a_BlockZ) override;
|
2015-04-07 14:41:19 +00:00
|
|
|
virtual void SendTitleTimes (int a_FadeInTicks, int a_DisplayTicks, int a_FadeOutTicks) override;
|
2021-04-05 00:38:43 +00:00
|
|
|
virtual void SendTimeUpdate (cTickTimeLong a_WorldAge, cTickTimeLong a_WorldDate, bool a_DoDaylightCycle) override;
|
2017-08-21 08:46:41 +00:00
|
|
|
virtual void SendUnleashEntity (const cEntity & a_Entity) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendUnloadChunk (int a_ChunkX, int a_ChunkZ) override;
|
|
|
|
|
virtual void SendUpdateBlockEntity (cBlockEntity & a_BlockEntity) override;
|
|
|
|
|
virtual void SendUpdateSign (int a_BlockX, int a_BlockY, int a_BlockZ, const AString & a_Line1, const AString & a_Line2, const AString & a_Line3, const AString & a_Line4) override;
|
2020-07-14 16:56:42 +00:00
|
|
|
virtual void SendUnlockRecipe (UInt32 a_RecipeID) override;
|
|
|
|
|
virtual void SendInitRecipes (UInt32 a_RecipeID) override;
|
2014-09-18 16:50:17 +00:00
|
|
|
virtual void SendWeather (eWeather a_Weather) override;
|
|
|
|
|
virtual void SendWholeInventory (const cWindow & a_Window) override;
|
|
|
|
|
virtual void SendWindowClose (const cWindow & a_Window) override;
|
|
|
|
|
virtual void SendWindowOpen (const cWindow & a_Window) override;
|
2020-10-02 13:22:17 +00:00
|
|
|
virtual void SendWindowProperty (const cWindow & a_Window, size_t a_Property, short a_Value) override;
|
2014-09-08 17:24:33 +00:00
|
|
|
|
|
|
|
|
virtual AString GetAuthServerID(void) override { return m_AuthServerID; }
|
2014-09-03 22:29:36 +00:00
|
|
|
|
2014-09-09 16:27:31 +00:00
|
|
|
/** Compress the packet. a_Packet must be without packet length.
|
2021-01-11 16:39:43 +00:00
|
|
|
a_Compressed will be set to the compressed packet includes packet length and data length. */
|
|
|
|
|
static void CompressPacket(CircularBufferCompressor & a_Packet, ContiguousByteBuffer & a_Compressed);
|
2014-09-09 16:27:31 +00:00
|
|
|
|
2014-09-03 22:29:36 +00:00
|
|
|
protected:
|
|
|
|
|
|
2020-09-12 20:08:23 +00:00
|
|
|
/** State of the protocol. */
|
|
|
|
|
State m_State;
|
|
|
|
|
|
2021-04-10 14:57:16 +00:00
|
|
|
/** Converts the BlockFace received by the protocol into eBlockFace constants.
|
|
|
|
|
If the received value doesn't match any of our eBlockFace constants, BLOCK_FACE_NONE is returned. */
|
|
|
|
|
static eBlockFace FaceIntToBlockFace(Int32 a_FaceInt);
|
2017-09-04 15:58:38 +00:00
|
|
|
|
2021-04-10 14:57:16 +00:00
|
|
|
/** Get the packet ID for a given packet. */
|
|
|
|
|
virtual UInt32 GetPacketID(ePacketType a_Packet) const override;
|
2020-07-18 17:57:23 +00:00
|
|
|
|
2021-04-09 22:17:01 +00:00
|
|
|
/** Converts an animation into an ID suitable for use with the Entity Animation packet.
|
|
|
|
|
Returns (uchar)-1 if the protocol version doesn't support this animation. */
|
|
|
|
|
virtual unsigned char GetProtocolEntityAnimation(EntityAnimation a_Animation) const;
|
|
|
|
|
|
|
|
|
|
/** Converts an animation into an ID suitable for use with the Entity Status packet.
|
|
|
|
|
Returns -1 if the protocol version doesn't support this animation. */
|
|
|
|
|
virtual signed char GetProtocolEntityStatus(EntityAnimation a_Animation) const;
|
|
|
|
|
|
2020-03-29 15:54:37 +00:00
|
|
|
/** Converts eMonsterType to protocol-specific mob types */
|
2021-04-10 14:57:16 +00:00
|
|
|
virtual UInt32 GetProtocolMobType(eMonsterType a_MobType) const;
|
|
|
|
|
|
|
|
|
|
/** Returns the protocol version. */
|
|
|
|
|
virtual Version GetProtocolVersion() const override;
|
2020-03-29 15:54:37 +00:00
|
|
|
|
2014-09-08 17:24:33 +00:00
|
|
|
/** Reads and handles the packet. The packet length and type have already been read.
|
2021-04-09 22:17:01 +00:00
|
|
|
Returns true if the packet was understood, false if it was an unknown packet. */
|
2020-04-20 00:37:23 +00:00
|
|
|
virtual bool HandlePacket(cByteBuffer & a_ByteBuffer, UInt32 a_PacketType);
|
2014-09-08 17:24:33 +00:00
|
|
|
|
|
|
|
|
// Packet handlers while in the Status state (m_State == 1):
|
2020-04-20 00:37:23 +00:00
|
|
|
virtual void HandlePacketStatusPing(cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketStatusRequest(cByteBuffer & a_ByteBuffer);
|
2014-09-04 01:22:35 +00:00
|
|
|
|
2014-09-08 17:24:33 +00:00
|
|
|
// Packet handlers while in the Login state (m_State == 2):
|
2020-04-20 00:37:23 +00:00
|
|
|
virtual void HandlePacketLoginEncryptionResponse(cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketLoginStart(cByteBuffer & a_ByteBuffer);
|
2016-02-05 21:45:45 +00:00
|
|
|
|
2014-09-04 01:22:35 +00:00
|
|
|
// Packet handlers while in the Game state (m_State == 3):
|
2020-04-20 00:37:23 +00:00
|
|
|
virtual void HandlePacketAnimation (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketBlockDig (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketBlockPlace (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketChatMessage (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketClientSettings (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketClientStatus (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketCreativeInventoryAction(cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketEntityAction (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketKeepAlive (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketPlayer (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketPlayerAbilities (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketPlayerLook (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketPlayerPos (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketPlayerPosLook (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketPluginMessage (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketResourcePackStatus (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketSlotSelect (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketSpectate (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketSteerVehicle (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketTabComplete (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketUpdateSign (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketUseEntity (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketEnchantItem (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketWindowClick (cByteBuffer & a_ByteBuffer);
|
|
|
|
|
virtual void HandlePacketWindowClose (cByteBuffer & a_ByteBuffer);
|
2016-02-05 21:45:45 +00:00
|
|
|
|
2014-09-30 11:33:57 +00:00
|
|
|
/** Parses Vanilla plugin messages into specific ClientHandle calls.
|
|
|
|
|
The message payload is still in the bytebuffer, the handler reads it specifically for each handled channel */
|
2020-04-20 00:37:23 +00:00
|
|
|
virtual void HandleVanillaPluginMessage(cByteBuffer & a_ByteBuffer, const AString & a_Channel);
|
2016-02-05 21:45:45 +00:00
|
|
|
|
2021-04-10 14:57:16 +00:00
|
|
|
/** Parses item metadata as read by ReadItem(), into the item enchantments. */
|
|
|
|
|
virtual void ParseItemMetadata(cItem & a_Item, ContiguousByteBufferView a_Metadata) const;
|
2015-03-22 18:46:08 +00:00
|
|
|
|
2014-09-25 18:34:49 +00:00
|
|
|
/** Reads an item out of the received data, sets a_Item to the values read.
|
|
|
|
|
Returns false if not enough received data.
|
|
|
|
|
a_KeepRemainingBytes tells the function to keep that many bytes at the end of the buffer. */
|
2021-04-10 14:57:16 +00:00
|
|
|
virtual bool ReadItem(cByteBuffer & a_ByteBuffer, cItem & a_Item, size_t a_KeepRemainingBytes = 0) const;
|
2015-03-22 18:46:08 +00:00
|
|
|
|
2020-05-04 08:10:47 +00:00
|
|
|
/** Sends the entity type and entity-dependent data required for the entity to initially spawn. */
|
|
|
|
|
virtual void SendEntitySpawn(const cEntity & a_Entity, const UInt8 a_ObjectType, const Int32 a_ObjectData);
|
|
|
|
|
|
2021-04-10 14:57:16 +00:00
|
|
|
/** Sends the data to the client, encrypting them if needed. */
|
|
|
|
|
virtual void SendData(ContiguousByteBufferView a_Size) override;
|
2021-03-15 17:06:58 +00:00
|
|
|
|
2021-04-10 14:57:16 +00:00
|
|
|
/** Sends the packet to the client. Called by the cPacketizer's destructor. */
|
|
|
|
|
virtual void SendPacket(cPacketizer & a_Packet) override;
|
2015-03-22 18:46:08 +00:00
|
|
|
|
2021-04-10 14:57:16 +00:00
|
|
|
/** Writes the block entity data for the specified block entity into the packet. */
|
|
|
|
|
virtual void WriteBlockEntity(cFastNBTWriter & a_Writer, const cBlockEntity & a_BlockEntity) const;
|
2015-03-22 18:46:08 +00:00
|
|
|
|
2021-04-10 14:57:16 +00:00
|
|
|
/** Writes the metadata for the specified entity, not including the terminating 0x7f. */
|
|
|
|
|
virtual void WriteEntityMetadata(cPacketizer & a_Pkt, const cEntity & a_Entity) const;
|
2015-03-22 18:46:08 +00:00
|
|
|
|
|
|
|
|
/** Writes the entity properties for the specified entity, including the Count field. */
|
2021-04-10 14:57:16 +00:00
|
|
|
virtual void WriteEntityProperties(cPacketizer & a_Pkt, const cEntity & a_Entity) const;
|
|
|
|
|
|
|
|
|
|
/** Writes the item data into a packet. */
|
|
|
|
|
virtual void WriteItem(cPacketizer & a_Pkt, const cItem & a_Item) const;
|
|
|
|
|
|
|
|
|
|
/** Writes the mob-specific metadata for the specified mob */
|
|
|
|
|
virtual void WriteMobMetadata(cPacketizer & a_Pkt, const cMonster & a_Mob) const;
|
2015-03-22 18:46:08 +00:00
|
|
|
|
2020-04-20 19:46:04 +00:00
|
|
|
private:
|
|
|
|
|
|
2020-09-12 20:08:23 +00:00
|
|
|
AString m_ServerAddress;
|
|
|
|
|
|
|
|
|
|
AString m_AuthServerID;
|
|
|
|
|
|
|
|
|
|
bool m_IsEncrypted;
|
|
|
|
|
|
|
|
|
|
cAesCfb128Decryptor m_Decryptor;
|
|
|
|
|
cAesCfb128Encryptor m_Encryptor;
|
|
|
|
|
|
2021-01-11 16:39:43 +00:00
|
|
|
CircularBufferCompressor m_Compressor;
|
|
|
|
|
CircularBufferExtractor m_Extractor;
|
|
|
|
|
|
2020-09-12 20:08:23 +00:00
|
|
|
/** The logfile where the comm is logged, when g_ShouldLogComm is true */
|
|
|
|
|
cFile m_CommLogFile;
|
|
|
|
|
|
2021-03-08 16:37:36 +00:00
|
|
|
/** Adds the received (unencrypted) data to m_ReceivedData, parses complete packets */
|
|
|
|
|
void AddReceivedData(cByteBuffer & a_Buffer, ContiguousByteBufferView a_Data);
|
|
|
|
|
|
2020-04-20 19:46:04 +00:00
|
|
|
/** Converts an entity to a protocol-specific entity type.
|
|
|
|
|
Only entities that the Send Spawn Entity packet supports are valid inputs to this method */
|
2020-08-12 08:54:36 +00:00
|
|
|
static UInt8 GetProtocolEntityType(const cEntity & a_Entity);
|
|
|
|
|
|
2021-04-09 22:17:01 +00:00
|
|
|
/** The 1.8 protocol use a particle id instead of a string. This function converts the name to the id. If the name is incorrect, it returns 0. */
|
|
|
|
|
static int GetProtocolParticleID(const AString & a_ParticleName);
|
|
|
|
|
|
2020-08-12 08:54:36 +00:00
|
|
|
/** Converts a statistic to a protocol-specific string.
|
|
|
|
|
Protocols <= 1.12 use strings, hence this is a static as the string-mapping was append-only for the versions that used it.
|
|
|
|
|
Returns an empty string, handled correctly by the client, for newer, unsupported statistics. */
|
|
|
|
|
static const char * GetProtocolStatisticName(Statistic a_Statistic);
|
2021-04-10 14:57:16 +00:00
|
|
|
|
|
|
|
|
/** Handle a complete packet stored in the given buffer. */
|
|
|
|
|
void HandlePacket(cByteBuffer & a_Buffer);
|
|
|
|
|
|
|
|
|
|
/** Sends an entity teleport packet.
|
|
|
|
|
Mitigates a 1.8 bug where the position in the entity spawn packet is ignored,
|
|
|
|
|
and so entities don't show up until a teleport is sent. */
|
|
|
|
|
void SendEntityTeleport(const cEntity & a_Entity);
|
|
|
|
|
|
|
|
|
|
void StartEncryption(const Byte * a_Key);
|
2014-09-08 17:24:33 +00:00
|
|
|
} ;
|
