Protocol_1_12.cpp

Go to the documentation of this file.

// Protocol_1_12.cpp

/*
Implements the 1.12 protocol classes:
- release 1.12 protocol (#335)
*/

#include "Globals.h"
#include "Protocol_1_12.h"
#include "ProtocolRecognizer.h"
#include "Packetizer.h"

#include "../Entities/Boat.h"
#include "../Entities/Minecart.h"
#include "../Entities/Pickup.h"
#include "../Entities/Player.h"
#include "../Entities/ItemFrame.h"
#include "../Entities/ArrowEntity.h"
#include "../Entities/FireworkEntity.h"
#include "../Entities/SplashPotionEntity.h"

#include "../Mobs/IncludeAllMonsters.h"

#include "../Root.h"
#include "../Server.h"
#include "../ClientHandle.h"
#include "../Bindings/PluginManager.h"





// The disabled error is intended, since the Metadata have overlapping indexes
// based on the type of the Entity.
//
// IMPORTANT: The enum is used to automate the sequential counting of the
// Metadata indexes. Adding a new enum value causes the following values to
// increase their index. Therefore the ordering of the enum values is VERY important!
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wduplicate-enum"
#endif

namespace Metadata
{
    enum Metadata_Index
    {
        // Entity
        ENTITY_FLAGS,
        ENTITY_AIR,
        ENTITY_CUSTOM_NAME,
        ENTITY_CUSTOM_NAME_VISIBLE,
        ENTITY_SILENT,
        ENTITY_NO_GRAVITY,
        _ENTITY_NEXT,  // Used by descendants

        // Potion
        POTION_THROWN = _ENTITY_NEXT,

        // FallingBlock
        FALLING_BLOCK_POSITION = _ENTITY_NEXT,

        // AreaEffectCloud
        AREA_EFFECT_CLOUD_RADIUS = _ENTITY_NEXT,
        AREA_EFFECT_CLOUD_COLOR,
        AREA_EFFECT_CLOUD_SINGLE_POINT_EFFECT,
        AREA_EFFECT_CLOUD_PARTICLE_ID,
        AREA_EFFECT_CLOUD_PARTICLE_PARAMETER1,
        AREA_EFFECT_CLOUD_PARTICLE_PARAMETER2,

        // Arrow
        ARROW_CRITICAL = _ENTITY_NEXT,
        _ARROW_NEXT,

        // TippedArrow
        TIPPED_ARROW_COLOR = _ARROW_NEXT,

        // Boat
        BOAT_LAST_HIT_TIME = _ENTITY_NEXT,
        BOAT_FORWARD_DIRECTION,
        BOAT_DAMAGE_TAKEN,
        BOAT_TYPE,
        BOAT_RIGHT_PADDLE_TURNING,
        BOAT_LEFT_PADDLE_TURNING,

        // EnderCrystal
        ENDER_CRYSTAL_BEAM_TARGET = _ENTITY_NEXT,
        ENDER_CRYSTAL_SHOW_BOTTOM,

        // Fireball
        _FIREBALL_NEXT = _ENTITY_NEXT,

        // WitherSkull
        WITHER_SKULL_INVULNERABLE = _FIREBALL_NEXT,

        // Fireworks
        FIREWORK_INFO = _ENTITY_NEXT,
        FIREWORK_BOOSTED_ENTITY_ID,  // 1.11.1 only

        // Hanging
        _HANGING_NEXT = _ENTITY_NEXT,

        // ItemFrame
        ITEM_FRAME_ITEM = _HANGING_NEXT,
        ITEM_FRAME_ROTATION,

        // Item
        ITEM_ITEM = _ENTITY_NEXT,

        // Living
        LIVING_ACTIVE_HAND = _ENTITY_NEXT,
        LIVING_HEALTH,
        LIVING_POTION_EFFECT_COLOR,
        LIVING_POTION_EFFECT_AMBIENT,
        LIVING_NUMBER_OF_ARROWS,
        _LIVING_NEXT,

        // Player
        PLAYER_ADDITIONAL_HEARTHS = _LIVING_NEXT,
        PLAYER_SCORE,
        PLAYER_DISPLAYED_SKIN_PARTS,
        PLAYER_MAIN_HAND,

        // ArmorStand
        ARMOR_STAND_STATUS = _LIVING_NEXT,
        ARMOR_STAND_HEAD_ROTATION,
        ARMOR_STAND_BODY_ROTATION,
        ARMOR_STAND_LEFT_ARM_ROTATION,
        ARMOR_STAND_RIGHT_ARM_ROTATION,
        ARMOR_STAND_LEFT_LEG_ROTATION,
        ARMOR_STAND_RIGHT_LEG_ROTATION,

        // Insentient
        INSENTIENT_STATUS = _LIVING_NEXT,
        _INSENTIENT_NEXT,

        // Ambient
        _AMBIENT_NEXT = _INSENTIENT_NEXT,

        // Bat
        BAT_HANGING = _AMBIENT_NEXT,

        // Creature
        _CREATURE_NEXT = _INSENTIENT_NEXT,

        // Ageable
        AGEABLE_BABY = _CREATURE_NEXT,
        _AGEABLE_NEXT,

        // PolarBear
        POLAR_BEAR_STANDING = _AGEABLE_NEXT,

        // Animal
        _ANIMAL_NEXT = _AGEABLE_NEXT,

        // Abstract horse
        ABSTRACT_HORSE_STATUS = _ANIMAL_NEXT,
        ABSTRACT_HORSE_OWNER,
        _ABSTRACT_HORSE_NEXT,

        // Horse
        HORSE_VARIANT = _ABSTRACT_HORSE_NEXT,
        HORSE_ARMOR,

        // Chested horse
        CHESTED_HORSE_CHESTED = _ABSTRACT_HORSE_NEXT,
        _CHESTED_HORSE_NEXT,

        // Llama
        LLAMA_STRENGTH = _CHESTED_HORSE_NEXT,
        LLAMA_CARPET_COLOR,
        LLAMA_VARIANT,

        // Pig
        PIG_HAS_SADDLE = _ANIMAL_NEXT,
        PIG_TOTAL_CARROT_ON_A_STICK_BOOST,  // 1.11.1 only

        // Rabbit
        RABBIT_TYPE = _ANIMAL_NEXT,

        // Sheep
        SHEEP_STATUS = _ANIMAL_NEXT,

        // TameableAnimal
        TAMEABLE_ANIMAL_STATUS = _ANIMAL_NEXT,
        TAMEABLE_ANIMAL_OWNER,
        _TAMEABLE_NEXT,

        // Ocelot
        OCELOT_TYPE = _TAMEABLE_NEXT,

        // Wolf
        WOLF_DAMAGE_TAKEN = _TAMEABLE_NEXT,
        WOLF_BEGGING,
        WOLF_COLLAR_COLOR,

        // Villager
        VILLAGER_PROFESSION = _AGEABLE_NEXT,

        // Golem
        _GOLEM_NEXT = _CREATURE_NEXT,

        // IronGolem
        IRON_GOLEM_PLAYER_CREATED = _GOLEM_NEXT,

        // Shulker
        SHULKER_FACING_DIRECTION = _GOLEM_NEXT,
        SHULKER_ATTACHMENT_FALLING_BLOCK_POSITION,
        SHULKER_SHIELD_HEIGHT,

        // Monster
        _MONSTER_NEXT = _CREATURE_NEXT,

        // Blaze
        BLAZE_ON_FIRE = _MONSTER_NEXT,

        // Creeper
        CREEPER_STATE = _MONSTER_NEXT,
        CREEPER_POWERED,
        CREEPER_IGNITED,

        // Guardian
        GUARDIAN_STATUS = _MONSTER_NEXT,
        GUARDIAN_TARGET,

        // Abstract Skeleton
        ABSTRACT_SKELETON_ARMS_SWINGING = _MONSTER_NEXT,

        // Spider
        SPIDER_CLIMBING = _MONSTER_NEXT,

        // Witch
        WITCH_AGGRESIVE = _MONSTER_NEXT,

        // Wither
        WITHER_FIRST_HEAD_TARGET = _MONSTER_NEXT,
        WITHER_SECOND_HEAD_TARGET,
        WITHER_THIRD_HEAD_TARGET,
        WITHER_INVULNERABLE_TIMER,

        // Zombie
        ZOMBIE_IS_BABY = _MONSTER_NEXT,
        ZOMBIE_UNUSED,  // Was type
        ZOMBIE_HANDS_RISED_UP,
        _ZOMBIE_NEXT,

        // Zombie villager
        ZOMBIE_VILLAGER_CONVERTING = _ZOMBIE_NEXT,
        ZOMBIE_VILLAGER_PROFESSION,

        // Enderman
        ENDERMAN_CARRIED_BLOCK = _MONSTER_NEXT,
        ENDERMAN_SCREAMING,

        // Evocation illager
        EVOKER_SPELL = _MONSTER_NEXT,

        // Vex
        VEX_FLAGS = _MONSTER_NEXT,

        // Vindication illager
        VINDICATOR_FLAGS = _MONSTER_NEXT,

        // EnderDragon
        ENDER_DRAGON_DRAGON_PHASE = _INSENTIENT_NEXT,

        // Flying
        _FLYING_NEXT = _INSENTIENT_NEXT,

        // Ghast
        GHAST_ATTACKING = _FLYING_NEXT,

        // Slime
        SLIME_SIZE = _INSENTIENT_NEXT,

        // Minecart
        MINECART_SHAKING_POWER = _ENTITY_NEXT,
        MINECART_SHAKING_DIRECTION,
        MINECART_SHAKING_MULTIPLIER,
        MINECART_BLOCK_ID_META,
        MINECART_BLOCK_Y,
        MINECART_SHOW_BLOCK,
        _MINECART_NEXT,

        // MinecartCommandBlock
        MINECART_COMMAND_BLOCK_COMMAND = _MINECART_NEXT,
        MINECART_COMMAND_BLOCK_LAST_OUTPUT,

        // MinecartFurnace
        MINECART_FURNACE_POWERED = _MINECART_NEXT,

        // TNTPrimed
        TNT_PRIMED_FUSE_TIME = _ENTITY_NEXT,
    };
}

#ifdef __clang__
#pragma clang diagnostic pop  // Restore ignored clang errors
#endif





#define HANDLE_READ(ByteBuf, Proc, Type, Var) \
    Type Var; \
    do { \
        if (!ByteBuf.Proc(Var))\
        {\
            return;\
        } \
    } while (false)





cProtocol_1_12::cProtocol_1_12(cClientHandle * a_Client, const AString & a_ServerAddress, UInt16 a_ServerPort, UInt32 a_State) :
    Super(a_Client, a_ServerAddress, a_ServerPort, a_State)
{
}





void cProtocol_1_12::SendSpawnMob(const cMonster & a_Mob)
{
    ASSERT(m_State == 3);  // In game mode?

    cPacketizer Pkt(*this, pktSpawnMob);
    Pkt.WriteVarInt32(a_Mob.GetUniqueID());
    // TODO: Bad way to write a UUID, and it's not a true UUID, but this is functional for now.
    Pkt.WriteBEUInt64(0);
    Pkt.WriteBEUInt64(a_Mob.GetUniqueID());
    Pkt.WriteVarInt32(static_cast<UInt32>(a_Mob.GetMobType()));
    Pkt.WriteBEDouble(a_Mob.GetPosX());
    Pkt.WriteBEDouble(a_Mob.GetPosY());
    Pkt.WriteBEDouble(a_Mob.GetPosZ());
    Pkt.WriteByteAngle(a_Mob.GetPitch());
    Pkt.WriteByteAngle(a_Mob.GetHeadYaw());
    Pkt.WriteByteAngle(a_Mob.GetYaw());
    Pkt.WriteBEInt16(static_cast<Int16>(a_Mob.GetSpeedX() * 400));
    Pkt.WriteBEInt16(static_cast<Int16>(a_Mob.GetSpeedY() * 400));
    Pkt.WriteBEInt16(static_cast<Int16>(a_Mob.GetSpeedZ() * 400));
    WriteEntityMetadata(Pkt, a_Mob);
    Pkt.WriteBEUInt8(0xff);  // Metadata terminator
}





void cProtocol_1_12::HandlePacketBlockPlace(cByteBuffer & a_ByteBuffer)
{
    int BlockX, BlockY, BlockZ;
    if (!a_ByteBuffer.ReadPosition64(BlockX, BlockY, BlockZ))
    {
        return;
    }

    HANDLE_READ(a_ByteBuffer, ReadVarInt, Int32, Face);
    HANDLE_READ(a_ByteBuffer, ReadVarInt, Int32, Hand);
    HANDLE_READ(a_ByteBuffer, ReadBEFloat, float, CursorX);
    HANDLE_READ(a_ByteBuffer, ReadBEFloat, float, CursorY);
    HANDLE_READ(a_ByteBuffer, ReadBEFloat, float, CursorZ);
    m_Client->HandleRightClick(BlockX, BlockY, BlockZ, FaceIntToBlockFace(Face), FloorC(CursorX * 16), FloorC(CursorY * 16), FloorC(CursorZ * 16), HandIntToEnum(Hand));
}





void cProtocol_1_12::HandlePacketStatusRequest(cByteBuffer & a_ByteBuffer)
{
    cServer * Server = cRoot::Get()->GetServer();
    AString ServerDescription = Server->GetDescription();
    auto NumPlayers = static_cast<signed>(Server->GetNumPlayers());
    auto MaxPlayers = static_cast<signed>(Server->GetMaxPlayers());
    AString Favicon = Server->GetFaviconData();
    cRoot::Get()->GetPluginManager()->CallHookServerPing(*m_Client, ServerDescription, NumPlayers, MaxPlayers, Favicon);

    // Version:
    Json::Value Version;
    Version["name"] = "Cuberite 1.12";
    Version["protocol"] = cProtocolRecognizer::PROTO_VERSION_1_12;

    // Players:
    Json::Value Players;
    Players["online"] = NumPlayers;
    Players["max"] = MaxPlayers;
    // TODO: Add "sample"

    // Description:
    Json::Value Description;
    Description["text"] = ServerDescription.c_str();

    // Create the response:
    Json::Value ResponseValue;
    ResponseValue["version"] = Version;
    ResponseValue["players"] = Players;
    ResponseValue["description"] = Description;
    m_Client->ForgeAugmentServerListPing(ResponseValue);
    if (!Favicon.empty())
    {
        ResponseValue["favicon"] = Printf("data:image/png;base64,%s", Favicon.c_str());
    }

    // Serialize the response into a packet:
    Json::FastWriter Writer;
    cPacketizer Pkt(*this, pktStatusResponse);
    Pkt.WriteString(Writer.write(ResponseValue));
}





void cProtocol_1_12::WriteEntityMetadata(cPacketizer & a_Pkt, const cEntity & a_Entity)
{
    using namespace Metadata;

    // Common metadata:
    Int8 Flags = 0;
    if (a_Entity.IsOnFire())
    {
        Flags |= 0x01;
    }
    if (a_Entity.IsCrouched())
    {
        Flags |= 0x02;
    }
    if (a_Entity.IsSprinting())
    {
        Flags |= 0x08;
    }
    if (a_Entity.IsRclking())
    {
        Flags |= 0x10;
    }
    if (a_Entity.IsInvisible())
    {
        Flags |= 0x20;
    }
    a_Pkt.WriteBEUInt8(ENTITY_FLAGS);  // Index
    a_Pkt.WriteBEUInt8(METADATA_TYPE_BYTE);  // Type
    a_Pkt.WriteBEInt8(Flags);

    switch (a_Entity.GetEntityType())
    {
        case cEntity::etPlayer:
        {
            auto & Player = static_cast<const cPlayer &>(a_Entity);

            // TODO Set player custom name to their name.
            // Then it's possible to move the custom name of mobs to the entities
            // and to remove the "special" player custom name.
            a_Pkt.WriteBEUInt8(ENTITY_CUSTOM_NAME);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_STRING);
            a_Pkt.WriteString(Player.GetName());

            a_Pkt.WriteBEUInt8(LIVING_HEALTH);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_FLOAT);
            a_Pkt.WriteBEFloat(static_cast<float>(Player.GetHealth()));

            a_Pkt.WriteBEUInt8(PLAYER_DISPLAYED_SKIN_PARTS);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BYTE);
            a_Pkt.WriteBEUInt8(static_cast<UInt8>(Player.GetSkinParts()));

            a_Pkt.WriteBEUInt8(PLAYER_MAIN_HAND);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BYTE);
            a_Pkt.WriteBEUInt8(static_cast<UInt8>(Player.GetMainHand()));
            break;
        }
        case cEntity::etPickup:
        {
            a_Pkt.WriteBEUInt8(ITEM_ITEM);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_ITEM);
            WriteItem(a_Pkt, static_cast<const cPickup &>(a_Entity).GetItem());
            break;
        }
        case cEntity::etMinecart:
        {
            a_Pkt.WriteBEUInt8(MINECART_SHAKING_POWER);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);

            // The following expression makes Minecarts shake more with less health or higher damage taken
            auto & Minecart = static_cast<const cMinecart &>(a_Entity);
            auto maxHealth = a_Entity.GetMaxHealth();
            auto curHealth = a_Entity.GetHealth();
            a_Pkt.WriteVarInt32(static_cast<UInt32>((maxHealth - curHealth) * Minecart.LastDamage() * 4));

            a_Pkt.WriteBEUInt8(MINECART_SHAKING_DIRECTION);  // (doesn't seem to effect anything)
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(1);

            a_Pkt.WriteBEUInt8(MINECART_SHAKING_MULTIPLIER);  // or damage taken
            a_Pkt.WriteBEUInt8(METADATA_TYPE_FLOAT);
            a_Pkt.WriteBEFloat(static_cast<float>(Minecart.LastDamage() + 10));

            if (Minecart.GetPayload() == cMinecart::mpNone)
            {
                auto & RideableMinecart = static_cast<const cRideableMinecart &>(Minecart);
                const cItem & MinecartContent = RideableMinecart.GetContent();
                if (!MinecartContent.IsEmpty())
                {
                    a_Pkt.WriteBEUInt8(MINECART_BLOCK_ID_META);
                    a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
                    int Content = MinecartContent.m_ItemType;
                    Content |= MinecartContent.m_ItemDamage << 8;
                    a_Pkt.WriteVarInt32(static_cast<UInt32>(Content));

                    a_Pkt.WriteBEUInt8(MINECART_BLOCK_Y);
                    a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
                    a_Pkt.WriteVarInt32(static_cast<UInt32>(RideableMinecart.GetBlockHeight()));

                    a_Pkt.WriteBEUInt8(MINECART_SHOW_BLOCK);
                    a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
                    a_Pkt.WriteBool(true);
                }
            }
            else if (Minecart.GetPayload() == cMinecart::mpFurnace)
            {
                a_Pkt.WriteBEUInt8(MINECART_FURNACE_POWERED);
                a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
                a_Pkt.WriteBool(static_cast<const cMinecartWithFurnace &>(Minecart).IsFueled());
            }
            break;
        }  // case etMinecart

        case cEntity::etProjectile:
        {
            auto & Projectile = static_cast<const cProjectileEntity &>(a_Entity);
            switch (Projectile.GetProjectileKind())
            {
                case cProjectileEntity::pkArrow:
                {
                    a_Pkt.WriteBEUInt8(ARROW_CRITICAL);
                    a_Pkt.WriteBEUInt8(METADATA_TYPE_BYTE);
                    a_Pkt.WriteBEInt8(static_cast<const cArrowEntity &>(Projectile).IsCritical() ? 1 : 0);
                    break;
                }
                case cProjectileEntity::pkFirework:
                {
                    a_Pkt.WriteBEUInt8(FIREWORK_INFO);  // Firework item used for this firework
                    a_Pkt.WriteBEUInt8(METADATA_TYPE_ITEM);
                    WriteItem(a_Pkt, static_cast<const cFireworkEntity &>(Projectile).GetItem());

                    // FIREWORK_BOOSTED_ENTITY_ID, in 1.11.1 only
                    break;
                }
                case cProjectileEntity::pkSplashPotion:
                {
                    a_Pkt.WriteBEUInt8(POTION_THROWN);  // Potion item which was thrown
                    a_Pkt.WriteBEUInt8(METADATA_TYPE_ITEM);
                    WriteItem(a_Pkt, static_cast<const cSplashPotionEntity &>(Projectile).GetItem());
                }
                default:
                {
                    break;
                }
            }
            break;
        }  // case etProjectile

        case cEntity::etMonster:
        {
            WriteMobMetadata(a_Pkt, static_cast<const cMonster &>(a_Entity));
            break;
        }

        case cEntity::etBoat:
        {
            auto & Boat = static_cast<const cBoat &>(a_Entity);

            a_Pkt.WriteBEInt8(BOAT_LAST_HIT_TIME);
            a_Pkt.WriteBEInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(static_cast<UInt32>(Boat.GetLastDamage()));

            a_Pkt.WriteBEInt8(BOAT_FORWARD_DIRECTION);
            a_Pkt.WriteBEInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(static_cast<UInt32>(Boat.GetForwardDirection()));

            a_Pkt.WriteBEInt8(BOAT_DAMAGE_TAKEN);
            a_Pkt.WriteBEInt8(METADATA_TYPE_FLOAT);
            a_Pkt.WriteBEFloat(Boat.GetDamageTaken());

            a_Pkt.WriteBEInt8(BOAT_TYPE);
            a_Pkt.WriteBEInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(static_cast<UInt32>(Boat.GetMaterial()));

            a_Pkt.WriteBEInt8(BOAT_RIGHT_PADDLE_TURNING);
            a_Pkt.WriteBEInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Boat.IsRightPaddleUsed());

            a_Pkt.WriteBEInt8(BOAT_LEFT_PADDLE_TURNING);
            a_Pkt.WriteBEInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Boat.IsLeftPaddleUsed());

            break;
        }  // case etBoat

        case cEntity::etItemFrame:
        {
            auto & Frame = static_cast<const cItemFrame &>(a_Entity);
            a_Pkt.WriteBEUInt8(ITEM_FRAME_ITEM);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_ITEM);
            WriteItem(a_Pkt, Frame.GetItem());
            a_Pkt.WriteBEUInt8(ITEM_FRAME_ROTATION);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(Frame.GetItemRotation());
            break;
        }  // case etItemFrame

        default:
        {
            break;
        }
    }
}





void cProtocol_1_12::WriteMobMetadata(cPacketizer & a_Pkt, const cMonster & a_Mob)
{
    using namespace Metadata;

    // Living Enitiy Metadata
    if (a_Mob.HasCustomName())
    {
        // TODO: As of 1.9 _all_ entities can have custom names; should this be moved up?
        a_Pkt.WriteBEUInt8(ENTITY_CUSTOM_NAME);
        a_Pkt.WriteBEUInt8(METADATA_TYPE_STRING);
        a_Pkt.WriteString(a_Mob.GetCustomName());

        a_Pkt.WriteBEUInt8(ENTITY_CUSTOM_NAME_VISIBLE);  // Custom name always visible
        a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
        a_Pkt.WriteBool(a_Mob.IsCustomNameAlwaysVisible());
    }

    a_Pkt.WriteBEUInt8(LIVING_HEALTH);
    a_Pkt.WriteBEUInt8(METADATA_TYPE_FLOAT);
    a_Pkt.WriteBEFloat(static_cast<float>(a_Mob.GetHealth()));

    switch (a_Mob.GetMobType())
    {
        case mtBat:
        {
            auto & Bat = static_cast<const cBat &>(a_Mob);
            a_Pkt.WriteBEUInt8(BAT_HANGING);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BYTE);
            a_Pkt.WriteBEInt8(Bat.IsHanging() ? 1 : 0);
            break;
        }  // case mtBat

        case mtChicken:
        {
            auto & Chicken = static_cast<const cChicken &>(a_Mob);

            a_Pkt.WriteBEUInt8(AGEABLE_BABY);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Chicken.IsBaby());
            break;
        }  // case mtChicken

        case mtCow:
        {
            auto & Cow = static_cast<const cCow &>(a_Mob);

            a_Pkt.WriteBEUInt8(AGEABLE_BABY);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Cow.IsBaby());
            break;
        }  // case mtCow

        case mtCreeper:
        {
            auto & Creeper = static_cast<const cCreeper &>(a_Mob);
            a_Pkt.WriteBEUInt8(CREEPER_STATE);  // (idle or "blowing")
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(Creeper.IsBlowing() ? 1 : static_cast<UInt32>(-1));

            a_Pkt.WriteBEUInt8(CREEPER_POWERED);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Creeper.IsCharged());

            a_Pkt.WriteBEUInt8(CREEPER_IGNITED);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Creeper.IsBurnedWithFlintAndSteel());
            break;
        }  // case mtCreeper

        case mtEnderman:
        {
            auto & Enderman = static_cast<const cEnderman &>(a_Mob);
            a_Pkt.WriteBEUInt8(ENDERMAN_CARRIED_BLOCK);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BLOCKID);
            UInt32 Carried = 0;
            Carried |= static_cast<UInt32>(Enderman.GetCarriedBlock() << 4);
            Carried |= Enderman.GetCarriedMeta();
            a_Pkt.WriteVarInt32(Carried);

            a_Pkt.WriteBEUInt8(ENDERMAN_SCREAMING);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Enderman.IsScreaming());
            break;
        }  // case mtEnderman

        case mtGhast:
        {
            auto & Ghast = static_cast<const cGhast &>(a_Mob);
            a_Pkt.WriteBEUInt8(GHAST_ATTACKING);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Ghast.IsCharging());
            break;
        }  // case mtGhast

        case mtHorse:
        {
            // XXX This behaves incorrectly with different varients; horses have different entity IDs now

            // Abstract horse
            auto & Horse = static_cast<const cHorse &>(a_Mob);
            Int8 Flags = 0;
            if (Horse.IsTame())
            {
                Flags |= 0x02;
            }
            if (Horse.IsSaddled())
            {
                Flags |= 0x04;
            }
            if (Horse.IsChested())
            {
                Flags |= 0x08;
            }
            if (Horse.IsEating())
            {
                Flags |= 0x20;
            }
            if (Horse.IsRearing())
            {
                Flags |= 0x40;
            }
            if (Horse.IsMthOpen())
            {
                Flags |= 0x80;
            }
            a_Pkt.WriteBEUInt8(ABSTRACT_HORSE_STATUS);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BYTE);
            a_Pkt.WriteBEInt8(Flags);

            // This doesn't exist any more; it'll cause horses to all be the normal type
            // a_Pkt.WriteBEUInt8(HORSE_TYPE);
            // a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            // a_Pkt.WriteVarInt32(static_cast<UInt32>(Horse.GetHorseType()));

            // Regular horses
            a_Pkt.WriteBEUInt8(HORSE_VARIANT);  // Color / style
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            int Appearance = 0;
            Appearance = Horse.GetHorseColor();
            Appearance |= Horse.GetHorseStyle() << 8;
            a_Pkt.WriteVarInt32(static_cast<UInt32>(Appearance));

            a_Pkt.WriteBEUInt8(HORSE_ARMOR);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(static_cast<UInt32>(Horse.GetHorseArmour()));

            a_Pkt.WriteBEUInt8(AGEABLE_BABY);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Horse.IsBaby());
            break;
        }  // case mtHorse

        case mtMagmaCube:
        {
            auto & MagmaCube = static_cast<const cMagmaCube &>(a_Mob);
            a_Pkt.WriteBEUInt8(SLIME_SIZE);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(static_cast<UInt32>(MagmaCube.GetSize()));
            break;
        }  // case mtMagmaCube

        case mtOcelot:
        {
            auto & Ocelot = static_cast<const cOcelot &>(a_Mob);

            a_Pkt.WriteBEUInt8(AGEABLE_BABY);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Ocelot.IsBaby());

            Int8 OcelotStatus = 0;
            if (Ocelot.IsSitting())
            {
                OcelotStatus |= 0x1;
            }
            if (Ocelot.IsTame())
            {
                OcelotStatus |= 0x4;
            }
            a_Pkt.WriteBEUInt8(TAMEABLE_ANIMAL_STATUS);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BYTE);
            a_Pkt.WriteBEInt8(OcelotStatus);

            a_Pkt.WriteBEUInt8(OCELOT_TYPE);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(static_cast<UInt32>(Ocelot.GetOcelotType()));

            break;
        }  // case mtOcelot

        case mtPig:
        {
            auto & Pig = static_cast<const cPig &>(a_Mob);

            a_Pkt.WriteBEUInt8(AGEABLE_BABY);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Pig.IsBaby());

            a_Pkt.WriteBEUInt8(PIG_HAS_SADDLE);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Pig.IsSaddled());

            // PIG_TOTAL_CARROT_ON_A_STICK_BOOST in 1.11.1 only
            break;
        }  // case mtPig

        case mtRabbit:
        {
            auto & Rabbit = static_cast<const cRabbit &>(a_Mob);
            a_Pkt.WriteBEUInt8(AGEABLE_BABY);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Rabbit.IsBaby());

            a_Pkt.WriteBEUInt8(RABBIT_TYPE);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(static_cast<UInt32>(Rabbit.GetRabbitType()));
            break;
        }  // case mtRabbit

        case mtSheep:
        {
            auto & Sheep = static_cast<const cSheep &>(a_Mob);

            a_Pkt.WriteBEUInt8(AGEABLE_BABY);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Sheep.IsBaby());

            a_Pkt.WriteBEUInt8(SHEEP_STATUS);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BYTE);
            Int8 SheepMetadata = 0;
            SheepMetadata = static_cast<Int8>(Sheep.GetFurColor());
            if (Sheep.IsSheared())
            {
                SheepMetadata |= 0x10;
            }
            a_Pkt.WriteBEInt8(SheepMetadata);
            break;
        }  // case mtSheep

        case mtSkeleton:
        {
            // XXX Skeletons are separate entities; all skeletons are currently treated as regular ones

            // auto & Skeleton = static_cast<const cSkeleton &>(a_Mob);
            // a_Pkt.WriteBEUInt8(SKELETON_TYPE);
            // a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            // a_Pkt.WriteVarInt32(Skeleton.IsWither() ? 1 : 0);
            break;
        }  // case mtSkeleton

        case mtSlime:
        {
            auto & Slime = static_cast<const cSlime &>(a_Mob);
            a_Pkt.WriteBEUInt8(SLIME_SIZE);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(static_cast<UInt32>(Slime.GetSize()));
            break;
        }  // case mtSlime

        case mtVillager:
        {
            auto & Villager = static_cast<const cVillager &>(a_Mob);
            a_Pkt.WriteBEUInt8(AGEABLE_BABY);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Villager.IsBaby());

            a_Pkt.WriteBEUInt8(VILLAGER_PROFESSION);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(static_cast<UInt32>(Villager.GetVilType()));
            break;
        }  // case mtVillager

        case mtWitch:
        {
            auto & Witch = static_cast<const cWitch &>(a_Mob);
            a_Pkt.WriteBEUInt8(WITCH_AGGRESIVE);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Witch.IsAngry());
            break;
        }  // case mtWitch

        case mtWither:
        {
            auto & Wither = static_cast<const cWither &>(a_Mob);
            a_Pkt.WriteBEUInt8(WITHER_INVULNERABLE_TIMER);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(Wither.GetWitherInvulnerableTicks());

            // TODO: Use boss bar packet for health
            break;
        }  // case mtWither

        case mtWolf:
        {
            auto & Wolf = static_cast<const cWolf &>(a_Mob);
            a_Pkt.WriteBEUInt8(AGEABLE_BABY);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Wolf.IsBaby());

            Int8 WolfStatus = 0;
            if (Wolf.IsSitting())
            {
                WolfStatus |= 0x1;
            }
            if (Wolf.IsAngry())
            {
                WolfStatus |= 0x2;
            }
            if (Wolf.IsTame())
            {
                WolfStatus |= 0x4;
            }
            a_Pkt.WriteBEUInt8(TAMEABLE_ANIMAL_STATUS);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BYTE);
            a_Pkt.WriteBEInt8(WolfStatus);

            a_Pkt.WriteBEUInt8(WOLF_DAMAGE_TAKEN);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_FLOAT);
            a_Pkt.WriteBEFloat(static_cast<float>(a_Mob.GetHealth()));  // TODO Not use the current health

            a_Pkt.WriteBEUInt8(WOLF_BEGGING);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Wolf.IsBegging());

            a_Pkt.WriteBEUInt8(WOLF_COLLAR_COLOR);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            a_Pkt.WriteVarInt32(static_cast<UInt32>(Wolf.GetCollarColor()));
            break;
        }  // case mtWolf

        case mtZombie:
        {
            // XXX Zombies were also split into new sublcasses; this doesn't handle that.
            auto & Zombie = static_cast<const cZombie &>(a_Mob);
            a_Pkt.WriteBEUInt8(ZOMBIE_IS_BABY);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(Zombie.IsBaby());

            // These don't exist
            // a_Pkt.WriteBEUInt8(ZOMBIE_TYPE);
            // a_Pkt.WriteBEUInt8(METADATA_TYPE_VARINT);
            // a_Pkt.WriteVarInt32(Zombie.IsVillagerZombie() ? 1 : 0);

            // a_Pkt.WriteBEUInt8(ZOMBIE_CONVERTING);
            // a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            // a_Pkt.WriteBool(Zombie.IsConverting());
            break;
        }  // case mtZombie

        case mtZombiePigman:
        {
            auto & ZombiePigman = static_cast<const cZombiePigman &>(a_Mob);
            a_Pkt.WriteBEUInt8(AGEABLE_BABY);
            a_Pkt.WriteBEUInt8(METADATA_TYPE_BOOL);
            a_Pkt.WriteBool(ZombiePigman.IsBaby());
            break;
        }  // case mtZombiePigman

        case mtBlaze:
        case mtEnderDragon:
        case mtGuardian:
        case mtIronGolem:
        case mtSnowGolem:
        case mtSpider:
        {
            // TODO: Mobs with extra fields that aren't implemented
            break;
        }

        case mtMooshroom:
        case mtCaveSpider:
        {
            // Not mentioned on http://wiki.vg/Entities
            break;
        }

        case mtGiant:
        case mtSilverfish:
        case mtSquid:
        {
            // Mobs with no extra fields
            break;
        }

        case mtInvalidType:
        {
            ASSERT(!"cProtocol_1_12::WriteMobMetadata: Recieved mob of invalid type");
            break;
        }
    }  // switch (a_Mob.GetType())
}





UInt32 cProtocol_1_12::GetPacketID(cProtocol::ePacketType a_Packet)
{
    switch (a_Packet)
    {
        case pktAttachEntity:        return 0x42;
        case pktCameraSetTo:         return 0x38;
        case pktCollectEntity:       return 0x4a;
        case pktDestroyEntity:       return 0x31;
        case pktDisplayObjective:    return 0x3a;
        case pktEntityEffect:        return 0x4e;
        case pktEntityEquipment:     return 0x3e;
        case pktEntityHeadLook:      return 0x35;
        case pktEntityLook:          return 0x28;
        case pktEntityMeta:          return 0x3b;
        case pktEntityProperties:    return 0x4d;
        case pktEntityRelMove:       return 0x26;
        case pktEntityRelMoveLook:   return 0x27;
        case pktEntityVelocity:      return 0x3d;
        case pktExperience:          return 0x3f;
        case pktHeldItemChange:      return 0x39;
        case pktLeashEntity:         return 0x3c;
        case pktPlayerMaxSpeed:      return 0x4d;
        case pktRemoveEntityEffect:  return 0x32;
        case pktRespawn:             return 0x34;
        case pktScoreboardObjective: return 0x41;
        case pktSpawnPosition:       return 0x45;
        case pktTeleportEntity:      return 0x4b;
        case pktTimeUpdate:          return 0x46;
        case pktTitle:               return 0x47;
        case pktUpdateBlockEntity:   return 0x09;
        case pktUpdateHealth:        return 0x40;
        case pktUpdateScore:         return 0x44;

        default: return Super::GetPacketID(a_Packet);
    }
}





void cProtocol_1_12::HandlePacketCraftingBookData(cByteBuffer & a_ByteBuffer)
{
    a_ByteBuffer.SkipRead(a_ByteBuffer.GetReadableSpace() - 1);
    m_Client->GetPlayer()->SendMessageInfo("The green crafting book feature is not implemented yet.");
}





void cProtocol_1_12::HandlePacketAdvancementTab(cByteBuffer & a_ByteBuffer)
{
    a_ByteBuffer.SkipRead(a_ByteBuffer.GetReadableSpace() - 1);
    m_Client->GetPlayer()->SendMessageInfo("The new advancements are not implemented.");
}





void cProtocol_1_12::SendTitleTimes(int a_FadeInTicks, int a_DisplayTicks, int a_FadeOutTicks)
{
    ASSERT(m_State == 3);  // In game mode?

    cPacketizer Pkt(*this, pktTitle);
    Pkt.WriteVarInt32(3);  // Set title display times
    Pkt.WriteBEInt32(a_FadeInTicks);
    Pkt.WriteBEInt32(a_DisplayTicks);
    Pkt.WriteBEInt32(a_FadeOutTicks);
}





void cProtocol_1_12::SendHideTitle(void)
{
    ASSERT(m_State == 3);  // In game mode?

    cPacketizer Pkt(*this, pktTitle);
    Pkt.WriteVarInt32(4);  // Hide title
}





void cProtocol_1_12::SendResetTitle(void)
{
    ASSERT(m_State == 3);  // In game mode?

    cPacketizer Pkt(*this, pktTitle);
    Pkt.WriteVarInt32(5);  // Reset title
}





void cProtocol_1_12::SendCollectEntity(const cEntity & a_Entity, const cPlayer & a_Player, int a_Count)
{
    ASSERT(m_State == 3);  // In game mode?

    cPacketizer Pkt(*this, pktCollectEntity);
    Pkt.WriteVarInt32(a_Entity.GetUniqueID());
    Pkt.WriteVarInt32(a_Player.GetUniqueID());
    Pkt.WriteVarInt32(static_cast<UInt32>(a_Count));
}





bool cProtocol_1_12::HandlePacket(cByteBuffer & a_ByteBuffer, UInt32 a_PacketType)
{
    switch (m_State)
    {
        case 1:
        {
            // Status
            switch (a_PacketType)
            {
                case 0x00: HandlePacketStatusRequest(a_ByteBuffer); return true;
                case 0x01: HandlePacketStatusPing(a_ByteBuffer); return true;
            }
            break;
        }

        case 2:
        {
            // Login
            switch (a_PacketType)
            {
                case 0x00: HandlePacketLoginStart(a_ByteBuffer); return true;
                case 0x01: HandlePacketLoginEncryptionResponse(a_ByteBuffer); return true;
            }
            break;
        }

        case 3:
        {
            // Game
            switch (a_PacketType)
            {
                case 0x00: HandleConfirmTeleport(a_ByteBuffer); return true;
                case 0x01: break;  // Prepare Crafting Grid, not yet implemented
                case 0x02: HandlePacketTabComplete(a_ByteBuffer); return true;
                case 0x03: HandlePacketChatMessage(a_ByteBuffer); return true;
                case 0x04: HandlePacketClientStatus(a_ByteBuffer); return true;
                case 0x05: HandlePacketClientSettings(a_ByteBuffer); return true;
                case 0x06: break;  // Confirm transaction - not used in Cuberite
                case 0x07: HandlePacketEnchantItem(a_ByteBuffer); return true;
                case 0x08: HandlePacketWindowClick(a_ByteBuffer); return true;
                case 0x09: HandlePacketWindowClose(a_ByteBuffer); return true;
                case 0x0a: HandlePacketPluginMessage(a_ByteBuffer); return true;
                case 0x0b: HandlePacketUseEntity(a_ByteBuffer); return true;
                case 0x0c: HandlePacketKeepAlive(a_ByteBuffer); return true;
                case 0x0d: HandlePacketPlayer(a_ByteBuffer); return true;
                case 0x0e: HandlePacketPlayerPos(a_ByteBuffer); return true;
                case 0x0f: HandlePacketPlayerPosLook(a_ByteBuffer); return true;
                case 0x10: HandlePacketPlayerLook(a_ByteBuffer); return true;
                case 0x11: HandlePacketVehicleMove(a_ByteBuffer); return true;
                case 0x12: HandlePacketBoatSteer(a_ByteBuffer); return true;
                case 0x13: HandlePacketPlayerAbilities(a_ByteBuffer); return true;
                case 0x14: HandlePacketBlockDig(a_ByteBuffer); return true;
                case 0x15: HandlePacketEntityAction(a_ByteBuffer); return true;
                case 0x16: HandlePacketSteerVehicle(a_ByteBuffer); return true;
                case 0x17: HandlePacketCraftingBookData(a_ByteBuffer); return true;
                case 0x18: break;  // Resource pack status - not yet implemented
                case 0x19: HandlePacketAdvancementTab(a_ByteBuffer); return true;
                case 0x1a: HandlePacketSlotSelect(a_ByteBuffer); return true;
                case 0x1b: HandlePacketCreativeInventoryAction(a_ByteBuffer); return true;
                case 0x1c: HandlePacketUpdateSign(a_ByteBuffer); return true;
                case 0x1d: HandlePacketAnimation(a_ByteBuffer); return true;
                case 0x1e: HandlePacketSpectate(a_ByteBuffer); return true;
                case 0x1f: HandlePacketBlockPlace(a_ByteBuffer); return true;
                case 0x20: HandlePacketUseItem(a_ByteBuffer); return true;
            }
            break;
        }
        default:
        {
            // Received a packet in an unknown state, report:
            LOGWARNING("Received a packet in an unknown protocol state %d. Ignoring further packets.", m_State);

            // Cannot kick the client - we don't know this state and thus the packet number for the kick packet

            // Switch to a state when all further packets are silently ignored:
            m_State = 255;
            return false;
        }
        case 255:
        {
            // This is the state used for "not processing packets anymore" when we receive a bad packet from a client.
            // Do not output anything (the caller will do that for us), just return failure
            return false;
        }
    }  // switch (m_State)

    // Unknown packet type, report to the ClientHandle:
    m_Client->PacketUnknown(a_PacketType);
    return false;
}





cProtocol_1_12_1::cProtocol_1_12_1(cClientHandle * a_Client, const AString & a_ServerAddress, UInt16 a_ServerPort, UInt32 a_State) :
    Super(a_Client, a_ServerAddress, a_ServerPort, a_State)
{
}





UInt32 cProtocol_1_12_1::GetPacketID(ePacketType a_Packet)
{
    switch (a_Packet)
    {
        case pktAttachEntity:        return 0x43;
        case pktCameraSetTo:         return 0x39;
        case pktCollectEntity:       return 0x4b;
        case pktDestroyEntity:       return 0x32;
        case pktDisplayObjective:    return 0x3b;
        case pktEntityEffect:        return 0x4f;
        case pktEntityEquipment:     return 0x3f;
        case pktEntityHeadLook:      return 0x36;
        case pktEntityMeta:          return 0x3c;
        case pktEntityProperties:    return 0x4e;
        case pktEntityVelocity:      return 0x3e;
        case pktExperience:          return 0x40;
        case pktHeldItemChange:      return 0x3a;
        case pktLeashEntity:         return 0x3d;
        case pktPlayerList:          return 0x2e;
        case pktPlayerAbilities:     return 0x2c;
        case pktPlayerMaxSpeed:      return 0x4e;
        case pktPlayerMoveLook:      return 0x2f;
        case pktRemoveEntityEffect:  return 0x33;
        case pktRespawn:             return 0x35;
        case pktScoreboardObjective: return 0x42;
        case pktSpawnPosition:       return 0x46;
        case pktUpdateHealth:        return 0x41;
        case pktUpdateScore:         return 0x45;
        case pktUseBed:              return 0x30;
        case pktTeleportEntity:      return 0x4c;
        case pktTimeUpdate:          return 0x47;
        case pktTitle:               return 0x48;

        default: return Super::GetPacketID(a_Packet);
    }
}





void cProtocol_1_12_1::HandlePacketStatusRequest(cByteBuffer & a_ByteBuffer)
{
    cServer * Server = cRoot::Get()->GetServer();
    AString ServerDescription = Server->GetDescription();
    auto NumPlayers = static_cast<signed>(Server->GetNumPlayers());
    auto MaxPlayers = static_cast<signed>(Server->GetMaxPlayers());
    AString Favicon = Server->GetFaviconData();
    cRoot::Get()->GetPluginManager()->CallHookServerPing(*m_Client, ServerDescription, NumPlayers, MaxPlayers, Favicon);

    // Version:
    Json::Value Version;
    Version["name"] = "Cuberite 1.12.1";
    Version["protocol"] = cProtocolRecognizer::PROTO_VERSION_1_12_1;

    // Players:
    Json::Value Players;
    Players["online"] = NumPlayers;
    Players["max"] = MaxPlayers;
    // TODO: Add "sample"

    // Description:
    Json::Value Description;
    Description["text"] = ServerDescription.c_str();

    // Create the response:
    Json::Value ResponseValue;
    ResponseValue["version"] = Version;
    ResponseValue["players"] = Players;
    ResponseValue["description"] = Description;
    if (!Favicon.empty())
    {
        ResponseValue["favicon"] = Printf("data:image/png;base64,%s", Favicon.c_str());
    }

    // Serialize the response into a packet:
    Json::FastWriter Writer;
    cPacketizer Pkt(*this, pktStatusResponse);
    Pkt.WriteString(Writer.write(ResponseValue));
}





bool cProtocol_1_12_1::HandlePacket(cByteBuffer & a_ByteBuffer, UInt32 a_PacketType)
{
    switch (m_State)
    {
        case 1:
        {
            // Status
            switch (a_PacketType)
            {
                case 0x00: HandlePacketStatusRequest(a_ByteBuffer); return true;
                case 0x01: HandlePacketStatusPing(a_ByteBuffer); return true;
            }
            break;
        }

        case 2:
        {
            // Login
            switch (a_PacketType)
            {
                case 0x00: HandlePacketLoginStart(a_ByteBuffer); return true;
                case 0x01: HandlePacketLoginEncryptionResponse(a_ByteBuffer); return true;
            }
            break;
        }

        case 3:
        {
            // Game
            switch (a_PacketType)
            {
                case 0x00: HandleConfirmTeleport(a_ByteBuffer); return true;
                case 0x01: HandlePacketTabComplete(a_ByteBuffer); return true;
                case 0x02: HandlePacketChatMessage(a_ByteBuffer); return true;
                case 0x03: HandlePacketClientStatus(a_ByteBuffer); return true;
                case 0x04: HandlePacketClientSettings(a_ByteBuffer); return true;
                case 0x05: break;  // Confirm transaction - not used in Cuberite
                case 0x06: HandlePacketEnchantItem(a_ByteBuffer); return true;
                case 0x07: HandlePacketWindowClick(a_ByteBuffer); return true;
                case 0x08: HandlePacketWindowClose(a_ByteBuffer); return true;
                case 0x09: HandlePacketPluginMessage(a_ByteBuffer); return true;
                case 0x0a: HandlePacketUseEntity(a_ByteBuffer); return true;
                case 0x0b: HandlePacketKeepAlive(a_ByteBuffer); return true;
                case 0x0c: HandlePacketPlayer(a_ByteBuffer); return true;
                case 0x0d: HandlePacketPlayerPos(a_ByteBuffer); return true;
                case 0x0e: HandlePacketPlayerPosLook(a_ByteBuffer); return true;
                case 0x0f: HandlePacketPlayerLook(a_ByteBuffer); return true;
                case 0x10: HandlePacketVehicleMove(a_ByteBuffer); return true;
                case 0x11: HandlePacketBoatSteer(a_ByteBuffer); return true;
                case 0x12: break;  // Craft Recipe Request - not yet implemented
                case 0x13: HandlePacketPlayerAbilities(a_ByteBuffer); return true;
                case 0x14: HandlePacketBlockDig(a_ByteBuffer); return true;
                case 0x15: HandlePacketEntityAction(a_ByteBuffer); return true;
                case 0x16: HandlePacketSteerVehicle(a_ByteBuffer); return true;
                case 0x17: HandlePacketCraftingBookData(a_ByteBuffer); return true;
                case 0x18: break;  // Resource pack status - not yet implemented
                case 0x19: HandlePacketAdvancementTab(a_ByteBuffer); return true;
                case 0x1a: HandlePacketSlotSelect(a_ByteBuffer); return true;
                case 0x1b: HandlePacketCreativeInventoryAction(a_ByteBuffer); return true;
                case 0x1c: HandlePacketUpdateSign(a_ByteBuffer); return true;
                case 0x1d: HandlePacketAnimation(a_ByteBuffer); return true;
                case 0x1e: HandlePacketSpectate(a_ByteBuffer); return true;
                case 0x1f: HandlePacketBlockPlace(a_ByteBuffer); return true;
                case 0x20: HandlePacketUseItem(a_ByteBuffer); return true;
            }
            break;
        }
        default:
        {
            // Received a packet in an unknown state, report:
            LOGWARNING("Received a packet in an unknown protocol state %d. Ignoring further packets.", m_State);

            // Cannot kick the client - we don't know this state and thus the packet number for the kick packet

            // Switch to a state when all further packets are silently ignored:
            m_State = 255;
            return false;
        }
        case 255:
        {
            // This is the state used for "not processing packets anymore" when we receive a bad packet from a client.
            // Do not output anything (the caller will do that for us), just return failure
            return false;
        }
    }  // switch (m_State)

    // Unknown packet type, report to the ClientHandle:
    m_Client->PacketUnknown(a_PacketType);
    return false;
}




// cProtocol_1_12_2:

void cProtocol_1_12_2::HandlePacketKeepAlive(cByteBuffer & a_ByteBuffer)
{
    HANDLE_READ(a_ByteBuffer, ReadBEInt64, Int64, KeepAliveID);
    if (
        (KeepAliveID <= std::numeric_limits<UInt32>::max()) &&
        (KeepAliveID >= 0)
    )
    {
        // The server will only send a UInt32 so any value out of that range shouldn't keep the client alive.
        m_Client->HandleKeepAlive(static_cast<UInt32>(KeepAliveID));
    }
}





void cProtocol_1_12_2::HandlePacketStatusRequest(cByteBuffer & a_ByteBuffer)
{
    cServer * Server = cRoot::Get()->GetServer();
    AString ServerDescription = Server->GetDescription();
    auto NumPlayers = static_cast<signed>(Server->GetNumPlayers());
    auto MaxPlayers = static_cast<signed>(Server->GetMaxPlayers());
    AString Favicon = Server->GetFaviconData();
    cRoot::Get()->GetPluginManager()->CallHookServerPing(*m_Client, ServerDescription, NumPlayers, MaxPlayers, Favicon);

    // Version:
    Json::Value Version;
    Version["name"] = "Cuberite 1.12.2";
    Version["protocol"] = cProtocolRecognizer::PROTO_VERSION_1_12_2;

    // Players:
    Json::Value Players;
    Players["online"] = NumPlayers;
    Players["max"] = MaxPlayers;
    // TODO: Add "sample"

    // Description:
    Json::Value Description;
    Description["text"] = ServerDescription.c_str();

    // Create the response:
    Json::Value ResponseValue;
    ResponseValue["version"] = Version;
    ResponseValue["players"] = Players;
    ResponseValue["description"] = Description;
    if (!Favicon.empty())
    {
        ResponseValue["favicon"] = Printf("data:image/png;base64,%s", Favicon.c_str());
    }

    // Serialize the response into a packet:
    Json::FastWriter Writer;
    cPacketizer Pkt(*this, pktStatusResponse);
    Pkt.WriteString(Writer.write(ResponseValue));
}





void cProtocol_1_12_2::SendKeepAlive(UInt32 a_PingID)
{
    // Drop the packet if the protocol is not in the Game state yet (caused a client crash):
    if (m_State != 3)
    {
        LOGWARNING("Trying to send a KeepAlive packet to a player who's not yet fully logged in (%d). The protocol class prevented the packet.", m_State);
        return;
    }

    cPacketizer Pkt(*this, pktKeepAlive);
    Pkt.WriteBEInt64(a_PingID);
}