packet

package
Version: v1.16.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 24, 2021 License: MIT Imports: 15 Imported by: 9

Documentation

Overview

Package packet implements every packet in the Minecraft Bedrock Edition protocol using the functions found in the minecraft/protocol package. Each of the packets hold their own encoding and decoding methods which are used to read the packet from a bytes.Buffer or write the packet to one.

Besides the implementations of packets themselves, the packet package also implements the decoding and encoding of the lowest level Minecraft related packets, meaning the compressed packet batches. It handles the compression and (optional) encryption of these packet batches.

Index

Constants

View Source
const (
	ActorEventJump
	ActorEventHurt
	ActorEventDeath
	ActorEventStartAttack
	ActorEventStopAttack
	ActorEventTameFail
	ActorEventTameSucceed
	ActorEventShakeDry
	ActorEventUseItem
	ActorEventEatGrass
	ActorEventFishHookBubble
	ActorEventFishHookPosition
	ActorEventFishHook
	ActorEventFishHookTease
	ActorEventSquidInkCloud
	ActorEventZombieVillagerCure
	ActorEventPlayAmbientSound
	ActorEventRespawn
	ActorEventIronGolemOfferFlower
	ActorEventIronGolemWithdrawFlower
	ActorEventLookingForPartner
	ActorEventHappyVillager
	ActorEventAngryVillager
	ActorEventWitchSpell
	ActorEventFirework
	ActorEventFoundPartner
	ActorEventSilverfishSpawn
	ActorEventGuardianAttack
	ActorEventWitchDrinkPotion
	ActorEventWitchThrowPotion
	ActorEventMinecartTNTPrimeFuse
	ActorEventCreeperPrimeFuse
	ActorEventAirSupplyExpired
	ActorEventPlayerAddXPLevels
	ActorEventElderGuardianCurse
	ActorEventAgentArmSwing
	ActorEventEnderDragonDeath
	ActorEventDustParticles
	ActorEventArrowShake
)
View Source
const (
	ActorEventEatingItem = iota + 57

	ActorEventBabyAnimalFeed
	ActorEventDeathSmokeCloud
	ActorEventCompleteTrade
	ActorEventRemoveLeash
	ActorEventLlamaCaravanUpdated
	ActorEventConsumeTotem
	ActorEventPlayerCheckTreasureHunterAchievement
	ActorEventEntitySpawn
	ActorEventDragonBreath
	ActorEventItemEntityMerge
	ActorEventStartSwimming
	ActorEventBalloonPop
	ActorEventTreasureHunt
	ActorEventSummonAgent
	ActorEventCrossbowCharged
	ActorEventLandedOnGround
	ActorEventEntityGrowUp
)
View Source
const (
	AdventureFlagWorldImmutable = 1 << iota
	AdventureFlagNoPVP

	AdventureFlagAutoJump
	AdventureFlagAllowFlight
	AdventureFlagNoClip
	AdventureFlagWorldBuilder
	AdventureFlagFlying
	AdventureFlagMuted
)
View Source
const (
	CommandPermissionLevelNormal = iota
	CommandPermissionLevelOperator
	CommandPermissionLevelHost
	CommandPermissionLevelAutomation
	CommandPermissionLevelAdmin
)
View Source
const (
	ActionPermissionBuild = 1 << iota
	ActionPermissionDoorsAndSwitched
	ActionPermissionOpenContainers
	ActionPermissionAttackPlayers
	ActionPermissionAttackMobs
	ActionPermissionOperator
	ActionPermissionTeleport
	ActionPermissionMine
	ActionPermissionDefault
)
View Source
const (
	PermissionLevelVisitor = iota
	PermissionLevelMember
	PermissionLevelOperator
	PermissionLevelCustom
)
View Source
const (
	AnimateActionSwingArm = iota + 1

	AnimateActionStopSleep
	AnimateActionCriticalHit
)
View Source
const (
	BookActionReplacePage = iota
	BookActionAddPage
	BookActionDeletePage
	BookActionSwapPages
	BookActionSign
)
View Source
const (
	BossEventShow = iota
	// BossEventRegisterPlayer is sent by the client to the server to request being shown the boss bar.
	BossEventRegisterPlayer
	BossEventHide
	// BossEventUnregisterPlayer is sent by the client to request the removal of the boss bar.
	BossEventUnregisterPlayer
	BossEventHealthPercentage
	BossEventTitle
	BossEventAppearanceProperties
	BossEventTexture
)
View Source
const (
	CameraShakeTypePositional uint8 = iota
	CameraShakeTypeRotational
)
View Source
const (
	CameraShakeActionAdd = iota
	CameraShakeActionStop
)
View Source
const (
	DimensionOverworld = iota
	DimensionNether
	DimensionEnd
)
View Source
const (
	ClientBoundDebugRendererTypeClear int32 = iota + 1
	ClientBoundDebugRendererTypeAddCube
)
View Source
const (
	MapUpdateFlagTexture = 1 << (iota + 1)
	MapUpdateFlagDecoration
	MapUpdateFlagInitialisation
)
View Source
const (
	CommandBlockImpulse = iota
	CommandBlockRepeat
	CommandBlockChain
)
View Source
const (
	CommandOutputTypeNone = iota
	CommandOutputTypeLastOutput
	CommandOutputTypeSilent
	CommandOutputTypeAllOutput
	CommandOutputTypeDataSet
)
View Source
const (
	UseItemEquipArmor = iota
	UseItemEat
	UseItemAttack
	UseItemConsume
	UseItemThrow
	UseItemShoot
	UseItemPlace
	UseItemFillBottle
	UseItemFillBucket
	UseItemPourBucket
	UseItemUseTool
	UseItemInteract
	UseItemRetrieved
	UseItemDyed
	UseItemTraded
)
View Source
const (
	ContainerDataFurnaceTickCount = iota
	ContainerDataFurnaceLitTime
	ContainerDataFurnaceLitDuration

	ContainerDataFurnaceFuelAux
)
View Source
const (
	ContainerDataBrewingStandBrewTime = iota
	ContainerDataBrewingStandFuelAmount
	ContainerDataBrewingStandFuelTotal
)
View Source
const (
	EventTypeAchievementAwarded = iota
	EventTypeEntityInteract
	EventTypePortalBuilt
	EventTypePortalUsed
	EventTypeMobKilled
	EventTypeCauldronUsed
	EventTypePlayerDied
	EventTypeBossKilled
	EventTypeAgentCommand
	EventTypeAgentCreated // Unused for whatever reason?
	EventTypePatternRemoved
	EventTypeSlashCommandExecuted
	EventTypeFishBucketed
	EventTypeMobBorn
	EventTypePetDied
	EventTypeCauldronInteract
	EventTypeComposterInteract
	EventTypeBellUsed
	EventTypeEntityDefinitionTrigger
	EventTypeRaidUpdate
	EventTypeMovementAnomaly
	EventTypeMovementCorrected
	EventTypeExtractHoney
	EventTypeUndefined
)
View Source
const (
	IDLogin = iota + 1
	IDPlayStatus
	IDServerToClientHandshake
	IDClientToServerHandshake
	IDDisconnect
	IDResourcePacksInfo
	IDResourcePackStack
	IDResourcePackClientResponse
	IDText
	IDSetTime
	IDStartGame
	IDAddPlayer
	IDAddActor
	IDRemoveActor
	IDAddItemActor

	IDTakeItemActor
	IDMoveActorAbsolute
	IDMovePlayer
	IDPassengerJump
	IDUpdateBlock
	IDAddPainting
	IDTickSync

	IDLevelEvent
	IDBlockEvent
	IDActorEvent
	IDMobEffect
	IDUpdateAttributes
	IDInventoryTransaction
	IDMobEquipment
	IDMobArmourEquipment
	IDInteract
	IDBlockPickRequest
	IDActorPickRequest
	IDPlayerAction

	IDHurtArmour
	IDSetActorData
	IDSetActorMotion
	IDSetActorLink
	IDSetHealth
	IDSetSpawnPosition
	IDAnimate
	IDRespawn
	IDContainerOpen
	IDContainerClose
	IDPlayerHotBar
	IDInventoryContent
	IDInventorySlot
	IDContainerSetData
	IDCraftingData
	IDCraftingEvent
	IDGUIDataPickItem
	IDAdventureSettings
	IDBlockActorData
	IDPlayerInput
	IDLevelChunk
	IDSetCommandsEnabled
	IDSetDifficulty
	IDChangeDimension
	IDSetPlayerGameType
	IDPlayerList
	IDSimpleEvent
	IDEvent
	IDSpawnExperienceOrb
	IDClientBoundMapItemData
	IDMapInfoRequest
	IDRequestChunkRadius
	IDChunkRadiusUpdated
	IDItemFrameDropItem
	IDGameRulesChanged
	IDCamera
	IDBossEvent
	IDShowCredits
	IDAvailableCommands
	IDCommandRequest
	IDCommandBlockUpdate
	IDCommandOutput
	IDUpdateTrade
	IDUpdateEquip
	IDResourcePackDataInfo
	IDResourcePackChunkData
	IDResourcePackChunkRequest
	IDTransfer
	IDPlaySound
	IDStopSound
	IDSetTitle
	IDAddBehaviourTree
	IDStructureBlockUpdate
	IDShowStoreOffer
	IDPurchaseReceipt
	IDPlayerSkin
	IDSubClientLogin
	IDAutomationClientConnect
	IDSetLastHurtBy
	IDBookEdit
	IDNPCRequest
	IDPhotoTransfer
	IDModalFormRequest
	IDModalFormResponse
	IDServerSettingsRequest
	IDServerSettingsResponse
	IDShowProfile
	IDSetDefaultGameType
	IDRemoveObjective
	IDSetDisplayObjective
	IDSetScore
	IDLabTable
	IDUpdateBlockSynced
	IDMoveActorDelta
	IDSetScoreboardIdentity
	IDSetLocalPlayerAsInitialised
	IDUpdateSoftEnum
	IDNetworkStackLatency

	IDScriptCustomEvent
	IDSpawnParticleEffect
	IDAvailableActorIdentifiers

	IDNetworkChunkPublisherUpdate
	IDBiomeDefinitionList
	IDLevelSoundEvent
	IDLevelEventGeneric
	IDLecternUpdate

	IDAddEntity
	IDRemoveEntity
	IDClientCacheStatus
	IDMapCreateLockedCopy
	IDOnScreenTextureAnimation
	IDStructureTemplateDataRequest
	IDStructureTemplateDataResponse

	IDClientCacheBlobStatus
	IDClientCacheMissResponse
	IDEducationSettings
	IDEmote
	IDMultiPlayerSettings
	IDSettingsCommand
	IDAnvilDamage
	IDCompletedUsingItem
	IDNetworkSettings
	IDPlayerAuthInput
	IDCreativeContent
	IDPlayerEnchantOptions
	IDItemStackRequest
	IDItemStackResponse
	IDPlayerArmourDamage
	IDCodeBuilder
	IDUpdatePlayerGameType
	IDEmoteList
	IDPositionTrackingDBServerBroadcast
	IDPositionTrackingDBClientRequest
	IDDebugInfo
	IDPacketViolationWarning
	IDMotionPredictionHints
	IDAnimateEntity
	IDCameraShake
	IDPlayerFog
	IDCorrectPlayerMovePrediction
	IDItemComponent
	IDFilterText
	IDClientBoundDebugRenderer
	IDSyncActorProperty
	IDAddVolumeEntity
	IDRemoveVolumeEntity
	IDSimulationType
	IDNPCDialogue
	IDEducationResourceURI
	IDCreatePhoto
	IDUpdateSubChunkBlocks
	IDPhotoInfoRequest
	IDSubChunk
	IDSubChunkRequest
)
View Source
const (
	InteractActionLeaveVehicle
	InteractActionMouseOverEntity

	InteractActionOpenInventory
)
View Source
const (
	InventoryTransactionTypeNormal = iota
	InventoryTransactionTypeMismatch
	InventoryTransactionTypeUseItem
	InventoryTransactionTypeUseItemOnEntity
	InventoryTransactionTypeReleaseItem
)
View Source
const (
	LabTableActionCombine = iota
	LabTableActionReact
)
View Source
const (
	EventSoundClick         = 1000
	EventSoundClickFail     = 1001
	EventSoundShoot         = 1002
	EventSoundDoor          = 1003
	EventSoundFizz          = 1004
	EventSoundIgnite        = 1005
	EventSoundPlayRecording = 1006
	EventSoundGhast         = 1007
	EventSoundGhastShoot    = 1008
	EventSoundBlazeShoot    = 1009
	EventSoundDoorBump      = 1010

	EventSoundDoorCrash = 1012

	EventSoundZombieInfected   = 1016
	EventSoundZombieConverted  = 1017
	EventSoundEndermanTeleport = 1018

	EventSoundAnvilBreak = 1020
	EventSoundAnvilUse   = 1021
	EventSoundAnvilFall  = 1022

	EventSoundPop = 1030

	EventSoundPortal = 1032

	EventSoundItemFrameAddItem    = 1040
	EventSoundItemFrameBreak      = 1041
	EventSoundItemFramePlace      = 1042
	EventSoundItemFrameRemoveItem = 1043
	EventSoundItemFrameRotateItem = 1044

	EventSoundCamera = 1050
	EventSoundOrb    = 1051
	EventSoundTotem  = 1052

	EventSoundArmourStandBreak     = 1060
	EventSoundArmourStandHit       = 1061
	EventSoundArmourStandFall      = 1062
	EventSoundArmourStandPlace     = 1063
	EventSoundPointedDripstoneLand = 1064
	EventSoundDyeUsed              = 1065
	EventSoundInkSackUsed          = 1066

	EventParticleShoot                 = 2000
	EventParticleDestroy               = 2001
	EventParticleSplash                = 2002
	EventParticleEyeDespawn            = 2003
	EventParticleSpawn                 = 2004
	EventParticleCropGrowth            = 2005
	EventParticleSoundGuardianCurse    = 2006
	EventParticleDeathSmoke            = 2007
	EventParticleBlockForceField       = 2008
	EventParticleProjectileHit         = 2009
	EventParticleDragonEggTeleport     = 2010
	EventParticleCropEaten             = 2011
	EventParticleCritical              = 2012
	EventParticleEndermanTeleport      = 2013
	EventParticlePunchBlock            = 2014
	EventParticleBubble                = 2015
	EventParticleEvaporate             = 2016
	EventParticleDestroyArmorStand     = 2017
	EventParticleBreakingEgg           = 2018
	EventParticleDestroyEgg            = 2019
	EventParticleEvaporateWater        = 2020
	EventParticleDestroyBlockNoSound   = 2021
	EventParticleKnockbackRoar         = 2022
	EventParticleTeleportTrail         = 2023
	EventParticlePointCloud            = 2024
	EventParticleExplosion             = 2025
	EventParticleBlockExplosion        = 2026
	EventParticleVibrationSignal       = 2027
	EventParticleParticleDripstoneDrip = 2028
	EventParticleParticleFizzEffect    = 2029
	EventParticleWaxOn                 = 2030
	EventParticleWaxOff                = 2031
	EventParticleScrape                = 2032
	EventParticleElectricSpark         = 2033
	EventParticleTurtleEgg             = 2034
	EventParticleSkulkShriek           = 2035

	EventStartRain           = 3001
	EventStartThunder        = 3002
	EventStopRain            = 3003
	EventStopThunder         = 3004
	EventPauseGame           = 3005
	EventSimulationTimeStep  = 3006
	EventSimulationTimeScale = 3007

	EventRedstoneTrigger     = 3500
	EventCauldronExplode     = 3501
	EventCauldronDyeArmour   = 3502
	EventCauldronCleanArmour = 3503
	EventCauldronFillPotion  = 3504
	EventCauldronTakePotion  = 3505
	EventCauldronFillWater   = 3506
	EventCauldronTakeWater   = 3507
	EventCauldronAddDye      = 3508
	EventCauldronCleanBanner = 3509
	EventCauldronFlush       = 3510
	EventAgentSpawnEffect    = 3511
	EventCauldronFillLava    = 3512
	EventCauldronTakeLava    = 3513

	EventBlockStartBreak     = 3600
	EventBlockStopBreak      = 3601
	EventUpdateBlockCracking = 3602

	EventSetData = 4000

	EventPlayersSleeping = 9800
	EventJumpPrevented   = 9810

	EventAddParticleMask = 0x4000
)
View Source
const (
	SoundEventItemUseOn = iota
	SoundEventHit
	SoundEventStep
	SoundEventFly
	SoundEventJump
	SoundEventBreak
	SoundEventPlace
	SoundEventHeavyStep
	SoundEventGallop
	SoundEventFall
	SoundEventAmbient
	SoundEventAmbientBaby
	SoundEventAmbientInWater
	SoundEventBreathe
	SoundEventDeath
	SoundEventDeathInWater
	SoundEventDeathToZombie
	SoundEventHurt
	SoundEventHurtInWater
	SoundEventMad
	SoundEventBoost
	SoundEventBow
	SoundEventSquishBig
	SoundEventSquishSmall
	SoundEventFallBig
	SoundEventFallSmall
	SoundEventSplash
	SoundEventFizz
	SoundEventFlap
	SoundEventSwim
	SoundEventDrink
	SoundEventEat
	SoundEventTakeoff
	SoundEventShake
	SoundEventPlop
	SoundEventLand
	SoundEventSaddle
	SoundEventArmor
	SoundEventMobArmorStandPlace
	SoundEventAddChest
	SoundEventThrow
	SoundEventAttack
	SoundEventAttackNoDamage
	SoundEventAttackStrong
	SoundEventWarn
	SoundEventShear
	SoundEventMilk
	SoundEventThunder
	SoundEventExplode
	SoundEventFire
	SoundEventIgnite
	SoundEventFuse
	SoundEventStare
	SoundEventSpawn
	SoundEventShoot
	SoundEventBreakBlock
	SoundEventLaunch
	SoundEventBlast
	SoundEventLargeBlast
	SoundEventTwinkle
	SoundEventRemedy
	SoundEventInfect
	SoundEventLevelUp
	SoundEventBowHit
	SoundEventBulletHit
	SoundEventExtinguishFire
	SoundEventItemFizz
	SoundEventChestOpen
	SoundEventChestClosed
	SoundEventShulkerBoxOpen
	SoundEventShulkerBoxClosed
	SoundEventEnderChestOpen
	SoundEventEnderChestClosed
	SoundEventPowerOn
	SoundEventPowerOff
	SoundEventAttach
	SoundEventDetach
	SoundEventDeny
	SoundEventTripod
	SoundEventPop
	SoundEventDropSlot
	SoundEventNote
	SoundEventThorns
	SoundEventPistonIn
	SoundEventPistonOut
	SoundEventPortal
	SoundEventWater
	SoundEventLavaPop
	SoundEventLava
	SoundEventBurp
	SoundEventBucketFillWater
	SoundEventBucketFillLava
	SoundEventBucketEmptyWater
	SoundEventBucketEmptyLava
	SoundEventArmorEquipChain
	SoundEventArmorEquipDiamond
	SoundEventArmorEquipGeneric
	SoundEventArmorEquipGold
	SoundEventArmorEquipIron
	SoundEventArmorEquipLeather
	SoundEventArmorEquipElytra
	SoundEventRecord13
	SoundEventRecordCat
	SoundEventRecordBlocks
	SoundEventRecordChirp
	SoundEventRecordFar
	SoundEventRecordMall
	SoundEventRecordMellohi
	SoundEventRecordStal
	SoundEventRecordStrad
	SoundEventRecordWard
	SoundEventRecord11
	SoundEventRecordWait

	SoundEventFlop
	SoundEventElderGuardianCurse
	SoundEventMobWarning
	SoundEventMobWarningBaby
	SoundEventTeleport
	SoundEventShulkerOpen
	SoundEventShulkerClose
	SoundEventHaggle
	SoundEventHaggleYes
	SoundEventHaggleNo
	SoundEventHaggleIdle
	SoundEventChorusGrow
	SoundEventChorusDeath
	SoundEventGlass
	SoundEventPotionBrewed
	SoundEventCastSpell
	SoundEventPrepareAttack
	SoundEventPrepareSummon
	SoundEventPrepareWololo
	SoundEventFang
	SoundEventCharge
	SoundEventCameraTakePicture
	SoundEventLeashKnotPlace
	SoundEventLeashKnotBreak
	SoundEventGrowl
	SoundEventWhine
	SoundEventPant
	SoundEventPurr
	SoundEventPurreow
	SoundEventDeathMinVolume
	SoundEventDeathMidVolume

	SoundEventImitateCaveSpider
	SoundEventImitateCreeper
	SoundEventImitateElderGuardian
	SoundEventImitateEnderDragon
	SoundEventImitateEnderman

	SoundEventImitateEvocationIllager
	SoundEventImitateGhast
	SoundEventImitateHusk
	SoundEventImitateIllusionIllager
	SoundEventImitateMagmaCube
	SoundEventImitatePolarBear
	SoundEventImitateShulker
	SoundEventImitateSilverfish
	SoundEventImitateSkeleton
	SoundEventImitateSlime
	SoundEventImitateSpider
	SoundEventImitateStray
	SoundEventImitateVex
	SoundEventImitateVindicationIllager
	SoundEventImitateWitch
	SoundEventImitateWither
	SoundEventImitateWitherSkeleton
	SoundEventImitateWolf
	SoundEventImitateZombie
	SoundEventImitateZombiePigman
	SoundEventImitateZombieVillager
	SoundEventBlockEndPortalFrameFill
	SoundEventBlockEndPortalSpawn
	SoundEventRandomAnvilUse
	SoundEventBottleDragonBreath
	SoundEventPortalTravel
	SoundEventItemTridentHit
	SoundEventItemTridentReturn
	SoundEventItemTridentRiptide1
	SoundEventItemTridentRiptide2
	SoundEventItemTridentRiptide3
	SoundEventItemTridentThrow
	SoundEventItemTridentThunder
	SoundEventItemTridentHitGround
	SoundEventDefault
	SoundEventBlockFletchingTableUse
	SoundEventElemConstructOpen
	SoundEventIceBombHit
	SoundEventBalloonPop
	SoundEventLtReactionIceBomb
	SoundEventLtReactionBleach
	SoundEventLtReactionEPaste
	SoundEventLtReactionEPaste2
	SoundEventLtReactionFertilizer
	SoundEventLtReactionFireball
	SoundEventLtReactionMgsalt
	SoundEventLtReactionMiscfire
	SoundEventLtReactionFire
	SoundEventLtReactionMiscexplosion
	SoundEventLtReactionMiscmystical
	SoundEventLtReactionMiscmystical2
	SoundEventLtReactionProduct
	SoundEventSparklerUse
	SoundEventGlowstickUse
	SoundEventSparklerActive
	SoundEventConvertToDrowned
	SoundEventBucketFillFish
	SoundEventBucketEmptyFish
	SoundEventBubbleUp
	SoundEventBubbleDown
	SoundEventBubblePop
	SoundEventBubbleUpInside
	SoundEventBubbleDownInside
	SoundEventHurtBaby
	SoundEventDeathBaby
	SoundEventStepBaby
	SoundEventBabySpawn
	SoundEventBorn
	SoundEventBlockTurtleEggBreak
	SoundEventBlockTurtleEggCrack
	SoundEventBlockTurtleEggHatch
	SoundEventTurtleLayEgg
	SoundEventBlockTurtleEggAttack
	SoundEventBeaconActivate
	SoundEventBeaconAmbient
	SoundEventBeaconDeactivate
	SoundEventBeaconPower
	SoundEventConduitActivate
	SoundEventConduitAmbient
	SoundEventConduitAttack
	SoundEventConduitDeactivate
	SoundEventConduitShort
	SoundEventSwoop
	SoundEventBlockBambooSaplingPlace
	SoundEventPreSneeze
	SoundEventSneeze
	SoundEventAmbientTame
	SoundEventScared
	SoundEventBlockScaffoldingClimb
	SoundEventCrossbowLoadingStart
	SoundEventCrossbowLoadingMiddle
	SoundEventCrossbowLoadingEnd
	SoundEventCrossbowShoot
	SoundEventCrossbowQuickChargeStart
	SoundEventCrossbowQuickChargeMiddle
	SoundEventCrossbowQuickChargeEnd
	SoundEventAmbientAggressive
	SoundEventAmbientWorried
	SoundEventCantBreed
	SoundEventItemShieldBlock
	SoundEventItemBookPut
	SoundEventBlockGrindstoneUse
	SoundEventBlockBellHit
	SoundEventBlockCampfireCrackle
	SoundEventRoar
	SoundEventStun
	SoundEventBlockSweetBerryBushHurt
	SoundEventBlockSweetBerryBushPick
	SoundEventUICartographyTableTakeResult
	SoundEventUIStoneCutterTakeResult
	SoundEventBlockComposterEmpty
	SoundEventBlockComposterFill
	SoundEventBlockComposterFillSuccess
	SoundEventBlockComposterReady
	SoundEventBlockBarrelOpen
	SoundEventBlockBarrelClose
	SoundEventRaidHorn
	SoundEventBlockLoomUse
	SoundEventAmbientRaid
	SoundEventUICartographyTableUse
	SoundEventUIStoneCutterUse
	SoundEventUILoomUse
	SoundEventSmokerUse
	SoundEventBlastFurnaceUse
	SoundEventSmithingTableUse
	SoundEventScreech
	SoundEventSleep
	SoundEventFurnaceUse
	SoundEventMooshroomConvert
	SoundEventMilkSuspiciously
	SoundEventCelebrate
	SoundEventJumpPrevent
	SoundEventAmbientPollinate
	SoundEventBeeHiveDrip
	SoundEventBeeHiveEnter
	SoundEventBeeHiveExit
	SoundEventBeeHiveWork
	SoundEventBeeHiveShear
	SoundEventHoneyBottleDrink
	SoundEventAmbientCave
	SoundEventRetreat
	SoundEventConvertToZombified
	SoundEventAdmire
	SoundEventStepLava
	SoundEventTempt
	SoundEventPanic
	SoundEventAngry
	SoundEventAmbientWarpedForest
	SoundEventAmbientSoulsandValley
	SoundEventAmbientNetherWastes
	SoundEventAmbientBasaltDeltas
	SoundEventAmbientCrimsonForest
	SoundEventRespawnAnchorCharge
	SoundEventRespawnAnchorDeplete
	SoundEventRespawnAnchorSetSpawn
	SoundEventRespawnAnchorAmbient
	SoundEventSoulEscapeQuiet
	SoundEventSoulEscapeLoud
	SoundEventRecordPigstep
	SoundEventLinkCompassToLodestone
	SoundEventBlockSmithingTableUse
	SoundEventEquipNetherite
	SoundEventAmbientLoopWarpedForest
	SoundEventAmbientLoopSoulsandValley
	SoundEventAmbientLoopNetherWastes
	SoundEventAmbientLoopBasaltDeltas
	SoundEventAmbientLoopCrimsonForest
	SoundEventAmbientAdditionWarpedForest
	SoundEventAmbientAdditionSoulsandValley
	SoundEventAmbientAdditionNetherWastes
	SoundEventAmbientAdditionBasaltDeltas
	SoundEventAmbientAdditionCrimsonForest
	SoundEventSculkSensorPowerOn
	SoundEventSculkSensorPowerOff
	SoundEventBucketFillPowderSnow
	SoundEventBucketEmptyPowderSnow
	SoundEventPointedDripstoneCauldronDripWater
	SoundEventPointedDripstoneCauldronDripLava
	SoundEventPointedDripstoneDripWater
	SoundEventPointedDripstoneDripLava
	SoundEventCaveVinesPickBerries
	SoundEventBigDripleafTiltDown
	SoundEventBigDripleafTiltUp

	SoundEventCopperWaxOn
	SoundEventCopperWaxOff
	SoundEventScrape
	SoundEventPlayerHurtDrown
	SoundEventPlayerHurtOnFire
	SoundEventPlayerHurtFreeze
	SoundEventUseSpyglass
	SoundEventStopUsingSpyglass
	SoundEventAmetheystBlockChime
	SoundEventAmbientScreamer
	SoundEventHurtScreamer
	SoundEventDeathScreamer
	SoundEventMilkScreamer
	SoundEventJumpToBlock
	SoundEventPreRam
	SoundEventPreRamScreamer
	SoundEventRamImpact
	SoundEventRamImpactScreamer
	SoundEventSquidInkSquirt
	SoundEventGlowSquidInkSquirt
	SoundEventConvertToStray
	SoundEventCakeAddCandle
	SoundEventExtinguishCandle
	SoundEventAmbientCandle
	SoundEventBlockClick
	SoundEventBlockClickFail
	SoundEventSculkShriekerShriek
	SoundEventWardenNearbyClose
	SoundEventWardenNearbyCloser
	SoundEventWardenNearbyClosest
	SoundEventWardenSlightlyAngry
	SoundEventUndefined
)

noinspection SpellCheckingInspection

View Source
const (
	MobEffectAdd = iota + 1
	MobEffectModify
	MobEffectRemove
)
View Source
const (
	EffectSpeed = iota + 1
	EffectSlowness
	EffectHaste
	EffectMiningFatigue
	EffectStrength
	EffectInstantHealth
	EffectInstantDamage
	EffectJumpBoost
	EffectNausea
	EffectRegeneration
	EffectResistance
	EffectFireResistance
	EffectWaterBreathing
	EffectInvisibility
	EffectBlindness
	EffectNightVision
	EffectHunger
	EffectWeakness
	EffectPoison
	EffectWither
	EffectHealthBoost
	EffectAbsorption
	EffectSaturation
	EffectLevitation
	EffectFatalPoison
	EffectConduitPower
)
View Source
const (
	MoveFlagOnGround = 1 << iota
	MoveFlagTeleport
)
View Source
const (
	MoveActorDeltaFlagHasX = 1 << iota
	MoveActorDeltaFlagHasY
	MoveActorDeltaFlagHasZ
	MoveActorDeltaFlagHasRotX
	MoveActorDeltaFlagHasRotY
	MoveActorDeltaFlagHasRotZ
	MoveActorDeltaFlagOnGround
	MoveActorDeltaFlagTeleport
	MoveActorDeltaFlagForceMove
)
View Source
const (
	MoveModeNormal = iota
	MoveModeReset
	MoveModeTeleport
	MoveModeRotation
)
View Source
const (
	TeleportCauseUnknown = iota
	TeleportCauseProjectile
	TeleportCauseChorusFruit
	TeleportCauseCommand
	TeleportCauseBehaviour
)
View Source
const (
	EnableMultiPlayer = iota
	DisableMultiPlayer
	RefreshJoinCode
)
View Source
const (
	NPCDialogueActionOpen int32 = iota
	NPCDialogueActionClose
)
View Source
const (
	NPCRequestActionSetActions = iota
	NPCRequestActionExecuteAction
	NPCRequestActionExecuteClosingCommands
	NPCRequestActionSetName
	NPCRequestActionSetSkin
	NPCRequestActionSetInteractText
	NPCRequestActionExecuteOpeningCommands
)
View Source
const (
	ViolationSeverityWarning = iota
	ViolationSeverityFinalWarning
	ViolationSeverityTerminatingConnection
)
View Source
const (
	PhotoTypePortfolio uint8 = iota
	PhotoTypePhotoItem
	PhotoTypeBook
)
View Source
const (
	PlayStatusLoginSuccess int32 = iota
	PlayStatusLoginFailedClient
	PlayStatusLoginFailedServer
	PlayStatusPlayerSpawn
	PlayStatusLoginFailedInvalidTenant
	PlayStatusLoginFailedVanillaEdu
	PlayStatusLoginFailedEduVanilla
	PlayStatusLoginFailedServerFull
)
View Source
const (
	InputFlagAscend = 1 << iota
	InputFlagDescend
	InputFlagNorthJump
	InputFlagJumpDown
	InputFlagSprintDown
	InputFlagChangeHeight
	InputFlagJumping
	InputFlagAutoJumpingInWater
	InputFlagSneaking
	InputFlagSneakDown
	InputFlagUp
	InputFlagDown
	InputFlagLeft
	InputFlagRight
	InputFlagUpLeft
	InputFlagUpRight
	InputFlagWantUp
	InputFlagWantDown
	InputFlagWantDownSlow
	InputFlagWantUpSlow
	InputFlagSprinting
	InputFlagAscendBlock
	InputFlagDescendBlock
	InputFlagSneakToggleDown
	InputFlagPersistSneak
	InputFlagStartSprinting
	InputFlagStopSprinting
	InputFlagStartSneaking
	InputFlagStopSneaking
	InputFlagStartSwimming
	InputFlagStopSwimming
	InputFlagStartJumping
	InputFlagStartGliding
	InputFlagStopGliding
	InputFlagPerformItemInteraction
	InputFlagPerformBlockActions
	InputFlagPerformItemStackRequest
)
View Source
const (
	InputModeMouse = iota + 1
	InputModeTouch
	InputModeGamePad
	InputModeMotionController
)
View Source
const (
	PlayModeNormal = iota
	PlayModeTeaser
	PlayModeScreen
	PlayModeViewer
	PlayModeReality
	PlayModePlacement
	PlayModeLivingRoom
	PlayModeExitLevel
	PlayModeExitLevelLivingRoom
	PlayModeNumModes
)
View Source
const (
	PlayerListActionAdd = iota
	PlayerListActionRemove
)
View Source
const (
	PositionTrackingDBBroadcastActionUpdate = iota
	PositionTrackingDBBroadcastActionDestroy
	PositionTrackingDBBroadcastActionNotFound
)
View Source
const (
	PackResponseRefused = iota + 1
	PackResponseSendPacks
	PackResponseAllPacksDownloaded
	PackResponseCompleted
)
View Source
const (
	ResourcePackTypeAddon = iota + 1
	ResourcePackTypeCached
	ResourcePackTypeCopyProtected
	ResourcePackTypeBehaviour
	ResourcePackTypePersonaPiece
	ResourcePackTypeResources
	ResourcePackTypeSkins
	ResourcePackTypeWorldTemplate
)

noinspection SpellCheckingInspection

View Source
const (
	// Respawn packets with these states are sent by the server.
	RespawnStateSearchingForSpawn = iota
	RespawnStateReadyToSpawn

	// A Respawn packet with this state is sent by the client.
	RespawnStateClientReadyToSpawn
)
View Source
const (
	ScoreboardSlotList      = "list"
	ScoreboardSlotSidebar   = "sidebar"
	ScoreboardSlotBelowName = "belowname"
)

noinspection SpellCheckingInspection

View Source
const (
	ScoreboardSortOrderAscending = iota
	ScoreboardSortOrderDescending
)
View Source
const (
	GameTypeSurvival = iota
	GameTypeCreative
	GameTypeAdventure
	GameTypeSurvivalSpectator
	GameTypeCreativeSpectator
)
View Source
const (
	ScoreboardActionModify = iota
	ScoreboardActionRemove
)
View Source
const (
	ScoreboardIdentityActionRegister = iota
	ScoreboardIdentityActionClear
)
View Source
const (
	SpawnTypePlayer = iota
	SpawnTypeWorld
)
View Source
const (
	TitleActionClear = iota
	TitleActionReset
	TitleActionSetTitle
	TitleActionSetSubtitle
	TitleActionSetActionBar
	TitleActionSetDurations
)
View Source
const (
	SimpleEventCommandsEnabled = iota + 1
	SimpleEventCommandsDisabled
)
View Source
const (
	SimulationTypeGame byte = iota
	SimulationTypeEditor
	SimulationTypeTest
	SimulationTypeInvalid
)
View Source
const (
	SpawnBiomeTypeDefault = iota
	SpawnBiomeTypeUserDefined
)
View Source
const (
	StructureBlockData = iota
	StructureBlockSave
	StructureBlockLoad
	StructureBlockCorner

	StructureBlockExport
)
View Source
const (
	StructureRedstoneSaveModeMemory = iota
	StructureRedstoneSaveModeDisk
)
View Source
const (
	StructureTemplateRequestExportFromSave = iota + 1
	StructureTemplateRequestExportFromLoad
	StructureTemplateRequestQuerySavedStructure
)
View Source
const (
	StructureTemplateResponseExport = iota + 1
	StructureTemplateResponseQuery
)
View Source
const (
	SubChunkRequestResultUndefined int32 = iota
	SubChunkRequestResultSuccess
	SubChunkRequestResultChunkNotFound
	SubChunkRequestResultInvalidDimension
	SubChunkRequestResultPlayerNotFound
	SubChunkRequestResultIndexOutOfBounds
)
View Source
const (
	HeightMapDataTypeNone byte = iota
	HeightMapDataTypeHasData
	HeightMapDataTypeTooHigh
	HeightMapDataTypeTooLow
)
View Source
const (
	TextTypeRaw = iota
	TextTypeChat
	TextTypeTranslation
	TextTypePopup
	TextTypeJukeboxPopup
	TextTypeTip
	TextTypeSystem
	TextTypeWhisper
	TextTypeAnnouncement
	TextTypeObject
	TextTypeObjectWhisper
)
View Source
const (
	BlockUpdateNeighbours = 1 << iota
	BlockUpdateNetwork
	BlockUpdateNoGraphics
	BlockUpdatePriority
)
View Source
const (
	BlockToEntityTransition = iota + 1
	EntityToBlockTransition
)
View Source
const (
	SoftEnumActionAdd = iota
	SoftEnumActionRemove
	SoftEnumActionSet
)
View Source
const (
	BlockEventChangeChestState = 1
)
View Source
const (
	EmoteFlagServerSide = 1 << iota
)
View Source
const (
	PositionTrackingDBRequestActionQuery = iota
)
View Source
const (
	ViolationTypeMalformed = iota
)

Variables

This section is empty.

Functions

func Register added in v1.5.0

func Register(id uint32, pk func() Packet)

Register registers a function that returns a packet for a specific ID. Packets with this ID coming in from connections will resolve to the packet returned by the function passed. noinspection GoUnusedExportedFunction

Types

type ActorEvent added in v0.9.2

type ActorEvent struct {
	// EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// EventType is the ID of the event to be called. It is one of the constants that can be found above.
	EventType byte
	// EventData is optional data associated with a particular event. The data has a different function for
	// different events, however most events don't use this field at all.
	EventData int32
}

ActorEvent is sent by the server when a particular event happens that has to do with an entity. Some of these events are entity-specific, for example a wolf shaking itself dry, but others are used for each entity, such as dying.

func (*ActorEvent) ID added in v0.9.2

func (*ActorEvent) ID() uint32

ID ...

func (*ActorEvent) Marshal added in v0.9.2

func (pk *ActorEvent) Marshal(w *protocol.Writer)

Marshal ...

func (*ActorEvent) Unmarshal added in v0.9.2

func (pk *ActorEvent) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ActorPickRequest added in v0.9.2

type ActorPickRequest struct {
	// EntityUniqueID is the unique ID of the entity that was attempted to be picked. The server must find the
	// type of that entity and provide the correct spawn egg to the player.
	EntityUniqueID int64
	// HotBarSlot is the held hot bar slot of the player at the time of trying to pick the entity. If empty,
	// the resulting spawn egg should be put into this slot.
	HotBarSlot byte
	// WithData is true if the pick request requests the entity metadata.
	WithData bool
}

ActorPickRequest is sent by the client when it tries to pick an entity, so that it gets a spawn egg which can spawn that entity.

func (*ActorPickRequest) ID added in v0.9.2

func (*ActorPickRequest) ID() uint32

ID ...

func (*ActorPickRequest) Marshal added in v0.9.2

func (pk *ActorPickRequest) Marshal(w *protocol.Writer)

Marshal ...

func (*ActorPickRequest) Unmarshal added in v0.9.2

func (pk *ActorPickRequest) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AddActor added in v0.9.2

type AddActor struct {
	// EntityUniqueID is the unique ID of the entity. The unique ID is a value that remains consistent across
	// different sessions of the same world, but most servers simply fill the runtime ID of the entity out for
	// this field.
	EntityUniqueID int64
	// EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// EntityType is the string entity type of the entity, for example 'minecraft:skeleton'. A list of these
	// entities may be found online.
	EntityType string
	// Position is the position to spawn the entity on. If the entity is on a distance that the player cannot
	// see it, the entity will still show up if the player moves closer.
	Position mgl32.Vec3
	// Velocity is the initial velocity the entity spawns with. This velocity will initiate client side
	// movement of the entity.
	Velocity mgl32.Vec3
	// Pitch is the vertical rotation of the entity. Facing straight forward yields a pitch of 0. Pitch is
	// measured in degrees.
	Pitch float32
	// Yaw is the horizontal rotation of the entity. Yaw is also measured in degrees.
	Yaw float32
	// HeadYaw is the same as Yaw, except that it applies specifically to the head of the entity. A different
	// value for HeadYaw than Yaw means that the entity will have its head turned.
	HeadYaw float32
	// Attributes is a slice of attributes that the entity has. It includes attributes such as its health,
	// movement speed, etc.
	Attributes []protocol.Attribute
	// EntityMetadata is a map of entity metadata, which includes flags and data properties that alter in
	// particular the way the entity looks. Flags include ones such as 'on fire' and 'sprinting'.
	// The metadata values are indexed by their property key.
	EntityMetadata map[uint32]interface{}
	// EntityLinks is a list of entity links that are currently active on the entity. These links alter the
	// way the entity shows up when first spawned in terms of it shown as riding an entity. Setting these
	// links is important for new viewers to see the entity is riding another entity.
	EntityLinks []protocol.EntityLink
}

AddActor is sent by the server to the client to spawn an entity to the player. It is used for every entity except other players, for which the AddPlayer packet is used.

func (*AddActor) ID added in v0.9.2

func (*AddActor) ID() uint32

ID ...

func (*AddActor) Marshal added in v0.9.2

func (pk *AddActor) Marshal(w *protocol.Writer)

Marshal ...

func (*AddActor) Unmarshal added in v0.9.2

func (pk *AddActor) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AddBehaviourTree added in v0.9.1

type AddBehaviourTree struct {
	// BehaviourTree is an unused string.
	BehaviourTree string
}

AddBehaviourTree is sent by the server to the client. The packet is currently unused by both client and server.

func (*AddBehaviourTree) ID added in v0.9.1

func (*AddBehaviourTree) ID() uint32

ID ...

func (*AddBehaviourTree) Marshal added in v0.9.1

func (pk *AddBehaviourTree) Marshal(w *protocol.Writer)

Marshal ...

func (*AddBehaviourTree) Unmarshal added in v0.9.1

func (pk *AddBehaviourTree) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AddEntity added in v0.3.0

type AddEntity struct {
	// EntityNetworkID is the network ID of the entity that should be added.
	EntityNetworkID uint64
}

AddEntity is sent by the server to the client. Its function is not entirely clear: It does not add an entity in the sense of an in-game entity, but has to do with the ECS that Minecraft uses.

func (*AddEntity) ID added in v0.3.0

func (pk *AddEntity) ID() uint32

ID ...

func (*AddEntity) Marshal added in v0.3.0

func (pk *AddEntity) Marshal(w *protocol.Writer)

Marshal ...

func (*AddEntity) Unmarshal added in v0.3.0

func (pk *AddEntity) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AddItemActor added in v0.9.2

type AddItemActor struct {
	// EntityUniqueID is the unique ID of the entity. The unique ID is a value that remains consistent across
	// different sessions of the same world, but most servers simply fill the runtime ID of the entity out for
	// this field.
	EntityUniqueID int64
	// EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// Item is the item that is spawned. It must have a valid ID for it to show up client-side. If it is not
	// a valid item, the client will crash when coming near.
	Item protocol.ItemInstance
	// Position is the position to spawn the entity on. If the entity is on a distance that the player cannot
	// see it, the entity will still show up if the player moves closer.
	Position mgl32.Vec3
	// Velocity is the initial velocity the entity spawns with. This velocity will initiate client side
	// movement of the entity.
	Velocity mgl32.Vec3
	// EntityMetadata is a map of entity metadata, which includes flags and data properties that alter in
	// particular the way the entity looks. Flags include ones such as 'on fire' and 'sprinting'.
	// The metadata values are indexed by their property key.
	EntityMetadata map[uint32]interface{}
	// FromFishing specifies if the item was obtained by fishing it up using a fishing rod. It is not clear
	// why the client needs to know this.
	FromFishing bool
}

AddItemActor is sent by the server to the client to make an item entity show up. It is one of the few entities that cannot be sent using the AddActor packet

func (*AddItemActor) ID added in v0.9.2

func (*AddItemActor) ID() uint32

ID ...

func (*AddItemActor) Marshal added in v0.9.2

func (pk *AddItemActor) Marshal(w *protocol.Writer)

Marshal ...

func (*AddItemActor) Unmarshal added in v0.9.2

func (pk *AddItemActor) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AddPainting added in v0.3.0

type AddPainting struct {
	// EntityUniqueID is the unique ID of the entity. The unique ID is a value that remains consistent across
	// different sessions of the same world, but most servers simply fill the runtime ID of the entity out for
	// this field.
	EntityUniqueID int64
	// EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// Position is the position to spawn the entity on. If the entity is on a distance that the player cannot
	// see it, the entity will still show up if the player moves closer.
	Position mgl32.Vec3
	// Direction is the facing direction of the painting.
	Direction int32
	// Title is the title of the painting. It specifies the motive of the painting. The title of the painting
	// must be valid.
	Title string
}

AddPainting is sent by the server to the client to make a painting entity show up. It is one of the few entities that cannot be sent using the AddActor packet.

func (*AddPainting) ID added in v0.3.0

func (*AddPainting) ID() uint32

ID ...

func (*AddPainting) Marshal added in v0.3.0

func (pk *AddPainting) Marshal(w *protocol.Writer)

Marshal ...

func (*AddPainting) Unmarshal added in v0.3.0

func (pk *AddPainting) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AddPlayer added in v0.3.0

type AddPlayer struct {
	// UUID is the UUID of the player. It is the same UUID that the client sent in the Login packet at the
	// start of the session. A player with this UUID must exist in the player list (built up using the
	// PlayerList packet), for it to show up in-game.
	UUID uuid.UUID
	// Username is the name of the player. This username is the username that will be set as the initial
	// name tag of the player.
	Username string
	// EntityUniqueID is the unique ID of the player. The unique ID is a value that remains consistent across
	// different sessions of the same world, but most servers simply fill the runtime ID of the player out for
	// this field.
	EntityUniqueID int64
	// EntityRuntimeID is the runtime ID of the player. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// PlatformChatID is an identifier only set for particular platforms when chatting (presumably only for
	// Nintendo Switch). It is otherwise an empty string, and is used to decide which players are able to
	// chat with each other.
	PlatformChatID string
	// Position is the position to spawn the player on. If the player is on a distance that the viewer cannot
	// see it, the player will still show up if the viewer moves closer.
	Position mgl32.Vec3
	// Velocity is the initial velocity the player spawns with. This velocity will initiate client side
	// movement of the player.
	Velocity mgl32.Vec3
	// Pitch is the vertical rotation of the player. Facing straight forward yields a pitch of 0. Pitch is
	// measured in degrees.
	Pitch float32
	// Yaw is the horizontal rotation of the player. Yaw is also measured in degrees.
	Yaw float32
	// HeadYaw is the same as Yaw, except that it applies specifically to the head of the player. A different
	// value for HeadYaw than Yaw means that the player will have its head turned.
	HeadYaw float32
	// HeldItem is the item that the player is holding. The item is shown to the viewer as soon as the player
	// itself shows up. Needless to say that this field is rather pointless, as additional packets still must
	// be sent for armour to show up.
	HeldItem protocol.ItemInstance
	// EntityMetadata is a map of entity metadata, which includes flags and data properties that alter in
	// particular the way the player looks. Flags include ones such as 'on fire' and 'sprinting'.
	// The metadata values are indexed by their property key.
	EntityMetadata map[uint32]interface{}
	// Flags is a set of flags that specify certain properties of the player, such as whether or not it can
	// fly and/or move through blocks.
	Flags uint32
	// CommandPermissionLevel is a set of permissions that specify what commands a player is allowed to execute.
	CommandPermissionLevel uint32
	// ActionPermissions is, much like Flags, a set of flags that specify actions that the player is allowed
	// to undertake, such as whether it is allowed to edit blocks, open doors etc.
	ActionPermissions uint32
	// PermissionLevel is the permission level of the player as it shows up in the player list built up using
	// the PlayerList packet.
	PermissionLevel uint32
	// CustomStoredPermissions ...
	CustomStoredPermissions uint32
	// PlayerUniqueID is a unique identifier of the player. It appears it is not required to fill this field
	// out with a correct value. Simply writing 0 seems to work.
	PlayerUniqueID int64
	// EntityLinks is a list of entity links that are currently active on the player. These links alter the
	// way the player shows up when first spawned in terms of it shown as riding an entity. Setting these
	// links is important for new viewers to see the player is riding another entity.
	EntityLinks []protocol.EntityLink
	// DeviceID is the device ID set in one of the files found in the storage of the device of the player. It
	// may be changed freely, so it should not be relied on for anything.
	DeviceID string
	// BuildPlatform is the build platform/device OS of the player that is about to be added, as it sent in
	// the Login packet when joining.
	BuildPlatform int32
}

AddPlayer is sent by the server to the client to make a player entity show up client-side. It is one of the few entities that cannot be sent using the AddActor packet.

func (*AddPlayer) ID added in v0.3.0

func (*AddPlayer) ID() uint32

ID ...

func (*AddPlayer) Marshal added in v0.3.0

func (pk *AddPlayer) Marshal(w *protocol.Writer)

Marshal ...

func (*AddPlayer) Unmarshal added in v0.3.0

func (pk *AddPlayer) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AddVolumeEntity added in v1.13.0

type AddVolumeEntity struct {
	// EntityRuntimeID ...
	EntityRuntimeID uint64
	// VolumeEntityData ...
	VolumeEntityData map[string]interface{}
	// EngineVersion ...
	EngineVersion string
}

AddVolumeEntity sends a volume entity's definition and components from server to client.

func (*AddVolumeEntity) ID added in v1.13.0

func (*AddVolumeEntity) ID() uint32

ID ...

func (*AddVolumeEntity) Marshal added in v1.13.0

func (pk *AddVolumeEntity) Marshal(w *protocol.Writer)

Marshal ...

func (*AddVolumeEntity) Unmarshal added in v1.13.0

func (pk *AddVolumeEntity) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AdventureSettings added in v0.7.0

type AdventureSettings struct {
	// Flags is a set of flags that specify certain properties of the player, such as whether or not it can
	// fly and/or move through blocks. It is one of the AdventureFlag constants above.
	Flags uint32
	// CommandPermissionLevel is a permission level that specifies the kind of commands that the player is
	// allowed to use. It is one of the CommandPermissionLevel constants above.
	CommandPermissionLevel uint32
	// ActionPermissions is, much like Flags, a set of flags that specify actions that the player is allowed
	// to undertake, such as whether it is allowed to edit blocks, open doors etc. It is a combination of the
	// ActionPermission constants above.
	ActionPermissions uint32
	// PermissionLevel is the permission level of the player as it shows up in the player list built up using
	// the PlayerList packet. It is one of the PermissionLevel constants above.
	PermissionLevel uint32
	// CustomStoredPermissions ...
	CustomStoredPermissions uint32
	// PlayerUniqueID is a unique identifier of the player. This must be filled out with the entity unique ID of the
	// player.
	PlayerUniqueID int64
}

AdventureSettings is sent by the server to update game-play related features, in particular permissions to access these features for the client. It includes allowing the player to fly, build and mine, and attack entities. Most of these flags should be checked server-side instead of using this packet only. The client may also send this packet to the server when it updates one of these settings through the in-game settings interface. The server should verify if the player actually has permission to update those settings.

func (*AdventureSettings) ID added in v0.7.0

func (*AdventureSettings) ID() uint32

ID ...

func (*AdventureSettings) Marshal added in v0.7.0

func (pk *AdventureSettings) Marshal(w *protocol.Writer)

Marshal ...

func (*AdventureSettings) Unmarshal added in v0.7.0

func (pk *AdventureSettings) Unmarshal(r *protocol.Reader)

Unmarshal ...

type Animate added in v0.7.0

type Animate struct {
	// ActionType is the ID of the animation action to execute. It is one of the action type constants that
	// may be found above.
	ActionType int32
	// EntityRuntimeID is the runtime ID of the player that the animation should be played upon. The runtime
	// ID is unique for each world session, and entities are generally identified in packets using this
	// runtime ID.
	EntityRuntimeID uint64
	// BoatRowingTime ...
	BoatRowingTime float32
}

Animate is sent by the server to send a player animation from one player to all viewers of that player. It is used for a couple of actions, such as arm swimming and critical hits.

func (*Animate) ID added in v0.7.0

func (*Animate) ID() uint32

ID ...

func (*Animate) Marshal added in v0.7.0

func (pk *Animate) Marshal(w *protocol.Writer)

Marshal ...

func (*Animate) Unmarshal added in v0.7.0

func (pk *Animate) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AnimateEntity added in v1.9.0

type AnimateEntity struct {
	// Animation is the name of a single animation to start playing.
	Animation string
	// NextState is the first state to start with. These states are declared in animation controllers (which,
	// in themselves, are animations too). These states in turn may have animations and transitions to move to
	// a next state.
	NextState string
	// StopCondition is a MoLang expression that specifies when the animation should be stopped.
	StopCondition string
	// StopConditionVersion is the MoLang stop condition version.
	StopConditionVersion int64
	// Controller is the animation controller that is used to manage animations. These controllers decide when
	// to play which animation.
	Controller string
	// BlendOutTime does not currently seem to be used.
	BlendOutTime float32
	// EntityRuntimeIDs is list of runtime IDs of entities that the animation should be applied to.
	EntityRuntimeIDs []uint64
}

AnimateEntity is sent by the server to animate an entity client-side. It may be used to play a single animation, or to activate a controller which can start a sequence of animations based on different conditions specified in an animation controller. Much of the documentation of this packet can be found at https://minecraft.gamepedia.com/Bedrock_Edition_beta_animation_documentation.

func (*AnimateEntity) ID added in v1.9.0

func (*AnimateEntity) ID() uint32

ID ...

func (*AnimateEntity) Marshal added in v1.9.0

func (pk *AnimateEntity) Marshal(w *protocol.Writer)

Marshal ...

func (*AnimateEntity) Unmarshal added in v1.9.0

func (pk *AnimateEntity) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AnvilDamage added in v1.3.0

type AnvilDamage struct {
	// Damage is the damage that the client requests to be dealt to the anvil.
	Damage uint8
	// AnvilPosition is the position in the world that the anvil can be found at.
	AnvilPosition protocol.BlockPos
}

AnvilDamage is sent by the client to request the dealing damage to an anvil. This packet is completely pointless and the server should never listen to it.

func (*AnvilDamage) ID added in v1.3.0

func (*AnvilDamage) ID() uint32

ID ...

func (*AnvilDamage) Marshal added in v1.3.0

func (pk *AnvilDamage) Marshal(w *protocol.Writer)

Marshal ...

func (*AnvilDamage) Unmarshal added in v1.3.0

func (pk *AnvilDamage) Unmarshal(r *protocol.Reader)

Unmarshal ..

type AutomationClientConnect added in v0.9.1

type AutomationClientConnect struct {
	// ServerURI is the URI to make the client connect to. It can be, for example, 'localhost:8000/ws' to
	// connect to a websocket server on the localhost at port 8000.
	ServerURI string
}

AutomationClientConnect is used to make the client connect to a websocket server. This websocket server has the ability to execute commands on the behalf of the client and it can listen for certain events fired by the client.

func (*AutomationClientConnect) ID added in v0.9.1

ID ...

func (*AutomationClientConnect) Marshal added in v0.9.1

func (pk *AutomationClientConnect) Marshal(w *protocol.Writer)

Marshal ...

func (*AutomationClientConnect) Unmarshal added in v0.9.1

func (pk *AutomationClientConnect) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AvailableActorIdentifiers added in v0.9.2

type AvailableActorIdentifiers struct {
	// SerialisedEntityIdentifiers is a network NBT serialised compound of all entity identifiers that are
	// available in the server.
	SerialisedEntityIdentifiers []byte
}

AvailableActorIdentifiers is sent by the server at the start of the game to let the client know all entities that are available on the server.

func (*AvailableActorIdentifiers) ID added in v0.9.2

ID ...

func (*AvailableActorIdentifiers) Marshal added in v0.9.2

func (pk *AvailableActorIdentifiers) Marshal(w *protocol.Writer)

Marshal ...

func (*AvailableActorIdentifiers) Unmarshal added in v0.9.2

func (pk *AvailableActorIdentifiers) Unmarshal(r *protocol.Reader)

Unmarshal ...

type AvailableCommands added in v0.9.1

type AvailableCommands struct {
	// Commands is a list of all commands that the client should show client-side. The AvailableCommands
	// packet replaces any commands sent before. It does not only add the commands that are sent in it.
	Commands []protocol.Command
	// Constraints is a list of constraints that should be applied to certain options of enums in the commands
	// above.
	Constraints []protocol.CommandEnumConstraint
}

AvailableCommands is sent by the server to send a list of all commands that the player is able to use on the server. This packet holds all the arguments of each commands as well, making it possible for the client to provide auto-completion and command usages.

func (*AvailableCommands) ID added in v0.9.1

func (*AvailableCommands) ID() uint32

ID ...

func (*AvailableCommands) Marshal added in v0.9.1

func (pk *AvailableCommands) Marshal(w *protocol.Writer)

Marshal ...

func (*AvailableCommands) Unmarshal added in v0.9.1

func (pk *AvailableCommands) Unmarshal(r *protocol.Reader)

Unmarshal ...

type BiomeDefinitionList added in v0.9.1

type BiomeDefinitionList struct {
	// SerialisedBiomeDefinitions is a network NBT serialised compound of all definitions of biomes that are
	// available on the server.
	SerialisedBiomeDefinitions []byte
}

BiomeDefinitionList is sent by the server to let the client know all biomes that are available and implemented on the server side. It is much like the AvailableActorIdentifiers packet, but instead functions for biomes.

func (*BiomeDefinitionList) ID added in v0.9.1

ID ...

func (*BiomeDefinitionList) Marshal added in v0.9.1

func (pk *BiomeDefinitionList) Marshal(w *protocol.Writer)

Marshal ...

func (*BiomeDefinitionList) Unmarshal added in v0.9.1

func (pk *BiomeDefinitionList) Unmarshal(r *protocol.Reader)

Unmarshal ...

type BlockActorData added in v0.9.2

type BlockActorData struct {
	// Position is the position of the block that holds the block entity. If no block entity is at this
	// position, the packet is ignored by the client.
	Position protocol.BlockPos
	// NBTData is the new data of the block that will be encoded to NBT and applied client-side, so that the
	// client can see the block update. The NBTData should contain all properties of the block, not just
	// properties that were changed.
	NBTData map[string]interface{}
}

BlockActorData is sent by the server to update data of a block entity client-side, for example the data of a chest.

func (*BlockActorData) ID added in v0.9.2

func (*BlockActorData) ID() uint32

ID ...

func (*BlockActorData) Marshal added in v0.9.2

func (pk *BlockActorData) Marshal(w *protocol.Writer)

Marshal ...

func (*BlockActorData) Unmarshal added in v0.9.2

func (pk *BlockActorData) Unmarshal(r *protocol.Reader)

Unmarshal ...

type BlockEvent added in v0.3.0

type BlockEvent struct {
	// Position is the position of the block that an event occurred at.
	Position protocol.BlockPos
	// EventType is the type of the block event. The event type decides the way the event data that follows
	// is used. It is one of the constants found above.
	EventType int32
	// EventData holds event type specific data. For chests for example, opening the chest means the data must
	// hold 1, whereas closing it should hold 0.
	EventData int32
}

BlockEvent is sent by the server to initiate a certain event that has something to do with blocks in specific, for example opening a chest.

func (*BlockEvent) ID added in v0.3.0

func (*BlockEvent) ID() uint32

ID ...

func (*BlockEvent) Marshal added in v0.3.0

func (pk *BlockEvent) Marshal(w *protocol.Writer)

Marshal ...

func (*BlockEvent) Unmarshal added in v0.3.0

func (pk *BlockEvent) Unmarshal(r *protocol.Reader)

Unmarshal ...

type BlockPickRequest added in v0.6.0

type BlockPickRequest struct {
	// Position is the position at which the client requested to pick the block. The block at that position
	// should have its item put in HotBarSlot if it is empty.
	Position protocol.BlockPos
	// AddBlockNBT specifies if the item should get all NBT tags from the block, meaning the item places a
	// block practically always equal to the one picked.
	AddBlockNBT bool
	// HotBarSlot is the slot that was held at the time of picking a block.
	HotBarSlot byte
}

BlockPickRequest is sent by the client when it requests to pick a block in the world and place its item in their inventory.

func (*BlockPickRequest) ID added in v0.6.0

func (*BlockPickRequest) ID() uint32

ID ...

func (*BlockPickRequest) Marshal added in v0.6.0

func (pk *BlockPickRequest) Marshal(w *protocol.Writer)

Marshal ...

func (*BlockPickRequest) Unmarshal added in v0.6.0

func (pk *BlockPickRequest) Unmarshal(r *protocol.Reader)

Unmarshal ...

type BookEdit added in v0.9.1

type BookEdit struct {
	// ActionType is the type of the book edit action. The data obtained depends on what type this is. The
	// action type is one of the constants above.
	ActionType byte
	// InventorySlot is the slot in which the book that was edited may be found. Typically, the server should
	// check if this slot matches the held item slot of the player.
	InventorySlot byte
	// PageNumber is the number of the page that the book edit action concerns. It applies for all actions
	// but the BookActionSign. In BookActionSwapPages, it is one of the pages that was swapped.
	PageNumber byte
	// SecondaryPageNumber is the page number of the second page that the action concerned. It is only set for
	// the BookActionSwapPages action, in which case it is the other page that is swapped.
	SecondaryPageNumber byte
	// Text is the text that was written in a particular page of the book. It applies for the
	// BookActionAddPage and BookActionReplacePage only.
	Text string
	// PhotoName is the name of the photo on the page in the book. It applies for the BookActionAddPage and
	// BookActionReplacePage only.
	// Unfortunately, the functionality of this field was removed from the default Minecraft Bedrock Edition.
	// It is still available on Education Edition.
	PhotoName string
	// Title is the title that the player has given the book. It applies only for the BookActionSign action.
	Title string
	// Author is the author that the player has given the book. It applies only for the BookActionSign action.
	// Note that the author may be freely changed, so no assumptions can be made on if the author is actually
	// the name of a player.
	Author string
	// XUID is the XBOX Live User ID of the player that edited the book. The field is rather pointless, as the
	// server is already aware of the XUID of the player anyway.
	XUID string
}

BookEdit is sent by the client when it edits a book. It is sent each time a modification was made and the player stops its typing 'session', rather than simply after closing the book.

func (*BookEdit) ID added in v0.9.1

func (*BookEdit) ID() uint32

ID ...

func (*BookEdit) Marshal added in v0.9.1

func (pk *BookEdit) Marshal(w *protocol.Writer)

Marshal ...

func (*BookEdit) Unmarshal added in v0.9.1

func (pk *BookEdit) Unmarshal(r *protocol.Reader)

Unmarshal ...

type BossEvent added in v0.7.0

type BossEvent struct {
	// BossEntityUniqueID is the unique ID of the boss entity that the boss event sent involves. The health
	// percentage and title of the boss bar depend on the health and name tag of this entity.
	BossEntityUniqueID int64
	// EventType is the type of the event. The fields written depend on the event type set, and some event
	// types are sent by the client, whereas others are sent by the server. The event type is one of the
	// constants above.
	EventType uint32
	// PlayerUniqueID is the unique ID of the player that is registered to or unregistered from the boss
	// fight. It is set if EventType is either BossEventRegisterPlayer or BossEventUnregisterPlayer.
	PlayerUniqueID int64
	// BossBarTitle is the title shown above the boss bar. It currently does not function, and instead uses
	// the name tag of the boss entity at all times. It is only set if the EventType is BossEventShow or
	// BossEventTitle.
	BossBarTitle string
	// HealthPercentage is the percentage of health that is shown in the boss bar. It currently does not
	// function, and instead uses the health percentage of the boss entity at all times. It is only set if the
	// EventType is BossEventShow or BossEventHealthPercentage.
	HealthPercentage float32
	// ScreenDarkening currently seems not to do anything.
	ScreenDarkening int16
	// Colour is the colour of the boss bar that is shown when a player is subscribed. It currently does not
	// function. It is only set if the EventType is BossEventShow, BossEventAppearanceProperties or
	// BossEventTexture.
	Colour uint32
	// Overlay is the overlay of the boss bar that is shown on top of the boss bar when a player is
	// subscribed. It currently does not function. It is only set if the EventType is BossEventShow,
	// BossEventAppearanceProperties or BossEventTexture.
	Overlay uint32
}

BossEvent is sent by the server to make a specific 'boss event' occur in the world. It includes features such as showing a boss bar to the player and turning the sky dark.

func (*BossEvent) ID added in v0.7.0

func (*BossEvent) ID() uint32

ID ...

func (*BossEvent) Marshal added in v0.7.0

func (pk *BossEvent) Marshal(w *protocol.Writer)

Marshal ...

func (*BossEvent) Unmarshal added in v0.7.0

func (pk *BossEvent) Unmarshal(r *protocol.Reader)

Unmarshal ...

type Camera added in v0.7.0

type Camera struct {
	// CameraEntityUniqueID is the unique ID of the camera entity from which the picture was taken.
	CameraEntityUniqueID int64
	// TargetPlayerUniqueID is the unique ID of the target player. The unique ID is a value that remains
	// consistent across different sessions of the same world, but most servers simply fill the runtime ID of
	// the player out for this field.
	TargetPlayerUniqueID int64
}

Camera is sent by the server to use an Education Edition camera on a player. It produces an image client-side.

func (*Camera) ID added in v0.7.0

func (*Camera) ID() uint32

ID ...

func (*Camera) Marshal added in v0.7.0

func (pk *Camera) Marshal(w *protocol.Writer)

Marshal ...

func (*Camera) Unmarshal added in v0.7.0

func (pk *Camera) Unmarshal(r *protocol.Reader)

Unmarshal ...

type CameraShake added in v1.9.0

type CameraShake struct {
	// Intensity is the intensity of the shaking. The client limits this value to 4, so anything higher may
	// not work.
	Intensity float32
	// Duration is the number of seconds the camera will shake for.
	Duration float32
	// Type is the type of shake, and is one of the constants listed above. The different type affects how
	// the shake looks in game.
	Type uint8
	// Action is the action to be performed, and is one of the constants listed above. Currently the
	// different actions will either add or stop shaking the client.
	Action uint8
}

CameraShake is sent by the server to make the camera shake client-side. This feature was added for map- making partners.

func (*CameraShake) ID added in v1.9.0

func (*CameraShake) ID() uint32

ID ...

func (*CameraShake) Marshal added in v1.9.0

func (pk *CameraShake) Marshal(w *protocol.Writer)

Marshal ...

func (*CameraShake) Unmarshal added in v1.9.0

func (pk *CameraShake) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ChangeDimension added in v0.7.0

type ChangeDimension struct {
	// Dimension is the dimension that the client should be changed to. The fog colour will change depending
	// on the type of dimension, which is one of the constants above.
	// Note that Dimension MUST be a different dimension than the one that the player is currently in. Sending
	// a ChangeDimension packet with a Dimension that the player is currently in will result in a never-ending
	// dimension change screen.
	Dimension int32
	// Position is the position in the new dimension that the player is spawned in.
	Position mgl32.Vec3
	// Respawn specifies if the dimension change was respawn based, meaning that the player died in one
	// dimension and got respawned into another. The client will send a PlayerAction packet with
	// PlayerActionDimensionChangeRequest if it dies in another dimension, indicating that it needs a
	// DimensionChange packet with Respawn set to true.
	Respawn bool
}

ChangeDimension is sent by the server to the client to send a dimension change screen client-side. Once the screen is cleared client-side, the client will send a PlayerAction packet with PlayerActionDimensionChangeDone.

func (*ChangeDimension) ID added in v0.7.0

func (*ChangeDimension) ID() uint32

ID ...

func (*ChangeDimension) Marshal added in v0.7.0

func (pk *ChangeDimension) Marshal(w *protocol.Writer)

Marshal ...

func (*ChangeDimension) Unmarshal added in v0.7.0

func (pk *ChangeDimension) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ChunkRadiusUpdated

type ChunkRadiusUpdated struct {
	// ChunkRadius is the final chunk radius that the client will adapt when it receives the packet. It does
	// not have to be the same as the requested chunk radius.
	ChunkRadius int32
}

ChunkRadiusUpdated is sent by the server in response to a RequestChunkRadius packet. It defines the chunk radius that the server allows the client to have. This may be lower than the chunk radius requested by the client in the RequestChunkRadius packet.

func (*ChunkRadiusUpdated) ID

func (*ChunkRadiusUpdated) ID() uint32

ID ...

func (*ChunkRadiusUpdated) Marshal

func (pk *ChunkRadiusUpdated) Marshal(w *protocol.Writer)

Marshal ...

func (*ChunkRadiusUpdated) Unmarshal

func (pk *ChunkRadiusUpdated) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ClientBoundDebugRenderer added in v1.11.0

type ClientBoundDebugRenderer struct {
	// Type is the type of action. It is one of the constants above.
	Type int32
	// Text is the text that is displayed above the debug.
	Text string
	// Position is the position to spawn the debug on.
	Position mgl32.Vec3
	// Red is the red value from the RGBA colour rendered on the debug. This value is in the range 0-1.
	Red float32
	// Green is the green value from the RGBA colour rendered on the debug. This value is in the range 0-1.
	Green float32
	// Blue is the blue value from the RGBA colour rendered on the debug. This value is in the range 0-1.
	Blue float32
	// Alpha is the alpha value from the RGBA colour rendered on the debug. This value is in the range 0-1.
	Alpha float32
	// Duration is how long the debug will last in the world for. It is measured in milliseconds.
	Duration int64
}

ClientBoundDebugRenderer is sent by the server to spawn an outlined cube on client-side.

func (*ClientBoundDebugRenderer) ID added in v1.11.0

ID ...

func (*ClientBoundDebugRenderer) Marshal added in v1.11.0

func (pk *ClientBoundDebugRenderer) Marshal(w *protocol.Writer)

Marshal ...

func (*ClientBoundDebugRenderer) Unmarshal added in v1.11.0

func (pk *ClientBoundDebugRenderer) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ClientBoundMapItemData added in v0.7.0

type ClientBoundMapItemData struct {
	// MapID is the unique identifier that represents the map that is updated over network. It remains
	// consistent across sessions.
	MapID int64
	// UpdateFlags is a combination of flags found above that indicate what parts of the map should be updated
	// client-side.
	UpdateFlags uint32
	// Dimension is the dimension of the map that should be updated, for example the overworld (0), the nether
	// (1) or the end (2).
	Dimension byte
	// LockedMap specifies if the map that was updated was a locked map, which may be done using a cartography
	// table.
	LockedMap bool
	// Scale is the scale of the map as it is shown in-game. It is written when any of the MapUpdateFlags are
	// set to the UpdateFlags field.
	Scale byte

	// MapsIncludedIn holds an array of map IDs that the map updated is included in. This has to do with the
	// scale of the map: Each map holds its own map ID and all map IDs of maps that include this map and have
	// a bigger scale. This means that a scale 0 map will have 5 map IDs in this slice, whereas a scale 4 map
	// will have only 1 (its own).
	// The actual use of this field remains unknown.
	MapsIncludedIn []int64

	// TrackedObjects is a list of tracked objects on the map, which may either be entities or blocks. The
	// client makes sure these tracked objects are actually tracked. (position updated etc.)
	TrackedObjects []protocol.MapTrackedObject
	// Decorations is a list of fixed decorations located on the map. The decorations will not change
	// client-side, unless the server updates them.
	Decorations []protocol.MapDecoration

	// Height is the height of the texture area that was updated. The height may be a subset of the total
	// height of the map.
	Height int32
	// Width is the width of the texture area that was updated. The width may be a subset of the total width
	// of the map.
	Width int32
	// XOffset is the X offset in pixels at which the updated texture area starts. From this X, the updated
	// texture will extend exactly Width pixels to the right.
	XOffset int32
	// YOffset is the Y offset in pixels at which the updated texture area starts. From this Y, the updated
	// texture will extend exactly Height pixels up.
	YOffset int32
	// Pixels is a list of pixel colours for the new texture of the map. It is indexed as Pixels[y][x], with
	// the length of the outer slice having to be exactly Height long and the inner slices exactly Width long.
	Pixels [][]color.RGBA
}

ClientBoundMapItemData is sent by the server to the client to update the data of a map shown to the client. It is sent with a combination of flags that specify what data is updated. The ClientBoundMapItemData packet may be used to update specific parts of the map only. It is not required to send the entire map each time when updating one part.

func (*ClientBoundMapItemData) ID added in v0.7.0

ID ...

func (*ClientBoundMapItemData) Marshal added in v0.7.0

func (pk *ClientBoundMapItemData) Marshal(w *protocol.Writer)

Marshal ...

func (*ClientBoundMapItemData) Unmarshal added in v0.7.0

func (pk *ClientBoundMapItemData) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ClientCacheBlobStatus added in v0.9.2

type ClientCacheBlobStatus struct {
	// MissHashes is a list of blob hashes that the client does not have a blob available for. The server
	// should send the blobs matching these hashes as soon as possible.
	MissHashes []uint64
	// HitHashes is a list of blob hashes that the client has a blob available for. The blobs hashes here mean
	// that the client already has them: The server does not need to send the blobs anymore.
	HitHashes []uint64
}

ClientCacheBlobStatus is part of the blob cache protocol. It is sent by the client to let the server know what blobs it needs and which blobs it already has, in an ACK type system.

func (*ClientCacheBlobStatus) ID added in v0.9.2

func (pk *ClientCacheBlobStatus) ID() uint32

ID ...

func (*ClientCacheBlobStatus) Marshal added in v0.9.2

func (pk *ClientCacheBlobStatus) Marshal(w *protocol.Writer)

Marshal ...

func (*ClientCacheBlobStatus) Unmarshal added in v0.9.2

func (pk *ClientCacheBlobStatus) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ClientCacheMissResponse added in v0.9.2

type ClientCacheMissResponse struct {
	// Blobs is a list of all blobs that the client sent misses for in the ClientCacheBlobStatus. These blobs
	// hold the data of the blobs with the hashes they are matched with.
	Blobs []protocol.CacheBlob
}

ClientCacheMissResponse is part of the blob cache protocol. It is sent by the server in response to a ClientCacheBlobStatus packet and contains the blob data of all blobs that the client acknowledged not to have yet.

func (*ClientCacheMissResponse) ID added in v0.9.2

ID ...

func (*ClientCacheMissResponse) Marshal added in v0.9.2

func (pk *ClientCacheMissResponse) Marshal(w *protocol.Writer)

Marshal ...

func (*ClientCacheMissResponse) Unmarshal added in v0.9.2

func (pk *ClientCacheMissResponse) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ClientCacheStatus added in v0.9.2

type ClientCacheStatus struct {
	// Enabled specifies if the blob cache is enabled. If false, the server should not attempt to use the
	// blob cache. If true, it may do so, but it may also choose not to use it.
	Enabled bool
}

ClientCacheStatus is sent by the client to the server at the start of the game. It is sent to let the server know if it supports the client-side blob cache. Clients such as Nintendo Switch do not support the cache, and attempting to use it anyway will fail.

func (*ClientCacheStatus) ID added in v0.9.2

func (pk *ClientCacheStatus) ID() uint32

ID ...

func (*ClientCacheStatus) Marshal added in v0.9.2

func (pk *ClientCacheStatus) Marshal(w *protocol.Writer)

Marshal ...

func (*ClientCacheStatus) Unmarshal added in v0.9.2

func (pk *ClientCacheStatus) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ClientToServerHandshake

type ClientToServerHandshake struct {
}

ClientToServerHandshake is sent by the client in response to a ServerToClientHandshake packet sent by the server. It is the first encrypted packet in the login handshake and serves as a confirmation that encryption is correctly initialised client side.

func (*ClientToServerHandshake) ID

ID ...

func (*ClientToServerHandshake) Marshal

Marshal ...

func (*ClientToServerHandshake) Unmarshal

Unmarshal ...

type CodeBuilder added in v1.7.0

type CodeBuilder struct {
	// URL is the url to the Code Builder (websocket) server.
	URL string
	// ShouldOpenCodeBuilder specifies if the client should automatically open the Code Builder app. If set to
	// true, the client will attempt to use the Code Builder app to connect to and interface with the server
	// running at the URL above.
	ShouldOpenCodeBuilder bool
}

CodeBuilder is an Education Edition packet sent by the server to the client to open the URL to a Code Builder (websocket) server.

func (*CodeBuilder) ID added in v1.7.0

func (*CodeBuilder) ID() uint32

ID ...

func (*CodeBuilder) Marshal added in v1.7.0

func (pk *CodeBuilder) Marshal(w *protocol.Writer)

Marshal ...

func (*CodeBuilder) Unmarshal added in v1.7.0

func (pk *CodeBuilder) Unmarshal(r *protocol.Reader)

Unmarshal ...

type CommandBlockUpdate added in v0.9.1

type CommandBlockUpdate struct {
	// Block specifies if the command block updated was an actual physical block. If false, the command block
	// is in a minecart and has an entity runtime ID instead.
	Block bool

	// Position is the position of the command block updated. It is only set if Block is set to true. Nothing
	// happens if no command block is set at this position.
	Position protocol.BlockPos
	// Mode is the mode of the command block. It is either CommandBlockImpulse, CommandBlockChain or
	// CommandBlockRepeat. It is only set if Block is set to true.
	Mode uint32
	// NeedsRedstone specifies if the command block needs to be powered by redstone to be activated. If false,
	// the command block is always active. The field is only set if Block is set to true.
	NeedsRedstone bool
	// Conditional specifies the behaviour of the command block if the command block before it (the opposite
	// side of the direction the arrow if facing) fails to execute. If set to false, it will activate at all
	// times, whereas if set to true, it will activate only if the previous command block executed
	// successfully. The field is only set if Block is set to true.
	Conditional bool

	// MinecartEntityRuntimeID is the runtime ID of the minecart entity carrying the command block that is
	// updated. It is set only if Block is set to false.
	MinecartEntityRuntimeID uint64

	// Command is the command currently entered in the command block. This is the command that is executed
	// when the command block is activated.
	Command string
	// LastOutput is the output of the last command executed by the command block. It may be left empty to
	// show simply no output at all, in combination with setting ShouldTrackOutput to false.
	LastOutput string
	// Name is the name of the command block updated. If not empty, it will show this name hovering above the
	// command block when hovering over the block with the cursor.
	Name string
	// ShouldTrackOutput specifies if the command block tracks output. If set to false, the output box won't
	// be shown within the command block.
	ShouldTrackOutput bool
	// TickDelay is the delay in ticks between executions of a command block, if it is a repeating command
	// block.
	TickDelay int32
	// ExecuteOnFirstTick specifies if the command block should execute on the first tick, AKA as soon as the
	// command block is enabled.
	ExecuteOnFirstTick bool
}

CommandBlockUpdate is sent by the client to update a command block at a specific position. The command block may be either a physical block or an entity.

func (*CommandBlockUpdate) ID added in v0.9.1

func (*CommandBlockUpdate) ID() uint32

ID ...

func (*CommandBlockUpdate) Marshal added in v0.9.1

func (pk *CommandBlockUpdate) Marshal(w *protocol.Writer)

Marshal ...

func (*CommandBlockUpdate) Unmarshal added in v0.9.1

func (pk *CommandBlockUpdate) Unmarshal(r *protocol.Reader)

Unmarshal ...

type CommandOutput added in v0.9.1

type CommandOutput struct {
	// CommandOrigin is the data specifying the origin of the command. In other words, the source that the
	// command request was from, such as the player itself or a websocket server. The client forwards the
	// messages in this packet to the right origin, depending on what is sent here.
	CommandOrigin protocol.CommandOrigin
	// OutputType specifies the type of output that is sent. The OutputType sent by vanilla games appears to
	// be 3, which seems to work.
	OutputType byte
	// SuccessCount is the amount of times that a command was executed successfully as a result of the command
	// that was requested. For servers, this is usually a rather meaningless fields, but for vanilla, this is
	// applicable for commands created with Functions.
	SuccessCount uint32
	// OutputMessages is a list of all output messages that should be sent to the player. Whether they are
	// shown or not, depends on the type of the messages.
	OutputMessages []protocol.CommandOutputMessage
	// DataSet ... TODO: Find out what this is for.
	DataSet string
}

CommandOutput is sent by the server to the client to send text as output of a command. Most servers do not use this packet and instead simply send Text packets, but there is reason to send it. If the origin of a CommandRequest packet is not the player itself, but, for example, a websocket server, sending a Text packet will not do what is expected: The message should go to the websocket server, not to the client's chat. The CommandOutput packet will make sure the messages are relayed to the correct origin of the command request.

func (*CommandOutput) ID added in v0.9.1

func (*CommandOutput) ID() uint32

ID ...

func (*CommandOutput) Marshal added in v0.9.1

func (pk *CommandOutput) Marshal(w *protocol.Writer)

Marshal ...

func (*CommandOutput) Unmarshal added in v0.9.1

func (pk *CommandOutput) Unmarshal(r *protocol.Reader)

Unmarshal ...

type CommandRequest added in v0.9.1

type CommandRequest struct {
	// CommandLine is the raw entered command line. The client does no parsing of the command line by itself
	// (unlike it did in the early stages), but lets the server do that.
	CommandLine string
	// CommandOrigin is the data specifying the origin of the command. In other words, the source that the
	// command was from, such as the player itself or a websocket server.
	CommandOrigin protocol.CommandOrigin
	// Internal specifies if the command request internal. Setting it to false seems to work and the usage of
	// this field is not known.
	Internal bool
}

CommandRequest is sent by the client to request the execution of a server-side command. Although some servers support sending commands using the Text packet, this packet is guaranteed to have the correct result.

func (*CommandRequest) ID added in v0.9.1

func (*CommandRequest) ID() uint32

ID ...

func (*CommandRequest) Marshal added in v0.9.1

func (pk *CommandRequest) Marshal(w *protocol.Writer)

Marshal ...

func (*CommandRequest) Unmarshal added in v0.9.1

func (pk *CommandRequest) Unmarshal(r *protocol.Reader)

Unmarshal ...

type CompletedUsingItem added in v1.3.0

type CompletedUsingItem struct {
	// UsedItemID is the item ID of the item that the client completed using. This should typically be the
	// ID of the item held in the hand.
	UsedItemID int16
	// UseMethod is the method of the using of the item that was completed. It is one of the constants that
	// may be found above.
	UseMethod int32
}

CompletedUsingItem is sent by the server to tell the client that it should be done using the item it is currently using.

func (*CompletedUsingItem) ID added in v1.3.0

func (*CompletedUsingItem) ID() uint32

ID ...

func (*CompletedUsingItem) Marshal added in v1.3.0

func (pk *CompletedUsingItem) Marshal(w *protocol.Writer)

Marshal ...

func (*CompletedUsingItem) Unmarshal added in v1.3.0

func (pk *CompletedUsingItem) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ContainerClose added in v0.7.0

type ContainerClose struct {
	// WindowID is the ID representing the window of the container that should be closed. It must be equal to
	// the one sent in the ContainerOpen packet to close the designated window.
	WindowID byte
	// ServerSide determines whether or not the container was force-closed by the server. If this value is
	// not set correctly, the client may ignore the packet and respond with a PacketViolationWarning.
	ServerSide bool
}

ContainerClose is sent by the server to close a container the player currently has opened, which was opened using the ContainerOpen packet, or by the client to tell the server it closed a particular container, such as the crafting grid.

func (*ContainerClose) ID added in v0.7.0

func (*ContainerClose) ID() uint32

ID ...

func (*ContainerClose) Marshal added in v0.7.0

func (pk *ContainerClose) Marshal(w *protocol.Writer)

Marshal ...

func (*ContainerClose) Unmarshal added in v0.7.0

func (pk *ContainerClose) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ContainerOpen added in v0.7.0

type ContainerOpen struct {
	// WindowID is the ID representing the window that is being opened. It may be used later to close the
	// container using a ContainerClose packet.
	WindowID byte
	// ContainerType is the type ID of the container that is being opened when opening the container at the
	// position of the packet. It depends on the block/entity, and could, for example, be the window type of
	// a chest or a hopper, but also a horse inventory.
	ContainerType byte
	// ContainerPosition is the position of the container opened. The position must point to a block entity
	// that actually has a container. If that is not the case, the window will not be opened and the packet
	// will be ignored, if a valid ContainerEntityUniqueID has not also been provided.
	ContainerPosition protocol.BlockPos
	// ContainerEntityUniqueID is the unique ID of the entity container that was opened. It is only used if
	// the ContainerType is one that points to an entity, for example a horse.
	ContainerEntityUniqueID int64
}

ContainerOpen is sent by the server to open a container client-side. This container must be physically present in the world, for the packet to have any effect. Unlike Java Edition, Bedrock Edition requires that chests for example must be present and in range to open its inventory.

func (*ContainerOpen) ID added in v0.7.0

func (*ContainerOpen) ID() uint32

ID ...

func (*ContainerOpen) Marshal added in v0.7.0

func (pk *ContainerOpen) Marshal(w *protocol.Writer)

Marshal ...

func (*ContainerOpen) Unmarshal added in v0.7.0

func (pk *ContainerOpen) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ContainerSetData added in v0.7.0

type ContainerSetData struct {
	// WindowID is the ID of the window that should have its data set. The player must have a window open with
	// the window ID passed, or nothing will happen.
	WindowID byte
	// Key is the key of the property. It is one of the constants that can be found above. Multiple properties
	// share the same key, but the functionality depends on the type of the container that the data is set to.
	Key int32
	// Value is the value of the property. Its use differs per property.
	Value int32
}

ContainerSetData is sent by the server to update specific data of a single container, meaning a block such as a furnace or a brewing stand. This data is usually used by the client to display certain features client-side.

func (*ContainerSetData) ID added in v0.7.0

func (*ContainerSetData) ID() uint32

ID ...

func (*ContainerSetData) Marshal added in v0.7.0

func (pk *ContainerSetData) Marshal(w *protocol.Writer)

Marshal ...

func (*ContainerSetData) Unmarshal added in v0.7.0

func (pk *ContainerSetData) Unmarshal(r *protocol.Reader)

Unmarshal ...

type CorrectPlayerMovePrediction added in v1.9.0

type CorrectPlayerMovePrediction struct {
	// Position is the position that the player is supposed to be at at the tick written in the field below.
	// The client will change its current position based on movement after that tick starting from the
	// Position.
	Position mgl32.Vec3
	// Delta is the change in position compared to what the client sent as its position at that specific tick.
	Delta mgl32.Vec3
	// OnGround specifies if the player was on the ground at the time of the tick below.
	OnGround bool
	// Tick is the tick of the movement which was corrected by this packet.
	Tick uint64
}

CorrectPlayerMovePrediction is sent by the server if and only if StartGame.ServerAuthoritativeMovementMode is set to AuthoritativeMovementModeServerWithRewind. The packet is used to correct movement at a specific point in time.

func (*CorrectPlayerMovePrediction) ID added in v1.9.0

ID ...

func (*CorrectPlayerMovePrediction) Marshal added in v1.9.0

Marshal ...

func (*CorrectPlayerMovePrediction) Unmarshal added in v1.9.0

func (pk *CorrectPlayerMovePrediction) Unmarshal(r *protocol.Reader)

Unmarshal ...

type CraftingData added in v0.7.0

type CraftingData struct {
	// Recipes is a list of all recipes available on the server. It includes among others shapeless, shaped
	// and furnace recipes. The client will only be able to craft these recipes.
	Recipes []protocol.Recipe
	// PotionRecipes is a list of all potion mixing recipes which may be used in the brewing stand.
	PotionRecipes []protocol.PotionRecipe
	// PotionContainerChangeRecipes is a list of all recipes to convert a potion from one type to another,
	// such as from a drinkable potion to a splash potion, or from a splash potion to a lingering potion.
	PotionContainerChangeRecipes []protocol.PotionContainerChangeRecipe
	// MaterialReducers is a list of all material reducers which is used in education edition chemistry.
	MaterialReducers []protocol.MaterialReducer
	// ClearRecipes indicates if all recipes currently active on the client should be cleaned. Doing this
	// means that the client will have no recipes active by itself: Any CraftingData packets previously sent
	// will also be discarded, and only the recipes in this CraftingData packet will be used.
	ClearRecipes bool
}

CraftingData is sent by the server to let the client know all crafting data that the server maintains. This includes shapeless crafting, crafting table recipes, furnace recipes etc. Each crafting station's recipes are included in it.

func (*CraftingData) ID added in v0.7.0

func (*CraftingData) ID() uint32

ID ...

func (*CraftingData) Marshal added in v0.7.0

func (pk *CraftingData) Marshal(w *protocol.Writer)

Marshal ...

func (*CraftingData) Unmarshal added in v0.7.0

func (pk *CraftingData) Unmarshal(r *protocol.Reader)

Unmarshal ...

type CraftingEvent added in v0.7.0

type CraftingEvent struct {
	// WindowID is the ID representing the window that the player crafted in.
	WindowID byte
	// CraftingType is a type that indicates the way the crafting was done, for example if a crafting table
	// was used.
	// TODO: Find out the options of the CraftingType field in the CraftingEvent packet.
	CraftingType int32
	// RecipeUUID is the UUID of the recipe that was crafted. It points to the UUID of the recipe that was
	// sent earlier in the CraftingData packet.
	RecipeUUID uuid.UUID
	// Input is a list of items that the player put into the recipe so that it could create the Output items.
	// These items are consumed in the process.
	Input []protocol.ItemInstance
	// Output is a list of items that were obtained as a result of crafting the recipe.
	Output []protocol.ItemInstance
}

CraftingEvent is sent by the client when it crafts a particular item. Note that this packet may be fully ignored, as the InventoryTransaction packet provides all the information required.

func (*CraftingEvent) ID added in v0.7.0

func (*CraftingEvent) ID() uint32

ID ...

func (*CraftingEvent) Marshal added in v0.7.0

func (pk *CraftingEvent) Marshal(w *protocol.Writer)

Marshal ...

func (*CraftingEvent) Unmarshal added in v0.7.0

func (pk *CraftingEvent) Unmarshal(r *protocol.Reader)

Unmarshal ...

type CreatePhoto added in v1.15.0

type CreatePhoto struct {
	// EntityUniqueID is the unique ID of the entity.
	EntityUniqueID int64
	// PhotoName is the name of the photo.
	PhotoName string
	// ItemName is the name of the photo as an item.
	ItemName string
}

CreatePhoto is a packet that allows players to export photos from their portfolios into items in their inventory. This packet only works on the Education Edition version of Minecraft.

func (*CreatePhoto) ID added in v1.15.0

func (*CreatePhoto) ID() uint32

ID ...

func (*CreatePhoto) Marshal added in v1.15.0

func (pk *CreatePhoto) Marshal(w *protocol.Writer)

Marshal ...

func (*CreatePhoto) Unmarshal added in v1.15.0

func (pk *CreatePhoto) Unmarshal(r *protocol.Reader)

Unmarshal ...

type CreativeContent added in v1.7.0

type CreativeContent struct {
	// Items is a list of the items that should be added to the creative inventory.
	Items []protocol.CreativeItem
}

CreativeContent is a packet sent by the server to set the creative inventory's content for a player. Introduced in 1.16, this packet replaces the previous method - sending an InventoryContent packet with creative inventory window ID. As of v1.16.100, this packet must be sent during the login sequence. Not sending it will stop the client from joining the server.

func (*CreativeContent) ID added in v1.7.0

func (*CreativeContent) ID() uint32

ID ...

func (*CreativeContent) Marshal added in v1.7.0

func (pk *CreativeContent) Marshal(w *protocol.Writer)

Marshal ...

func (*CreativeContent) Unmarshal added in v1.7.0

func (pk *CreativeContent) Unmarshal(r *protocol.Reader)

Unmarshal ...

type DebugInfo added in v1.7.0

type DebugInfo struct {
	// PlayerUniqueID is the unique ID of the player that the packet is sent to.
	PlayerUniqueID int64
	// Data is the debug data.
	Data []byte
}

DebugInfo is a packet sent by the server to the client. It does not seem to do anything when sent to the normal client in 1.16.

func (*DebugInfo) ID added in v1.7.0

func (*DebugInfo) ID() uint32

ID ...

func (*DebugInfo) Marshal added in v1.7.0

func (pk *DebugInfo) Marshal(w *protocol.Writer)

Marshal ...

func (*DebugInfo) Unmarshal added in v1.7.0

func (pk *DebugInfo) Unmarshal(r *protocol.Reader)

Unmarshal ...

type Decoder

type Decoder struct {
	// contains filtered or unexported fields
}

Decoder handles the decoding of Minecraft packets sent through an io.Reader. These packets in turn contain multiple compressed packets.

func NewDecoder

func NewDecoder(reader io.Reader) *Decoder

NewDecoder returns a new decoder decoding data from the io.Reader passed. One read call from the reader is assumed to consume an entire packet.

func (*Decoder) Decode

func (decoder *Decoder) Decode() (packets [][]byte, err error)

Decode decodes one 'packet' from the io.Reader passed in NewDecoder(), producing a slice of packets that it held and an error if not successful.

func (*Decoder) DisableBatchPacketLimit added in v1.2.10

func (decoder *Decoder) DisableBatchPacketLimit()

DisableBatchPacketLimit disables the check that limits the number of packets allowed in a single packet batch. This should typically be called for Decoders decoding from a server connection.

func (*Decoder) EnableEncryption

func (decoder *Decoder) EnableEncryption(keyBytes [32]byte)

EnableEncryption enables encryption for the Decoder using the secret key bytes passed. Each packet received will be decrypted.

type Disconnect

type Disconnect struct {
	// HideDisconnectionScreen specifies if the disconnection screen should be hidden when the client is
	// disconnected, meaning it will be sent directly to the main menu.
	HideDisconnectionScreen bool
	// Message is an optional message to show when disconnected. This message is only written if the
	// HideDisconnectionScreen field is set to true.
	Message string
}

Disconnect may be sent by the server to disconnect the client using an optional message to send as the disconnect screen.

func (*Disconnect) ID

func (*Disconnect) ID() uint32

ID ...

func (*Disconnect) Marshal

func (pk *Disconnect) Marshal(w *protocol.Writer)

Marshal ...

func (*Disconnect) Unmarshal

func (pk *Disconnect) Unmarshal(r *protocol.Reader)

Unmarshal ...

type EducationResourceURI added in v1.15.0

type EducationResourceURI struct {
	// Resource is the resource that is being referenced.
	Resource protocol.EducationSharedResourceURI
}

EducationResourceURI is a packet that transmits education resource settings to all clients.

func (*EducationResourceURI) ID added in v1.15.0

ID ...

func (*EducationResourceURI) Marshal added in v1.15.0

func (pk *EducationResourceURI) Marshal(w *protocol.Writer)

Marshal ...

func (*EducationResourceURI) Unmarshal added in v1.15.0

func (pk *EducationResourceURI) Unmarshal(r *protocol.Reader)

Unmarshal ...

type EducationSettings added in v1.3.0

type EducationSettings struct {
	// CodeBuilderDefaultURI is the default URI that the code builder is ran on. Using this, a Code Builder program can
	// make code directly affect the server.
	CodeBuilderDefaultURI string
	// CodeBuilderTitle is the title of the code builder shown when connected to the CodeBuilderDefaultURI.
	CodeBuilderTitle string
	// CanResizeCodeBuilder specifies if clients connected to the world should be able to resize the code
	// builder when it is opened.
	CanResizeCodeBuilder bool
	// DisableLegacyTitleBar ...
	DisableLegacyTitleBar bool
	// PostProcessFilter ...
	PostProcessFilter string
	// ScreenshotBorderPath ...
	ScreenshotBorderPath string
	// AgentCapabilities ...
	AgentCapabilities *bool
	// OverrideURI ...
	OverrideURI string
	// HasQuiz specifies if the world has a quiz connected to it.
	HasQuiz bool
	// ExternalLinkSettings ...
	ExternalLinkSettings *protocol.EducationExternalLinkSettings
}

EducationSettings is a packet sent by the server to update Minecraft: Education Edition related settings. It is unused by the normal base game.

func (*EducationSettings) ID added in v1.3.0

func (*EducationSettings) ID() uint32

ID ...

func (*EducationSettings) Marshal added in v1.3.0

func (pk *EducationSettings) Marshal(w *protocol.Writer)

Marshal ...

func (*EducationSettings) Unmarshal added in v1.3.0

func (pk *EducationSettings) Unmarshal(r *protocol.Reader)

Unmarshal ...

type Emote added in v1.3.0

type Emote struct {
	// EntityRuntimeID is the entity that sent the emote. When a player sends this packet, it has this field
	// set as its own entity runtime ID.
	EntityRuntimeID uint64
	// EmoteID is the ID of the emote to send.
	EmoteID string
	// Flags is a combination of flags that change the way the Emote packet operates. When the server sends
	// this packet to other players, EmoteFlagServerSide must be present.
	Flags byte
}

Emote is sent by both the server and the client. When the client sends an emote, it sends this packet to the server, after which the server will broadcast the packet to other players online.

func (*Emote) ID added in v1.3.0

func (*Emote) ID() uint32

ID ...

func (*Emote) Marshal added in v1.3.0

func (pk *Emote) Marshal(w *protocol.Writer)

Marshal ...

func (*Emote) Unmarshal added in v1.3.0

func (pk *Emote) Unmarshal(r *protocol.Reader)

Unmarshal ...

type EmoteList added in v1.7.0

type EmoteList struct {
	// PlayerRuntimeID is the runtime ID of the player that owns the emote pieces below. If sent by the
	// client, this player runtime ID is always that of the player itself.
	PlayerRuntimeID uint64
	// EmotePieces is a list of emote pieces that the player with the runtime ID above has.
	EmotePieces []uuid.UUID
}

EmoteList is sent by the client every time it joins the server and when it equips new emotes. It may be used by the server to find out which emotes the client has available. If the player has no emotes equipped, this packet is not sent. Under certain circumstances, this packet is also sent from the server to the client, but I was unable to find when this is done.

func (*EmoteList) ID added in v1.7.0

func (*EmoteList) ID() uint32

ID ...

func (*EmoteList) Marshal added in v1.7.0

func (pk *EmoteList) Marshal(w *protocol.Writer)

Marshal ...

func (*EmoteList) Unmarshal added in v1.7.0

func (pk *EmoteList) Unmarshal(r *protocol.Reader)

Unmarshal ...

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

Encoder handles the encoding of Minecraft packets that are sent to an io.Writer. The packets are compressed and optionally encoded before they are sent to the io.Writer.

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder returns a new Encoder for the io.Writer passed. Each final packet produced by the Encoder is sent with a single call to io.Writer.Write().

func (*Encoder) EnableEncryption

func (encoder *Encoder) EnableEncryption(keyBytes [32]byte)

EnableEncryption enables encryption for the Encoder using the secret key bytes passed. Each packet sent after encryption is enabled will be encrypted.

func (*Encoder) Encode

func (encoder *Encoder) Encode(packets [][]byte) error

Encode encodes the packets passed. It writes all of them as a single packet which is compressed and optionally encrypted.

type Event added in v0.7.0

type Event struct {
	// EntityRuntimeID is the runtime ID of the player. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// EventType is the type of the event to be called. It is one of the constants that may be found above.
	EventType int32
	// UsePlayerID ...
	UsePlayerID byte
	// EventData is the parsed event data.
	EventData protocol.EventData
}

Event is sent by the server to send an event with additional data. It is typically sent to the client for telemetry reasons, much like the SimpleEvent packet. TODO: Figure out what UsePlayerID is for.

func (*Event) ID added in v0.7.0

func (*Event) ID() uint32

ID ...

func (*Event) Marshal added in v0.7.0

func (pk *Event) Marshal(w *protocol.Writer)

Marshal ...

func (*Event) Unmarshal added in v0.7.0

func (pk *Event) Unmarshal(r *protocol.Reader)

Unmarshal ...

type FilterText added in v1.10.1

type FilterText struct {
	// Text is either the text from the client or the safer version of the text sent by the server.
	Text string
	// FromServer indicates if the packet was sent by the server or not.
	FromServer bool
}

FilterText is sent by the both the client and the server. The client sends the packet to the server to allow the server to filter the text server-side. The server then responds with the same packet and the safer version of the text.

func (*FilterText) ID added in v1.10.1

func (*FilterText) ID() uint32

ID ...

func (*FilterText) Marshal added in v1.10.1

func (pk *FilterText) Marshal(w *protocol.Writer)

Marshal ...

func (*FilterText) Unmarshal added in v1.10.1

func (pk *FilterText) Unmarshal(r *protocol.Reader)

Unmarshal ...

type GUIDataPickItem added in v0.7.0

type GUIDataPickItem struct {
	// ItemName is the name of the item that shows up in the top part of the popup that shows up when
	// selecting an item. It is shown as if an item was selected by the player itself.
	ItemName string
	// ItemEffects is the line under the ItemName, where the effects of the item are usually situated.
	ItemEffects string
	// HotBarSlot is the hot bar slot to be selected/picked. This does not currently work, so it does not
	// matter what number this is.
	HotBarSlot int32
}

GUIDataPickItem is sent by the server to make the client 'select' a hot bar slot. It currently appears to be broken however, and does not actually set the selected slot to the hot bar slot set in the packet.

func (*GUIDataPickItem) ID added in v0.7.0

func (*GUIDataPickItem) ID() uint32

ID ...

func (*GUIDataPickItem) Marshal added in v0.7.0

func (pk *GUIDataPickItem) Marshal(w *protocol.Writer)

Marshal ...

func (*GUIDataPickItem) Unmarshal added in v0.7.0

func (pk *GUIDataPickItem) Unmarshal(r *protocol.Reader)

Unmarshal ...

type GameRulesChanged added in v0.7.0

type GameRulesChanged struct {
	// GameRules defines game rules changed with their respective values. The value of these game rules may be
	// either 'bool', 'int32' or 'float32'.
	// Note that some game rules are server side only, and don't necessarily need to be sent to the client.
	// Only changed game rules need to be sent in this packet. Game rules that were not changed do not need to
	// be sent if the client is already updated on them.
	GameRules []protocol.GameRule
}

GameRulesChanged is sent by the server to the client to update client-side game rules, such as game rules like the 'showCoordinates' game rule.

func (*GameRulesChanged) ID added in v0.7.0

func (*GameRulesChanged) ID() uint32

ID ...

func (*GameRulesChanged) Marshal added in v0.7.0

func (pk *GameRulesChanged) Marshal(w *protocol.Writer)

Marshal ...

func (*GameRulesChanged) Unmarshal added in v0.7.0

func (pk *GameRulesChanged) Unmarshal(r *protocol.Reader)

Unmarshal ...

type Header struct {
	PacketID        uint32
	SenderSubClient byte
	TargetSubClient byte
}

Header is the header of a packet. It exists out of a single varuint32 which is composed of a packet ID and a sender and target sub client ID. These IDs are used for split screen functionality.

func (*Header) Read

func (header *Header) Read(r io.ByteReader) error

Read reads a varuint32 from buf and sets the corresponding values to the Header.

func (*Header) Write

func (header *Header) Write(w io.ByteWriter) error

Write writes the header as a single varuint32 to buf.

type HurtArmour added in v0.7.0

type HurtArmour struct {
	// Cause is the cause of the damage dealt to the armour.
	Cause int32
	// Damage is the amount of damage points that was dealt to the player. The damage to the armour will be
	// calculated by the client based upon this damage, and will also be based upon any enchantments like
	// thorns that the armour may have.
	Damage int32
	// ArmourSlots is a bitset of all armour slots affected.
	ArmourSlots int64
}

HurtArmour is sent by the server to damage the player's armour after being hit. The packet should never be used by servers as it hands the responsibility over to the player completely, while the server can easily reliably update the armour damage of players itself.

func (*HurtArmour) ID added in v0.7.0

func (*HurtArmour) ID() uint32

ID ...

func (*HurtArmour) Marshal added in v0.7.0

func (pk *HurtArmour) Marshal(w *protocol.Writer)

Marshal ...

func (*HurtArmour) Unmarshal added in v0.7.0

func (pk *HurtArmour) Unmarshal(r *protocol.Reader)

Unmarshal ...

type Interact added in v0.6.0

type Interact struct {
	// Action type is the ID of the action that was executed by the player. It is one of the constants that
	// may be found above.
	ActionType byte
	// TargetEntityRuntimeID is the runtime ID of the entity that the player interacted with. This is empty
	// for the InteractActionOpenInventory action type.
	TargetEntityRuntimeID uint64
	// Position associated with the ActionType above. For the InteractActionMouseOverEntity, this is the
	// position relative to the entity moused over over which the player hovered with its mouse/touch. For the
	// InteractActionLeaveVehicle, this is the position that the player spawns at after leaving the vehicle.
	Position mgl32.Vec3
}

Interact is sent by the client when it interacts with another entity in some way. It used to be used for normal entity and block interaction, but this is no longer the case now.

func (*Interact) ID added in v0.6.0

func (*Interact) ID() uint32

ID ...

func (*Interact) Marshal added in v0.6.0

func (pk *Interact) Marshal(w *protocol.Writer)

Marshal ...

func (*Interact) Unmarshal added in v0.6.0

func (pk *Interact) Unmarshal(r *protocol.Reader)

Unmarshal ...

type InventoryContent added in v0.7.0

type InventoryContent struct {
	// WindowID is the ID that identifies one of the windows that the client currently has opened, or one of
	// the consistent windows such as the main inventory.
	WindowID uint32
	// Content is the new content of the inventory. The length of this slice must be equal to the full size of
	// the inventory window updated.
	Content []protocol.ItemInstance
}

InventoryContent is sent by the server to update the full content of a particular inventory. It is usually sent for the main inventory of the player, but also works for other inventories that are currently opened by the player.

func (*InventoryContent) ID added in v0.7.0

func (*InventoryContent) ID() uint32

ID ...

func (*InventoryContent) Marshal added in v0.7.0

func (pk *InventoryContent) Marshal(w *protocol.Writer)

Marshal ...

func (*InventoryContent) Unmarshal added in v0.7.0

func (pk *InventoryContent) Unmarshal(r *protocol.Reader)

Unmarshal ...

type InventorySlot added in v0.7.0

type InventorySlot struct {
	// WindowID is the ID of the window that the packet modifies. It must point to one of the windows that the
	// client currently has opened.
	WindowID uint32
	// Slot is the index of the slot that the packet modifies. The new item will be set to the slot at this
	// index.
	Slot uint32
	// NewItem is the item to be put in the slot at Slot. It will overwrite any item that may currently
	// be present in that slot.
	NewItem protocol.ItemInstance
}

InventorySlot is sent by the server to update a single slot in one of the inventory windows that the client currently has opened. Usually this is the main inventory, but it may also be the off hand or, for example, a chest inventory.

func (*InventorySlot) ID added in v0.7.0

func (*InventorySlot) ID() uint32

ID ...

func (*InventorySlot) Marshal added in v0.7.0

func (pk *InventorySlot) Marshal(w *protocol.Writer)

Marshal ...

func (*InventorySlot) Unmarshal added in v0.7.0

func (pk *InventorySlot) Unmarshal(r *protocol.Reader)

Unmarshal ...

type InventoryTransaction added in v0.4.0

type InventoryTransaction struct {
	// LegacyRequestID is an ID that is only non-zero at times when sent by the client. The server should
	// always send 0 for this. When this field is not 0, the LegacySetItemSlots slice below will have values
	// in it.
	// LegacyRequestID ties in with the ItemStackResponse packet. If this field is non-0, the server should
	// respond with an ItemStackResponse packet. Some inventory actions such as dropping an item out of the
	// hotbar are still one using this packet, and the ItemStackResponse packet needs to tie in with it.
	LegacyRequestID int32
	// LegacySetItemSlots are only present if the LegacyRequestID is non-zero. These item slots inform the
	// server of the slots that were changed during the inventory transaction, and the server should send
	// back an ItemStackResponse packet with these slots present in it. (Or false with no slots, if rejected.)
	LegacySetItemSlots []protocol.LegacySetItemSlot
	// Actions is a list of actions that took place, that form the inventory transaction together. Each of
	// these actions hold one slot in which one item was changed to another. In general, the combination of
	// all of these actions results in a balanced inventory transaction. This should be checked to ensure that
	// no items are cheated into the inventory.
	Actions []protocol.InventoryAction
	// TransactionData is a data object that holds data specific to the type of transaction that the
	// TransactionPacket held. Its concrete type must be one of NormalTransactionData, MismatchTransactionData
	// UseItemTransactionData, UseItemOnEntityTransactionData or ReleaseItemTransactionData. If nil is set,
	// the transaction will be assumed to of type InventoryTransactionTypeNormal.
	TransactionData protocol.InventoryTransactionData
}

InventoryTransaction is a packet sent by the client. It essentially exists out of multiple sub-packets, each of which have something to do with the inventory in one way or another. Some of these sub-packets directly relate to the inventory, others relate to interaction with the world, that could potentially result in a change in the inventory.

func (*InventoryTransaction) ID added in v0.4.0

ID ...

func (*InventoryTransaction) Marshal added in v0.4.0

func (pk *InventoryTransaction) Marshal(w *protocol.Writer)

Marshal ...

func (*InventoryTransaction) Unmarshal added in v0.4.0

func (pk *InventoryTransaction) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ItemComponent added in v1.9.0

type ItemComponent struct {
	// Items holds a list of all custom items with their respective components set.
	Items []protocol.ItemComponentEntry
}

ItemComponent is sent by the server to attach client-side components to a custom item.

func (*ItemComponent) ID added in v1.9.0

func (*ItemComponent) ID() uint32

ID ...

func (*ItemComponent) Marshal added in v1.9.0

func (pk *ItemComponent) Marshal(w *protocol.Writer)

Marshal ...

func (*ItemComponent) Unmarshal added in v1.9.0

func (pk *ItemComponent) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ItemFrameDropItem added in v0.7.0

type ItemFrameDropItem struct {
	// Position is the position of the item frame that had its item dropped. There must be a 'block entity'
	// present at this position.
	Position protocol.BlockPos
}

ItemFrameDropItem is sent by the client when it takes an item out of an item frame.

func (*ItemFrameDropItem) ID added in v0.7.0

func (*ItemFrameDropItem) ID() uint32

ID ...

func (*ItemFrameDropItem) Marshal added in v0.7.0

func (pk *ItemFrameDropItem) Marshal(w *protocol.Writer)

Marshal ...

func (*ItemFrameDropItem) Unmarshal added in v0.7.0

func (pk *ItemFrameDropItem) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ItemStackRequest added in v1.7.0

type ItemStackRequest struct {
	// Requests holds a list of item stack requests. These requests are all separate, but the client buffers
	// the requests, so you might find multiple unrelated requests in this packet.
	Requests []protocol.ItemStackRequest
}

ItemStackRequest is sent by the client to change item stacks in an inventory. It is essentially a replacement of the InventoryTransaction packet added in 1.16 for inventory specific actions, such as moving items around or crafting. The InventoryTransaction packet is still used for actions such as placing blocks and interacting with entities.

func (*ItemStackRequest) ID added in v1.7.0

func (*ItemStackRequest) ID() uint32

ID ...

func (*ItemStackRequest) Marshal added in v1.7.0

func (pk *ItemStackRequest) Marshal(w *protocol.Writer)

Marshal ...

func (*ItemStackRequest) Unmarshal added in v1.7.0

func (pk *ItemStackRequest) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ItemStackResponse added in v1.7.0

type ItemStackResponse struct {
	// Responses is a list of responses to ItemStackRequests sent by the client before. Responses either
	// approve or reject a request from the client.
	// Vanilla limits the size of this slice to 4096.
	Responses []protocol.ItemStackResponse
}

ItemStackResponse is sent by the server in response to an ItemStackRequest packet from the client. This packet is used to either approve or reject ItemStackRequests from the client. If a request is approved, the client will simply continue as normal. If rejected, the client will undo the actions so that the inventory should be in sync with the server again.

func (*ItemStackResponse) ID added in v1.7.0

func (*ItemStackResponse) ID() uint32

ID ...

func (*ItemStackResponse) Marshal added in v1.7.0

func (pk *ItemStackResponse) Marshal(w *protocol.Writer)

Marshal ...

func (*ItemStackResponse) Unmarshal added in v1.7.0

func (pk *ItemStackResponse) Unmarshal(r *protocol.Reader)

Unmarshal ...

type LabTable added in v0.9.1

type LabTable struct {
	// ActionType is the type of the action that was executed. It is one of the constants above. Typically,
	// only LabTableActionCombine is sent by the client, whereas LabTableActionReact is sent by the server.
	ActionType byte
	// Position is the position at which the lab table used was located.
	Position protocol.BlockPos
	// ReactionType is the type of the reaction that took place as a result of the items put into the lab
	// table. The reaction type can be either that of an item or a particle, depending on whatever the result
	// was of the reaction.
	ReactionType byte
}

LabTable is sent by the client to let the server know it started a chemical reaction in Education Edition, and is sent by the server to other clients to show the effects. The packet is only functional if Education features are enabled.

func (*LabTable) ID added in v0.9.1

func (*LabTable) ID() uint32

ID ...

func (*LabTable) Marshal added in v0.9.1

func (pk *LabTable) Marshal(w *protocol.Writer)

Marshal ...

func (*LabTable) Unmarshal added in v0.9.1

func (pk *LabTable) Unmarshal(r *protocol.Reader)

Unmarshal ...

type LecternUpdate added in v0.9.1

type LecternUpdate struct {
	// Page is the page number in the book that was opened by the player on the lectern.
	Page byte
	// PageCount is the number of pages that the book opened in the lectern has.
	PageCount byte
	// Position is the position of the lectern that was updated. If no lectern is at the block position,
	// the packet should be ignored.
	Position protocol.BlockPos
	// DropBook specifies if the book currently set on display in the lectern should be dropped server-side.
	DropBook bool
}

LecternUpdate is sent by the client to update the server on which page was opened in a book on a lectern, or if the book should be removed from it.

func (*LecternUpdate) ID added in v0.9.1

func (*LecternUpdate) ID() uint32

ID ...

func (*LecternUpdate) Marshal added in v0.9.1

func (pk *LecternUpdate) Marshal(w *protocol.Writer)

Marshal ...

func (*LecternUpdate) Unmarshal added in v0.9.1

func (pk *LecternUpdate) Unmarshal(r *protocol.Reader)

Unmarshal ...

type LevelChunk added in v0.9.2

type LevelChunk struct {
	// ChunkX is the X coordinate of the chunk sent. (To translate a block's X to a chunk's X: x >> 4)
	ChunkX int32
	// ChunkZ is the Z coordinate of the chunk sent. (To translate a block's Z to a chunk's Z: z >> 4)
	ChunkZ int32
	// SubChunkCount is the amount of sub chunks that are part of the chunk sent. Depending on if the cache
	// is enabled, a list of blob hashes will be sent, or, if disabled, the sub chunk data.
	SubChunkCount uint32
	// CacheEnabled specifies if the client blob cache should be enabled. This system is based on hashes of
	// blobs which are consistent and saved by the client in combination with that blob, so that the server
	// does not have the same chunk multiple times. If the client does not yet have a blob with the hash sent,
	// it will send a ClientCacheBlobStatus packet containing the hashes is does not have the data of.
	CacheEnabled bool
	// BlobHashes is a list of all blob hashes used in the chunk. It is composed of SubChunkCount + 1 hashes,
	// with the first SubChunkCount hashes being those of the sub chunks and the last one that of the biome
	// of the chunk.
	// If CacheEnabled is set to false, BlobHashes can be left empty.
	BlobHashes []uint64
	// RawPayload is a serialised string of chunk data. The data held depends on if CacheEnabled is set to
	// true. If set to false, the payload is composed of multiple sub-chunks, each of which carry a version
	// which indicates the way they are serialised, followed by biomes, border blocks and tile entities. If
	// CacheEnabled is true, the payload consists out of the border blocks and tile entities only.
	RawPayload []byte
}

LevelChunk is sent by the server to provide the client with a chunk of a world data (16xYx16 blocks). Typically a certain amount of chunks is sent to the client before sending it the spawn PlayStatus packet, so that the client spawns in a loaded world.

func (*LevelChunk) ID added in v0.9.2

func (*LevelChunk) ID() uint32

ID ...

func (*LevelChunk) Marshal added in v0.9.2

func (pk *LevelChunk) Marshal(w *protocol.Writer)

Marshal ...

func (*LevelChunk) Unmarshal added in v0.9.2

func (pk *LevelChunk) Unmarshal(r *protocol.Reader)

Unmarshal ...

type LevelEvent added in v0.3.0

type LevelEvent struct {
	// EventType is the ID of the event that is being 'called'. It is one of the events found in the constants
	// above.
	EventType int32
	// Position is the position of the level event. Practically every event requires this Vec3 set for it, as
	// particles, sounds and block editing relies on it.
	Position mgl32.Vec3
	// EventData is an integer holding additional data of the event. The type of data held depends on the
	// EventType.
	EventData int32
}

LevelEvent is sent by the server to make a certain event in the level occur. It ranges from particles, to sounds, and other events such as starting rain and block breaking.

func (*LevelEvent) ID added in v0.3.0

func (*LevelEvent) ID() uint32

ID ...

func (*LevelEvent) Marshal added in v0.3.0

func (pk *LevelEvent) Marshal(w *protocol.Writer)

Marshal ...

func (*LevelEvent) Unmarshal added in v0.3.0

func (pk *LevelEvent) Unmarshal(r *protocol.Reader)

Unmarshal ...

type LevelEventGeneric added in v0.9.2

type LevelEventGeneric struct {
	// EventID is a unique identifier that identifies the event called. The data that follows has fields in
	// the NBT depending on what event it is.
	EventID int32
	// SerialisedEventData is a network little endian serialised object of event data, with fields that vary
	// depending on EventID.
	// Unlike many other NBT structures, this data is not actually in a compound but just loosely floating
	// NBT tags. To decode using the nbt package, you would need to append 0x0a00 at the start (compound id
	// and name length) and add 0x00 at the end, to manually wrap it in a compound. Likewise, you would have
	// to remove these bytes when encoding.
	// Example of the resulting data with an EventID of 2026:
	// TAG_Compound({
	//    'pos15x': TAG_Float(198),
	//    'pos11x': TAG_Float(201),
	//    'pos6y': TAG_Float(65),
	//    'pos13y': TAG_Float(64),
	//    'pos17z': TAG_Float(36),
	//    'pos8y': TAG_Float(65),
	//    'originY': TAG_Float(65.06125),
	//    'pos10z': TAG_Float(37),
	//    'pos13x': TAG_Float(201),
	//    'pos7y': TAG_Float(65),
	//    'pos9x': TAG_Float(203),
	//    'pos11y': TAG_Float(64),
	//    'pos15y': TAG_Float(65),
	//    'pos15z': TAG_Float(40),
	//    'pos7z': TAG_Float(41),
	//    'pos8x': TAG_Float(198),
	//    'pos13z': TAG_Float(40),
	//    'pos1z': TAG_Float(37),
	//    'pos6z': TAG_Float(42),
	//    'size': TAG_Int(18),
	//    'pos0x': TAG_Float(204),
	//    'pos12x': TAG_Float(200),
	//    'pos2x': TAG_Float(204),
	//    'pos9z': TAG_Float(37),
	//    'pos16y': TAG_Float(64),
	//    'pos5x': TAG_Float(204),
	//    'pos5y': TAG_Float(64),
	//    'pos17x': TAG_Float(202),
	//    'pos3y': TAG_Float(64),
	//    'pos3z': TAG_Float(36),
	//    'radius': TAG_Float(4),
	//    'pos0z': TAG_Float(38),
	//    'pos4z': TAG_Float(36),
	//    'pos8z': TAG_Float(38),
	//    'pos1x': TAG_Float(204),
	//    'pos0y': TAG_Float(64),
	//    'pos14z': TAG_Float(39),
	//    'pos16z': TAG_Float(40),
	//    'pos2y': TAG_Float(63),
	//    'pos6x': TAG_Float(203),
	//    'pos10x': TAG_Float(205),
	//    'pos12y': TAG_Float(64),
	//    'pos1y': TAG_Float(64),
	//    'pos14x': TAG_Float(200),
	//    'pos3x': TAG_Float(204),
	//    'pos9y': TAG_Float(64),
	//    'pos4y': TAG_Float(63),
	//    'pos10y': TAG_Float(63),
	//    'pos12z': TAG_Float(38),
	//    'pos16x': TAG_Float(202),
	//    'originX': TAG_Float(202.48654),
	//    'pos14y': TAG_Float(62),
	//    'pos17y': TAG_Float(62),
	//    'pos5z': TAG_Float(35),
	//    'pos4x': TAG_Float(204),
	//    'pos7x': TAG_Float(203),
	//    'originZ': TAG_Float(38.297028),
	//    'pos11z': TAG_Float(38),
	//    'pos2z': TAG_Float(39),
	// })
	// The 'originX', 'originY' and 'originZ' fields are present in every event and serve as a replacement for
	// a Position field in this packet.
	SerialisedEventData []byte
}

LevelEventGeneric is sent by the server to send a 'generic' level event to the client. This packet sends an NBT serialised object and may for that reason be used for any event holding additional data.

func (*LevelEventGeneric) ID added in v0.9.2

func (pk *LevelEventGeneric) ID() uint32

ID ...

func (*LevelEventGeneric) Marshal added in v0.9.2

func (pk *LevelEventGeneric) Marshal(w *protocol.Writer)

Marshal ...

func (*LevelEventGeneric) Unmarshal added in v0.9.2

func (pk *LevelEventGeneric) Unmarshal(r *protocol.Reader)

Unmarshal ...

type LevelSoundEvent added in v0.9.1

type LevelSoundEvent struct {
	// SoundType is the type of the sound to play. It is one of the constants above. Some of the sound types
	// require additional data, which is set in the EventData field.
	SoundType uint32
	// Position is the position of the sound event. The player will be able to hear the direction of the sound
	// based on what position is sent here.
	Position mgl32.Vec3
	// ExtraData is a packed integer that some sound types use to provide extra data. An example of this is
	// the note sound, which is composed of a pitch and an instrument type.
	ExtraData int32
	// EntityType is the string entity type of the entity that emitted the sound, for example
	// 'minecraft:skeleton'. Some sound types use this entity type for additional data.
	EntityType string
	// BabyMob specifies if the sound should be that of a baby mob. It is most notably used for parrot
	// imitations, which will change based on if this field is set to true or not.
	BabyMob bool
	// DisableRelativeVolume specifies if the sound should be played relatively or not. If set to true, the
	// sound will have full volume, regardless of where the Position is, whereas if set to false, the sound's
	// volume will be based on the distance to Position.
	DisableRelativeVolume bool
}

LevelSoundEvent is sent by the server to make any kind of built-in sound heard to a player. It is sent to, for example, play a stepping sound or a shear sound. The packet is also sent by the client, in which case it could be forwarded by the server to the other players online. If possible, the packets from the client should be ignored however, and the server should play them on its own accord.

func (*LevelSoundEvent) ID added in v0.9.1

func (*LevelSoundEvent) ID() uint32

ID ...

func (*LevelSoundEvent) Marshal added in v0.9.1

func (pk *LevelSoundEvent) Marshal(w *protocol.Writer)

Marshal ...

func (*LevelSoundEvent) Unmarshal added in v0.9.1

func (pk *LevelSoundEvent) Unmarshal(r *protocol.Reader)

Unmarshal ...

type Login

type Login struct {
	// ClientProtocol is the protocol version of the player. The player is disconnected if the protocol is
	// incompatible with the protocol of the server.
	ClientProtocol int32
	// ConnectionRequest is a string containing information about the player and JWTs that may be used to
	// verify if the player is connected to XBOX Live. The connection request also contains the necessary
	// client public key to initiate encryption.
	ConnectionRequest []byte
}

Login is sent when the client initially tries to join the server. It is the first packet sent and contains information specific to the player.

func (*Login) ID

func (*Login) ID() uint32

ID ...

func (*Login) Marshal

func (pk *Login) Marshal(w *protocol.Writer)

Marshal ...

func (*Login) Unmarshal

func (pk *Login) Unmarshal(r *protocol.Reader)

Unmarshal ...

type MapCreateLockedCopy added in v0.9.1

type MapCreateLockedCopy struct {
	// OriginalMapID is the ID of the map that is being copied. The locked copy will obtain all content that
	// is visible on this map, except the content will not change.
	OriginalMapID int64
	// NewMapID is the ID of the map that holds the locked copy of the map that OriginalMapID points to. Its
	// contents will be impossible to change.
	NewMapID int64
}

MapCreateLockedCopy is sent by the server to create a locked copy of one map into another map. In vanilla, it is used in the cartography table to create a map that is locked and cannot be modified.

func (*MapCreateLockedCopy) ID added in v0.9.1

ID ...

func (*MapCreateLockedCopy) Marshal added in v0.9.1

func (pk *MapCreateLockedCopy) Marshal(w *protocol.Writer)

Marshal ...

func (*MapCreateLockedCopy) Unmarshal added in v0.9.1

func (pk *MapCreateLockedCopy) Unmarshal(r *protocol.Reader)

Unmarshal ...

type MapInfoRequest added in v0.7.0

type MapInfoRequest struct {
	// MapID is the unique identifier that represents the map that is requested over network. It remains
	// consistent across sessions.
	MapID int64
}

MapInfoRequest is sent by the client to request the server to deliver information of a certain map in the inventory of the player. The server should respond with a ClientBoundMapItemData packet.

func (*MapInfoRequest) ID added in v0.7.0

func (*MapInfoRequest) ID() uint32

ID ...

func (*MapInfoRequest) Marshal added in v0.7.0

func (pk *MapInfoRequest) Marshal(w *protocol.Writer)

Marshal ...

func (*MapInfoRequest) Unmarshal added in v0.7.0

func (pk *MapInfoRequest) Unmarshal(r *protocol.Reader)

Unmarshal ...

type MobArmourEquipment added in v0.6.0

type MobArmourEquipment struct {
	// EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// Helmet is the equipped helmet of the entity. Items that are not wearable on the head will not be
	// rendered by the client. Unlike in Java Edition, blocks cannot be worn.
	Helmet protocol.ItemInstance
	// Chestplate is the chestplate of the entity. Items that are not wearable as chestplate will not be
	// rendered.
	Chestplate protocol.ItemInstance
	// Leggings is the item worn as leggings by the entity. Items not wearable as leggings will not be
	// rendered client-side.
	Leggings protocol.ItemInstance
	// Boots is the item worn as boots by the entity. Items not wearable as boots will not be rendered.
	Boots protocol.ItemInstance
}

MobArmourEquipment is sent by the server to the client to update the armour an entity is wearing. It is sent for both players and other entities, such as zombies.

func (*MobArmourEquipment) ID added in v0.6.0

func (*MobArmourEquipment) ID() uint32

ID ...

func (*MobArmourEquipment) Marshal added in v0.6.0

func (pk *MobArmourEquipment) Marshal(w *protocol.Writer)

Marshal ...

func (*MobArmourEquipment) Unmarshal added in v0.6.0

func (pk *MobArmourEquipment) Unmarshal(r *protocol.Reader)

Unmarshal ...

type MobEffect added in v0.4.0

type MobEffect struct {
	// EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// Operation is the operation of the packet. It is either MobEffectAdd, MobEffectModify or MobEffectRemove
	// and specifies the result of the packet client-side.
	Operation byte
	// EffectType is the ID of the effect to be added, removed or modified. It is one of the constants that
	// may be found above.
	EffectType int32
	// Amplifier is the amplifier of the effect. Take note that the amplifier is not the same as the effect's
	// level. The level is usually one higher than the amplifier, and the amplifier can actually be negative
	// to reverse the behaviour effect.
	Amplifier int32
	// Particles specifies if viewers of the entity that gets the effect shows particles around it. If set to
	// false, no particles are emitted around the entity.
	Particles bool
	// Duration is the duration of the effect in seconds. After the duration has elapsed, the effect will be
	// removed automatically client-side.
	Duration int32
}

MobEffect is sent by the server to apply an effect to the player, for example an effect like poison. It may also be used to modify existing effects, or removing them completely.

func (*MobEffect) ID added in v0.4.0

func (*MobEffect) ID() uint32

ID ...

func (*MobEffect) Marshal added in v0.4.0

func (pk *MobEffect) Marshal(w *protocol.Writer)

Marshal ...

func (*MobEffect) Unmarshal added in v0.4.0

func (pk *MobEffect) Unmarshal(r *protocol.Reader)

Unmarshal ...

type MobEquipment added in v0.6.0

type MobEquipment struct {
	// EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// NewItem is the new item held after sending the MobEquipment packet. The entity will be shown holding
	// that item to the player it was sent to.
	NewItem protocol.ItemInstance
	// InventorySlot is the slot in the inventory that was held. This is the same as HotBarSlot, and only
	// remains for backwards compatibility.
	InventorySlot byte
	// HotBarSlot is the slot in the hot bar that was held. It is the same as InventorySlot, which is only
	// there for backwards compatibility purposes.
	HotBarSlot byte
	// WindowID is the window ID of the window that had its equipped item changed. This is usually the window
	// ID of the normal inventory, but may also be something else, for example with the off hand.
	WindowID byte
}

MobEquipment is sent by the client to the server and the server to the client to make the other side aware of the new item that an entity is holding. It is used to show the item in the hand of entities such as zombies too.

func (*MobEquipment) ID added in v0.6.0

func (*MobEquipment) ID() uint32

ID ...

func (*MobEquipment) Marshal added in v0.6.0

func (pk *MobEquipment) Marshal(w *protocol.Writer)

Marshal ...

func (*MobEquipment) Unmarshal added in v0.6.0

func (pk *MobEquipment) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ModalFormRequest

type ModalFormRequest struct {
	// FormID is an ID used to identify the form. The ID is saved by the client and sent back when the player
	// submits the form, so that the server can identify which form was submitted.
	FormID uint32
	// FormData is a JSON encoded object of form data. The content of the object differs, depending on the
	// type of the form sent, which is also set in the JSON.
	FormData []byte
}

ModalFormRequest is sent by the server to make the client open a form. This form may be either a modal form which has two options, a menu form for a selection of options and a custom form for properties.

func (*ModalFormRequest) ID

func (*ModalFormRequest) ID() uint32

ID ...

func (*ModalFormRequest) Marshal

func (pk *ModalFormRequest) Marshal(w *protocol.Writer)

Marshal ...

func (*ModalFormRequest) Unmarshal

func (pk *ModalFormRequest) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ModalFormResponse

type ModalFormResponse struct {
	// FormID is the form ID of the form the client has responded to. It is the same as the ID sent in the
	// ModalFormRequest, and may be used to identify which form was submitted.
	FormID uint32
	// ResponseData is a JSON encoded value representing the response of the player. If the form was
	// cancelled, a JSON encoded 'null' is in the response. For a modal form, the response is either true or
	// false, for a menu form, the response is an integer specifying the index of the button clicked, and for
	// a custom form, the response is an array containing a value for each element.
	ResponseData []byte
}

ModalFormResponse is sent by the client in response to a ModalFormRequest, after the player has submitted the form sent. It contains the options/properties selected by the player, or a JSON encoded 'null' if the form was closed by clicking the X at the top right corner of the form.

func (*ModalFormResponse) ID

func (*ModalFormResponse) ID() uint32

ID ...

func (*ModalFormResponse) Marshal

func (pk *ModalFormResponse) Marshal(w *protocol.Writer)

Marshal ...

func (*ModalFormResponse) Unmarshal

func (pk *ModalFormResponse) Unmarshal(r *protocol.Reader)

Unmarshal ...

type MotionPredictionHints added in v1.9.0

type MotionPredictionHints struct {
	// EntityRuntimeID is the runtime ID of the entity whose velocity is sent to the client.
	EntityRuntimeID uint64
	// Velocity is the server-calculated velocity of the entity at the point of sending the packet.
	Velocity mgl32.Vec3
	// OnGround specifies if the server currently thinks the entity is on the ground.
	OnGround bool
}

MotionPredictionHints is sent by the server to the client. There is a predictive movement component for entities. This packet fills the "history" of that component and entity movement is computed based on the points. Vanilla sends this packet instead of the SetActorMotion packet when 'spatial optimisations' are enabled.

func (*MotionPredictionHints) ID added in v1.9.0

ID ...

func (*MotionPredictionHints) Marshal added in v1.9.0

func (pk *MotionPredictionHints) Marshal(w *protocol.Writer)

Marshal ...

func (*MotionPredictionHints) Unmarshal added in v1.9.0

func (pk *MotionPredictionHints) Unmarshal(r *protocol.Reader)

Unmarshal ...

type MoveActorAbsolute added in v0.9.2

type MoveActorAbsolute struct {
	// EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// Flags is a combination of flags that specify details of the movement. It is a combination of the flags
	// above.
	Flags byte
	// Position is the position to spawn the entity on. If the entity is on a distance that the player cannot
	// see it, the entity will still show up if the player moves closer.
	Position mgl32.Vec3
	// Rotation is a Vec3 holding the X, Y and Z rotation of the entity after the movement. This is a Vec3 for
	// the reason that projectiles like arrows don't have yaw/pitch, but do have roll.
	Rotation mgl32.Vec3
}

MoveActorAbsolute is sent by the server to move an entity to an absolute position. It is typically used for movements where high accuracy isn't needed, such as for long range teleporting.

func (*MoveActorAbsolute) ID added in v0.9.2

func (*MoveActorAbsolute) ID() uint32

ID ...

func (*MoveActorAbsolute) Marshal added in v0.9.2

func (pk *MoveActorAbsolute) Marshal(w *protocol.Writer)

Marshal ...

func (*MoveActorAbsolute) Unmarshal added in v0.9.2

func (pk *MoveActorAbsolute) Unmarshal(r *protocol.Reader)

Unmarshal ...

type MoveActorDelta added in v0.9.2

type MoveActorDelta struct {
	// Flags is a list of flags that specify what data is in the packet.
	Flags uint16
	// EntityRuntimeID is the runtime ID of the entity that is being moved. The packet works provided a
	// non-player entity with this runtime ID is present.
	EntityRuntimeID uint64
	// Position is the new position that the entity was moved to.
	Position mgl32.Vec3
	// Rotation is the new absolute rotation. Unlike the position, it is not actually a delta. If any of the
	// values of this rotation are not sent, these values are 0 and no flag for them is present.
	Rotation mgl32.Vec3
}

MoveActorDelta is sent by the server to move an entity. The packet is specifically optimised to save as much space as possible, by only writing non-zero fields. As of 1.16.100, this packet no longer actually contains any deltas.

func (*MoveActorDelta) ID added in v0.9.2

func (*MoveActorDelta) ID() uint32

ID ...

func (*MoveActorDelta) Marshal added in v0.9.2

func (pk *MoveActorDelta) Marshal(w *protocol.Writer)

Marshal ...

func (*MoveActorDelta) Unmarshal added in v0.9.2

func (pk *MoveActorDelta) Unmarshal(r *protocol.Reader)

Unmarshal ...

type MovePlayer added in v0.3.0

type MovePlayer struct {
	// EntityRuntimeID is the runtime ID of the player. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// Position is the position to spawn the player on. If the player is on a distance that the viewer cannot
	// see it, the player will still show up if the viewer moves closer.
	Position mgl32.Vec3
	// Pitch is the vertical rotation of the player. Facing straight forward yields a pitch of 0. Pitch is
	// measured in degrees.
	Pitch float32
	// Yaw is the horizontal rotation of the player. Yaw is also measured in degrees.
	Yaw float32
	// HeadYaw is the same as Yaw, except that it applies specifically to the head of the player. A different
	// value for HeadYaw than Yaw means that the player will have its head turned.
	HeadYaw float32
	// Mode is the mode of the movement. It specifies the way the player's movement should be shown to other
	// players. It is one of the constants above.
	Mode byte
	// OnGround specifies if the player is considered on the ground. Note that proxies or hacked clients could
	// fake this to always be true, so it should not be taken for granted.
	OnGround bool
	// RiddenEntityRuntimeID is the runtime ID of the entity that the player might currently be riding. If not
	// riding, this should be left 0.
	RiddenEntityRuntimeID uint64
	// TeleportCause is written only if Mode is MoveModeTeleport. It specifies the cause of the teleportation,
	// which is one of the constants above.
	TeleportCause int32
	// TeleportSourceEntityType is the entity type that caused the teleportation, for example an ender pearl.
	TeleportSourceEntityType int32
	// Tick is the server tick at which the packet was sent. It is used in relation to CorrectPlayerMovePrediction.
	Tick uint64
}

MovePlayer is sent by players to send their movement to the server, and by the server to update the movement of player entities to other players.

func (*MovePlayer) ID added in v0.3.0

func (*MovePlayer) ID() uint32

ID ...

func (*MovePlayer) Marshal added in v0.3.0

func (pk *MovePlayer) Marshal(w *protocol.Writer)

Marshal ...

func (*MovePlayer) Unmarshal added in v0.3.0

func (pk *MovePlayer) Unmarshal(r *protocol.Reader)

Unmarshal ...

type MultiPlayerSettings added in v1.3.0

type MultiPlayerSettings struct {
	// ActionType is the action that should be done when this packet is sent. It is one of the constants that
	// may be found above.
	ActionType int32
}

MultiPlayerSettings is sent by the client to update multi-player related settings server-side and sent back to online players by the server. The MultiPlayerSettings packet is a Minecraft: Education Edition packet. It has no functionality for the base game.

func (*MultiPlayerSettings) ID added in v1.3.0

ID ...

func (*MultiPlayerSettings) Marshal added in v1.3.0

func (pk *MultiPlayerSettings) Marshal(w *protocol.Writer)

Marshal ...

func (*MultiPlayerSettings) Unmarshal added in v1.3.0

func (pk *MultiPlayerSettings) Unmarshal(r *protocol.Reader)

Unmarshal ...

type NPCDialogue added in v1.14.0

type NPCDialogue struct {
	// ActorUniqueID is the ID of the NPC being requested.
	ActorUniqueID uint64
	// ActionType is the type of action for the packet.
	ActionType int32
	// Dialogue is the text that the client should see.
	Dialogue string
	// SceneName is the scene the data was pulled from for the client.
	SceneName string
	// NPCName is the name of the NPC to be displayed to the client.
	NPCName string
	// ActionJSON is the JSON string of the buttons/actions the server can perform.
	ActionJSON string
}

NPCDialogue is a packet that allows the client to display dialog boxes for interacting with NPCs.

func (*NPCDialogue) ID added in v1.14.0

func (*NPCDialogue) ID() uint32

ID ...

func (*NPCDialogue) Marshal added in v1.14.0

func (pk *NPCDialogue) Marshal(w *protocol.Writer)

Marshal ...

func (*NPCDialogue) Unmarshal added in v1.14.0

func (pk *NPCDialogue) Unmarshal(r *protocol.Reader)

Unmarshal ...

type NPCRequest added in v0.9.1

type NPCRequest struct {
	// EntityRuntimeID is the runtime ID of the NPC entity that the player interacted with. It is the same
	// as sent by the server when spawning the entity.
	EntityRuntimeID uint64
	// RequestType is the type of the request, which depends on the permission that the player has. It will
	// be either a type that indicates that the NPC should show its dialog, or that it should open the
	// editing window.
	RequestType byte
	// CommandString is the command string set in the NPC. It may consist of multiple commands, depending on
	// what the player set in it.
	CommandString string
	// ActionType is the type of the action to execute.
	ActionType byte
	// SceneName is the name of the scene.
	SceneName string
}

NPCRequest is sent by the client when it interacts with an NPC. The packet is specifically made for Education Edition, where NPCs are available to use.

func (*NPCRequest) ID added in v0.9.1

func (*NPCRequest) ID() uint32

ID ...

func (*NPCRequest) Marshal added in v0.9.1

func (pk *NPCRequest) Marshal(w *protocol.Writer)

Marshal ...

func (*NPCRequest) Unmarshal added in v0.9.1

func (pk *NPCRequest) Unmarshal(r *protocol.Reader)

Unmarshal ...

type NetworkChunkPublisherUpdate added in v0.9.1

type NetworkChunkPublisherUpdate struct {
	// Position is the block position around which chunks loaded will remain shown to the client. Most servers
	// set this position to the position of the player itself.
	Position protocol.BlockPos
	// Radius is the radius in blocks around Position that chunks sent show up in and will remain loaded in.
	// Unlike the RequestChunkRadius and ChunkRadiusUpdated packets, this radius is in blocks rather than
	// chunks, so the chunk radius needs to be multiplied by 16. (Or shifted to the left by 4.)
	Radius uint32
}

NetworkChunkPublisherUpdate is sent by the server to change the point around which chunks are and remain loaded. This is useful for mini-game servers, where only one area is ever loaded, in which case the NetworkChunkPublisherUpdate packet can be sent in the middle of it, so that no chunks ever need to be additionally sent during the course of the game. In reality, the packet is not extraordinarily useful, and most servers just send it constantly at the position of the player. If the packet is not sent at all, no chunks will be shown to the player, regardless of where they are sent.

func (*NetworkChunkPublisherUpdate) ID added in v0.9.1

ID ...

func (*NetworkChunkPublisherUpdate) Marshal added in v0.9.1

Marshal ...

func (*NetworkChunkPublisherUpdate) Unmarshal added in v0.9.1

func (pk *NetworkChunkPublisherUpdate) Unmarshal(r *protocol.Reader)

Unmarshal ...

type NetworkSettings added in v1.3.0

type NetworkSettings struct {
	// CompressionThreshold is the minimum size of a packet that is compressed when sent. If the size of a
	// packet is under this value, it is not compressed.
	// When set to 0, all packets will be left uncompressed.
	CompressionThreshold uint16
}

NetworkSettings is sent by the server to update a variety of network settings. These settings modify the way packets are sent over the network stack.

func (*NetworkSettings) ID added in v1.3.0

func (*NetworkSettings) ID() uint32

ID ...

func (*NetworkSettings) Marshal added in v1.3.0

func (pk *NetworkSettings) Marshal(w *protocol.Writer)

Marshal ...

func (*NetworkSettings) Unmarshal added in v1.3.0

func (pk *NetworkSettings) Unmarshal(r *protocol.Reader)

Unmarshal ...

type NetworkStackLatency added in v0.9.1

type NetworkStackLatency struct {
	// Timestamp is the timestamp of the network stack latency packet. The client will, if NeedsResponse is
	// set to true, send a NetworkStackLatency packet with this same timestamp packet in response.
	Timestamp int64
	// NeedsResponse specifies if the sending side of this packet wants a response to the packet, meaning that
	// the other side should send a NetworkStackLatency packet back.
	NeedsResponse bool
}

NetworkStackLatency is sent by the server (and the client, on development builds) to measure the latency over the entire Minecraft stack, rather than the RakNet latency. It has other usages too, such as the ability to be used as some kind of acknowledgement packet, to know when the client has received a certain other packet.

func (*NetworkStackLatency) ID added in v0.9.1

ID ...

func (*NetworkStackLatency) Marshal added in v0.9.1

func (pk *NetworkStackLatency) Marshal(w *protocol.Writer)

Marshal ...

func (*NetworkStackLatency) Unmarshal added in v0.9.1

func (pk *NetworkStackLatency) Unmarshal(r *protocol.Reader)

Unmarshal ...

type OnScreenTextureAnimation added in v0.9.1

type OnScreenTextureAnimation struct {
	// AnimationType is the type of the animation to show. The packet provides no further extra data to allow
	// modifying the duration or other properties of the animation.
	AnimationType int32
}

OnScreenTextureAnimation is sent by the server to show a certain animation on the screen of the player. The packet is used, as an example, for when a raid is triggered and when a raid is defeated.

func (*OnScreenTextureAnimation) ID added in v0.9.1

ID ...

func (*OnScreenTextureAnimation) Marshal added in v0.9.1

func (pk *OnScreenTextureAnimation) Marshal(w *protocol.Writer)

Marshal ...

func (*OnScreenTextureAnimation) Unmarshal added in v0.9.1

func (pk *OnScreenTextureAnimation) Unmarshal(r *protocol.Reader)

Unmarshal ...

type Packet

type Packet interface {
	// ID returns the ID of the packet. All of these identifiers of packets may be found in id.go.
	ID() uint32
	// Marshal encodes the packet to its binary representation into buf.
	Marshal(w *protocol.Writer)
	// Unmarshal decodes a serialised packet in buf into the Packet instance. The serialised packet passed
	// into Unmarshal will not have a header in it.
	Unmarshal(r *protocol.Reader)
}

Packet represents a packet that may be sent over a Minecraft network connection. The packet needs to hold a method to encode itself to binary and decode itself from binary.

type PacketViolationWarning added in v1.7.0

type PacketViolationWarning struct {
	// Type is the type of violation. It is one of the constants above.
	Type int32
	// Severity specifies the severity of the packet violation. The action the client takes after this
	// violation depends on the severity sent.
	Severity int32
	// PacketID is the ID of the invalid packet that was received.
	PacketID int32
	// ViolationContext holds a description on the violation of the packet.
	ViolationContext string
}

PacketViolationWarning is sent by the client when it receives an invalid packet from the server. It holds some information on the error that occurred. noinspection GoNameStartsWithPackageName

func (*PacketViolationWarning) ID added in v1.7.0

ID ...

func (*PacketViolationWarning) Marshal added in v1.7.0

func (pk *PacketViolationWarning) Marshal(w *protocol.Writer)

Marshal ...

func (*PacketViolationWarning) Unmarshal added in v1.7.0

func (pk *PacketViolationWarning) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PassengerJump added in v1.16.0

type PassengerJump struct {
	// JumpStrength is the strength of the jump, depending on how long the rider has held the jump button.
	JumpStrength int32
}

PassengerJump is sent by the client to the server when it jumps while riding an entity that has the WASDControlled entity flag set, for example when riding a horse.

func (*PassengerJump) ID added in v1.16.0

func (*PassengerJump) ID() uint32

ID ...

func (*PassengerJump) Marshal added in v1.16.0

func (pk *PassengerJump) Marshal(w *protocol.Writer)

Marshal ...

func (*PassengerJump) Unmarshal added in v1.16.0

func (pk *PassengerJump) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PhotoInfoRequest added in v1.16.0

type PhotoInfoRequest struct {
	// PhotoID is the ID of the photo.
	PhotoID int64
}

PhotoInfoRequest is sent by the client to request photo information from the server.

func (*PhotoInfoRequest) ID added in v1.16.0

func (*PhotoInfoRequest) ID() uint32

ID ...

func (*PhotoInfoRequest) Marshal added in v1.16.0

func (pk *PhotoInfoRequest) Marshal(w *protocol.Writer)

Marshal ...

func (*PhotoInfoRequest) Unmarshal added in v1.16.0

func (pk *PhotoInfoRequest) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PhotoTransfer added in v0.9.1

type PhotoTransfer struct {
	// PhotoName is the name of the photo to transfer. It is the exact file name that the client will download
	// the photo as, including the extension of the file.
	PhotoName string
	// PhotoData is the raw data of the photo image. The format of this data may vary: Formats such as JPEG or
	// PNG work, as long as PhotoName has the correct extension.
	PhotoData []byte
	// BookID is the ID of the book that the photo is associated with. If the PhotoName in a book with this ID
	// is set to PhotoName, it will display the photo (provided Education Edition is used).
	// The photo image is downloaded to a sub-folder with this book ID.
	BookID string
	// PhotoType is one of the three photo types above.
	PhotoType byte
	// SourceType is the source photo type. It is one of the three photo types above.
	SourceType byte
	// OwnerEntityUniqueID is the entity unique ID of the photo's owner.
	OwnerEntityUniqueID int64
	// NewPhotoName is the new name of the photo.
	NewPhotoName string
}

PhotoTransfer is sent by the server to transfer a photo (image) file to the client. It is typically used to transfer photos so that the client can display it in a portfolio in Education Edition. While previously usable in the default Bedrock Edition, the displaying of photos in books was disabled and the packet now has little use anymore.

func (*PhotoTransfer) ID added in v0.9.1

func (*PhotoTransfer) ID() uint32

ID ...

func (*PhotoTransfer) Marshal added in v0.9.1

func (pk *PhotoTransfer) Marshal(w *protocol.Writer)

Marshal ...

func (*PhotoTransfer) Unmarshal added in v0.9.1

func (pk *PhotoTransfer) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PlaySound added in v0.9.1

type PlaySound struct {
	// SoundName is the name of the sound to play.
	SoundName string
	// Position is the position at which the sound was played. Some of the sounds do not depend on a position,
	// which will then ignore it, but most of them will play with the direction based on the position compared
	// to the player's position.
	Position mgl32.Vec3
	// Volume is the relative volume of the sound to play. It will be less loud for the player if it is
	// farther away from the position of the sound.
	Volume float32
	// Pitch is the pitch of the sound to play. Some sounds completely ignore this field, whereas others use
	// it to specify the pitch as the field is intended.
	Pitch float32
}

PlaySound is sent by the server to play a sound to the client. Some of the sounds may only be started using this packet and must be stopped using the StopSound packet.

func (*PlaySound) ID added in v0.9.1

func (*PlaySound) ID() uint32

ID ...

func (*PlaySound) Marshal added in v0.9.1

func (pk *PlaySound) Marshal(w *protocol.Writer)

Marshal ...

func (*PlaySound) Unmarshal added in v0.9.1

func (pk *PlaySound) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PlayStatus

type PlayStatus struct {
	// Status is the status of the packet. It is one of the constants found above.
	Status int32
}

PlayStatus is sent by the server to update a player on the play status. This includes failed statuses due to a mismatched version, but also success statuses.

func (*PlayStatus) ID

func (*PlayStatus) ID() uint32

ID ...

func (*PlayStatus) Marshal

func (pk *PlayStatus) Marshal(w *protocol.Writer)

Marshal ...

func (*PlayStatus) Unmarshal

func (pk *PlayStatus) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PlayerAction added in v0.6.0

type PlayerAction struct {
	// EntityRuntimeID is the runtime ID of the player. The runtime ID is unique for each world session, and
	// entities are generally identified in packets using this runtime ID.
	EntityRuntimeID uint64
	// ActionType is the ID of the action that was executed by the player. It is one of the constants that may
	// be found in protocol/player.go.
	ActionType int32
	// BlockPosition is the position of the target block, if the action with the ActionType set concerned a
	// block. If that is not the case, the block position will be zero.
	BlockPosition protocol.BlockPos
	// BlockFace is the face of the target block that was touched. If the action with the ActionType set
	// concerned a block. If not, the face is always 0.
	BlockFace int32
}

PlayerAction is sent by the client when it executes any action, for example starting to sprint, swim, starting the breaking of a block, dropping an item, etc.

func (*PlayerAction) ID added in v0.6.0

func (*PlayerAction) ID() uint32

ID ...

func (*PlayerAction) Marshal added in v0.6.0

func (pk *PlayerAction) Marshal(w *protocol.Writer)

Marshal ...

func (*PlayerAction) Unmarshal added in v0.6.0

func (pk *PlayerAction) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PlayerArmourDamage added in v1.7.0

type PlayerArmourDamage struct {
	// Bitset holds a bitset of 4 bits that indicate which pieces of armour need to have damage dealt to them.
	// The first bit, when toggled, is for a helmet, the second for the chestplate, the third for the leggings
	// and the fourth for boots.
	Bitset uint8
	// HelmetDamage is the amount of damage that should be dealt to the helmet.
	HelmetDamage int32
	// ChestplateDamage is the amount of damage that should be dealt to the chestplate.
	ChestplateDamage int32
	// LeggingsDamage is the amount of damage that should be dealt to the leggings.
	LeggingsDamage int32
	// BootsDamage is the amount of damage that should be dealt to the boots.
	BootsDamage int32
}

PlayerArmourDamage is sent by the server to damage the armour of a player. It is a very efficient packet, but generally it's much easier to just send a slot update for the damaged armour.

func (*PlayerArmourDamage) ID added in v1.7.0

func (pk *PlayerArmourDamage) ID() uint32

ID ...

func (*PlayerArmourDamage) Marshal added in v1.7.0

func (pk *PlayerArmourDamage) Marshal(w *protocol.Writer)

Marshal ...

func (*PlayerArmourDamage) Unmarshal added in v1.7.0

func (pk *PlayerArmourDamage) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PlayerAuthInput added in v1.3.0

type PlayerAuthInput struct {
	// Pitch and Yaw hold the rotation that the player reports it has.
	Pitch, Yaw float32
	// Position holds the position that the player reports it has.
	Position mgl32.Vec3
	// MoveVector is a Vec2 that specifies the direction in which the player moved, as a combination of X/Z
	// values which are created using the WASD/controller stick state.
	MoveVector mgl32.Vec2
	// HeadYaw is the horizontal rotation of the head that the player reports it has.
	HeadYaw float32
	// InputData is a combination of bit flags that together specify the way the player moved last tick. It
	// is a combination of the flags above.
	InputData uint64
	// InputMode specifies the way that the client inputs data to the screen. It is one of the constants that
	// may be found above.
	InputMode uint32
	// PlayMode specifies the way that the player is playing. The values it holds, which are rather random,
	// may be found above.
	PlayMode uint32
	// GazeDirection is the direction in which the player is gazing, when the PlayMode is PlayModeReality: In
	// other words, when the player is playing in virtual reality.
	GazeDirection mgl32.Vec3
	// Tick is the server tick at which the packet was sent. It is used in relation to
	// CorrectPlayerMovePrediction.
	Tick uint64
	// Delta was the delta between the old and the new position. There isn't any practical use for this field
	// as it can be calculated by the server itself.
	Delta mgl32.Vec3
	// ItemInteractionData is the transaction data if the InputData includes an item interaction.
	ItemInteractionData protocol.UseItemTransactionData
	// ItemStackRequest is sent by the client to change an item in their inventory.
	ItemStackRequest protocol.ItemStackRequest
	// BlockActions is a slice of block actions that the client has interacted with.
	BlockActions []protocol.PlayerBlockAction
}

PlayerAuthInput is sent by the client to allow for server authoritative movement. It is used to synchronise the player input with the position server-side. The client sends this packet when the ServerAuthoritativeMovementMode field in the StartGame packet is set to true, instead of the MovePlayer packet. The client will send this packet once every tick.

func (*PlayerAuthInput) ID added in v1.3.0

func (pk *PlayerAuthInput) ID() uint32

ID ...

func (*PlayerAuthInput) Marshal added in v1.3.0

func (pk *PlayerAuthInput) Marshal(w *protocol.Writer)

Marshal ...

func (*PlayerAuthInput) Unmarshal added in v1.3.0

func (pk *PlayerAuthInput) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PlayerEnchantOptions added in v1.7.0

type PlayerEnchantOptions struct {
	// Options is a list of possible enchantment options for the item that was put into the enchantment table.
	Options []protocol.EnchantmentOption
}

PlayerEnchantOptions is sent by the server to update the enchantment options displayed when the user opens the enchantment table and puts an item in. This packet was added in 1.16 and allows the server to decide on the enchantments that can be selected by the player. The PlayerEnchantOptions packet should be sent once for every slot update of the enchantment table. The vanilla server sends an empty PlayerEnchantOptions packet when the player opens the enchantment table (air is present in the enchantment table slot) and sends the packet with actual enchantments in it when items are put in that can have enchantments.

func (*PlayerEnchantOptions) ID added in v1.7.0

ID ...

func (*PlayerEnchantOptions) Marshal added in v1.7.0

func (pk *PlayerEnchantOptions) Marshal(w *protocol.Writer)

Marshal ...

func (*PlayerEnchantOptions) Unmarshal added in v1.7.0

func (pk *PlayerEnchantOptions) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PlayerFog added in v1.9.0

type PlayerFog struct {
	// Stack is a list of fog identifiers to be sent to the client. Examples of fog identifiers are
	// "minecraft:fog_ocean" and "minecraft:fog_hell".
	Stack []string
}

PlayerFog is sent by the server to render the different fogs in the Stack. The types of fog are controlled by resource packs to change how they are rendered, and the ability to create custom fog.

func (*PlayerFog) ID added in v1.9.0

func (*PlayerFog) ID() uint32

ID ...

func (*PlayerFog) Marshal added in v1.9.0

func (pk *PlayerFog) Marshal(w *protocol.Writer)

Marshal ...

func (*PlayerFog) Unmarshal added in v1.9.0

func (pk *PlayerFog) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PlayerHotBar added in v0.7.0

type PlayerHotBar struct {
	// SelectedHotBarSlot ...
	SelectedHotBarSlot uint32
	// WindowID ...
	WindowID byte
	// SelectHotBarSlot ...
	SelectHotBarSlot bool
}

PlayerHotBar is sent by the server to the client. It used to be used to link hot bar slots of the player to actual slots in the inventory, but as of 1.2, this was changed and hot bar slots are no longer a free floating part of the inventory. Since 1.2, the packet has been re-purposed, but its new functionality is not clear.

func (*PlayerHotBar) ID added in v0.7.0

func (*PlayerHotBar) ID() uint32

ID ...

func (*PlayerHotBar) Marshal added in v0.7.0

func (pk *PlayerHotBar) Marshal(w *protocol.Writer)

Marshal ...

func (*PlayerHotBar) Unmarshal added in v0.7.0

func (pk *PlayerHotBar) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PlayerInput added in v0.7.0

type PlayerInput struct {
	// Movement is the movement vector of the input. It should be thought of in Pocket Edition controls, where
	// specific arrows (or a combination of two, resulting in a diagonal arrow) decide the direction of
	// movement. The movement vector typically has a length of 1: Either it has movement on one axis, or it
	// has a combination, resulting in sqrt(2)/2 for both axes.
	Movement mgl32.Vec2
	// Jumping indicates if the player was pressing the jump button during the input. It does not define if
	// the player was actually in the air or not.
	Jumping bool
	// Sneaking indicates if the player was sneaking during the input. Note that this may also be checked by
	// keeping the sneaking state updated using the PlayerAction packet.
	Sneaking bool
}

PlayerInput is sent by the client to the server when the player is moving but the server does not allow it to update its movement using the MovePlayer packet. It includes situations where the player is riding an entity like a boat. If this is the case, the packet is sent roughly every tick.

func (*PlayerInput) ID added in v0.7.0

func (*PlayerInput) ID() uint32

ID ...

func (*PlayerInput) Marshal added in v0.7.0

func (pk *PlayerInput) Marshal(w *protocol.Writer)

Marshal ...

func (*PlayerInput) Unmarshal added in v0.7.0

func (pk *PlayerInput) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PlayerList added in v0.7.0

type PlayerList struct {
	// ActionType is the action to execute upon the player list. The entries that follow specify which entries
	// are added or removed from the player list.
	ActionType byte
	// Entries is a list of all player list entries that should be added/removed from the player list,
	// depending on the ActionType set.
	Entries []protocol.PlayerListEntry
}

PlayerList is sent by the server to update the client-side player list in the in-game menu screen. It shows the icon of each player if the correct XUID is written in the packet. Sending the PlayerList packet is obligatory when sending an AddPlayer packet. The added player will not show up to a client if it has not been added to the player list, because several properties of the player are obtained from the player list, such as the skin.

func (*PlayerList) ID added in v0.7.0

func (*PlayerList) ID() uint32

ID ...

func (*PlayerList) Marshal added in v0.7.0

func (pk *PlayerList) Marshal(w *protocol.Writer)

Marshal ...

func (*PlayerList) Unmarshal added in v0.7.0

func (pk *PlayerList) Unmarshal(r *protocol.Reader)

Unmarshal ...

type PlayerSkin added in v0.7.0

type PlayerSkin struct {
	// UUID is the UUID of the player as sent in the Login packet when the client joined the server. It must
	// match this UUID exactly for the skin to show up on the player.
	UUID uuid.UUID
	// Skin is the new skin to be applied on the player with the UUID in the field above. The skin, including
	// its animations, will be shown after sending it.
	Skin protocol.Skin
	// NewSkinName no longer has a function: The field can be left empty at all times.
	NewSkinName string
	// OldSkinName no longer has a function: The field can be left empty at all times.
	OldSkinName string
}

PlayerSkin is sent by the client to the server when it updates its own skin using the in-game skin picker. It is relayed by the server, or sent if the server changes the skin of a player on its own accord. Note that the packet can only be sent for players that are in the player list at the time of sending.

func (*PlayerSkin) ID added in v0.7.0

func (*PlayerSkin) ID() uint32

ID ...

func (*PlayerSkin) Marshal added in v0.7.0

func (pk *PlayerSkin) Marshal(w *protocol.Writer)

Marshal ...

func (*PlayerSkin) Unmarshal added in v0.7.0

func (pk *PlayerSkin) Unmarshal(r *protocol.Reader)

Unmarshal ...

type Pool

type Pool map[uint32]func() Packet

Pool is a map holding packets indexed by a packet ID.

func NewPool

func NewPool() Pool

NewPool returns a new pool with all supported packets sent. Packets may be retrieved from it simply by indexing it with the packet ID.

type PositionTrackingDBClientRequest added in v1.7.0

type PositionTrackingDBClientRequest struct {
	// RequestAction is the action that should be performed upon the receiving of the packet. It is one of the
	// constants found above.
	RequestAction byte
	// TrackingID is a unique ID used to identify the request. The server responds with a
	// PositionTrackingDBServerBroadcast packet holding the same ID, so that the client can find out what that
	// packet was in response to.
	TrackingID int32
}

PositionTrackingDBClientRequest is a packet sent by the client to request the position and dimension of a 'tracking ID'. These IDs are tracked in a database by the server. In 1.16, this is used for lodestones. The client will send this request to find the position a lodestone compass needs to point to. If found, it will point to the lodestone. If not, it will start spinning around. A PositionTrackingDBServerBroadcast packet should be sent in response to this packet.

func (*PositionTrackingDBClientRequest) ID added in v1.7.0

ID ...

func (*PositionTrackingDBClientRequest) Marshal added in v1.7.0

Marshal ...

func (*PositionTrackingDBClientRequest) Unmarshal added in v1.7.0

Unmarshal ...

type PositionTrackingDBServerBroadcast added in v1.7.0

type PositionTrackingDBServerBroadcast struct {
	// BroadcastAction specifies the status of the position tracking DB response. It is one of the constants
	// above, specifying the result of the request with the ID below.
	// The Update action is sent for setting the position of a lodestone compass, the Destroy and NotFound to
	// indicate that there is not (no longer) a lodestone at that position.
	BroadcastAction byte
	// TrackingID is the ID of the PositionTrackingDBClientRequest packet that this packet was in response to.
	// The tracking ID is also present as the 'id' field in the SerialisedData field.
	TrackingID int32
	// SerialisedData is a network little endian encoded NBT compound tag holding the data retrieved from the
	// position tracking DB.
	// An example data structure sent if BroadcastAction is of the type Update:
	// TAG_Compound({
	//        'version': TAG_Byte(0x01),
	//        'dim': TAG_Int(0),
	//        'id': TAG_String(0x00000001),
	//        'pos': TAG_List<TAG_Int>({
	//                -299,
	//                86,
	//                74,
	//        }),
	//        'status': TAG_Byte(0x00), // 0x00 for updating, 0x02 for not found/block destroyed.
	// })
	SerialisedData []byte
}

PositionTrackingDBServerBroadcast is sent by the server in response to the PositionTrackingDBClientRequest packet. This packet is, as of 1.16, currently only used for lodestones. The server maintains a database with tracking IDs and their position and dimension. The client will request these tracking IDs, (NBT tag set on the lodestone compass with the tracking ID?) and the server will respond with the status of those tracking IDs. What is actually done with the data sent depends on what the client chooses to do with it. For the lodestone compass, it is used to make the compass point towards lodestones and to make it spin if the lodestone at a position is no longer there.

func (*PositionTrackingDBServerBroadcast) ID added in v1.7.0

ID ...

func (*PositionTrackingDBServerBroadcast) Marshal added in v1.7.0

Marshal ...

func (*PositionTrackingDBServerBroadcast) Unmarshal added in v1.7.0

Unmarshal ...

type PurchaseReceipt added in v0.9.1

type PurchaseReceipt struct {
	// Receipts is a list of receipts, or proofs of purchases, for the offers that have been purchased by the
	// player.
	Receipts []string
}

PurchaseReceipt is sent by the client to the server to notify the server it purchased an item from the Marketplace store that was offered by the server. The packet is only used for partnered servers.

func (*PurchaseReceipt) ID added in v0.9.1

func (*PurchaseReceipt) ID() uint32

ID ...

func (*PurchaseReceipt) Marshal added in v0.9.1

func (pk *PurchaseReceipt) Marshal(w *protocol.Writer)

Marshal ...

func (*PurchaseReceipt) Unmarshal added in v0.9.1

func (pk *PurchaseReceipt) Unmarshal(r *protocol.Reader)

Unmarshal ...

type RemoveActor added in v0.9.2

type RemoveActor struct {
	// EntityUniqueID is the unique ID of the entity to be removed. The unique ID is a value that remains
	// consistent across different sessions of the same world, but most servers simply fill the runtime ID
	// of the entity out for this field.
	EntityUniqueID int64
}

RemoveActor is sent by the server to remove an entity that currently exists in the world from the client- side. Sending this packet if the client cannot already see this entity will have no effect.

func (*RemoveActor) ID added in v0.9.2

func (*RemoveActor) ID() uint32

ID ...

func (*RemoveActor) Marshal added in v0.9.2

func (pk *RemoveActor) Marshal(w *protocol.Writer)

Marshal ...

func (*RemoveActor) Unmarshal added in v0.9.2

func (pk *RemoveActor) Unmarshal(r *protocol.Reader)

Unmarshal ...

type RemoveEntity added in v0.3.0

type RemoveEntity struct {
	// EntityNetworkID is the network ID of the entity that should be removed.
	EntityNetworkID uint64
}

RemoveEntity is sent by the server to the client. Its function is not entirely clear: It does not remove an entity in the sense of an in-game entity, but has to do with the ECS that Minecraft uses.

func (*RemoveEntity) ID added in v0.3.0

func (pk *RemoveEntity) ID() uint32

ID ...

func (*RemoveEntity) Marshal added in v0.3.0

func (pk *RemoveEntity) Marshal(w *protocol.Writer)

Marshal ...

func (*RemoveEntity) Unmarshal added in v0.3.0

func (pk *RemoveEntity) Unmarshal(r *protocol.Reader)

Unmarshal ...

type RemoveObjective added in v0.9.1

type RemoveObjective struct {
	// ObjectiveName is the name of the objective that the scoreboard currently active has. This name must
	// be identical to the one sent in the SetDisplayObjective packet.
	ObjectiveName string
}

RemoveObjective is sent by the server to remove a scoreboard objective. It is used to stop showing a scoreboard to a player.

func (*RemoveObjective) ID added in v0.9.1

func (*RemoveObjective) ID() uint32

ID ...

func (*RemoveObjective) Marshal added in v0.9.1

func (pk *RemoveObjective) Marshal(w *protocol.Writer)

Marshal ...

func (*RemoveObjective) Unmarshal added in v0.9.1

func (pk *RemoveObjective) Unmarshal(r *protocol.Reader)

Unmarshal ...

type RemoveVolumeEntity added in v1.13.0

type RemoveVolumeEntity struct {
	// EntityRuntimeID ...
	EntityRuntimeID uint64
}

RemoveVolumeEntity indicates a volume entity to be removed from server to client.

func (*RemoveVolumeEntity) ID added in v1.13.0

func (*RemoveVolumeEntity) ID() uint32

ID ...

func (*RemoveVolumeEntity) Marshal added in v1.13.0

func (pk *RemoveVolumeEntity) Marshal(w *protocol.Writer)

Marshal ...

func (*RemoveVolumeEntity) Unmarshal added in v1.13.0

func (pk *RemoveVolumeEntity) Unmarshal(r *protocol.Reader)

Unmarshal ...

type RequestChunkRadius

type RequestChunkRadius struct {
	// ChunkRadius is the requested chunk radius. This value is always the value set in the settings of the
	// player.
	ChunkRadius int32
}

RequestChunkRadius is sent by the client to the server to update the server on the chunk view radius that it has set in the settings. The server may respond with a ChunkRadiusUpdated packet with either the chunk radius requested, or a different chunk radius if the server chooses so.

func (*RequestChunkRadius) ID

func (*RequestChunkRadius) ID() uint32

ID ...

func (*RequestChunkRadius) Marshal

func (pk *RequestChunkRadius) Marshal(w *protocol.Writer)

Marshal ...

func (*RequestChunkRadius) Unmarshal

func (pk *RequestChunkRadius) Unmarshal(r *protocol.Reader)

Unmarshal ...

type ResourcePackChunkData

type ResourcePackChunkData struct {
	// UUID is the unique ID of the resource pack that the chunk of data is taken out of.
	UUID string
	// ChunkIndex is the current chunk index of the chunk. It is a number that starts at 0 and is incremented
	// for each resource pack data chunk sent to the client.
	ChunkIndex uint32
	// DataOffset is the current progress in bytes or offset in the data that the resource pack data chunk is
	// taken from.
	DataOffset uint64
	// RawPayload is a byte slice containing a chunk of data from the resource pack. It must be of the same size or
	// less than the DataChunkSize set in the ResourcePackDataInfo packet.
	Data []byte
}

ResourcePackChunkData is sent to the client so that the client can download the resource pack. Each packet holds a chunk of the compressed resource pack, of which the size is defined in the ResourcePackDataInfo packet sent before.

func (*ResourcePackChunkData) ID

ID ...

func (*ResourcePackChunkData) Marshal

func (pk *ResourcePackChunkData) Marshal(w *protocol.Writer)

Marshal ...

func (*ResourcePackChunkData) Unmarshal