packet

package
Version: v0.11.0 Latest Latest
Warning

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

Go to latest
Published: Jul 28, 2019 License: MIT Imports: 19 Imported by: 28

Documentation

Index

Constants

View Source
const (
	ActorEventHurt
	ActorEventDeath
	ActorEventArmSwing

	ActorEventTameFail
	ActorEventTameSucceed
	ActorEventShakeDry
	ActorEventUseItem
	ActorEventEatGrass
	ActorEventFishHookBubble
	ActorEventFishHookPosition
	ActorEventFishHook
	ActorEventFishHookTease
	ActorEventSquidInkCloud
	ActorEventZombieVillagerCure

	ActorEventRespawn
	ActorEventIronGolemOfferFlower
	ActorEventIronGolemWithdrawFlower
	ActorEventLookingForPartner

	ActorEventWitchSpell
	ActorEventFirework

	ActorEventSilverfishSpawn

	ActorEventWitchDrinkPotion
	ActorEventWitchThrowPotion
	ActorEventMinecartTNTPrimeFuse

	ActorEventPlayerAddXPLevels
	ActorEventElderGuardianCurse
	ActorEventAgentArmSwing
	ActorEventEnderDragonDeath
	ActorEventDustParticles
	ActorEventArrowShake
	// ...
	ActorEventEatingItem = 57
)
View Source
const (
	ActorEventBabyAnimalFeed = iota + 60
	ActorEventDeathSmokeCloud
	ActorEventCompleteTrade
	ActorEventRemoveLeash

	ActorEventConsumeToken
	ActorEventPlayerCheckTreasureHunterAchievement
	ActorEventEntitySpawn
	ActorEventDragonBreath
	ActorEventItemEntityMerge
)
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 (
	ActionPermissionBuildAndMine = 1 << iota
	ActionPermissionDoorsAndSwitched
	ActionPermissionOpenContainers
	ActionPermissionAttackPlayers
	ActionPermissionAttackMobs
	ActionPermissionOperator
	ActionPermissionTeleport
)
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 (
	DimensionOverworld = iota
	DimensionNether
	DimensionEnd
)
View Source
const (
	MapUpdateFlagTexture = 1 << (iota + 1)
	MapUpdateFlagDecoration
	MapUpdateFlagInitialisation
)
View Source
const (
	CommandBlockImpulse = iota
	CommandBlockRepeat
	CommandBlockChain
)
View Source
const (
	ContainerDataFurnaceTickCount = iota
	ContainerDataFurnaceLitTime
	ContainerDataFurnaceLitDuration

	ContainerDataFurnaceFuelAux
)
View Source
const (
	ContainerDataBrewingStandBrewTime = iota
	ContainerDataBrewingStandFuelAmount
	ContainerDataBrewingStandFuelTotal
)
View Source
const (
	EventAchievementAwarded = iota
	EventEntityInteract
	EventPortalBuilt
	EventPortalUsed
	EventMobKilled
	EventCauldronUsed
	EventPlayerDeath
	EventBossKilled
	EventAgentCommand
	EventAgentCreated
	EventBannerPatternRemoved
	EventCommandExecuted
	EventFishBucketed
)
View Source
const (
	IDLogin = iota + 0x01
	IDPlayStatus
	IDServerToClientHandshake
	IDClientToServerHandshake
	IDDisconnect
	IDResourcePacksInfo
	IDResourcePackStack
	IDResourcePackClientResponse
	IDText
	IDSetTime
	IDStartGame
	IDAddPlayer
	IDAddActor
	IDRemoveActor
	IDAddItemActor

	IDTakeItemActor
	IDMoveActorAbsolute
	IDMovePlayer
	IDRiderJump
	IDUpdateBlock
	IDAddPainting
	IDExplode

	IDLevelEvent
	IDBlockEvent
	IDActorEvent
	IDMobEffect
	IDUpdateAttributes
	IDInventoryTransaction
	IDMobEquipment
	IDMobArmourEquipment
	IDInteract
	IDBlockPickRequest
	IDActorPickRequest
	IDPlayerAction
	IDActorFall
	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
	IDVideoStreamConnect
	IDAddEntity
	IDRemoveEntity
	IDClientCacheStatus
	IDMapCreateLockedCopy
	IDOnScreenTextureAnimation
	IDStructureTemplateDataExportRequest
	IDStructureTemplateDataExportResponse
	IDUpdateBlockProperties
	IDClientCacheBlobStatus
	IDClientCacheMissResponse
)
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

	EventSoundGhast      = 1007
	EventSoundGhastShoot = 1008
	EventSoundBlazeShoot = 1009
	EventSoundDoorBump   = 1010

	EventSoundDoorCrash = 1012

	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

	EventParticleShoot      = 2000
	EventParticleDestroy    = 2001
	EventParticleSplash     = 2002
	EventParticleEyeDespawn = 2003
	EventParticleSpawn      = 2004

	EventGuardianCurse = 2006

	EventParticleBlockForceField   = 2008
	EventParticleProjectileHit     = 2009
	EventParticleDragonEggTeleport = 2010

	EventParticleEndermanTeleport = 2013
	EventParticlePunchBlock       = 2014

	EventStartRain    = 3001
	EventStartThunder = 3002
	EventStopRain     = 3003
	EventStopThunder  = 3004
	EventPauseGame    = 3005

	EventRedstoneTrigger     = 3500
	EventCauldronExplode     = 3501
	EventCauldronDyeArmour   = 3502
	EventCauldronCleanArmour = 3503
	EventCauldronFillPotion  = 3504
	EventCauldronTakePotion  = 3505
	EventCauldronFillWater   = 3506
	EventCauldronTakeWater   = 3507
	EventCauldronAddDye      = 3508
	EventCauldronCleanBanner = 3509

	EventBlockStartBreak = 3600
	EventBlockStopBreak  = 3601

	EventSetData = 4000

	EventPlayersSleeping = 9800

	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
	SoundEventUnfect
	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

	SoundEventBorn
	SoundEventBlockTurtleEggBreak
	SoundEventBlockTurtleEggCrack
	SoundEventBlockTurtleEggHatch

	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
	SoundEventUndefined
)
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 (
	MoveModeNormal = iota
	MoveModeReset
	MoveModeTeleport
	MoveModeRotation
)
View Source
const (
	TeleportCauseUnknown = iota
	TeleportCauseProjectile
	TeleportCauseChorusFruit
	TeleportCauseCommand
	TeleportCauseBehaviour
)
View Source
const (
	PlayStatusLoginSuccess int32 = iota
	PlayStatusLoginFailedClient
	PlayStatusLoginFailedServer
	PlayStatusPlayerSpawn
	PlayStatusLoginFailedInvalidTenant
	PlayStatusLoginFailedVanillaEdu
	PlayStatusLoginFailedEduVanilla
	PlayStatusLoginFailedServerFull
)
View Source
const (
	PlayerActionStartBreak = iota
	PlayerActionAbortBreak
	PlayerActionStopBreak
	PlayerActionGetUpdatedBlock
	PlayerActionDropItem
	PlayerActionStartSleeping
	PlayerActionStopSleeping
	PlayerActionRespawn
	PlayerActionJump
	PlayerActionStartSprint
	PlayerActionStopSprint
	PlayerActionStartSneak
	PlayerActionStopSneak
	PlayerActionDimensionChangeRequest
	PlayerActionDimensionChangeDone
	PlayerActionStartGlide
	PlayerActionStopGlide
	PlayerActionBuildDenied
	PlayerActionContinueBreak

	PlayerActionSetEnchantmentSeed
	PlayerActionStartSwimming
	PlayerActionStopSwimming
	PlayerActionStartSpinAttack
	PlayerActionStopSpinAttack
)
View Source
const (
	PlayerListActionAdd = iota
	PlayerListActionRemove
)
View Source
const (
	PackResponseRefused = iota + 1
	PackResponseSendPacks
	PackResponseAllPacksDownloaded
	PackResponseCompleted
)
View Source
const (
	ResourcePackTypeResource = iota + 1
	ResourcePackTypeBehaviour
	ResourcePackTypeWorldTemplate
	ResourcePackTypeAddon
	ResourcePackTypeSkins
	ResourcePackTypeCached
	ResourcePackTypeCopyProtected
)
View Source
const (
	ScoreboardSlotList      = "list"
	ScoreboardSlotSidebar   = "sidebar"
	ScoreboardSlotBelowName = "belowname"
)
View Source
const (
	ScoreboardSortOrderAscending = iota
	ScoreboardSortOrderDescending
)
View Source
const (
	GameTypeSurvival = iota
	GameTypeCreative
	GameTypeAdventure
	GameTypeSurvivalSpectator
	GameTypeCreativeSpectator
)
View Source
const (
	ScoreboardActionRemove = iota
	ScoreboardActionModify
)
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 (
	StructureBlockData = iota + 1
	StructureBlockSave
	StructureBlockLoad
	StructureBlockCorner
	StructureBlockExport
)
View Source
const (
	TextTypeRaw = iota
	TextTypeChat
	TextTypeTranslation
	TextTypePopup
	TextTypeJukeboxPopup
	TextTypeTip
	TextTypeSystem
	TextTypeWhisper
	TextTypeAnnouncement
	TextTypeJSON
)
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 (
	VideoStreamActionStart = iota
	VideoStreamActionStop
)
View Source
const (
	BlockEventChangeChestState = 1
)

Variables

View Source
var PacketsByName = map[string]func() Packet{}

PacketsByName is a map holding a function to create a new packet for each packet registered in Pool. These functions are indexed using the exact packet name they return.

Functions

This section is empty.

Types

type ActorEvent added in v0.9.2

type ActorEvent struct {
	// EntityNetworkID 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(buf *bytes.Buffer)

Marshal ...

func (*ActorEvent) Unmarshal added in v0.9.2

func (pk *ActorEvent) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ActorFall added in v0.9.2

type ActorFall struct {
	// EntityNetworkID 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
	// FallDistance is the distance that the entity fell until it hit the ground. The damage would otherwise
	// be calculated using this field.
	FallDistance float32
	// InVoid specifies if the fall was in the void. The player can't fall below roughly Y=-40.
	InVoid bool
}

ActorFall is sent by the client when it falls from a distance onto a block that would damage the player. This packet should not be used at all by the server, as it can easily be spoofed using a proxy or custom client. Servers should implement fall damage using their own calculations.

func (*ActorFall) ID added in v0.9.2

func (*ActorFall) ID() uint32

ID ...

func (*ActorFall) Marshal added in v0.9.2

func (pk *ActorFall) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ActorFall) Unmarshal added in v0.9.2

func (pk *ActorFall) Unmarshal(buf *bytes.Buffer) error

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
}

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(buf *bytes.Buffer)

Marshal ...

func (*ActorPickRequest) Unmarshal added in v0.9.2

func (pk *ActorPickRequest) Unmarshal(buf *bytes.Buffer) error

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
	// EntityNetworkID 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(buf *bytes.Buffer)

Marshal ...

func (*AddActor) Unmarshal added in v0.9.2

func (pk *AddActor) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type AddBehaviourTree added in v0.9.1

type AddBehaviourTree struct {
	// BehaviourTree is a JSON encoded tree containing behaviour. It does not seem like it has any real
	// effect on the client.
	BehaviourTree string
}

AddBehaviourTree is sent by the server to the client. Its usage remains unknown, as behaviour packs are typically all sent at the start of the game.

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(buf *bytes.Buffer)

Marshal ...

func (*AddBehaviourTree) Unmarshal added in v0.9.1

func (pk *AddBehaviourTree) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*AddEntity) Unmarshal added in v0.3.0

func (pk *AddEntity) Unmarshal(buf *bytes.Buffer) error

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
	// EntityNetworkID 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.ItemStack
	// 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(buf *bytes.Buffer)

Marshal ...

func (*AddItemActor) Unmarshal added in v0.9.2

func (pk *AddItemActor) Unmarshal(buf *bytes.Buffer) error

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
	// EntityNetworkID 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(buf *bytes.Buffer)

Marshal ...

func (*AddPainting) Unmarshal added in v0.3.0

func (pk *AddPainting) Unmarshal(buf *bytes.Buffer) error

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
	// EntityNetworkID 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.ItemStack
	// 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
}

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(buf *bytes.Buffer)

Marshal ...

func (*AddPlayer) Unmarshal added in v0.3.0

func (pk *AddPlayer) Unmarshal(buf *bytes.Buffer) error

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. It appears it is not required to fill this field
	// out with a correct value. Simply writing 0 seems to work.
	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(buf *bytes.Buffer)

Marshal ...

func (*AdventureSettings) Unmarshal added in v0.7.0

func (pk *AdventureSettings) Unmarshal(buf *bytes.Buffer) error

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
	// EntityNetworkID 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(buf *bytes.Buffer)

Marshal ...

func (*Animate) Unmarshal added in v0.7.0

func (pk *Animate) Unmarshal(buf *bytes.Buffer) error

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, previously called WSConnect, 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(buf *bytes.Buffer)

Marshal ...

func (*AutomationClientConnect) Unmarshal added in v0.9.1

func (pk *AutomationClientConnect) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*AvailableActorIdentifiers) Unmarshal added in v0.9.2

func (pk *AvailableActorIdentifiers) Unmarshal(buf *bytes.Buffer) error

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
}

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(buf *bytes.Buffer)

Marshal ...

func (*AvailableCommands) Unmarshal added in v0.9.1

func (pk *AvailableCommands) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*BiomeDefinitionList) Unmarshal added in v0.9.1

func (pk *BiomeDefinitionList) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*BlockActorData) Unmarshal added in v0.9.2

func (pk *BlockActorData) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*BlockEvent) Unmarshal added in v0.3.0

func (pk *BlockEvent) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*BlockPickRequest) Unmarshal added in v0.6.0

func (pk *BlockPickRequest) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*BookEdit) Unmarshal added in v0.9.1

func (pk *BookEdit) Unmarshal(buf *bytes.Buffer) error

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
	// UnknownInt16: Might be something to do with the sky darkening...
	UnknownInt16 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(buf *bytes.Buffer)

Marshal ...

func (*BossEvent) Unmarshal added in v0.7.0

func (pk *BossEvent) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*Camera) Unmarshal added in v0.7.0

func (pk *Camera) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*ChangeDimension) Unmarshal added in v0.7.0

func (pk *ChangeDimension) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*ChunkRadiusUpdated) Unmarshal

func (pk *ChunkRadiusUpdated) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*ClientBoundMapItemData) Unmarshal added in v0.7.0

func (pk *ClientBoundMapItemData) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ClientCacheBlobStatus added in v0.9.2

type ClientCacheBlobStatus struct {
	// 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 []int64
	// 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 []int64
}

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(buf *bytes.Buffer)

Marshal ...

func (*ClientCacheBlobStatus) Unmarshal added in v0.9.2

func (pk *ClientCacheBlobStatus) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*ClientCacheMissResponse) Unmarshal added in v0.9.2

func (pk *ClientCacheMissResponse) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*ClientCacheStatus) Unmarshal added in v0.9.2

func (pk *ClientCacheStatus) Unmarshal(buf *bytes.Buffer) error

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

func (*ClientToServerHandshake) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ClientToServerHandshake) Unmarshal

func (*ClientToServerHandshake) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*CommandBlockUpdate) Unmarshal added in v0.9.1

func (pk *CommandBlockUpdate) Unmarshal(buf *bytes.Buffer) error

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
	// UnknownString ...
	UnknownString 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(buf *bytes.Buffer)

Marshal ...

func (*CommandOutput) Unmarshal added in v0.9.1

func (pk *CommandOutput) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*CommandRequest) Unmarshal added in v0.9.1

func (pk *CommandRequest) Unmarshal(buf *bytes.Buffer) error

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
}

ContainerClose is sent by the server to close a container the player currently has opened, which was opened using the ContainerOpen packet.

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(buf *bytes.Buffer)

Marshal ...

func (*ContainerClose) Unmarshal added in v0.7.0

func (pk *ContainerClose) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*ContainerOpen) Unmarshal added in v0.7.0

func (pk *ContainerOpen) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*ContainerSetData) Unmarshal added in v0.7.0

func (pk *ContainerSetData) Unmarshal(buf *bytes.Buffer) error

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
	// CleanRecipes 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.
	CleanRecipes 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(buf *bytes.Buffer)

Marshal ...

func (*CraftingData) Unmarshal added in v0.7.0

func (pk *CraftingData) Unmarshal(buf *bytes.Buffer) error

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.
	CraftingType int32 // TODO: Figure out the options for this.
	// 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.ItemStack
	// Output is a list of items that were obtained as a result of crafting the recipe.
	Output []protocol.ItemStack
}

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(buf *bytes.Buffer)

Marshal ...

func (*CraftingEvent) Unmarshal added in v0.7.0

func (pk *CraftingEvent) Unmarshal(buf *bytes.Buffer) error

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 zlib compressed packets.

func NewDecoder

func NewDecoder(reader io.Reader) *Decoder

NewDecoder returns a new decoder decoding data from the 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 reader passed in NewDecoder(), producing a slice of packets that it held and an error if not successful.

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(buf *bytes.Buffer)

Marshal ...

func (*Disconnect) Unmarshal

func (pk *Disconnect) Unmarshal(buf *bytes.Buffer) error

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(writer 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 zlib compressed and optionally encoded.

type Event added in v0.7.0

type Event struct {
	// EntityNetworkID 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
	// Unknown ... TODO: Find out what this is for.
	Unknown byte
}

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.

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(buf *bytes.Buffer)

Marshal ...

func (*Event) Unmarshal added in v0.7.0

func (pk *Event) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type Explode added in v0.3.0

type Explode struct {
	// Position is the centre position of the explosion that is taking place. It has no effect on the blocks
	// broken client-side, and seems to have no other functionality.
	Position mgl32.Vec3
	// Radius is the radius of the explosion. It seems to have no functionality.
	Radius float32
	// BlocksBroken is a list of all block positions that are to be destroyed by the explosion. This is the
	// only field that has functionality in the packet.
	BlocksBroken []protocol.BlockPos
}

Explode is sent by the server to make an explosion happen. The explosion will break all blocks in the packet client-side.

func (*Explode) ID added in v0.3.0

func (*Explode) ID() uint32

ID ...

func (*Explode) Marshal added in v0.3.0

func (pk *Explode) Marshal(buf *bytes.Buffer)

Marshal ...

func (*Explode) Unmarshal added in v0.3.0

func (pk *Explode) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*GUIDataPickItem) Unmarshal added in v0.7.0

func (pk *GUIDataPickItem) Unmarshal(buf *bytes.Buffer) error

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 map[string]interface{}
}

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(buf *bytes.Buffer)

Marshal ...

func (*GameRulesChanged) Unmarshal added in v0.7.0

func (pk *GameRulesChanged) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer) error

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

func (*Header) Write

func (header *Header) Write(buf *bytes.Buffer) error

Write writes the header as a single varuint32 to buf.

type HurtArmour added in v0.7.0

type HurtArmour struct {
	// 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
}

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(buf *bytes.Buffer)

Marshal ...

func (*HurtArmour) Unmarshal added in v0.7.0

func (pk *HurtArmour) Unmarshal(buf *bytes.Buffer) error

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
	// MouseOverPosition was the position relative to the entity moused over over which the player hovered
	// with its mouse/touch. It is only set if ActionType is InteractActionMouseOverEntity.
	MouseOverPosition 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(buf *bytes.Buffer)

Marshal ...

func (*Interact) Unmarshal added in v0.6.0

func (pk *Interact) Unmarshal(buf *bytes.Buffer) error

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.ItemStack
}

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(buf *bytes.Buffer)

Marshal ...

func (*InventoryContent) Unmarshal added in v0.7.0

func (pk *InventoryContent) Unmarshal(buf *bytes.Buffer) error

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.ItemStack
}

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(buf *bytes.Buffer)

Marshal ...

func (*InventorySlot) Unmarshal added in v0.7.0

func (pk *InventorySlot) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type InventoryTransaction added in v0.4.0

type InventoryTransaction struct {
	// 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(buf *bytes.Buffer)

Marshal ...

func (*InventoryTransaction) Unmarshal added in v0.4.0

func (pk *InventoryTransaction) Unmarshal(buf *bytes.Buffer) error

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 server to make the item in an item frame drop out of the frame client-side.

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(buf *bytes.Buffer)

Marshal ...

func (*ItemFrameDropItem) Unmarshal added in v0.7.0

func (pk *ItemFrameDropItem) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*LabTable) Unmarshal added in v0.9.1

func (pk *LabTable) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type LecternUpdate added in v0.9.1

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

LecternUpdate is sent by the server to update a lectern block, so that players can see that the block changed. It is used, for example, when a page is turned.

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(buf *bytes.Buffer)

Marshal ...

func (*LecternUpdate) Unmarshal added in v0.9.1

func (pk *LecternUpdate) Unmarshal(buf *bytes.Buffer) error

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 []int64
	// 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(buf *bytes.Buffer)

Marshal ...

func (*LevelChunk) Unmarshal added in v0.9.2

func (pk *LevelChunk) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*LevelEvent) Unmarshal added in v0.3.0

func (pk *LevelEvent) Unmarshal(buf *bytes.Buffer) error

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.
	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(buf *bytes.Buffer)

Marshal ...

func (*LevelEventGeneric) Unmarshal added in v0.9.2

func (pk *LevelEventGeneric) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*LevelSoundEvent) Unmarshal added in v0.9.1

func (pk *LevelSoundEvent) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*Login) Unmarshal

func (pk *Login) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*MapCreateLockedCopy) Unmarshal added in v0.9.1

func (pk *MapCreateLockedCopy) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*MapInfoRequest) Unmarshal added in v0.7.0

func (pk *MapInfoRequest) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type MobArmourEquipment added in v0.6.0

type MobArmourEquipment struct {
	// EntityNetworkID 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.ItemStack
	// Chestplate is the chestplate of the entity. Items that are not wearable as chestplate will not be
	// rendered.
	Chestplate protocol.ItemStack
	// Leggings is the item worn as leggings by the entity. Items not wearable as leggings will not be
	// rendered client-side.
	Leggings protocol.ItemStack
	// Boots is the item worn as boots by the entity. Items not wearable as boots will not be rendered.
	Boots protocol.ItemStack
}

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(buf *bytes.Buffer)

Marshal ...

func (*MobArmourEquipment) Unmarshal added in v0.6.0

func (pk *MobArmourEquipment) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type MobEffect added in v0.4.0

type MobEffect struct {
	// EntityNetworkID 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(buf *bytes.Buffer)

Marshal ...

func (*MobEffect) Unmarshal added in v0.4.0

func (pk *MobEffect) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type MobEquipment added in v0.6.0

type MobEquipment struct {
	// EntityNetworkID 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.ItemStack
	// 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(buf *bytes.Buffer)

Marshal ...

func (*MobEquipment) Unmarshal added in v0.6.0

func (pk *MobEquipment) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*ModalFormRequest) Unmarshal

func (pk *ModalFormRequest) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*ModalFormResponse) Unmarshal

func (pk *ModalFormResponse) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type MoveActorAbsolute added in v0.9.2

type MoveActorAbsolute struct {
	// EntityNetworkID 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(buf *bytes.Buffer)

Marshal ...

func (*MoveActorAbsolute) Unmarshal added in v0.9.2

func (pk *MoveActorAbsolute) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type MoveActorDelta added in v0.9.2

type MoveActorDelta struct {
	// EntityNetworkID 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
	// DeltaPosition is the difference from the previous position to the new position. It is the distance on
	// each axis that the entity should be moved.
	DeltaPosition mgl32.Vec3
	// DeltaRotation is the difference from the previous rotation to the new rotation. It is the rotation on
	// each axis that the entity should be turned.
	DeltaRotation mgl32.Vec3
}

MoveActorDelta is sent by the server to move an entity by a given delta. The packet is specifically optimised to save as much space as possible, by only writing non-zero fields.

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(buf *bytes.Buffer)

Marshal ...

func (*MoveActorDelta) Unmarshal added in v0.9.2

func (pk *MoveActorDelta) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type MovePlayer added in v0.3.0

type MovePlayer struct {
	// EntityNetworkID 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
	// TeleportItem is the item network ID of the item type that was used to teleport. It is only non-zero if
	// the teleport cause was an item.
	TeleportItem int32
}

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(buf *bytes.Buffer)

Marshal ...

func (*MovePlayer) Unmarshal added in v0.3.0

func (pk *MovePlayer) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type NPCRequest added in v0.9.1

type NPCRequest struct {
	// EntityNetworkID 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
}

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(buf *bytes.Buffer)

Marshal ...

func (*NPCRequest) Unmarshal added in v0.9.1

func (pk *NPCRequest) Unmarshal(buf *bytes.Buffer) error

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

func (pk *NetworkChunkPublisherUpdate) Marshal(buf *bytes.Buffer)

Marshal ...

func (*NetworkChunkPublisherUpdate) Unmarshal added in v0.9.1

func (pk *NetworkChunkPublisherUpdate) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*NetworkStackLatency) Unmarshal added in v0.9.1

func (pk *NetworkStackLatency) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*OnScreenTextureAnimation) Unmarshal added in v0.9.1

func (pk *OnScreenTextureAnimation) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)
	// 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(buf *bytes.Buffer) error
}

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 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
}

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(buf *bytes.Buffer)

Marshal ...

func (*PhotoTransfer) Unmarshal added in v0.9.1

func (pk *PhotoTransfer) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*PlaySound) Unmarshal added in v0.9.1

func (pk *PlaySound) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*PlayStatus) Unmarshal

func (pk *PlayStatus) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type PlayerAction added in v0.6.0

type PlayerAction struct {
	// EntityNetworkID 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 above.
	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(buf *bytes.Buffer)

Marshal ...

func (*PlayerAction) Unmarshal added in v0.6.0

func (pk *PlayerAction) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*PlayerHotBar) Unmarshal added in v0.7.0

func (pk *PlayerHotBar) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*PlayerInput) Unmarshal added in v0.7.0

func (pk *PlayerInput) Unmarshal(buf *bytes.Buffer) error

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 []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(buf *bytes.Buffer)

Marshal ...

func (*PlayerList) Unmarshal added in v0.7.0

func (pk *PlayerList) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type PlayerListEntry added in v0.7.0

type PlayerListEntry 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 correct XBOX Live icon to show up in the list.
	UUID uuid.UUID
	// EntityUniqueID is the unique entity ID of the player. This ID typically stays consistent during the
	// lifetime of a world, but servers often send the runtime ID for this.
	EntityUniqueID int64
	// Username is the username that is shown in the player list of the player that obtains a PlayerList
	// packet with this entry. It does not have to be the same as the actual username of the player.
	Username string
	// SkinID is a unique ID produced for the skin, for example 'c18e65aa-7b21-4637-9b63-8ad63622ef01_Alex'
	// for the default Alex skin.
	SkinID string
	// SkinData is a byte slice of 64*32*4, 64*64*4 or 128*128*4 bytes. It is a RGBA ordered byte
	// representation of the skin colours.
	SkinData []byte
	// CapeData is a byte slice of 64*32*4 bytes. It is a RGBA ordered byte representation of the cape
	// colours, much like the SkinData.
	CapeData []byte
	// SkinGeometryName is the geometry name of the skin geometry above. This name must be equal to one of the
	// outer names found in the SkinGeometry, so that the client can find the correct geometry data.
	SkinGeometryName string
	// SkinGeometry is a base64 JSON encoded structure of the geometry data of a skin, containing properties
	// such as bones, uv, pivot etc.
	SkinGeometry []byte
	// XUID is the XBOX Live user ID of the player, which will remain consistent as long as the player is
	// logged in with the XBOX Live account.
	XUID string
	// 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
}

PlayerListEntry is an entry found in the PlayerList packet. It represents a single player using the UUID found in the entry, and contains several properties such as the skin.

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
	// SkinID is a unique ID produced for the skin, for example 'c18e65aa-7b21-4637-9b63-8ad63622ef01_Alex'
	// for the default Alex skin.
	SkinID string
	// 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
	// SkinData is a byte slice of 64*32*4, 64*64*4 or 128*128*4 bytes. It is a RGBA ordered byte
	// representation of the skin colours.
	SkinData []byte
	// CapeData is a byte slice of 64*32*4 bytes. It is a RGBA ordered byte representation of the cape
	// colours, much like the SkinData.
	CapeData []byte
	// SkinGeometryName is the geometry name of the skin geometry above. This name must be equal to one of the
	// outer names found in the SkinGeometry, so that the client can find the correct geometry data.
	SkinGeometryName string
	// SkinGeometry is a base64 JSON encoded structure of the geometry data of a skin, containing properties
	// such as bones, uv, pivot etc.
	SkinGeometry []byte
	// PremiumSkin specifies if the skin equipped was a premium skin, meaning a payment was required in the
	// marketplace to get access to it.
	PremiumSkin bool
}

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(buf *bytes.Buffer)

Marshal ...

func (*PlayerSkin) Unmarshal added in v0.7.0

func (pk *PlayerSkin) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type Pool

type Pool map[uint32]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 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(buf *bytes.Buffer)

Marshal ...

func (*PurchaseReceipt) Unmarshal added in v0.9.1

func (pk *PurchaseReceipt) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*RemoveActor) Unmarshal added in v0.9.2

func (pk *RemoveActor) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*RemoveEntity) Unmarshal added in v0.3.0

func (pk *RemoveEntity) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*RemoveObjective) Unmarshal added in v0.9.1

func (pk *RemoveObjective) Unmarshal(buf *bytes.Buffer) error

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(buf *bytes.Buffer)

Marshal ...

func (*RequestChunkRadius) Unmarshal

func (pk *RequestChunkRadius) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ResourcePack

type ResourcePack struct {
	// UUID is the UUID of the resource pack. Each resource pack downloaded must have a different UUID in
	// order for the client to be able to handle them properly.
	UUID string
	// Version is the version of the resource pack. The client will cache resource packs sent by the server as
	// long as they carry the same version. Sending a resource pack with a different version than previously
	// will force the client to re-download it.
	Version string
	// Size is the total size in bytes that the resource pack occupies. This is the size of the compressed
	// archive (zip) of the resource pack.
	Size int64
	// ContentKey is the key used to decrypt the resource pack if it is encrypted. This is generally the case
	// for marketplace resource packs.
	ContentKey string
	// SubPackName ...
	SubPackName string
	// ContentIdentity ...
	ContentIdentity string
	// HasScripts specifies if the resource packs has any scripts in it. A client will only download the
	// resource pack if it supports scripts, which, up to 1.11, only includes Windows 10.
	HasScripts bool
}

ResourcePack represents a resource pack sent over network. It holds information about the resource pack such as its name, description and version.

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 int32
	// DataOffset is the current progress in bytes or offset in the data that the resource pack data chunk is
	// taken from.
	DataOffset int64
	// 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(buf *bytes.Buffer)

Marshal ...

func (*ResourcePackChunkData) Unmarshal

func (pk *ResourcePackChunkData) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ResourcePackChunkRequest

type ResourcePackChunkRequest struct {
	// UUID is the unique ID of the resource pack that the chunk of data is requested from.
	UUID string
	// ChunkIndex is the requested chunk index of the chunk. It is a number that starts at 0 and is
	// incremented for each resource pack data chunk requested.
	ChunkIndex int32
}

ResourcePackChunkRequest is sent by the client to request a chunk of data from a particular resource pack, that it has obtained information about in a ResourcePackDataInfo packet.

func (*ResourcePackChunkRequest) ID

ID ...

func (*ResourcePackChunkRequest) Marshal

func (pk *ResourcePackChunkRequest) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ResourcePackChunkRequest) Unmarshal

func (pk *ResourcePackChunkRequest) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ResourcePackClientResponse

type ResourcePackClientResponse struct {
	// Response is the response type of the response. It is one of the constants found above.
	Response byte
	// PacksToDownload is a list of resource pack UUIDs combined with their version that need to be downloaded
	// (for example SomePack_1.0.0), if the Response field is PackResponseSendPacks.
	PacksToDownload []string
}

ResourcePackClientResponse is sent by the client in response to resource packets sent by the server. It is used to let the server know what action needs to be taken for the client to have all resource packs ready and set.

func (*ResourcePackClientResponse) ID

ID ...

func (*ResourcePackClientResponse) Marshal

func (pk *ResourcePackClientResponse) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ResourcePackClientResponse) Unmarshal

func (pk *ResourcePackClientResponse) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ResourcePackDataInfo

type ResourcePackDataInfo struct {
	// UUID is the unique ID of the resource pack that the info concerns.
	UUID string
	// DataChunkSize is the maximum size in bytes of the chunks in which the total size of the resource pack
	// to be sent will be divided. A size of 1MB (1024*1024) means that a resource pack of 15.5MB will be
	// split into 16 data chunks.
	DataChunkSize int32
	// ChunkCount is the total amount of data chunks that the sent resource pack will exist out of. It is the
	// total size of the resource pack divided by the DataChunkSize field.
	ChunkCount int32
	// Size is the total size in bytes that the resource pack occupies. This is the size of the compressed
	// archive (zip) of the resource pack.
	Size int64
	// Hash is a SHA256 hash of the content of the resource pack.
	Hash []byte
	// Premium specifies if the resource pack was a premium resource pack, meaning it was bought from the
	// Minecraft store.
	Premium bool
	// PackType is the type of the resource pack. It is one of the resource pack types that may be found in
	// the constants above.
	PackType byte
}

ResourcePackDataInfo is sent by the server to the client to inform the client about the data contained in one of the resource packs that are about to be sent.

func (*ResourcePackDataInfo) ID

ID ...

func (*ResourcePackDataInfo) Marshal

func (pk *ResourcePackDataInfo) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ResourcePackDataInfo) Unmarshal

func (pk *ResourcePackDataInfo) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ResourcePackStack

type ResourcePackStack struct {
	// TexturePackRequired specifies if the client must accept the texture packs the server has in order to
	// join the server. If set to true, the client gets the option to either download the resource packs and
	// join, or quit entirely. Behaviour packs never have to be downloaded.
	TexturePackRequired bool
	// BehaviourPack is a list of behaviour packs that the client needs to download before joining the server.
	// All of these behaviour packs will be applied together, and the order does not necessarily matter.
	BehaviourPacks []ResourcePack
	// TexturePacks is a list of texture packs that the client needs to download before joining the server.
	// The order of these texture packs specifies the order that they are applied in on the client side. The
	// first in the list will be applied first.
	TexturePacks []ResourcePack
	// Experimental specifies if the resource packs in the stack are experimental. This is internal and should
	// always be set to false.
	Experimental bool
}

ResourcePackStack is sent by the server to send the order in which resource packs and behaviour packs should be applied (and downloaded) by the client.

func (*ResourcePackStack) ID

func (*ResourcePackStack) ID() uint32

ID ...

func (*ResourcePackStack) Marshal

func (pk *ResourcePackStack) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ResourcePackStack) Unmarshal

func (pk *ResourcePackStack) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ResourcePacksInfo

type ResourcePacksInfo struct {
	// TexturePackRequired specifies if the client must accept the texture packs the server has in order to
	// join the server. If set to true, the client gets the option to either download the resource packs and
	// join, or quit entirely. Behaviour packs never have to be downloaded.
	TexturePackRequired bool
	// HasScripts specifies if any of the resource packs contain scripts in them. If set to true, only clients
	// that support scripts will be able to download them.
	HasScripts bool
	// BehaviourPack is a list of behaviour packs that the client needs to download before joining the server.
	// All of these behaviour packs will be applied together.
	BehaviourPacks []ResourcePack
	// TexturePacks is a list of texture packs that the client needs to download before joining the server.
	// The order of these texture packs is not relevant in this packet. It is however important in the
	// ResourcePackStack packet.
	TexturePacks []ResourcePack
}

ResourcePacksInfo is sent by the server to inform the client on what resource packs the server has. It sends a list of the resource packs it has and basic information on them like the version and description.

func (*ResourcePacksInfo) ID

func (*ResourcePacksInfo) ID() uint32

ID ...

func (*ResourcePacksInfo) Marshal

func (pk *ResourcePacksInfo) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ResourcePacksInfo) Unmarshal

func (pk *ResourcePacksInfo) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type Respawn added in v0.7.0

type Respawn struct {
	// Position is the position on which the player should be respawned. The position might be in a different
	// dimension, in which case the client should first be sent a ChangeDimension packet.
	Position mgl32.Vec3
}

Respawn is sent by the server to make a player respawn client-side. It is sent in response to a PlayerAction packet with ActionType PlayerActionRespawn.

func (*Respawn) ID added in v0.7.0

func (*Respawn) ID() uint32

ID ...

func (*Respawn) Marshal added in v0.7.0

func (pk *Respawn) Marshal(buf *bytes.Buffer)

Marshal ...

func (*Respawn) Unmarshal added in v0.7.0

func (pk *Respawn) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type RiderJump added in v0.3.0

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

RiderJump 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 (*RiderJump) ID added in v0.3.0

func (*RiderJump) ID() uint32

ID ...

func (*RiderJump) Marshal added in v0.3.0

func (pk *RiderJump) Marshal(buf *bytes.Buffer)

Marshal ...

func (*RiderJump) Unmarshal added in v0.3.0

func (pk *RiderJump) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ScriptCustomEvent added in v0.9.1

type ScriptCustomEvent struct {
	// EventName is the name of the event. The script and the server will use this event name to identify the
	// data that is sent.
	EventName string
	// EventData is the data of the event. This data is typically a JSON encoded string, that the script is
	// able to encode and decode too.
	EventData []byte
}

ScriptCustomEvent is sent by both the client and the server. It is a way to let scripts communicate with the server, so that the client can let the server know it triggered an event, or the other way around. It is essentially an RPC kind of system.

func (*ScriptCustomEvent) ID added in v0.9.1

func (*ScriptCustomEvent) ID() uint32

ID ...

func (*ScriptCustomEvent) Marshal added in v0.9.1

func (pk *ScriptCustomEvent) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ScriptCustomEvent) Unmarshal added in v0.9.1

func (pk *ScriptCustomEvent) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ServerSettingsRequest added in v0.2.0

type ServerSettingsRequest struct {
}

ServerSettingsRequest is sent by the client to request the settings specific to the server. These settings are shown in a separate tab client-side, and have the same structure as a custom form.

func (*ServerSettingsRequest) ID added in v0.2.0

ID ...

func (*ServerSettingsRequest) Marshal added in v0.2.0

func (*ServerSettingsRequest) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ServerSettingsRequest) Unmarshal added in v0.2.0

func (*ServerSettingsRequest) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ServerSettingsResponse added in v0.2.0

type ServerSettingsResponse 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
}

ServerSettingsResponse is optionally sent by the server in response to a ServerSettingsRequest from the client. It is structured the same as a ModalFormRequest packet, and if filled out correctly, will show a specific tab for the server in the settings of the client. A ModalFormResponse packet is sent by the client in response to a ServerSettingsResponse, when the client fills out the settings and closes the settings again.

func (*ServerSettingsResponse) ID added in v0.2.0

ID ...

func (*ServerSettingsResponse) Marshal added in v0.2.0

func (pk *ServerSettingsResponse) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ServerSettingsResponse) Unmarshal added in v0.2.0

func (pk *ServerSettingsResponse) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ServerToClientHandshake

type ServerToClientHandshake struct {
	// JWT is a raw JWT token containing data such as the public key from the server, the algorithm used and
	// the server's token. It is used for the client to produce a shared secret.
	JWT []byte
}

ServerToClientHandshake is sent by the server to the client to complete the key exchange in order to initialise encryption on client and server side. It is followed up by a ClientToServerHandshake packet from the client.

func (*ServerToClientHandshake) ID

ID ...

func (*ServerToClientHandshake) Marshal

func (pk *ServerToClientHandshake) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ServerToClientHandshake) Unmarshal

func (pk *ServerToClientHandshake) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetActorData added in v0.9.2

type SetActorData struct {
	// EntityNetworkID 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
	// 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{}
}

SetActorData is sent by the server to update the entity metadata of an entity. It includes flags such as if the entity is on fire, but also properties such as the air it has left until it starts drowning.

func (*SetActorData) ID added in v0.9.2

func (*SetActorData) ID() uint32

ID ...

func (*SetActorData) Marshal added in v0.9.2

func (pk *SetActorData) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetActorData) Unmarshal added in v0.9.2

func (pk *SetActorData) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetActorLink struct {
	// EntityLink is the link to be set client-side. It links two entities together, so that one entity rides
	// another. Note that players that see those entities later will not see the link, unless it is also sent
	// in the AddActor and AddPlayer packets.
	EntityLink protocol.EntityLink
}

SetActorLink is sent by the server to initiate an entity link client-side, meaning one entity will start riding another.

func (*SetActorLink) ID added in v0.9.2

func (*SetActorLink) ID() uint32

ID ...

func (*SetActorLink) Marshal added in v0.9.2

func (pk *SetActorLink) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetActorLink) Unmarshal added in v0.9.2

func (pk *SetActorLink) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetActorMotion added in v0.9.2

type SetActorMotion struct {
	// EntityNetworkID 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
	// Velocity is the new velocity the entity gets. This velocity will initiate the client-side movement of
	// the entity.
	Velocity mgl32.Vec3
}

SetActorMotion is sent by the server to change the client-side velocity of an entity. It is usually used in combination with server-side movement calculation.

func (*SetActorMotion) ID added in v0.9.2

func (*SetActorMotion) ID() uint32

ID ...

func (*SetActorMotion) Marshal added in v0.9.2

func (pk *SetActorMotion) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetActorMotion) Unmarshal added in v0.9.2

func (pk *SetActorMotion) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetCommandsEnabled added in v0.7.0

type SetCommandsEnabled struct {
	// Enabled defines if the commands should be enabled, or if false, disabled.
	Enabled bool
}

SetCommandsEnabled is sent by the server to enable or disable the ability to execute commands for the client. If disabled, the client itself will stop the execution of commands.

func (*SetCommandsEnabled) ID added in v0.7.0

func (*SetCommandsEnabled) ID() uint32

ID ...

func (*SetCommandsEnabled) Marshal added in v0.7.0

func (pk *SetCommandsEnabled) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetCommandsEnabled) Unmarshal added in v0.7.0

func (pk *SetCommandsEnabled) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetDefaultGameType added in v0.9.1

type SetDefaultGameType struct {
	// GameType is the new game type that is set. When sent by the client, this is the requested new default
	// game type.
	GameType int32
}

SetDefaultGameType is sent by the client when it toggles the default game type in the settings UI, and is sent by the server when it actually changes the default game type, resulting in the toggle being changed in the settings UI.

func (*SetDefaultGameType) ID added in v0.9.1

func (*SetDefaultGameType) ID() uint32

ID ...

func (*SetDefaultGameType) Marshal added in v0.9.1

func (pk *SetDefaultGameType) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetDefaultGameType) Unmarshal added in v0.9.1

func (pk *SetDefaultGameType) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetDifficulty added in v0.7.0

type SetDifficulty struct {
	// Difficulty is the new difficulty that the world has.
	Difficulty uint32
}

SetDifficulty is sent by the server to update the client-side difficulty of the client. The actual effect of this packet on the client isn't very significant, as the difficulty is handled server-side.

func (*SetDifficulty) ID added in v0.7.0

func (*SetDifficulty) ID() uint32

ID ...

func (*SetDifficulty) Marshal added in v0.7.0

func (pk *SetDifficulty) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetDifficulty) Unmarshal added in v0.7.0

func (pk *SetDifficulty) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetDisplayObjective added in v0.9.1

type SetDisplayObjective struct {
	// DisplaySlot is the slot in which the scoreboard should be displayed. Available options can be found in
	// the constants above.
	DisplaySlot string
	// ObjectiveName is the name of the objective that the scoreboard displays. Filling out a random unique
	// value for this field works: It is not displayed in the scoreboard.
	ObjectiveName string
	// DisplayName is the name, or title, that is displayed at the top of the scoreboard.
	DisplayName string
	// CriteriaName is the name of the criteria that need to be fulfilled in order for the score to be
	// increased. This can be any kind of string and does not show up client-side.
	CriteriaName string
	// SortOrder is the order in which entries on the scoreboard should be sorted. It is one of the constants
	// that may be found above.
	SortOrder int32
}

SetDisplayObjective is sent by the server to display an object as a scoreboard to the player. Once sent, it should be followed up by a SetScore packet to set the lines of the packet.

func (*SetDisplayObjective) ID added in v0.9.1

ID ...

func (*SetDisplayObjective) Marshal added in v0.9.1

func (pk *SetDisplayObjective) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetDisplayObjective) Unmarshal added in v0.9.1

func (pk *SetDisplayObjective) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetHealth added in v0.7.0

type SetHealth struct {
	// Health is the new health of the player.
	Health int32
}

SetHealth is sent by the server. It sets the health of the player it is sent to. The SetHealth packet should no longer be used. Instead, the health attribute should be used so that the health and maximum health may be changed directly.

func (*SetHealth) ID added in v0.7.0

func (*SetHealth) ID() uint32

ID ...

func (*SetHealth) Marshal added in v0.7.0

func (pk *SetHealth) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetHealth) Unmarshal added in v0.7.0

func (pk *SetHealth) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetLastHurtBy added in v0.9.1

type SetLastHurtBy struct {
	// EntityType is the numerical type of the entity that the player was last hurt by.
	EntityType int32
}

SetLastHurtBy is sent by the server to let the client know what entity type it was last hurt by. At this moment, the packet is useless and should not be used. There is no behaviour that depends on if this packet is sent or not.

func (*SetLastHurtBy) ID added in v0.9.1

func (*SetLastHurtBy) ID() uint32

ID ...

func (*SetLastHurtBy) Marshal added in v0.9.1

func (pk *SetLastHurtBy) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetLastHurtBy) Unmarshal added in v0.9.1

func (pk *SetLastHurtBy) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetLocalPlayerAsInitialised

type SetLocalPlayerAsInitialised struct {
	// EntityNetworkID is the entity runtime ID the player was assigned earlier in the login sequence in the
	// StartGame packet.
	EntityRuntimeID uint64
}

SetLocalPlayerAsInitialised is sent by the client in response to a PlayStatus packet with the status set to 3. The packet marks the moment at which the client is fully initialised and can receive any packet without discarding it.

func (*SetLocalPlayerAsInitialised) ID

ID ...

func (*SetLocalPlayerAsInitialised) Marshal

func (pk *SetLocalPlayerAsInitialised) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetLocalPlayerAsInitialised) Unmarshal

func (pk *SetLocalPlayerAsInitialised) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetPlayerGameType added in v0.7.0

type SetPlayerGameType struct {
	// GameType is the new game type of the player. It is one of the constants that can be found above. Some
	// of these game types require additional flags to be set in an AdventureSettings packet for the game mode
	// to obtain its full functionality.
	GameType int32
}

SetPlayerGameType is sent by the server to update the game type, which is otherwise known as the game mode, of a player.

func (*SetPlayerGameType) ID added in v0.7.0

func (*SetPlayerGameType) ID() uint32

ID ...

func (*SetPlayerGameType) Marshal added in v0.7.0

func (pk *SetPlayerGameType) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetPlayerGameType) Unmarshal added in v0.7.0

func (pk *SetPlayerGameType) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetScore added in v0.9.1

type SetScore struct {
	// ActionType is the type of the action to execute upon the scoreboard with the entries that the packet
	// has. If ActionType is ScoreboardActionModify, all entries will be added to the scoreboard if not yet
	// present, or modified if already present. If set to ScoreboardActionRemove, all scoreboard entries set
	// will be removed from the scoreboard.
	ActionType byte
	// Entries is a list of all entries that the client should operate on. When modifying, it will add or
	// modify all entries, whereas when removing, it will remove all entries.
	Entries []protocol.ScoreboardEntry
}

SetScore is sent by the server to send the contents of a scoreboard to the player. It may be used to either add, remove or edit entries on the scoreboard.

func (*SetScore) ID added in v0.9.1

func (*SetScore) ID() uint32

ID ...

func (*SetScore) Marshal added in v0.9.1

func (pk *SetScore) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetScore) Unmarshal added in v0.9.1

func (pk *SetScore) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetScoreboardIdentity added in v0.9.1

type SetScoreboardIdentity struct {
	// ActionType is the type of the action to execute. The action is either ScoreboardIdentityActionRegister
	// to associate an identity with the entry, or ScoreboardIdentityActionClear to remove associations with
	// an entity.
	ActionType byte
	// Entries is a list of all entries in the packet. Each of these entries points to one of the entries on
	// a scoreboard. Depending on ActionType, their identity will either be registered or cleared.
	Entries []protocol.ScoreboardIdentityEntry
}

SetScoreboardIdentity is sent by the server to change the identity type of one of the entries on a scoreboard. This is used to change, for example, an entry pointing to a player, to a fake player when it leaves the server, and to change it back to a real player when it joins again. In non-vanilla situations, the packet is quite useless.

func (*SetScoreboardIdentity) ID added in v0.9.1

ID ...

func (*SetScoreboardIdentity) Marshal added in v0.9.1

func (pk *SetScoreboardIdentity) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetScoreboardIdentity) Unmarshal added in v0.9.1

func (pk *SetScoreboardIdentity) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetSpawnPosition added in v0.7.0

type SetSpawnPosition struct {
	// SpawnType is the type of spawn to set. It is either SpawnTypePlayer or SpawnTypeWorld, and specifies
	// the behaviour of the spawn set. If SpawnTypeWorld is set, the position to which compasses will point is
	// also changed.
	SpawnType int32
	// Position is the new position of the spawn that was set. If SpawnType is SpawnTypeWorld, compasses will
	// point to this position.
	Position protocol.BlockPos
	// SpawnForced specifies if the spawn is forced.
	SpawnForced bool
}

SetSpawnPosition is sent by the server to update the spawn position of a player, for example when sleeping in a bed.

func (*SetSpawnPosition) ID added in v0.7.0

func (*SetSpawnPosition) ID() uint32

ID ...

func (*SetSpawnPosition) Marshal added in v0.7.0

func (pk *SetSpawnPosition) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetSpawnPosition) Unmarshal added in v0.7.0

func (pk *SetSpawnPosition) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetTime

type SetTime struct {
	// Time is the current time. The time is not limited to 24000 (time of day), but continues progressing
	// after that.
	Time int32
}

SetTime is sent by the server to update the current time client-side. The client actually advances time client-side by itself, so this packet does not need to be sent each tick. It is merely a means of synchronising time between server and client.

func (*SetTime) ID

func (*SetTime) ID() uint32

ID ...

func (*SetTime) Marshal

func (pk *SetTime) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetTime) Unmarshal

func (pk *SetTime) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SetTitle added in v0.9.1

type SetTitle struct {
	// ActionType is the type of the action that should be executed upon the title of a player. It is one of
	// the constants above and specifies the response of the client to the packet.
	ActionType int32
	// Text is the text of the title, which has a different meaning depending on the ActionType that the
	// packet has. The text is the text of a title, subtitle or action bar, depending on the type set.
	Text string
	// FadeInDuration is the duration that the title takes to fade in on the screen of the player. It is
	// measured in 20ths of a second (AKA in ticks).
	FadeInDuration int32
	// RemainDuration is the duration that the title remains on the screen of the player. It is measured in
	// 20ths of a second (AKA in ticks).
	RemainDuration int32
	// FadeOutDuration is the duration that the title takes to fade out of the screen of the player. It is
	// measured in 20ths of a second (AKA in ticks).
	FadeOutDuration int32
}

SetTitle is sent by the server to make a title, subtitle or action bar shown to a player. It has several fields that allow setting the duration of the titles.

func (*SetTitle) ID added in v0.9.1

func (*SetTitle) ID() uint32

ID ...

func (*SetTitle) Marshal added in v0.9.1

func (pk *SetTitle) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SetTitle) Unmarshal added in v0.9.1

func (pk *SetTitle) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ShowCredits added in v0.7.0

type ShowCredits struct {
	// PlayerRuntimeID is the entity runtime ID of the player to show the credits to. It's not clear why this
	// field is actually here in the first place.
	PlayerRuntimeID uint64
	// StatusType is the status type of the credits. It is one of the constants above, and either starts or
	// stops the credits.
	StatusType int32
}

ShowCredits is sent by the server to show the Minecraft credits screen to the client. It is typically sent when the player beats the ender dragon and leaves the End.

func (*ShowCredits) ID added in v0.7.0

func (*ShowCredits) ID() uint32

ID ...

func (*ShowCredits) Marshal added in v0.7.0

func (pk *ShowCredits) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ShowCredits) Unmarshal added in v0.7.0

func (pk *ShowCredits) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ShowProfile added in v0.9.1

type ShowProfile struct {
	// XUID is the XBOX Live User ID of the player whose profile should be shown to the player. If it is not
	// a valid XUID, the client ignores the packet.
	XUID string
}

ShowProfile is sent by the server to show the XBOX Live profile of one player to another.

func (*ShowProfile) ID added in v0.9.1

func (*ShowProfile) ID() uint32

ID ...

func (*ShowProfile) Marshal added in v0.9.1

func (pk *ShowProfile) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ShowProfile) Unmarshal added in v0.9.1

func (pk *ShowProfile) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type ShowStoreOffer added in v0.9.1

type ShowStoreOffer struct {
	// OfferID is a string that identifies the offer for which a window should be opened. While typically a
	// UUID, the ID could be anything.
	OfferID string
	// ShowAll specifies if all other offers of the same 'author' as the one of the offer associated with the
	// OfferID should also be displayed, alongside the target offer.
	ShowAll bool
}

ShowStoreOffer is sent by the server to show a Marketplace store offer to a player. It opens a window client-side that displays the item. The ShowStoreOffer packet only works on the partnered servers: Servers that are not partnered will not have a store buttons show up in the in-game pause menu and will, as a result, not be able to open store offers on the client side. Sending the packet does therefore not work when using a proxy that is not connected to with the domain of one of the partnered servers.

func (*ShowStoreOffer) ID added in v0.9.1

func (*ShowStoreOffer) ID() uint32

ID ...

func (*ShowStoreOffer) Marshal added in v0.9.1

func (pk *ShowStoreOffer) Marshal(buf *bytes.Buffer)

Marshal ...

func (*ShowStoreOffer) Unmarshal added in v0.9.1

func (pk *ShowStoreOffer) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SimpleEvent added in v0.7.0

type SimpleEvent struct {
	// EventType is the type of the event to be called. It is one of the constants that may be found above.
	EventType int16
}

SimpleEvent is sent by the server to send a 'simple event' to the client, meaning an event without any additional event data. The event is typically used by the client for telemetry.

func (*SimpleEvent) ID added in v0.7.0

func (*SimpleEvent) ID() uint32

ID ...

func (*SimpleEvent) Marshal added in v0.7.0

func (pk *SimpleEvent) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SimpleEvent) Unmarshal added in v0.7.0

func (pk *SimpleEvent) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SpawnExperienceOrb added in v0.7.0

type SpawnExperienceOrb struct {
	// Position is the position to spawn the experience orb 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
	// ExperienceAmount is the amount of experience in experience points that the orb carries. The client-side
	// size of the orb depends on the amount of experience in the orb: There are 11 possible sizes for the
	// orb, for 1–2, 3–6, 7–16, 17–36, 37–72, 73–148, 149–306, 307–616, 617–1236, 1237–2476, and 2477 and up.
	ExperienceAmount int32
}

SpawnExperienceOrb is sent by the server to spawn an experience orb entity client-side. Much like the AddPainting packet, it is one of the few packets that spawn an entity without using the AddActor packet.

func (*SpawnExperienceOrb) ID added in v0.7.0

func (*SpawnExperienceOrb) ID() uint32

ID ...

func (*SpawnExperienceOrb) Marshal added in v0.7.0

func (pk *SpawnExperienceOrb) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SpawnExperienceOrb) Unmarshal added in v0.7.0

func (pk *SpawnExperienceOrb) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type SpawnParticleEffect added in v0.9.1

type SpawnParticleEffect struct {
	// Dimension is the dimension that the particle is spawned in. Its exact usage is not clear, as the
	// dimension has no direct effect on the particle.
	Dimension byte
	// EntityUniqueID is the unique ID of the entity that the spawned particle may be associated with. For
	// a particle that isn't associated with an entity, this should be set to -1.
	EntityUniqueID int64
	// Position is the position that the particle should be spawned at. If the position is too far away from
	// the player, it will not show up.
	Position mgl32.Vec3
	// ParticleName is the name of the particle that should be shown. This name may point to a particle effect
	// that is built-in, or to one implemented by behaviour packs.
	ParticleName string
}

SpawnParticleEffect is sent by the server to spawn a particle effect client-side. Unlike other packets that result in the appearing of particles, this packet can show particles that are not hardcoded in the client. They can be added and changed through behaviour packs to implement custom particles.

func (*SpawnParticleEffect) ID added in v0.9.1

ID ...

func (*SpawnParticleEffect) Marshal added in v0.9.1

func (pk *SpawnParticleEffect) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SpawnParticleEffect) Unmarshal added in v0.9.1

func (pk *SpawnParticleEffect) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type StartGame

type StartGame struct {
	// 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 entity out for
	// this field.
	EntityUniqueID int64
	// EntityNetworkID 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
	// PlayerGameMode is the game mode the player currently has. It is a value from 0-4, with 0 being
	// survival mode, 1 being creative mode, 2 being adventure mode, 3 being survival spectator and 4 being
	// creative spectator.
	PlayerGameMode int32
	// PlayerPosition is the spawn position of the player in the world. In servers this is often the same as
	// the world's spawn position found below.
	PlayerPosition 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
	// WorldSeed is the seed used to generate the world. Unlike in PC edition, the seed is a 32bit integer
	// here.
	WorldSeed int32
	// Dimension is the ID of the dimension that the player spawns in. It is a value from 0-2, with 0 being
	// the overworld, 1 being the nether and 2 being the end.
	Dimension int32
	// Generator is the generator used for the world. It is a value from 0-4, with 0 being old limited worlds,
	// 1 being infinite worlds, 2 being flat worlds, 3 being nether worlds and 4 being end worlds. A value of
	// 0 will actually make the client stop rendering chunks you send beyond the world limit.
	Generator int32
	// WorldGameMode is the game mode that a player gets when it first spawns in the world. It has no effect
	// on the actual game mode the player spawns with. See PlayerGameMode for that.
	WorldGameMode int32
	// Difficulty is the difficulty of the world. It is a value from 0-3, with 0 being peaceful, 1 being easy,
	// 2 being normal and 3 being hard.
	Difficulty int32
	// WorldSpawn is the block on which the world spawn of the world. This coordinate has no effect on the
	// place that the client spawns, but it does have an effect on the direction that a compass points.
	WorldSpawn protocol.BlockPos
	// AchievementsDisabled defines if achievements are disabled in the world. The client crashes if this
	// value is set to true while the player's or the world's game mode is creative, and it's recommended to
	// simply always set this to false as a server.
	AchievementsDisabled bool
	// DayCycleLockTime is the time at which the day cycle was locked if the day cycle is disabled using the
	// respective game rule. The client will maintain this time as long as the day cycle is disabled.
	DayCycleLockTime int32
	// EducationMode specifies if the world is specifically for education edition clients. Setting this to
	// true for normal editions actually temporarily 'transforms' the client into Education Edition, with even
	// the ability to see that title on the home screen.
	EducationMode bool
	// EducationFeaturesEnabled specifies if the world has education edition features enabled, such as the
	// blocks or entities specific to education edition.
	EducationFeaturesEnabled bool
	// RainLevel is the level specifying the intensity of the rain falling. When set to 0, no rain falls at
	// all.
	RainLevel float32
	// LightningLevel is the level specifying the intensity of the thunder. This may actually be set
	// independently from the RainLevel, meaning dark clouds can be produced without rain.
	LightningLevel float32
	// ConfirmedPlatformLockedContent ...
	ConfirmedPlatformLockedContent bool
	// MultiPlayerGame specifies if the world is a multi-player game. This should always be set to true for
	// servers.
	MultiPlayerGame bool
	// LANBroadcastEnabled specifies if LAN broadcast was intended to be enabled for the world.
	LANBroadcastEnabled bool
	// XBLBroadcastMode is the mode used to broadcast the joined game across XBOX Live.
	XBLBroadcastMode int32
	// PlatformBroadcastMode is the mode used to broadcast the joined game across the platform.
	PlatformBroadcastMode int32
	// CommandsEnabled specifies if commands are enabled for the player. It is recommended to always set this
	// to true on the server, as setting it to false means the player cannot, under any circumstance, use a
	// command.
	CommandsEnabled bool
	// TexturePackRequired specifies if the texture pack the world might hold is required, meaning the client
	// was forced to download it before joining.
	TexturePackRequired bool
	// GameRules defines game rules currently active with their respective values. The value of these game
	// rules may be either 'bool', 'int32' or 'float32'. Some game rules are server side only, and don't
	// necessarily need to be sent to the client.
	GameRules map[string]interface{}
	// BonusChestEnabled specifies if the world had the bonus map setting enabled when generating it. It does
	// not have any effect client-side.
	BonusChestEnabled bool
	// StartWithMapEnabled specifies if the world has the start with map setting enabled, meaning each joining
	// player obtains a map. This should always be set to false, because the client obtains a map all on its
	// own accord if this is set to true.
	StartWithMapEnabled bool
	// PlayerPermissions is the permission level of the player. It is a value from 0-3, with 0 being visitor,
	// 1 being member, 2 being operator and 3 being custom.
	PlayerPermissions int32
	// ServerChunkTickRadius is the radius around the player in which chunks are ticked. Most servers set this
	// value to a fixed number, as it does not necessarily affect anything client-side.
	ServerChunkTickRadius int32
	// HasLockedBehaviourPack specifies if the behaviour pack of the world is locked, meaning it cannot be
	// disabled from the world. This is typically set for worlds on the marketplace that have a dedicated
	// behaviour pack.
	HasLockedBehaviourPack bool
	// HasLockedTexturePack specifies if the texture pack of the world is locked, meaning it cannot be
	// disabled from the world. This is typically set for worlds on the marketplace that have a dedicated
	// texture pack.
	HasLockedTexturePack bool
	// FromLockedWorldTemplate specifies if the world from the server was from a locked world template. For
	// servers this should always be set to false.
	FromLockedWorldTemplate bool
	// MSAGamerTagsOnly ..
	MSAGamerTagsOnly bool
	// FromWorldTemplate specifies if the world from the server was from a world template. For servers this
	// should always be set to false.
	FromWorldTemplate bool
	// WorldTemplateSettingsLocked specifies if the world was a template that locks all settings that change
	// properties above in the settings GUI. It is recommended to set this to true for servers that do not
	// allow things such as setting game rules through the GUI.
	WorldTemplateSettingsLocked bool
	// OnlySpawnV1Villagers is a hack that Mojang put in place to preserve backwards compatibility with old
	// villagers. The bool is never actually read though, so it has no functionality.
	OnlySpawnV1Villagers bool
	// LevelID is a base64 encoded world ID that is used to identify the world.
	LevelID string
	// WorldName is the name of the world that the player is joining. Note that this field shows up above the
	// player list for the rest of the game session, and cannot be changed. Setting the server name to this
	// field is recommended.
	WorldName string
	// PremiumWorldTemplateID is a UUID specific to the premium world template that might have been used to
	// generate the world. Servers should always fill out an empty string for this.
	PremiumWorldTemplateID string
	// Trial specifies if the world was a trial world, meaning features are limited and there is a time limit
	// on the world.
	Trial bool
	// Time is the total time that has elapsed since the start of the world.
	Time int64
	// EnchantmentSeed is the seed used to seed the random used to produce enchantments in the enchantment
	// table. Note that the exact correct random implementation must be used to produce the correct results
	// both client- and server-side.
	EnchantmentSeed int32
	// Blocks is a list of all blocks and variants existing in the game. Failing to send any of the blocks
	// that are in the game, including any specific variants of that block, will crash mobile clients. It
	// seems Windows 10 games do not crash.
	Blocks []protocol.BlockEntry
	// Items is a list of all items with their legacy IDs which are available in the game. Failing to send any
	// of the items that are in the game will crash mobile clients.
	Items []protocol.ItemEntry
	// MultiPlayerCorrelationID is a unique ID specifying the multi-player session of the player. A random
	// UUID should be filled out for this field.
	MultiPlayerCorrelationID string
}

StartGame is sent by the server to send information about the world the player will be spawned in. It contains information about the position the player spawns in, and information about the world in general such as its game rules.

func (*StartGame) ID

func (*StartGame) ID() uint32

ID ...

func (*StartGame) Marshal

func (pk *StartGame) Marshal(buf *bytes.Buffer)

Marshal ...

func (*StartGame) Unmarshal

func (pk *StartGame) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type StopSound added in v0.9.1

type StopSound struct {
	// SoundName is the name of the sound that should be stopped from playing. If no sound with this name is
	// currently active, the packet is ignored.
	SoundName string
	// StopAll specifies if all sounds currently playing to the player should be stopped. If set to true, the
	// SoundName field may be left empty.
	StopAll bool
}

StopSound is sent by the server to stop a sound playing to the player, such as a playing music disk track or other long-lasting sounds.

func (*StopSound) ID added in v0.9.1

func (*StopSound) ID() uint32

ID ...

func (*StopSound) Marshal added in v0.9.1

func (pk *StopSound) Marshal(buf *bytes.Buffer)

Marshal ...

func (*StopSound) Unmarshal added in v0.9.1

func (pk *StopSound) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type StructureBlockUpdate added in v0.9.1

type StructureBlockUpdate struct {
	// Position is the position of the structure block that is updated.
	Position protocol.BlockPos
	// StructureName is the name of the structure that was set in the structure block's UI. This is the name
	// used to export the structure to a file.
	StructureName string
	// CustomDataTagName is the name of a function to run, usually used during natural generation. A
	// description can be found here: https://minecraft.gamepedia.com/Structure_Block#Data.
	CustomDataTagName string
	// IncludePlayers specifies if the 'Include Players' toggle has been enabled, meaning players are also
	// exported by the structure block.
	IncludePlayers bool
	// DetectStructureSizeAndPosition specifies if the size and position of the selection of the structure
	// block should be detected using another structure block. Currently, this field is inaccessible in the
	// game. It is likely to be added in v1.13.
	DetectStructureSizeAndPosition bool
	// StructureBlockType is the type of the structure block updated. In Bedrock Edition v1.12, this will
	// always be '5': The 3D Export structure block. According to the Minecraft wiki, v1.13 adds other types
	// of structure blocks to the game, so expect changes once that happens.
	// A list of structure block types that will be used can be found in the constants above.
	StructureBlockType int32
	// Settings is a struct of settings that should be used for exporting the structure. These settings are
	// identical to the last sent in the StructureBlockUpdate packet by the client.
	Settings protocol.StructureSettings
	// Bool1 ...
	Bool1 bool
}

StructureBlockUpdate is sent by the client when it updates a structure block using the in-game UI. The data it contains depends on the type of structure block that it is. In Minecraft Bedrock Edition v1.11, there is only the Export structure block type, but in v1.13 the ones present in Java Edition will, according to the wiki, be added too.

func (*StructureBlockUpdate) ID added in v0.9.1

ID ...

func (*StructureBlockUpdate) Marshal added in v0.9.1

func (pk *StructureBlockUpdate) Marshal(buf *bytes.Buffer)

Marshal ...

func (*StructureBlockUpdate) Unmarshal added in v0.9.1

func (pk *StructureBlockUpdate) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type StructureTemplateDataExportRequest added in v0.9.2

type StructureTemplateDataExportRequest struct {
	// StructureName is the name of the structure that was set in the structure block's UI. This is the name
	// used to export the structure to a file.
	StructureName string
	// Position is the position of the structure block that has its template data requested.
	Position protocol.BlockPos
	// Settings is a struct of settings that should be used for exporting the structure. These settings are
	// identical to the last sent in the StructureBlockUpdate packet by the client.
	Settings protocol.StructureSettings
	// Byte1 ...
	Byte1 byte
}

StructureTemplateDataExportRequest is sent by the client to request data of a structure. It is currently unused: The client never sends this packet.

func (*StructureTemplateDataExportRequest) ID added in v0.9.2

ID ...

func (*StructureTemplateDataExportRequest) Marshal added in v0.9.2

Marshal ...

func (*StructureTemplateDataExportRequest) Unmarshal added in v0.9.2

Unmarshal ...

type StructureTemplateDataExportResponse added in v0.9.2

type StructureTemplateDataExportResponse struct {
	// StructureName is the name of the structure that was requested. This is the name used to export the
	// structure to a file.
	StructureName string
	// SerialisedStructureTemplate is a network little endian NBT serialised structure of the structure
	// template. It holds all the data of the structure.
	SerialisedStructureTemplate []byte
}

StructureTemplateDataExportResponse is sent by the server to send data of a structure to the client in response to a StructureTemplateDataExportRequest packet. It is currently unused: The former packet is not sent by the client.

func (*StructureTemplateDataExportResponse) ID added in v0.9.2

ID ...

func (*StructureTemplateDataExportResponse) Marshal added in v0.9.2

Marshal ...

func (*StructureTemplateDataExportResponse) Unmarshal added in v0.9.2

Unmarshal ...

type SubClientLogin added in v0.9.1

type SubClientLogin struct {
	// 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.
	// The ConnectionRequest in this packet is identical to the one found in the Login packet.
	ConnectionRequest []byte
}

SubClientLogin is sent when a sub-client joins the server while another client is already connected to it. The packet is sent as a result of split-screen game play, and allows up to four players to play using the same network connection. After an initial Login packet from the 'main' client, each sub-client that connects sends a SubClientLogin to request their own logins.

func (*SubClientLogin) ID added in v0.9.1

func (*SubClientLogin) ID() uint32

ID ...

func (*SubClientLogin) Marshal added in v0.9.1

func (pk *SubClientLogin) Marshal(buf *bytes.Buffer)

Marshal ...

func (*SubClientLogin) Unmarshal added in v0.9.1

func (pk *SubClientLogin) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type TakeItemActor added in v0.9.2

type TakeItemActor struct {
	// ItemEntityRuntimeID is the entity runtime ID of the item that is being taken by another entity. It will
	// disappear to viewers after showing the pick-up animation.
	ItemEntityRuntimeID uint64
	// TakerEntityRuntimeID is the runtime ID of the entity that took the item, which is usually a player, but
	// could be another entity like a zombie too.
	TakerEntityRuntimeID uint64
}

TakeItemActor is sent by the server when a player picks up an item entity. It makes the item entity disappear to viewers and shows the pick-up animation.

func (*TakeItemActor) ID added in v0.9.2

func (*TakeItemActor) ID() uint32

ID ...

func (*TakeItemActor) Marshal added in v0.9.2

func (pk *TakeItemActor) Marshal(buf *bytes.Buffer)

Marshal ...

func (*TakeItemActor) Unmarshal added in v0.9.2

func (pk *TakeItemActor) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type Text

type Text struct {
	// TextType is the type of the text sent. When a client sends this to the server, it should always be
	// TextTypeChat. If the server sends it, it may be one of the other text types above.
	TextType byte
	// NeedsTranslation specifies if any of the messages need to be translated. It seems that where % is found
	// in translatable text types, these are translated regardless of this bool. Translatable text types
	// include TextTypeTip, TextTypePopup and TextTypeJukeboxPopup.
	NeedsTranslation bool
	// SourceName is the name of the source of the messages. This source is displayed in text types such as
	// the TextTypeChat and TextTypeWhisper, where typically the username is shown.
	SourceName string
	// Message is the message of the packet. This field is set for each TextType and is the main component of
	// the packet.
	Message string
	// Parameters is a list of parameters that should be filled into the message. These parameters are only
	// written if the type of the packet is TextTypeTip, TextTypePopup or TextTypeJukeboxPopup.
	Parameters []string
	// XUID is the XBOX Live user ID of the player that sent the message. It is only set for packets of
	// TextTypeChat. When sent to a player, the player will only be shown the chat message if a player with
	// this XUID is present in the player list and not muted, or if the XUID is empty.
	XUID string
	// 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
}

Text is sent by the client to the server to send chat messages, and by the server to the client to forward or send messages, which may be chat, popups, tips etc.

func (*Text) ID

func (*Text) ID() uint32

ID ...

func (*Text) Marshal

func (pk *Text) Marshal(buf *bytes.Buffer)

Marshal ...

func (*Text) Unmarshal

func (pk *Text) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type Transfer

type Transfer struct {
	// Address is the address of the new server, which might be either a hostname or an actual IP address.
	Address string
	// Port is the UDP port of the new server.
	Port uint16
}

Transfer is sent by the server to transfer a player from the current server to another. Doing so will fully disconnect the client, bring it back to the main menu and make it connect to the next server.

func (*Transfer) ID

func (*Transfer) ID() uint32

ID ...

func (*Transfer) Marshal

func (pk *Transfer) Marshal(buf *bytes.Buffer)

Marshal ...

func (*Transfer) Unmarshal

func (pk *Transfer) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type Unknown

type Unknown struct {
	// PacketID is the packet ID of the packet.
	PacketID uint32
	// Payload is the raw payload of the packet.
	Payload []byte
}

Unknown is an implementation of the Packet interface for unknown/unimplemented packets. It holds the packet ID and the raw payload. It serves as a way to read raw unknown packets and forward them to another connection, without necessarily implementing them.

func (*Unknown) ID

func (pk *Unknown) ID() uint32

ID ...

func (*Unknown) Marshal

func (pk *Unknown) Marshal(buf *bytes.Buffer)

Marshal ...

func (*Unknown) String added in v0.8.0

func (pk *Unknown) String() string

String implements a hex representation of an unknown packet, so that it is easier to read an identify unknown incoming packets.

func (*Unknown) Unmarshal

func (pk *Unknown) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type UpdateAttributes added in v0.4.0

type UpdateAttributes struct {
	// EntityNetworkID 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
	// Attributes is a slice of new attributes that the entity gets. It includes attributes such as its
	// health, movement speed, etc. Note that only changed attributes have to be sent in this packet. It is
	// not required to send attributes that did not have their values changed.
	Attributes []protocol.Attribute
}

UpdateAttributes is sent by the server to update an amount of attributes of any entity in the world. These attributes include ones such as the health or the movement speed of the entity.

func (*UpdateAttributes) ID added in v0.4.0

func (*UpdateAttributes) ID() uint32

ID ...

func (*UpdateAttributes) Marshal added in v0.4.0

func (pk *UpdateAttributes) Marshal(buf *bytes.Buffer)

Marshal ...

func (*UpdateAttributes) Unmarshal added in v0.4.0

func (pk *UpdateAttributes) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type UpdateBlock added in v0.3.0

type UpdateBlock struct {
	// Position is the block position at which a block is updated.
	Position protocol.BlockPos
	// NewBlockRuntimeID is the runtime ID of the block that is placed at Position after sending the packet
	// to the client. The runtime ID must point to a block sent in the list in the StartGame packet.
	NewBlockRuntimeID uint32
	// Flags is a combination of flags that specify the way the block is updated client-side. It is a
	// combination of the flags above, but typically sending only the BlockUpdateNetwork flag is sufficient.
	Flags uint32
	// Layer is the world layer on which the block is updated. For most blocks, this is the first layer, as
	// that layer is the default layer to place blocks on, but for blocks inside of each other, this differs.
	Layer uint32
}

UpdateBlock is sent by the server to update a block client-side, without resending the entire chunk that the block is located in. It is particularly useful for small modifications like block breaking/placing.

func (*UpdateBlock) ID added in v0.3.0

func (*UpdateBlock) ID() uint32

ID ...

func (*UpdateBlock) Marshal added in v0.3.0

func (pk *UpdateBlock) Marshal(buf *bytes.Buffer)

Marshal ...

func (*UpdateBlock) Unmarshal added in v0.3.0

func (pk *UpdateBlock) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type UpdateBlockProperties added in v0.9.2

type UpdateBlockProperties struct {
	// SerialisedBlockProperties is a network little endian NBT serialised structure of the updated block
	// properties.
	SerialisedBlockProperties []byte
}

UpdateBlockProperties is sent by the server to update the available block properties.

func (*UpdateBlockProperties) ID added in v0.9.2

func (pk *UpdateBlockProperties) ID() uint32

ID ...

func (*UpdateBlockProperties) Marshal added in v0.9.2

func (pk *UpdateBlockProperties) Marshal(buf *bytes.Buffer)

Marshal ...

func (*UpdateBlockProperties) Unmarshal added in v0.9.2

func (pk *UpdateBlockProperties) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type UpdateBlockSynced added in v0.9.1

type UpdateBlockSynced struct {
	// Position is the block position at which a block is updated.
	Position protocol.BlockPos
	// NewBlockRuntimeID is the runtime ID of the block that is placed at Position after sending the packet
	// to the client. The runtime ID must point to a block sent in the list in the StartGame packet.
	NewBlockRuntimeID uint32
	// Flags is a combination of flags that specify the way the block is updated client-side. It is a
	// combination of the flags above, but typically sending only the BlockUpdateNetwork flag is sufficient.
	Flags uint32
	// Layer is the world layer on which the block is updated. For most blocks, this is the first layer, as
	// that layer is the default layer to place blocks on, but for blocks inside of each other, this differs.
	Layer uint32
	// EntityUniqueID is the unique ID of the falling block entity that the block transitions to or that the
	// entity transitions from.
	// Note that for both possible values for TransitionType, the EntityUniqueID should point to the falling
	// block entity involved.
	EntityUniqueID int64
	// TransitionType is the type of the transition that happened. It is either BlockToEntityTransition, when
	// a block placed becomes a falling entity, or EntityToBlockTransition, when a falling entity hits the
	// ground and becomes a solid block again.
	TransitionType uint64
}

UpdateBlockSynced is sent by the server to synchronise the falling of a falling block entity with the transitioning back and forth from and to a solid block. It is used to prevent the entity from flickering, and is used in places such as the pushing of blocks with pistons.

func (*UpdateBlockSynced) ID added in v0.9.1

func (*UpdateBlockSynced) ID() uint32

ID ...

func (*UpdateBlockSynced) Marshal added in v0.9.1

func (pk *UpdateBlockSynced) Marshal(buf *bytes.Buffer)

Marshal ...

func (*UpdateBlockSynced) Unmarshal added in v0.9.1

func (pk *UpdateBlockSynced) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type UpdateEquip added in v0.9.1

type UpdateEquip struct {
	// WindowID is the identifier associated with the window that the UpdateEquip packet concerns. It is the
	// ID sent for the horse inventory that was opened before this packet was sent.
	WindowID byte
	// WindowType is the type of the window that was opened. Generally, this is the type of a horse inventory,
	// as the packet is specifically made for that.
	WindowType byte
	// UnknownInt32 ...
	UnknownInt32 int32
	// EntityUniqueID is the unique ID of the entity whose equipment was 'updated' to the player. It is
	// typically the horse entity that had its inventory opened.
	EntityUniqueID int64
	// SerialisedInventoryData is a network NBT serialised compound holding the content of the inventory of
	// the entity (the equipment) and additional data such as the allowed items for a particular slot, used to
	// make sure only saddles can be put in the saddle slot etc.
	SerialisedInventoryData []byte
}

UpdateEquip is sent by the server to the client upon opening a horse inventory. It is used to set the content of the inventory and specify additional properties, such as the items that are allowed to be put in slots of the inventory.

func (*UpdateEquip) ID added in v0.9.1

func (*UpdateEquip) ID() uint32

ID ...

func (*UpdateEquip) Marshal added in v0.9.1

func (pk *UpdateEquip) Marshal(buf *bytes.Buffer)

Marshal ...

func (*UpdateEquip) Unmarshal added in v0.9.1

func (pk *UpdateEquip) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type UpdateSoftEnum added in v0.9.1

type UpdateSoftEnum struct {
	// EnumType is the type of the enum. This type must be identical to the one set in the AvailableCommands
	// packet, because the client uses this to recognise which enum to update.
	EnumType string
	// Options is a list of options that should be updated. Depending on the ActionType field, either these
	// options will be added to the enum, the enum options will be set to these options or all of these
	// options will be removed from the enum.
	Options []string
	// ActionType is the type of the action to execute on the enum. The Options field has a different result,
	// depending on what ActionType is used.
	ActionType byte
}

UpdateSoftEnum is sent by the server to update a soft enum, also known as a dynamic enum, previously sent in the AvailableCommands packet. It is sent whenever the enum should get new options or when some of its options should be removed. The UpdateSoftEnum packet will apply for enums that have been set in the AvailableCommands packet with the 'Dynamic' field of the CommandEnum set to true.

func (*UpdateSoftEnum) ID added in v0.9.1

func (*UpdateSoftEnum) ID() uint32

ID ...

func (*UpdateSoftEnum) Marshal added in v0.9.1

func (pk *UpdateSoftEnum) Marshal(buf *bytes.Buffer)

Marshal ...

func (*UpdateSoftEnum) Unmarshal added in v0.9.1

func (pk *UpdateSoftEnum) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type UpdateTrade added in v0.9.1

type UpdateTrade struct {
	// WindowID is the ID that identifies the trading window that the client currently has opened.
	WindowID byte
	// WindowType is an identifier specifying the type of the window opened. In vanilla, it appears this is
	// always filled out with 15.
	WindowType byte
	// UnknownInt32 ...
	UnknownInt32 int32
	// TradeTier is the tier of the villager that the player is trading with. The tier starts at 0 with a
	// first two offers being available, after which two additional offers are unlocked each time the tier
	// becomes one higher.
	TradeTier int32
	// VillagerUniqueID is the unique ID of the villager entity that the player is trading with. The
	// TradeTier sent above applies to this villager.
	VillagerUniqueID int64
	// EntityUniqueID is the unique ID of the entity (usually a player) for which the trades are updated. The
	// updated trades may apply only to this entity.
	EntityUniqueID int64
	// DisplayName is the name displayed at the top of the trading UI. It is usually used to represent the
	// profession of the villager in the UI.
	DisplayName string
	// NewTradeUI specifies if the villager should be using the new trade UI (The one added in 1.11.) rather
	// than the old one. This should usually be set to true.
	NewTradeUI bool
	// DemandBasedPrices specifies if the prices of the villager's offers are modified by an increase in
	// demand for the item. (A mechanic added in 1.11.) Buying more of the same item will increase the price
	// of that particular item.
	DemandBasedPrices bool
	// SerialisedOffers is a network NBT serialised compound of offers that the villager has.
	SerialisedOffers []byte
}

UpdateTrade is sent by the server to update the trades offered by a villager to a player. It is sent at the moment that a player interacts with a villager.

func (*UpdateTrade) ID added in v0.9.1

func (*UpdateTrade) ID() uint32

ID ...

func (*UpdateTrade) Marshal added in v0.9.1

func (pk *UpdateTrade) Marshal(buf *bytes.Buffer)

Marshal ...

func (*UpdateTrade) Unmarshal added in v0.9.1

func (pk *UpdateTrade) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

type VideoStreamConnect added in v0.9.1

type VideoStreamConnect 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.
	// Screenshots will be sent to this websocket server.
	ServerURI string
	// FrameSendFrequency is the frequency at which the client should send frames, AKA screenshots to the
	// websocket server. The exact unit of this value is not clear: The command in-game does not work, so
	// it is impossible to find out.
	FrameSendFrequency float32
	// ActionType is the type of the action to execute. It is either VideoStreamActionStart or
	// VideoStreamActionStop to start or stop the video streaming respectively.
	ActionType byte
	// ResolutionX is the width in pixels of the 'screenshots' sent to the websocket. This is the resolution
	// of the video on the X axis.
	ResolutionX int32
	// ResolutionY is the height in pixels of the 'screenshots' sent to the websocket. This is the resolution
	// of the video on the Y axis.
	ResolutionY int32
}

VideoStreamConnect is sent by the server to make the client start video streaming. Essentially, what this means is that the client will start sending screenshots at a rate specified to the websocket server it connects to with this packet. In version 1.11, this packet is blocked: The client sends a client-side message that video streaming is not supported on the device.

func (*VideoStreamConnect) ID added in v0.9.1

func (*VideoStreamConnect) ID() uint32

ID ...

func (*VideoStreamConnect) Marshal added in v0.9.1

func (pk *VideoStreamConnect) Marshal(buf *bytes.Buffer)

Marshal ...

func (*VideoStreamConnect) Unmarshal added in v0.9.1

func (pk *VideoStreamConnect) Unmarshal(buf *bytes.Buffer) error

Unmarshal ...

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL