API reference / @jsprismarine/protocol
@jsprismarine/protocol
Bedrock packet classes, structures, wire layouts, version gates, and payload builders live here. The package owns protocol encoding; a server supplies game registries and captured data through a ProtocolContext rather than making the protocol package load server data itself.
Supply per-connection data
ProtocolContext carries the negotiated protocol version plus the item, block, actor, biome, and jigsaw data that a packet may need. The data stays with the codec that negotiated the connection:
import { ItemRegistryPacket, NetworkBinaryStream } from '@jsprismarine/protocol';
import type { ProtocolContext } from '@jsprismarine/protocol';
const context: ProtocolContext = {
protocolVersion: 2225
};
const packet = new ItemRegistryPacket();
packet.serialize(new NetworkBinaryStream(), context);
void packet;The server builds this context from its supported-version captures and current registries. A packet may still receive explicit payload data when the server has generated custom content.
Build payloads from registries
The payload subpath translates item, block, creative, and recipe registries into protocol packet payloads. The functions accept those registries as arguments, so the protocol package can encode them without importing a server instance:
import {
buildBlockProperties,
buildCraftingData,
buildCreativeContent,
buildItemRegistry
} from '@jsprismarine/protocol/payload';
const { properties } = buildBlockProperties([]);
const { entries } = buildItemRegistry([]);
const creative = buildCreativeContent(itemIdsOf(entries), { groups: [], entries: [] });
const crafting = buildCraftingData([]);
void [properties, creative, crafting];For payload types, NBT helpers, and block palette checks, import from @jsprismarine/protocol/payload. Packet classes and structures are exported from the package root and from their individual module subpaths.
Compression benchmark
Run pnpm --filter @jsprismarine/protocol run bench:compression-variants to compare Node's synchronous and asynchronous zlib paths, a resettable zlib stream, and the libdeflate WebAssembly prototype on movement-like and chunk-sized batches. The benchmark checks that each compressed body inflates to the same packet bytes and reports CPU time, throughput, setup cost, allocation notes, and wire size. The WebAssembly package is a development dependency; the server continues to use Node zlib.
Namespaces
Enumerations
AbilityLayerFlag
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:19
AbilityLayerFlag, from Mojang's published protocol documentation.
Generated - do not edit. Change datagen/manifest.json and run pnpm generate. Source: Mojang/bedrock-protocol-docs@0e00fe80f4f3c71572ff6429de40146d1f4412fc (Minecraft 1.26.40, protocol 2168) Upstream name: AbilitiesIndex
NOT VERSIONED. No bedrock-protocol-docs release describes this enum: a schema exists only for a type some packet field is declared with, and this one travels as a plain integer. The members below come from the last enums.html Mojang published, for Minecraft 1.26.40, and every protocol this package generates reads them unchanged: 2193, 2225.
Treat them as approximate above protocol 2168. A member added since then is missing, and a member removed since then is still here. No source this package will take numbers from publishes this enum per version, so that is a known gap and not something to correct in the generated file.
Enumeration Members
ABILITY_COUNT
ABILITY_COUNT:
20
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:41
ATTACK_MOBS
ATTACK_MOBS:
5
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:26
ATTACK_PLAYERS
ATTACK_PLAYERS:
4
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:25
BUILD
BUILD:
0
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:21
DOORS_AND_SWITCHES
DOORS_AND_SWITCHES:
2
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:23
FLY_SPEED
FLY_SPEED:
13
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:34
FLYING
FLYING:
9
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:30
INSTABUILD
INSTABUILD:
11
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:32
INVALID
INVALID:
-1
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:20
INVULNERABLE
INVULNERABLE:
8
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:29
LIGHTNING
LIGHTNING:
12
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:33
MAY_FLY
MAY_FLY:
10
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:31
MINE
MINE:
1
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:22
MUTED
MUTED:
15
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:36
NO_CLIP
NO_CLIP:
17
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:38
OPEN_CONTAINERS
OPEN_CONTAINERS:
3
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:24
OPERATOR_COMMANDS
OPERATOR_COMMANDS:
6
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:27
PRIVILEGED_BUILDER
PRIVILEGED_BUILDER:
18
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:39
TELEPORT
TELEPORT:
7
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:28
VERTICAL_FLY_SPEED
VERTICAL_FLY_SPEED:
19
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:40
WALK_SPEED
WALK_SPEED:
14
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:35
WORLD_BUILDER
WORLD_BUILDER:
16
Defined in: minecraft/src/generated/unversioned/AbilityLayerFlag.ts:37
AbilityLayerType
Defined in: protocol/src/packet/UpdateAbilitiesPacket.ts:14
The "SerializedLayer" value of an ability layer, written as a uint16.
The client merges layers in this order, so a flag set in a later layer wins over the same flag in an earlier one. The docs type the field as a bare uint16; the values are the client's AbilitiesLayer enum, CustomCache through LoadingScreen.
Enumeration Members
BASE
BASE:
1
Defined in: protocol/src/packet/UpdateAbilitiesPacket.ts:16
CACHE
CACHE:
0
Defined in: protocol/src/packet/UpdateAbilitiesPacket.ts:15
COMMANDS
COMMANDS:
3
Defined in: protocol/src/packet/UpdateAbilitiesPacket.ts:18
EDITOR
EDITOR:
4
Defined in: protocol/src/packet/UpdateAbilitiesPacket.ts:19
LOADING_SCREEN
LOADING_SCREEN:
5
Defined in: protocol/src/packet/UpdateAbilitiesPacket.ts:20
SPECTATOR
SPECTATOR:
2
Defined in: protocol/src/packet/UpdateAbilitiesPacket.ts:17
AchievementId
Defined in: protocol/src/packet/AwardAchievementPacket.ts:14
A MinecraftEventing::AchievementIds member, the game's numbering for its achievements.
The values are the ones the wire carries, from Mojang's enum datagen and the protocol site's 1.26.60-preview.21 changelog. The 1.26.51 type page numbers the members 0 to 81 in list order; that is a rendering artifact, not the wire value. The numbering has gaps where achievements were retired.
Enumeration Members
AcquireHardware
AcquireHardware:
122
Defined in: protocol/src/packet/AwardAchievementPacket.ts:92
AdventuringTime
AdventuringTime:
116
Defined in: protocol/src/packet/AwardAchievementPacket.ts:86
Ahoy
Ahoy:
78
Defined in: protocol/src/packet/AwardAchievementPacket.ts:48
AlternativeFuel
AlternativeFuel:
72
Defined in: protocol/src/packet/AwardAchievementPacket.ts:42
ArtificialSelection
ArtificialSelection:
60
Defined in: protocol/src/packet/AwardAchievementPacket.ts:31
Atlantis
Atlantis:
79
Defined in: protocol/src/packet/AwardAchievementPacket.ts:49
Beaconator
Beaconator:
63
Defined in: protocol/src/packet/AwardAchievementPacket.ts:34
BeeOurGuest
BeeOurGuest:
91
Defined in: protocol/src/packet/AwardAchievementPacket.ts:61
BenchMaking
BenchMaking:
119
Defined in: protocol/src/packet/AwardAchievementPacket.ts:89
BirthdaySong
BirthdaySong:
105
Defined in: protocol/src/packet/AwardAchievementPacket.ts:75
BuyLowSellHigh
BuyLowSellHigh:
88
Defined in: protocol/src/packet/AwardAchievementPacket.ts:58
CarefulRestoration
CarefulRestoration:
108
Defined in: protocol/src/packet/AwardAchievementPacket.ts:78
Castaway
Castaway:
74
Defined in: protocol/src/packet/AwardAchievementPacket.ts:44
ChestFullOfCobblestone
ChestFullOfCobblestone:
7
Defined in: protocol/src/packet/AwardAchievementPacket.ts:15
CoverMeInDebris
CoverMeInDebris:
94
Defined in: protocol/src/packet/AwardAchievementPacket.ts:64
CraftersCraftingCrafters
CraftersCraftingCrafters:
110
Defined in: protocol/src/packet/AwardAchievementPacket.ts:80
DiamondForYou
DiamondForYou:
10
Defined in: protocol/src/packet/AwardAchievementPacket.ts:16
Diamonds
Diamonds:
125
Defined in: protocol/src/packet/AwardAchievementPacket.ts:95
Disenchanted
Disenchanted:
89
Defined in: protocol/src/packet/AwardAchievementPacket.ts:59
DoaBarrelRoll
DoaBarrelRoll:
81
Defined in: protocol/src/packet/AwardAchievementPacket.ts:51
Echolocation
Echolocation:
83
Defined in: protocol/src/packet/AwardAchievementPacket.ts:53
FashionShow
FashionShow:
69
Defined in: protocol/src/packet/AwardAchievementPacket.ts:40
FloatYourGoat
FloatYourGoat:
95
Defined in: protocol/src/packet/AwardAchievementPacket.ts:65
FreeDiver
FreeDiver:
61
Defined in: protocol/src/packet/AwardAchievementPacket.ts:32
FreightStation
FreightStation:
52
Defined in: protocol/src/packet/AwardAchievementPacket.ts:26
Friend
Friend:
96
Defined in: protocol/src/packet/AwardAchievementPacket.ts:66
FruitOnTheLoom
FruitOnTheLoom:
86
Defined in: protocol/src/packet/AwardAchievementPacket.ts:56
GettingAnUpgrade
GettingAnUpgrade:
123
Defined in: protocol/src/packet/AwardAchievementPacket.ts:93
GettingWood
GettingWood:
118
Defined in: protocol/src/packet/AwardAchievementPacket.ts:88
GoatHornAcquired
GoatHornAcquired:
99
Defined in: protocol/src/packet/AwardAchievementPacket.ts:69
GreatView
GreatView:
64
Defined in: protocol/src/packet/AwardAchievementPacket.ts:35
HeartTransplanter
HeartTransplanter:
113
Defined in: protocol/src/packet/AwardAchievementPacket.ts:83
HotTopic
HotTopic:
121
Defined in: protocol/src/packet/AwardAchievementPacket.ts:91
ImAMarineBiologist
ImAMarineBiologist:
75
Defined in: protocol/src/packet/AwardAchievementPacket.ts:45
Inception
Inception:
58
Defined in: protocol/src/packet/AwardAchievementPacket.ts:30
IronBelly
IronBelly:
20
Defined in: protocol/src/packet/AwardAchievementPacket.ts:17
IronMan
IronMan:
21
Defined in: protocol/src/packet/AwardAchievementPacket.ts:18
ItSpreads
ItSpreads:
104
Defined in: protocol/src/packet/AwardAchievementPacket.ts:74
JukeboxUsedInMeadows
JukeboxUsedInMeadows:
100
Defined in: protocol/src/packet/AwardAchievementPacket.ts:70
MapRoom
MapRoom:
50
Defined in: protocol/src/packet/AwardAchievementPacket.ts:25
MeGold
MeGold:
77
Defined in: protocol/src/packet/AwardAchievementPacket.ts:47
MobKabob
MobKabob:
115
Defined in: protocol/src/packet/AwardAchievementPacket.ts:85
MonsterHunter
MonsterHunter:
124
Defined in: protocol/src/packet/AwardAchievementPacket.ts:94
Moskstraumen
Moskstraumen:
82
Defined in: protocol/src/packet/AwardAchievementPacket.ts:52
OnARail
OnARail:
29
Defined in: protocol/src/packet/AwardAchievementPacket.ts:19
OnePickleTwoPickleSeaPickleFour
OnePickleTwoPickleSeaPickleFour:
80
Defined in: protocol/src/packet/AwardAchievementPacket.ts:50
Overkill
Overkill:
30
Defined in: protocol/src/packet/AwardAchievementPacket.ts:20
OverOverkill
OverOverkill:
112
Defined in: protocol/src/packet/AwardAchievementPacket.ts:82
PlantingThePast
PlantingThePast:
107
Defined in: protocol/src/packet/AwardAchievementPacket.ts:77
PlethoraOfCats
PlethoraOfCats:
126
Defined in: protocol/src/packet/AwardAchievementPacket.ts:96
ReturnToSender
ReturnToSender:
37
Defined in: protocol/src/packet/AwardAchievementPacket.ts:21
Revaulting
Revaulting:
109
Defined in: protocol/src/packet/AwardAchievementPacket.ts:79
SailThe7Seas
SailThe7Seas:
76
Defined in: protocol/src/packet/AwardAchievementPacket.ts:46
SelfPublishedAuthor
SelfPublishedAuthor:
71
Defined in: protocol/src/packet/AwardAchievementPacket.ts:41
ShootingStar
ShootingStar:
68
Defined in: protocol/src/packet/AwardAchievementPacket.ts:39
SleepWithTheFishes
SleepWithTheFishes:
73
Defined in: protocol/src/packet/AwardAchievementPacket.ts:43
SmeltEverything
SmeltEverything:
53
Defined in: protocol/src/packet/AwardAchievementPacket.ts:27
SneakCloseToSculkSensor
SneakCloseToSculkSensor:
103
Defined in: protocol/src/packet/AwardAchievementPacket.ts:73
SniperDuel
SniperDuel:
38
Defined in: protocol/src/packet/AwardAchievementPacket.ts:22
SoundTheAlarm
SoundTheAlarm:
87
Defined in: protocol/src/packet/AwardAchievementPacket.ts:57
SpawnTheWither
SpawnTheWither:
62
Defined in: protocol/src/packet/AwardAchievementPacket.ts:33
StayHydrated
StayHydrated:
114
Defined in: protocol/src/packet/AwardAchievementPacket.ts:84
StayinFrosty
StayinFrosty:
39
Defined in: protocol/src/packet/AwardAchievementPacket.ts:23
StickySituation
StickySituation:
93
Defined in: protocol/src/packet/AwardAchievementPacket.ts:63
StriderRiddenInLavaInOverworld
StriderRiddenInLavaInOverworld:
98
Defined in: protocol/src/packet/AwardAchievementPacket.ts:68
SuperSonic
SuperSonic:
65
Defined in: protocol/src/packet/AwardAchievementPacket.ts:36
SurvivedFallFromWorldHeight
SurvivedFallFromWorldHeight:
102
Defined in: protocol/src/packet/AwardAchievementPacket.ts:72
TakeInventory
TakeInventory:
40
Defined in: protocol/src/packet/AwardAchievementPacket.ts:24
TasteOfYourOwnMedicine
TasteOfYourOwnMedicine:
54
Defined in: protocol/src/packet/AwardAchievementPacket.ts:28
TheEndAgain
TheEndAgain:
66
Defined in: protocol/src/packet/AwardAchievementPacket.ts:37
TimeForStew
TimeForStew:
90
Defined in: protocol/src/packet/AwardAchievementPacket.ts:60
TimeToMine
TimeToMine:
120
Defined in: protocol/src/packet/AwardAchievementPacket.ts:90
TopOfTheWorld
TopOfTheWorld:
85
Defined in: protocol/src/packet/AwardAchievementPacket.ts:55
TotalBeeLocation
TotalBeeLocation:
92
Defined in: protocol/src/packet/AwardAchievementPacket.ts:62
TradedAtWorldHeight
TradedAtWorldHeight:
101
Defined in: protocol/src/packet/AwardAchievementPacket.ts:71
TreasureHunter
TreasureHunter:
67
Defined in: protocol/src/packet/AwardAchievementPacket.ts:38
UhOh
UhOh:
117
Defined in: protocol/src/packet/AwardAchievementPacket.ts:87
WaxOnWaxOff
WaxOnWaxOff:
97
Defined in: protocol/src/packet/AwardAchievementPacket.ts:67
WhenPigsFly
WhenPigsFly:
56
Defined in: protocol/src/packet/AwardAchievementPacket.ts:29
WhereHaveYouBeen
WhereHaveYouBeen:
84
Defined in: protocol/src/packet/AwardAchievementPacket.ts:54
WhoNeedsRockets
WhoNeedsRockets:
111
Defined in: protocol/src/packet/AwardAchievementPacket.ts:81
WithOurPowersCombined
WithOurPowersCombined:
106
Defined in: protocol/src/packet/AwardAchievementPacket.ts:76
ActorEvent
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:8
ActorEvent, from Mojang's published protocol documentation.
Generated - do not edit. Change datagen/manifest.json and run pnpm generate. Source: Mojang/bedrock-protocol-docs release v1.26.51 (Minecraft 1.26.51, protocol 2193) Upstream name: ActorEvent
Enumeration Members
ACTOR_GROW_UP
ACTOR_GROW_UP:
76
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:64
AGENT_SWING_ARM
AGENT_SWING_ARM:
36
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:44
AIR_SUPPLY
AIR_SUPPLY:
33
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:41
BABY_AGE
BABY_AGE:
60
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:49
BALLOON_POP
BALLOON_POP:
71
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:60
CARAVAN_UPDATED
CARAVAN_UPDATED:
64
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:53
DEATH_ANIMATION
DEATH_ANIMATION:
3
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:12
DEPRECATED_ADD_PLAYER_LEVELS
DEPRECATED_ADD_PLAYER_LEVELS:
34
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:42
DEPRECATED_UPDATE_STRUCTURE_FEATURE
DEPRECATED_UPDATE_STRUCTURE_FEATURE:
66
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:55
DRAGON_START_DEATH_ANIM
DRAGON_START_DEATH_ANIM:
37
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:45
DRINK_MILK
DRINK_MILK:
78
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:66
DRINK_POTION
DRINK_POTION:
29
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:37
EAT_GRASS
EAT_GRASS:
10
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:18
FEED
FEED:
57
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:48
FINISHED_CHARGING_ITEM
FINISHED_CHARGING_ITEM:
74
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:63
FIREWORKS_EXPLODE
FIREWORKS_EXPLODE:
25
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:33
FISHHOOK_BUBBLE
FISHHOOK_BUBBLE:
11
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:19
FISHHOOK_FISHPOS
FISHHOOK_FISHPOS:
12
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:20
FISHHOOK_HOOKTIME
FISHHOOK_HOOKTIME:
13
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:21
FISHHOOK_TEASE
FISHHOOK_TEASE:
14
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:22
GROUND_DUST
GROUND_DUST:
38
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:46
GUARDIAN_ATTACK_SOUND
GUARDIAN_ATTACK_SOUND:
28
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:36
GUARDIAN_MINING_FATIGUE
GUARDIAN_MINING_FATIGUE:
35
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:43
HURT_ANIMATION
HURT_ANIMATION:
2
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:11
HURT_WITHOUT_RECEIVING_DAMAGE
HURT_WITHOUT_RECEIVING_DAMAGE:
81
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:69
IN_LOVE_HEARTS
IN_LOVE_HEARTS:
26
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:34
INSTANT_DEATH
INSTANT_DEATH:
61
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:50
JUMP
JUMP:
1
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:10
KINETIC_DAMAGE_DEALT
KINETIC_DAMAGE_DEALT:
80
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:68
LEASH_DESTROYED
LEASH_DESTROYED:
63
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:52
LOVE_HEARTS
LOVE_HEARTS:
21
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:29
NONE
NONE:
0
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:9
NOTIFY_TRADE
NOTIFY_TRADE:
62
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:51
PLAY_AMBIENT
PLAY_AMBIENT:
17
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:25
PLAYER_SPAWNED_MOB
PLAYER_SPAWNED_MOB:
67
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:56
PRIME_CREEPER
PRIME_CREEPER:
32
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:40
PRIME_TNTCART
PRIME_TNTCART:
31
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:39
PUKE
PUKE:
68
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:57
SHAKE
SHAKE:
39
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:47
SHAKE_WETNESS
SHAKE_WETNESS:
8
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:17
SHAKE_WETNESS_STOP
SHAKE_WETNESS_STOP:
79
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:67
SILVERFISH_MERGE_ANIM
SILVERFISH_MERGE_ANIM:
27
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:35
SPAWN_ALIVE
SPAWN_ALIVE:
18
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:26
SQUID_FLEEING
SQUID_FLEEING:
15
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:23
START_ATTACKING
START_ATTACKING:
4
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:13
START_OFFER_FLOWER
START_OFFER_FLOWER:
19
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:27
START_SWIMMING
START_SWIMMING:
70
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:59
STOP_ATTACKING
STOP_ATTACKING:
5
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:14
STOP_OFFER_FLOWER
STOP_OFFER_FLOWER:
20
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:28
SUMMON_AGENT
SUMMON_AGENT:
73
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:62
TALISMAN_ACTIVATE
TALISMAN_ACTIVATE:
65
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:54
TAMING_FAILED
TAMING_FAILED:
6
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:15
TAMING_SUCCEEDED
TAMING_SUCCEEDED:
7
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:16
THROW_POTION
THROW_POTION:
30
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:38
TREASURE_HUNT
TREASURE_HUNT:
72
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:61
UPDATE_STACK_SIZE
UPDATE_STACK_SIZE:
69
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:58
VIBRATION_DETECTED
VIBRATION_DETECTED:
77
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:65
VILLAGER_ANGRY
VILLAGER_ANGRY:
22
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:30
VILLAGER_HAPPY
VILLAGER_HAPPY:
23
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:31
WITCH_HAT_MAGIC
WITCH_HAT_MAGIC:
24
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:32
ZOMBIE_CONVERTING
ZOMBIE_CONVERTING:
16
Defined in: minecraft/src/generated/v2193/ActorEvent.ts:24
ActorSyncMessage
Defined in: protocol/src/packet/UpdateBlockSyncedPacket.ts:8
How the client synchronizes a moving block actor with its block form.
Enumeration Members
BlockToEntity
BlockToEntity:
1
Defined in: protocol/src/packet/UpdateBlockSyncedPacket.ts:12
The block becomes an actor at this position.
EntityToBlock
EntityToBlock:
2
Defined in: protocol/src/packet/UpdateBlockSyncedPacket.ts:14
The actor becomes a block at this position.
None
None:
0
Defined in: protocol/src/packet/UpdateBlockSyncedPacket.ts:10
No actor synchronization accompanies the block update.
AgentActionType
Defined in: protocol/src/packet/AgentActionEventPacket.ts:15
The docs' AgentActionType, the action a Code Builder agent was asked to perform.
Numbered as the client writes it, from 1. Mojang's rendered page lists the members from 0, which is a display artifact: the datagen snapshot, gophertunnel, and PocketMine all start at Attack = 1, and the 1.26.60 preview changelog "moves" every member up by one to match.
Enumeration Members
ATTACK
ATTACK:
1
Defined in: protocol/src/packet/AgentActionEventPacket.ts:16
COLLECT
COLLECT:
2
Defined in: protocol/src/packet/AgentActionEventPacket.ts:17
DESTROY
DESTROY:
3
Defined in: protocol/src/packet/AgentActionEventPacket.ts:18
DETECT_OBSTACLE
DETECT_OBSTACLE:
5
Defined in: protocol/src/packet/AgentActionEventPacket.ts:20
DETECT_REDSTONE
DETECT_REDSTONE:
4
Defined in: protocol/src/packet/AgentActionEventPacket.ts:19
DROP
DROP:
6
Defined in: protocol/src/packet/AgentActionEventPacket.ts:21
DROP_ALL
DROP_ALL:
7
Defined in: protocol/src/packet/AgentActionEventPacket.ts:22
INSPECT
INSPECT:
8
Defined in: protocol/src/packet/AgentActionEventPacket.ts:23
INSPECT_DATA
INSPECT_DATA:
9
Defined in: protocol/src/packet/AgentActionEventPacket.ts:24
INSPECT_ITEM_COUNT
INSPECT_ITEM_COUNT:
10
Defined in: protocol/src/packet/AgentActionEventPacket.ts:25
INSPECT_ITEM_DETAIL
INSPECT_ITEM_DETAIL:
11
Defined in: protocol/src/packet/AgentActionEventPacket.ts:26
INSPECT_ITEM_SPACE
INSPECT_ITEM_SPACE:
12
Defined in: protocol/src/packet/AgentActionEventPacket.ts:27
INTERACT
INTERACT:
13
Defined in: protocol/src/packet/AgentActionEventPacket.ts:28
MOVE
MOVE:
14
Defined in: protocol/src/packet/AgentActionEventPacket.ts:29
PLACE_BLOCK
PLACE_BLOCK:
15
Defined in: protocol/src/packet/AgentActionEventPacket.ts:30
TILL
TILL:
16
Defined in: protocol/src/packet/AgentActionEventPacket.ts:31
TRANSFER_ITEM_TO
TRANSFER_ITEM_TO:
17
Defined in: protocol/src/packet/AgentActionEventPacket.ts:32
TURN
TURN:
18
Defined in: protocol/src/packet/AgentActionEventPacket.ts:33
AgentAnimation
Defined in: protocol/src/packet/AgentAnimationPacket.ts:9
The docs' Agent Animation, numbered from 0 as the datagen snapshot lists it.
Enumeration Members
ARM_SWING
ARM_SWING:
0
Defined in: protocol/src/packet/AgentAnimationPacket.ts:10
SHRUG
SHRUG:
1
Defined in: protocol/src/packet/AgentAnimationPacket.ts:11
AimAssistTargetMode
Defined in: protocol/src/structure/CameraPreset.ts:62
The docs' Aim-Assist Target Mode: how aim assist picks a target near the cursor.
Enumeration Members
ANGLE
ANGLE:
0
Defined in: protocol/src/structure/CameraPreset.ts:64
Any target inside the View Angle cone.
DISTANCE
DISTANCE:
1
Defined in: protocol/src/structure/CameraPreset.ts:66
Any target within Distance of the cursor.
AnimateAction
Defined in: protocol/src/wire/definitions/animate.ts:25
The Action byte.
The 1.26.51 docs page prints the members 0 to 4, but that table shows list positions: the page's own 2207 changelog "changes" WakeUp, CriticalHit and MagicCriticalHit to 3, 4 and 5, and gophertunnel and PocketMine have read them so for years. Nothing is 2.
Enumeration Members
CriticalHit
CriticalHit:
4
Defined in: protocol/src/wire/definitions/animate.ts:29
MagicCriticalHit
MagicCriticalHit:
5
Defined in: protocol/src/wire/definitions/animate.ts:30
NoAction
NoAction:
0
Defined in: protocol/src/wire/definitions/animate.ts:26
Swing
Swing:
1
Defined in: protocol/src/wire/definitions/animate.ts:27
WakeUp
WakeUp:
3
Defined in: protocol/src/wire/definitions/animate.ts:28
AnimateHand
Defined in: protocol/src/wire/definitions/animate.ts:34
The hand animating, byte values on the wire.
Enumeration Members
Mainhand
Mainhand:
0
Defined in: protocol/src/wire/definitions/animate.ts:35
Offhand
Offhand:
1
Defined in: protocol/src/wire/definitions/animate.ts:36
AnimationMode
Defined in: protocol/src/structure/StructureSettings.ts:29
How a structure animates into place, written as one byte.
Enumeration Members
Blocks
Blocks:
2
Defined in: protocol/src/structure/StructureSettings.ts:32
Layers
Layers:
1
Defined in: protocol/src/structure/StructureSettings.ts:31
None
None:
0
Defined in: protocol/src/structure/StructureSettings.ts:30
ArmorSlot
Defined in: minecraft/src/generated/v2193/ArmorSlot.ts:8
ArmorSlot, from Mojang's published protocol documentation.
Generated - do not edit. Change datagen/manifest.json and run pnpm generate. Source: Mojang/bedrock-protocol-docs release v1.26.51 (Minecraft 1.26.51, protocol 2193) Upstream name: SharedTypes::Legacy::ArmorSlot
Enumeration Members
BODY
BODY:
4
Defined in: minecraft/src/generated/v2193/ArmorSlot.ts:13
FEET
FEET:
3
Defined in: minecraft/src/generated/v2193/ArmorSlot.ts:12
HEAD
HEAD:
0
Defined in: minecraft/src/generated/v2193/ArmorSlot.ts:9
LEGS
LEGS:
2
Defined in: minecraft/src/generated/v2193/ArmorSlot.ts:11
TORSO
TORSO:
1
Defined in: minecraft/src/generated/v2193/ArmorSlot.ts:10
AttributeDataType
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:13
Which alternative an attribute value variant (Attribute, FromAttribute or ToAttribute) carries. The value is the alternative's index in the schema's oneOf, written as the varuint32 selector on the wire.
Enumeration Members
Bool
Bool:
0
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:15
BoolAttributeData: a boolean value and a BoolAttributeOperation.
Color
Color:
2
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:19
ColorAttributeData: a Color255RGBA value and a ColorAttributeOperation.
Float
Float:
1
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:17
FloatAttributeData: a float value, a FloatAttributeOperation and optional constraints.
AttributeLayerSyncDataType
Defined in: protocol/src/packet/ClientboundAttributeLayerSyncPacket.ts:14
Which alternative of the Data variant a ClientboundAttributeLayerSyncPacket carries. The value is the alternative's index in the schema's oneOf, written as the varuint32 selector on the wire.
Enumeration Members
RemoveEnvironmentAttributes
RemoveEnvironmentAttributes:
3
Defined in: protocol/src/packet/ClientboundAttributeLayerSyncPacket.ts:22
RemoveEnvironmentAttributesData: attribute names removed from one layer.
UpdateAttributeLayers
UpdateAttributeLayers:
0
Defined in: protocol/src/packet/ClientboundAttributeLayerSyncPacket.ts:16
UpdateAttributeLayersData: full layer definitions, sent on join and when a layer is added.
UpdateAttributeLayerSettings
UpdateAttributeLayerSettings:
1
Defined in: protocol/src/packet/ClientboundAttributeLayerSyncPacket.ts:18
UpdateAttributeLayerSettingsData: new settings for one layer.
UpdateEnvironmentAttributes
UpdateEnvironmentAttributes:
2
Defined in: protocol/src/packet/ClientboundAttributeLayerSyncPacket.ts:20
UpdateEnvironmentAttributesData: attributes of one layer that changed or were added.
AudioContentPlaybackType
Defined in: protocol/src/wire/definitions/added2225.ts:48
AudioContentPlaybackType: which mixer the audio content plays through.
Enumeration Members
Music
Music:
0
Defined in: protocol/src/wire/definitions/added2225.ts:49
Sound
Sound:
1
Defined in: protocol/src/wire/definitions/added2225.ts:50
BookEditAction
Defined in: protocol/src/packet/BookEditPacket.ts:7
The book edit operation, numbered as the packet's oneOf selector.
Enumeration Members
AddPage
AddPage:
1
Defined in: protocol/src/packet/BookEditPacket.ts:9
DeletePage
DeletePage:
2
Defined in: protocol/src/packet/BookEditPacket.ts:10
Finalize
Finalize:
4
Defined in: protocol/src/packet/BookEditPacket.ts:12
ReplacePage
ReplacePage:
0
Defined in: protocol/src/packet/BookEditPacket.ts:8
SwapPages
SwapPages:
3
Defined in: protocol/src/packet/BookEditPacket.ts:11
BoolAttributeOperation
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:23
The docs enum BoolAttributeOperation: how a boolean attribute combines with the layers below it.
Enumeration Members
ALPHA_BLEND
ALPHA_BLEND:
1
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:25
AND
AND:
2
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:26
NAND
NAND:
3
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:27
NOR
NOR:
5
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:29
OR
OR:
4
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:28
OVERRIDE
OVERRIDE:
0
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:24
XNOR
XNOR:
7
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:31
XOR
XOR:
6
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:30
BossBarColor
Defined in: protocol/src/packet/BossEventPacket.ts:24
The bar colors a boss bar can take, as the Color byte numbers them.
Enumeration Members
Blue
Blue:
1
Defined in: protocol/src/packet/BossEventPacket.ts:26
Green
Green:
3
Defined in: protocol/src/packet/BossEventPacket.ts:28
Pink
Pink:
0
Defined in: protocol/src/packet/BossEventPacket.ts:25
Purple
Purple:
5
Defined in: protocol/src/packet/BossEventPacket.ts:30
RebeccaPurple
RebeccaPurple:
6
Defined in: protocol/src/packet/BossEventPacket.ts:31
Red
Red:
2
Defined in: protocol/src/packet/BossEventPacket.ts:27
White
White:
7
Defined in: protocol/src/packet/BossEventPacket.ts:32
Yellow
Yellow:
4
Defined in: protocol/src/packet/BossEventPacket.ts:29
BossBarOverlay
Defined in: protocol/src/packet/BossEventPacket.ts:36
How the bar is divided, as the Overlay byte numbers it.
Enumeration Members
Notched10
Notched10:
2
Defined in: protocol/src/packet/BossEventPacket.ts:39
Notched12
Notched12:
3
Defined in: protocol/src/packet/BossEventPacket.ts:40
Notched20
Notched20:
4
Defined in: protocol/src/packet/BossEventPacket.ts:41
Notched6
Notched6:
1
Defined in: protocol/src/packet/BossEventPacket.ts:38
Progress
Progress:
0
Defined in: protocol/src/packet/BossEventPacket.ts:37
BossEventUpdateType
Defined in: protocol/src/packet/BossEventPacket.ts:11
What the event does to the boss bar, as the Event Type byte numbers it.
The docs spell the four update members with an underscore, such as Update_Percent.
Enumeration Members
Add
Add:
0
Defined in: protocol/src/packet/BossEventPacket.ts:12
PlayerAdded
PlayerAdded:
1
Defined in: protocol/src/packet/BossEventPacket.ts:13
PlayerRemoved
PlayerRemoved:
3
Defined in: protocol/src/packet/BossEventPacket.ts:15
Query
Query:
8
Defined in: protocol/src/packet/BossEventPacket.ts:20
Remove
Remove:
2
Defined in: protocol/src/packet/BossEventPacket.ts:14
UpdateName
UpdateName:
5
Defined in: protocol/src/packet/BossEventPacket.ts:17
UpdatePercent
UpdatePercent:
4
Defined in: protocol/src/packet/BossEventPacket.ts:16
UpdateProperties
UpdateProperties:
6
Defined in: protocol/src/packet/BossEventPacket.ts:18
UpdateStyle
UpdateStyle:
7
Defined in: protocol/src/packet/BossEventPacket.ts:19
CameraAimAssistAction
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:16
The docs enum CameraAimAssistPacketPayload Action.
Enumeration Members
CLEAR
CLEAR:
1
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:20
Turn aim assist off. The other fields are still on the wire.
SET
SET:
0
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:18
Turn aim assist on with the settings in the packet.
CameraAimAssistPresetsOperation
Defined in: protocol/src/packet/CameraAimAssistPresetsPacket.ts:12
The docs enum CameraAimAssistPresetsPacketOperation: what the client does with the lists.
Enumeration Members
ADD_TO_EXISTING
ADD_TO_EXISTING:
1
Defined in: protocol/src/packet/CameraAimAssistPresetsPacket.ts:16
Add the lists to the registry the client already has.
SET
SET:
0
Defined in: protocol/src/packet/CameraAimAssistPresetsPacket.ts:14
Replace the client's registry with the lists in the packet.
CameraAimAssistTargetMode
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:8
The docs enum CameraAimAssistPacketPayload TargetMode: how the client picks a target.
Enumeration Members
ANGLE
ANGLE:
0
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:10
Pick the target within View Angle of the crosshair.
DISTANCE
DISTANCE:
1
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:12
Pick the target within Distance of the crosshair.
CameraAudioListener
Defined in: protocol/src/structure/CameraPreset.ts:56
The docs' SharedTypes::Comprehensive::CameraPreset::AudioListener: where the preset hears sound from.
Enumeration Members
CAMERA
CAMERA:
0
Defined in: protocol/src/structure/CameraPreset.ts:57
PLAYER
PLAYER:
1
Defined in: protocol/src/structure/CameraPreset.ts:58
CameraShakeAction
Defined in: protocol/src/packet/CameraShakePacket.ts:13
What to do with the shake, as the Shake Action uint8 numbers it.
Enumeration Members
Add
Add:
0
Defined in: protocol/src/packet/CameraShakePacket.ts:14
Stop
Stop:
1
Defined in: protocol/src/packet/CameraShakePacket.ts:15
CameraShakeType
Defined in: protocol/src/packet/CameraShakePacket.ts:7
How the camera moves while it shakes, as the Shake Type uint8 numbers it.
Enumeration Members
Positional
Positional:
0
Defined in: protocol/src/packet/CameraShakePacket.ts:8
Rotational
Rotational:
1
Defined in: protocol/src/packet/CameraShakePacket.ts:9
CameraSplineType
Defined in: protocol/src/structure/CameraSplineDefinition.ts:9
The spline_type names: how the camera interpolates between control points.
Enumeration Members
CatmullRom
CatmullRom:
"catmullrom"
Defined in: protocol/src/structure/CameraSplineDefinition.ts:10
Linear
Linear:
"linear"
Defined in: protocol/src/structure/CameraSplineDefinition.ts:11
ClientCameraAimAssistAction
Defined in: protocol/src/packet/ClientCameraAimAssistPacket.ts:9
The docs enum ClientCameraAimAssistPacketAction.
Enumeration Members
CLEAR
CLEAR:
1
Defined in: protocol/src/packet/ClientCameraAimAssistPacket.ts:13
Turn aim assist off.
SET_FROM_CAMERA_PRESET
SET_FROM_CAMERA_PRESET:
0
Defined in: protocol/src/packet/ClientCameraAimAssistPacket.ts:11
Use the aim_assist settings of the camera preset named by Camera Preset Id.
ClientInputLock
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:15
One bit of Input Lock ComponentData. Set bits name the inputs the client must ignore; combine them with bitwise or.
The docs give no enum for this field. The values follow gophertunnel master (protocol 2193), which starts at bit 1 and leaves bit 3 unused.
Enumeration Members
Camera
Camera:
2
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:19
Camera rotation.
Dismount
Dismount:
256
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:31
Dismounting.
Jump
Jump:
64
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:27
Jumping.
LateralMovement
LateralMovement:
16
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:23
Walking in any horizontal direction.
Mount
Mount:
128
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:29
Mounting a rideable actor.
MoveBackward
MoveBackward:
1024
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:35
Walking backward.
MoveForward
MoveForward:
512
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:33
Walking forward.
MoveLeft
MoveLeft:
2048
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:37
Strafing left.
Movement
Movement:
4
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:21
All movement.
MoveRight
MoveRight:
4096
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:39
Strafing right.
None
None:
0
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:17
No input is locked.
Sneak
Sneak:
32
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:25
Sneaking.
ClientPlayMode
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:118
Whether the player is in the normal game or a legacy VR play mode.
Enumeration Members
ExitLevel
ExitLevel:
7
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:122
Normal
Normal:
0
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:119
NumModes
NumModes:
9
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:124
One past the last mode; a client cannot send this value.
Screen
Screen:
2
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:121
Teaser
Teaser:
1
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:120
CodeBuilderCategory
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:21
A CodeBuilderStorageQueryOptions::Category, written as one byte.
Enumeration Members
CodeStatus
CodeStatus:
1
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:25
Docs: CodeStatus.
Instantiation
Instantiation:
2
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:27
Docs: Instantiation.
None
None:
0
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:23
Docs: None.
CodeBuilderCodeStatus
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:31
A CodeBuilderExecutionState::CodeStatus, written as one byte.
Enumeration Members
Error
Error:
4
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:41
Docs: Error.
InProgress
InProgress:
2
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:37
Docs: InProgress.
None
None:
0
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:33
Docs: None.
NotStarted
NotStarted:
1
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:35
Docs: NotStarted.
Paused
Paused:
3
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:39
Docs: Paused.
Succeeded
Succeeded:
5
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:43
Docs: Succeeded.
CodeBuilderOperation
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:9
A CodeBuilderStorageQueryOptions::Operation, written as one byte.
Enumeration Members
Get
Get:
1
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:13
Docs: Get.
None
None:
0
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:11
Docs: None.
Reset
Reset:
3
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:17
Docs: Reset.
Set
Set:
2
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:15
Docs: Set.
ColorAttributeOperation
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:46
The docs enum ColorAttributeOperation: how a color attribute combines with the layers below it.
Enumeration Members
ADD
ADD:
2
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:49
ALPHA_BLEND
ALPHA_BLEND:
1
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:48
MULTIPLY
MULTIPLY:
4
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:51
OVERRIDE
OVERRIDE:
0
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:47
SUBTRACT
SUBTRACT:
3
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:50
CommandArgumentType
Defined in: protocol/src/wire/structures/CommandParameter.ts:33
The basic command argument type ids of protocol 2193 (Minecraft 1.26.50).
The numbers are the CommandArgType* constants in gophertunnel's protocol/command.go. They shift between releases, so a parameter is only ever written through CommandParameterType, which ORs them with CommandParameterTypeFlag.Valid.
The ids are a second copy of BedrockParameterTypeId in packages/commands/src/parameterTypes.ts, which is the verified table: it is keyed by the name Mojang's own command metadata spells, and the generator joins the two halves on that key. This package does not depend on @jsprismarine/commands, so the numbers are repeated here and CommandParameter.test.ts reads that file to prove the copies agree. The names below are the common library spelling, which is what the rest of this package reads.
Enumeration Members
BlockPosition
BlockPosition:
64
Defined in: protocol/src/wire/structures/CommandParameter.ts:59
POSITION, a block position.
BlockStateArray
BlockStateArray:
84
Defined in: protocol/src/wire/structures/CommandParameter.ts:74
BLOCK_STATE_ARRAY, Bedrock's stone_stairs["facing"="north"].
ClockTimeMarker
ClockTimeMarker:
86
Defined in: protocol/src/wire/structures/CommandParameter.ts:76
CLOCK_TIMEMARKER_NAME.
CodeBuilderArgs
CodeBuilderArgs:
92
Defined in: protocol/src/wire/structures/CommandParameter.ts:82
CODEBUILDERARGS, the command /execute run takes.
CompareOperator
CompareOperator:
7
Defined in: protocol/src/wire/structures/CommandParameter.ts:45
COMPAREOPERATOR.
EquipmentSlot
EquipmentSlot:
47
Defined in: protocol/src/wire/structures/CommandParameter.ts:55
EQUIPMENTSLOTENUM.
Float
Float:
3
Defined in: protocol/src/wire/structures/CommandParameter.ts:37
VAL.
FullIntegerRange
FullIntegerRange:
23
Defined in: protocol/src/wire/structures/CommandParameter.ts:53
FULLINTEGERRANGE, the range execute if score ... matches takes.
Int
Int:
1
Defined in: protocol/src/wire/structures/CommandParameter.ts:35
INT.
Json
Json:
74
Defined in: protocol/src/wire/structures/CommandParameter.ts:72
JSON_OBJECT.
Message
Message:
67
Defined in: protocol/src/wire/structures/CommandParameter.ts:66
An inner grammar rule, not a type Mojang's own command set uses. MessageRoot is the one that appears in the 1.26.50.4 metadata.
MessageRoot
MessageRoot:
68
Defined in: protocol/src/wire/structures/CommandParameter.ts:68
MESSAGE_ROOT.
Operator
Operator:
6
Defined in: protocol/src/wire/structures/CommandParameter.ts:43
OPERATOR.
PathCommand
PathCommand:
17
Defined in: protocol/src/wire/structures/CommandParameter.ts:51
PATHCOMMAND, the file path /function takes.
PoiTag
PoiTag:
87
Defined in: protocol/src/wire/structures/CommandParameter.ts:78
POI_TAG, new in 1.26.50.
PoiType
PoiType:
88
Defined in: protocol/src/wire/structures/CommandParameter.ts:80
POI_TYPE, new in 1.26.50.
Position
Position:
65
Defined in: protocol/src/wire/structures/CommandParameter.ts:61
POSITION_FLOAT.
RawText
RawText:
70
Defined in: protocol/src/wire/structures/CommandParameter.ts:70
RAWTEXT.
String
String:
56
Defined in: protocol/src/wire/structures/CommandParameter.ts:57
ID, a plain string.
Target
Target:
8
Defined in: protocol/src/wire/structures/CommandParameter.ts:47
SELECTION, a target selector.
Value
Value:
4
Defined in: protocol/src/wire/structures/CommandParameter.ts:39
RVAL, a value that may be relative.
WildcardInt
WildcardInt:
5
Defined in: protocol/src/wire/structures/CommandParameter.ts:41
WILDCARDINT.
WildcardSelection
WildcardSelection:
10
Defined in: protocol/src/wire/structures/CommandParameter.ts:49
WILDCARDSELECTION, a target selector that accepts *.
CommandBlockMode
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:8
The command block execution mode the client selected; Normal is called Impulse in the UI.
Enumeration Members
Chain
Chain:
2
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:11
Normal
Normal:
0
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:9
Repeating
Repeating:
1
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:10
CommandOutputType
Defined in: protocol/src/wire/definitions/commands.ts:39
How the client should treat the output, as CommandOutputType orders its members.
The wire carries the member name as a string, not the number: the 1.26.51 docs give the enum one wire format, "serialized as string", and its schema no Enum-as-Value option.
Enumeration Members
AllOutput
AllOutput:
3
Defined in: protocol/src/wire/definitions/commands.ts:43
DataSet
DataSet:
4
Defined in: protocol/src/wire/definitions/commands.ts:44
LastOutput
LastOutput:
1
Defined in: protocol/src/wire/definitions/commands.ts:41
None
None:
0
Defined in: protocol/src/wire/definitions/commands.ts:40
Silent
Silent:
2
Defined in: protocol/src/wire/definitions/commands.ts:42
CommandParameterFlags
Defined in: protocol/src/wire/structures/CommandParameter.ts:128
The options byte of a command parameter (ParamOption* in gophertunnel's command.go, CommandParameterOption in Mojang's own naming).
Enumeration Members
ENUM_AS_CHAINED_COMMAND
ENUM_AS_CHAINED_COMMAND:
4
Defined in: protocol/src/wire/structures/CommandParameter.ts:137
Marks the trailing "and then another subcommand" parameter of a chained /execute overload. The packet sets this itself for a parameter with a chainedSubcommand, so a caller never has to.
FLAG_HAS_ENUM_CONSTRAINT
FLAG_HAS_ENUM_CONSTRAINT:
2
Defined in: protocol/src/wire/structures/CommandParameter.ts:131
FORCE_COLLAPSE_ENUM
FORCE_COLLAPSE_ENUM:
1
Defined in: protocol/src/wire/structures/CommandParameter.ts:130
NONE
NONE:
0
Defined in: protocol/src/wire/structures/CommandParameter.ts:129
CommandParameterTypeFlag
Defined in: protocol/src/wire/structures/CommandParameter.ts:12
The flag bits of a command parameter's type word.
The client reads a parameter's type as one 32 bit word. A basic type is its id ORed with Valid. An enum parameter carries Enum (or SoftEnum) and the enum's index in the packet's enum table instead of a type id, and a postfixed integer carries Postfix and the postfix's index. From gophertunnel's protocol/command.go at protocol 2193.
Enumeration Members
Enum
Enum:
2097152
Defined in: protocol/src/wire/structures/CommandParameter.ts:14
Postfix
Postfix:
16777216
Defined in: protocol/src/wire/structures/CommandParameter.ts:15
SoftEnum
SoftEnum:
67108864
Defined in: protocol/src/wire/structures/CommandParameter.ts:16
Valid
Valid:
1048576
Defined in: protocol/src/wire/structures/CommandParameter.ts:13
CompressionThreshold
Defined in: protocol/src/packet/NetworkSettingsPacket.ts:10
Values the server commonly uses for the smallest payload worth compressing.
Enumeration Members
COMPRESS_EVERYTHING
COMPRESS_EVERYTHING:
1
Defined in: protocol/src/packet/NetworkSettingsPacket.ts:14
A threshold of one byte compresses every nonempty payload.
COMPRESS_NOTHING
COMPRESS_NOTHING:
0
Defined in: protocol/src/packet/NetworkSettingsPacket.ts:12
A threshold of zero disables compression for every packet.
ContainerUiId
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:8
ContainerUiId, from Mojang's published protocol documentation.
Generated - do not edit. Change datagen/manifest.json and run pnpm generate. Source: Mojang/bedrock-protocol-docs release v1.26.51 (Minecraft 1.26.51, protocol 2193) Upstream name: ContainerEnumName
Enumeration Members
ANVIL_INPUT_CONTAINER
ANVIL_INPUT_CONTAINER:
0
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:9
ANVIL_MATERIAL_CONTAINER
ANVIL_MATERIAL_CONTAINER:
1
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:10
ANVIL_RESULT_PREVIEW_CONTAINER
ANVIL_RESULT_PREVIEW_CONTAINER:
2
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:11
ARMOR_CONTAINER
ARMOR_CONTAINER:
6
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:15
BARREL_CONTAINER
BARREL_CONTAINER:
58
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:70
BEACON_PAYMENT_CONTAINER
BEACON_PAYMENT_CONTAINER:
8
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:17
BLAST_FURNACE_INGREDIENT_CONTAINER
BLAST_FURNACE_INGREDIENT_CONTAINER:
45
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:57
BREWING_STAND_FUEL_CONTAINER
BREWING_STAND_FUEL_CONTAINER:
11
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:20
BREWING_STAND_INPUT_CONTAINER
BREWING_STAND_INPUT_CONTAINER:
9
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:18
BREWING_STAND_RESULT_CONTAINER
BREWING_STAND_RESULT_CONTAINER:
10
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:19
CARTOGRAPHY_ADDITIONAL_CONTAINER
CARTOGRAPHY_ADDITIONAL_CONTAINER:
56
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:68
CARTOGRAPHY_INPUT_CONTAINER
CARTOGRAPHY_INPUT_CONTAINER:
55
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:67
CARTOGRAPHY_RESULT_PREVIEW_CONTAINER
CARTOGRAPHY_RESULT_PREVIEW_CONTAINER:
57
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:69
COMBINED_HOTBAR_AND_INVENTORY
COMBINED_HOTBAR_AND_INVENTORY:
12
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:21
COMPOUND_CREATOR_INPUT
COMPOUND_CREATOR_INPUT:
35
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:47
COMPOUND_CREATOR_OUTPUT_PREVIEW
COMPOUND_CREATOR_OUTPUT_PREVIEW:
36
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:48
CRAFTER_LEVEL_ENTITY_CONTAINER
CRAFTER_LEVEL_ENTITY_CONTAINER:
62
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:74
CRAFTING_INPUT
CRAFTING_INPUT:
13
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:22
CRAFTING_OUTPUT_PREVIEW_CONTAINER
CRAFTING_OUTPUT_PREVIEW_CONTAINER:
14
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:23
CREATED_OUTPUT
CREATED_OUTPUT:
60
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:72
CURSOR
CURSOR:
59
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:71
DYNAMIC_CONTAINER
DYNAMIC_CONTAINER:
63
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:75
ELEMENT_CONSTRUCTOR_OUTPUT_PREVIEW
ELEMENT_CONSTRUCTOR_OUTPUT_PREVIEW:
37
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:49
ENCHANTING_INPUT_CONTAINER
ENCHANTING_INPUT_CONTAINER:
22
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:34
ENCHANTING_MATERIAL_CONTAINER
ENCHANTING_MATERIAL_CONTAINER:
23
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:35
FURNACE_FUEL_CONTAINER
FURNACE_FUEL_CONTAINER:
24
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:36
FURNACE_INGREDIENT_CONTAINER
FURNACE_INGREDIENT_CONTAINER:
25
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:37
FURNACE_RESULT_CONTAINER
FURNACE_RESULT_CONTAINER:
26
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:38
GRINDSTONE_ADDITIONAL_CONTAINER
GRINDSTONE_ADDITIONAL_CONTAINER:
51
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:63
GRINDSTONE_INPUT_CONTAINER
GRINDSTONE_INPUT_CONTAINER:
50
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:62
GRINDSTONE_RESULT_PREVIEW_CONTAINER
GRINDSTONE_RESULT_PREVIEW_CONTAINER:
52
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:64
HORSE_EQUIP_CONTAINER
HORSE_EQUIP_CONTAINER:
27
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:39
HOTBAR
HOTBAR:
28
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:40
INVENTORY
INVENTORY:
29
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:41
LAB_TABLE_INPUT
LAB_TABLE_INPUT:
40
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:52
LEVEL_ENTITY_CONTAINER
LEVEL_ENTITY_CONTAINER:
7
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:16
LOOM_DYE_CONTAINER
LOOM_DYE_CONTAINER:
42
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:54
LOOM_INPUT_CONTAINER
LOOM_INPUT_CONTAINER:
41
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:53
LOOM_MATERIAL_CONTAINER
LOOM_MATERIAL_CONTAINER:
43
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:55
LOOM_RESULT_PREVIEW_CONTAINER
LOOM_RESULT_PREVIEW_CONTAINER:
44
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:56
MATERIAL_REDUCER_INPUT
MATERIAL_REDUCER_INPUT:
38
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:50
MATERIAL_REDUCER_OUTPUT
MATERIAL_REDUCER_OUTPUT:
39
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:51
OFFHAND
OFFHAND:
34
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:46
RECIPE_BLOCKS_CONTAINER
RECIPE_BLOCKS_CONTAINER:
65
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:28
RECIPE_BOOK_CONTAINER
RECIPE_BOOK_CONTAINER:
21
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:33
RECIPE_CONSTRUCTION_CONTAINER
RECIPE_CONSTRUCTION_CONTAINER:
15
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:24
RECIPE_EQUIPMENT_CONTAINER
RECIPE_EQUIPMENT_CONTAINER:
20
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:32
RECIPE_FOOD_CONTAINER
RECIPE_FOOD_CONTAINER:
64
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:27
RECIPE_FURNACE_ITEMS_CONTAINER
RECIPE_FURNACE_ITEMS_CONTAINER:
66
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:29
RECIPE_ITEMS_CONTAINER
RECIPE_ITEMS_CONTAINER:
17
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:26
RECIPE_NATURE_CONTAINER
RECIPE_NATURE_CONTAINER:
16
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:25
RECIPE_SEARCH_BAR_CONTAINER
RECIPE_SEARCH_BAR_CONTAINER:
19
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:31
RECIPE_SEARCH_CONTAINER
RECIPE_SEARCH_CONTAINER:
18
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:30
SHULKER_BOX_CONTAINER
SHULKER_BOX_CONTAINER:
30
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:42
SMITHING_TABLE_INPUT_CONTAINER
SMITHING_TABLE_INPUT_CONTAINER:
3
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:12
SMITHING_TABLE_MATERIAL_CONTAINER
SMITHING_TABLE_MATERIAL_CONTAINER:
4
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:13
SMITHING_TABLE_RESULT_PREVIEW_CONTAINER
SMITHING_TABLE_RESULT_PREVIEW_CONTAINER:
5
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:14
SMITHING_TABLE_TEMPLATE_CONTAINER
SMITHING_TABLE_TEMPLATE_CONTAINER:
61
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:73
SMOKER_INGREDIENT_CONTAINER
SMOKER_INGREDIENT_CONTAINER:
46
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:58
STONECUTTER_INPUT_CONTAINER
STONECUTTER_INPUT_CONTAINER:
53
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:65
STONECUTTER_RESULT_PREVIEW_CONTAINER
STONECUTTER_RESULT_PREVIEW_CONTAINER:
54
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:66
TRADE_INGREDIENT1_CONTAINER
TRADE_INGREDIENT1_CONTAINER:
31
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:43
TRADE_INGREDIENT2_CONTAINER
TRADE_INGREDIENT2_CONTAINER:
32
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:44
TRADE_RESULT_PREVIEW_CONTAINER
TRADE_RESULT_PREVIEW_CONTAINER:
33
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:45
TRADE2_INGREDIENT1_CONTAINER
TRADE2_INGREDIENT1_CONTAINER:
47
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:59
TRADE2_INGREDIENT2_CONTAINER
TRADE2_INGREDIENT2_CONTAINER:
48
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:60
TRADE2_RESULT_PREVIEW_CONTAINER
TRADE2_RESULT_PREVIEW_CONTAINER:
49
Defined in: minecraft/src/generated/v2193/ContainerUiId.ts:61
ControlScheme
Defined in: protocol/src/structure/CameraPreset.ts:70
The docs' Control Scheme: how movement input maps to the player while the preset is active.
Enumeration Members
CAMERA_RELATIVE
CAMERA_RELATIVE:
1
Defined in: protocol/src/structure/CameraPreset.ts:73
CAMERA_RELATIVE_STRAFE
CAMERA_RELATIVE_STRAFE:
2
Defined in: protocol/src/structure/CameraPreset.ts:74
LOCKED_PLAYER_RELATIVE_STRAFE
LOCKED_PLAYER_RELATIVE_STRAFE:
0
Defined in: protocol/src/structure/CameraPreset.ts:72
The default scheme. The client rejects it inside a custom camera.
PLAYER_RELATIVE
PLAYER_RELATIVE:
3
Defined in: protocol/src/structure/CameraPreset.ts:75
PLAYER_RELATIVE_STRAFE
PLAYER_RELATIVE_STRAFE:
4
Defined in: protocol/src/structure/CameraPreset.ts:76
CreativeItemCategory
Defined in: protocol/src/packet/CreativeContentPacket.ts:14
The docs' CreativeItemCategory: which tab of the creative menu a group belongs to.
The game data names a group's tab in words, which creativeCategoryOf turns into one of these.
Enumeration Members
ALL
ALL:
0
Defined in: protocol/src/packet/CreativeContentPacket.ts:15
CONSTRUCTION
CONSTRUCTION:
1
Defined in: protocol/src/packet/CreativeContentPacket.ts:16
EQUIPMENT
EQUIPMENT:
3
Defined in: protocol/src/packet/CreativeContentPacket.ts:18
ITEM_COMMAND_ONLY
ITEM_COMMAND_ONLY:
5
Defined in: protocol/src/packet/CreativeContentPacket.ts:20
ITEMS
ITEMS:
4
Defined in: protocol/src/packet/CreativeContentPacket.ts:19
NATURE
NATURE:
2
Defined in: protocol/src/packet/CreativeContentPacket.ts:17
UNDEFINED
UNDEFINED:
6
Defined in: protocol/src/packet/CreativeContentPacket.ts:21
CreditsState
Defined in: protocol/src/packet/ShowCreditsPacket.ts:7
The docs' CreditsState: whether the credits are starting or have finished.
Enumeration Members
Finished
Finished:
1
Defined in: protocol/src/packet/ShowCreditsPacket.ts:11
Client to server: the player watched them to the end or skipped them.
Start
Start:
0
Defined in: protocol/src/packet/ShowCreditsPacket.ts:9
Server to client: roll the credits.
CursorItemDragState
Defined in: protocol/src/wire/definitions/added2225.ts:42
CursorItemDragState: which end of a cursor split-drag this packet reports.
Enumeration Members
Start
Start:
0
Defined in: protocol/src/wire/definitions/added2225.ts:43
Stop
Stop:
1
Defined in: protocol/src/wire/definitions/added2225.ts:44
DataDrivenScreenClosedReason
Defined in: protocol/src/packet/ServerboundDataDrivenScreenClosedPacket.ts:12
The docs' DataDrivenScreenClosedReason. The schema gives the field no Enum-as-Value option, so the member name travels as a lowercase string rather than its number. The datagen snapshot numbers the members 0 to 4 in this order; those numbers never reach the wire. The strings match what gophertunnel and PocketMine read from real clients.
Enumeration Members
ClientCanceled
ClientCanceled:
"clientcanceled"
Defined in: protocol/src/packet/ServerboundDataDrivenScreenClosedPacket.ts:18
Docs: ClientCanceled (2). The player dismissed the screen.
InvalidForm
InvalidForm:
"invalidform"
Defined in: protocol/src/packet/ServerboundDataDrivenScreenClosedPacket.ts:22
Docs: InvalidForm (4). The client could not show the screen it was asked for.
ProgrammaticClose
ProgrammaticClose:
"programmaticclose"
Defined in: protocol/src/packet/ServerboundDataDrivenScreenClosedPacket.ts:14
Docs: ProgrammaticClose (0). The server closed this one screen.
ProgrammaticCloseAll
ProgrammaticCloseAll:
"programmaticcloseall"
Defined in: protocol/src/packet/ServerboundDataDrivenScreenClosedPacket.ts:16
Docs: ProgrammaticCloseAll (1). The server closed every screen.
UserBusy
UserBusy:
"userbusy"
Defined in: protocol/src/packet/ServerboundDataDrivenScreenClosedPacket.ts:20
Docs: UserBusy (3). The client could not show the screen because another one was open.
DataStoreEntryType
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:11
The alternatives of an Updates entry, numbered by their position in the schema's oneOf. The number is the varuint32 selector that opens each entry.
Enumeration Members
CHANGE
CHANGE:
1
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:15
A Data Store Change: a whole property and its new value.
REMOVAL
REMOVAL:
2
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:17
A Data Store Removal: a whole data store is gone.
UPDATE
UPDATE:
0
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:13
A Data Store Update: one path of one property and its new value.
DataStorePropertyType
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:25
The type tag of a Data Store Change's The New Property Value. The docs describe the field only as "Dynamic value"; the numbers and encodings are gophertunnel's for protocol 2193.
Enumeration Members
BOOL
BOOL:
1
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:29
One boolean byte.
DOUBLE
DOUBLE:
3
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:33
A little-endian double.
INT64
INT64:
2
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:31
A little-endian int64.
LIST
LIST:
5
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:37
A varuint32 count, then that many property values.
MAP
MAP:
6
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:39
A varuint32 count, then that many string keys each followed by a property value.
NONE
NONE:
0
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:27
No value follows.
STRING
STRING:
4
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:35
A string.
DataStoreValueType
Defined in: protocol/src/structure/DataStoreUpdate.ts:8
The alternatives of a Data Store Update's Data one-of, numbered by their position in the schema's oneOf. The number is the varuint32 selector that precedes the value.
Enumeration Members
BOOLEAN
BOOLEAN:
1
Defined in: protocol/src/structure/DataStoreUpdate.ts:12
Variant 1: one boolean byte.
DOUBLE
DOUBLE:
0
Defined in: protocol/src/structure/DataStoreUpdate.ts:10
Variant 0: a little-endian double.
STRING
STRING:
2
Defined in: protocol/src/structure/DataStoreUpdate.ts:14
Variant 2: a string, at most 5000 bytes.
DebugRendererType
Defined in: protocol/src/packet/ClientboundDebugRendererPacket.ts:8
The client-side debug renderer operation names sent as strings.
Enumeration Members
AddDebugMarkerCube
AddDebugMarkerCube:
"adddebugmarkercube"
Defined in: protocol/src/packet/ClientboundDebugRendererPacket.ts:10
ClearDebugMarkers
ClearDebugMarkers:
"cleardebugmarkers"
Defined in: protocol/src/packet/ClientboundDebugRendererPacket.ts:9
EasingType
Defined in: protocol/src/structure/CameraInstruction.ts:11
The docs' EasingType: the uint8 type of a set instruction's ease. Lowercasing a member name gives the easing_function string the FOV and spline instructions write instead (EasingFunction).
Enumeration Members
IN_BACK
IN_BACK:
26
Defined in: protocol/src/structure/CameraInstruction.ts:38
IN_BOUNCE
IN_BOUNCE:
23
Defined in: protocol/src/structure/CameraInstruction.ts:35
IN_CIRC
IN_CIRC:
20
Defined in: protocol/src/structure/CameraInstruction.ts:32
IN_CUBIC
IN_CUBIC:
5
Defined in: protocol/src/structure/CameraInstruction.ts:17
IN_ELASTIC
IN_ELASTIC:
29
Defined in: protocol/src/structure/CameraInstruction.ts:41
IN_EXPO
IN_EXPO:
17
Defined in: protocol/src/structure/CameraInstruction.ts:29
IN_OUT_BACK
IN_OUT_BACK:
28
Defined in: protocol/src/structure/CameraInstruction.ts:40
IN_OUT_BOUNCE
IN_OUT_BOUNCE:
25
Defined in: protocol/src/structure/CameraInstruction.ts:37
IN_OUT_CIRC
IN_OUT_CIRC:
22
Defined in: protocol/src/structure/CameraInstruction.ts:34
IN_OUT_CUBIC
IN_OUT_CUBIC:
7
Defined in: protocol/src/structure/CameraInstruction.ts:19
IN_OUT_ELASTIC
IN_OUT_ELASTIC:
31
Defined in: protocol/src/structure/CameraInstruction.ts:43
IN_OUT_EXPO
IN_OUT_EXPO:
19
Defined in: protocol/src/structure/CameraInstruction.ts:31
IN_OUT_QUAD
IN_OUT_QUAD:
4
Defined in: protocol/src/structure/CameraInstruction.ts:16
IN_OUT_QUART
IN_OUT_QUART:
10
Defined in: protocol/src/structure/CameraInstruction.ts:22
IN_OUT_QUINT
IN_OUT_QUINT:
13
Defined in: protocol/src/structure/CameraInstruction.ts:25
IN_OUT_SINE
IN_OUT_SINE:
16
Defined in: protocol/src/structure/CameraInstruction.ts:28
IN_QUAD
IN_QUAD:
2
Defined in: protocol/src/structure/CameraInstruction.ts:14
IN_QUART
IN_QUART:
8
Defined in: protocol/src/structure/CameraInstruction.ts:20
IN_QUINT
IN_QUINT:
11
Defined in: protocol/src/structure/CameraInstruction.ts:23
IN_SINE
IN_SINE:
14
Defined in: protocol/src/structure/CameraInstruction.ts:26
LINEAR
LINEAR:
0
Defined in: protocol/src/structure/CameraInstruction.ts:12
OUT_BACK
OUT_BACK:
27
Defined in: protocol/src/structure/CameraInstruction.ts:39
OUT_BOUNCE
OUT_BOUNCE:
24
Defined in: protocol/src/structure/CameraInstruction.ts:36
OUT_CIRC
OUT_CIRC:
21
Defined in: protocol/src/structure/CameraInstruction.ts:33
OUT_CUBIC
OUT_CUBIC:
6
Defined in: protocol/src/structure/CameraInstruction.ts:18
OUT_ELASTIC
OUT_ELASTIC:
30
Defined in: protocol/src/structure/CameraInstruction.ts:42
OUT_EXPO
OUT_EXPO:
18
Defined in: protocol/src/structure/CameraInstruction.ts:30
OUT_QUAD
OUT_QUAD:
3
Defined in: protocol/src/structure/CameraInstruction.ts:15
OUT_QUART
OUT_QUART:
9
Defined in: protocol/src/structure/CameraInstruction.ts:21
OUT_QUINT
OUT_QUINT:
12
Defined in: protocol/src/structure/CameraInstruction.ts:24
OUT_SINE
OUT_SINE:
15
Defined in: protocol/src/structure/CameraInstruction.ts:27
SPRING
SPRING:
1
Defined in: protocol/src/structure/CameraInstruction.ts:13
EditorLevelMigrationVersion
Defined in: protocol/src/packet/StartGamePacket.ts:21
EditorLevelMigrationVersion values carried from protocol 2225.
Enumeration Members
EditorAchievements
EditorAchievements:
1
Defined in: protocol/src/packet/StartGamePacket.ts:23
Legacy
Legacy:
0
Defined in: protocol/src/packet/StartGamePacket.ts:22
EmoteFlags
Defined in: protocol/src/packet/EmotePacket.ts:7
Bits of the Flags byte in an EmotePacket.
Enumeration Members
MuteChat
MuteChat:
2
Defined in: protocol/src/packet/EmotePacket.ts:11
The emote's chat message should not be shown.
ServerSide
ServerSide:
1
Defined in: protocol/src/packet/EmotePacket.ts:9
Set by the server on the copy it relays, so clients do not treat it as their own request.
EnchantType
Defined in: minecraft/src/generated/v2193/EnchantType.ts:8
EnchantType, from Mojang's published protocol documentation.
Generated - do not edit. Change datagen/manifest.json and run pnpm generate. Source: Mojang/bedrock-protocol-docs release v1.26.51 (Minecraft 1.26.51, protocol 2193) Upstream name: Enchant::Type
Enumeration Members
AQUA_AFFINITY
AQUA_AFFINITY:
8
Defined in: minecraft/src/generated/v2193/EnchantType.ts:17
BANE_OF_ARTHROPODS
BANE_OF_ARTHROPODS:
11
Defined in: minecraft/src/generated/v2193/EnchantType.ts:20
BLAST_PROTECTION
BLAST_PROTECTION:
3
Defined in: minecraft/src/generated/v2193/EnchantType.ts:12
BREACH
BREACH:
40
Defined in: minecraft/src/generated/v2193/EnchantType.ts:49
CHANNELING
CHANNELING:
32
Defined in: minecraft/src/generated/v2193/EnchantType.ts:41
CURSE_OF_BINDING
CURSE_OF_BINDING:
27
Defined in: minecraft/src/generated/v2193/EnchantType.ts:36
CURSE_OF_VANISHING
CURSE_OF_VANISHING:
28
Defined in: minecraft/src/generated/v2193/EnchantType.ts:37
DENSITY
DENSITY:
39
Defined in: minecraft/src/generated/v2193/EnchantType.ts:48
DEPTH_STRIDER
DEPTH_STRIDER:
7
Defined in: minecraft/src/generated/v2193/EnchantType.ts:16
EFFICIENCY
EFFICIENCY:
15
Defined in: minecraft/src/generated/v2193/EnchantType.ts:24
FEATHER_FALLING
FEATHER_FALLING:
2
Defined in: minecraft/src/generated/v2193/EnchantType.ts:11
FIRE_ASPECT
FIRE_ASPECT:
13
Defined in: minecraft/src/generated/v2193/EnchantType.ts:22
FIRE_PROTECTION
FIRE_PROTECTION:
1
Defined in: minecraft/src/generated/v2193/EnchantType.ts:10
FLAME
FLAME:
21
Defined in: minecraft/src/generated/v2193/EnchantType.ts:30
FORTUNE
FORTUNE:
18
Defined in: minecraft/src/generated/v2193/EnchantType.ts:27
FROST_WALKER
FROST_WALKER:
25
Defined in: minecraft/src/generated/v2193/EnchantType.ts:34
IMPALING
IMPALING:
29
Defined in: minecraft/src/generated/v2193/EnchantType.ts:38
INFINITY
INFINITY:
22
Defined in: minecraft/src/generated/v2193/EnchantType.ts:31
INVALID_ENCHANTMENT
INVALID_ENCHANTMENT:
43
Defined in: minecraft/src/generated/v2193/EnchantType.ts:52
KNOCKBACK
KNOCKBACK:
12
Defined in: minecraft/src/generated/v2193/EnchantType.ts:21
LOOTING
LOOTING:
14
Defined in: minecraft/src/generated/v2193/EnchantType.ts:23
LOYALTY
LOYALTY:
31
Defined in: minecraft/src/generated/v2193/EnchantType.ts:40
LUCK_OF_THE_SEA
LUCK_OF_THE_SEA:
23
Defined in: minecraft/src/generated/v2193/EnchantType.ts:32
LUNGE
LUNGE:
41
Defined in: minecraft/src/generated/v2193/EnchantType.ts:50
LURE
LURE:
24
Defined in: minecraft/src/generated/v2193/EnchantType.ts:33
MENDING
MENDING:
26
Defined in: minecraft/src/generated/v2193/EnchantType.ts:35
MULTISHOT
MULTISHOT:
33
Defined in: minecraft/src/generated/v2193/EnchantType.ts:42
NUM_ENCHANTMENTS
NUM_ENCHANTMENTS:
42
Defined in: minecraft/src/generated/v2193/EnchantType.ts:51
PIERCING
PIERCING:
34
Defined in: minecraft/src/generated/v2193/EnchantType.ts:43
POWER
POWER:
19
Defined in: minecraft/src/generated/v2193/EnchantType.ts:28
PROJECTILE_PROTECTION
PROJECTILE_PROTECTION:
4
Defined in: minecraft/src/generated/v2193/EnchantType.ts:13
PROTECTION
PROTECTION:
0
Defined in: minecraft/src/generated/v2193/EnchantType.ts:9
PUNCH
PUNCH:
20
Defined in: minecraft/src/generated/v2193/EnchantType.ts:29
QUICK_CHARGE
QUICK_CHARGE:
35
Defined in: minecraft/src/generated/v2193/EnchantType.ts:44
RESPIRATION
RESPIRATION:
6
Defined in: minecraft/src/generated/v2193/EnchantType.ts:15
RIPTIDE
RIPTIDE:
30
Defined in: minecraft/src/generated/v2193/EnchantType.ts:39
SHARPNESS
SHARPNESS:
9
Defined in: minecraft/src/generated/v2193/EnchantType.ts:18
SILK_TOUCH
SILK_TOUCH:
16
Defined in: minecraft/src/generated/v2193/EnchantType.ts:25
SMITE
SMITE:
10
Defined in: minecraft/src/generated/v2193/EnchantType.ts:19
SOUL_SPEED
SOUL_SPEED:
36
Defined in: minecraft/src/generated/v2193/EnchantType.ts:45
SWIFT_SNEAK
SWIFT_SNEAK:
37
Defined in: minecraft/src/generated/v2193/EnchantType.ts:46
THORNS
THORNS:
5
Defined in: minecraft/src/generated/v2193/EnchantType.ts:14
UNBREAKING
UNBREAKING:
17
Defined in: minecraft/src/generated/v2193/EnchantType.ts:26
WIND_BURST
WIND_BURST:
38
Defined in: minecraft/src/generated/v2193/EnchantType.ts:47
EntityOverrideUpdateType
Defined in: protocol/src/packet/PlayerUpdateEntityOverridesPacket.ts:11
Which alternative of the Update variant a PlayerUpdateEntityOverridesPacket carries. The value is the alternative's index in the schema's oneOf, written as the varuint32 selector, and matches the docs' UpdateType order.
Enumeration Members
ClearOverrides
ClearOverrides:
0
Defined in: protocol/src/packet/PlayerUpdateEntityOverridesPacket.ts:13
ClearOverride: drop every override the client holds for the entity.
RemoveOverride
RemoveOverride:
1
Defined in: protocol/src/packet/PlayerUpdateEntityOverridesPacket.ts:15
RemoveOverride: drop the override of the one property Property Index names.
SetFloatOverride
SetFloatOverride:
3
Defined in: protocol/src/packet/PlayerUpdateEntityOverridesPacket.ts:19
FloatOverride: set a float override for the property.
SetIntOverride
SetIntOverride:
2
Defined in: protocol/src/packet/PlayerUpdateEntityOverridesPacket.ts:17
IntOverride: set an integer override for the property.
FloatAttributeOperation
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:35
The docs enum FloatAttributeOperation: how a float attribute combines with the layers below it.
Enumeration Members
ADD
ADD:
2
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:38
ALPHA_BLEND
ALPHA_BLEND:
1
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:37
MAXIMUM
MAXIMUM:
6
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:42
MINIMUM
MINIMUM:
5
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:41
MULTIPLY
MULTIPLY:
4
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:40
OVERRIDE
OVERRIDE:
0
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:36
SUBTRACT
SUBTRACT:
3
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:39
FurnaceLayout
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:25
A FurnaceLayout: how the furnace screen is arranged.
Enumeration Members
Default
Default:
2
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:28
InventoryOnly
InventoryOnly:
1
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:27
None
None:
0
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:26
FurnaceLeftTabIndex
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:15
A FurnaceLeftTabIndex: the tab open on the left of the furnace screen.
Enumeration Members
Inventory
Inventory:
5
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:21
None
None:
0
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:16
RecipeBlocks
RecipeBlocks:
3
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:19
RecipeFood
RecipeFood:
1
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:17
RecipeItems
RecipeItems:
2
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:18
RecipeSearch
RecipeSearch:
4
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:20
FurnaceType
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:7
The docs' SetPlayerFurnaceOptionsPacketPayload FurnaceType: which furnace screen the options belong to.
Enumeration Members
BlastFurnace
BlastFurnace:
2
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:10
Furnace
Furnace:
1
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:9
None
None:
0
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:8
Smoker
Smoker:
3
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:11
GameRuleType
Defined in: protocol/src/packet/GameRuleType.ts:7
What kind of value a game rule carries, which is written in front of the value.
Lives in its own module so the wire definition and StartGamePacket can both use it without importing each other.
Enumeration Members
BOOL
BOOL:
1
Defined in: protocol/src/packet/GameRuleType.ts:9
FLOAT
FLOAT:
3
Defined in: protocol/src/packet/GameRuleType.ts:11
INT
INT:
2
Defined in: protocol/src/packet/GameRuleType.ts:10
NONE
NONE:
0
Defined in: protocol/src/packet/GameRuleType.ts:8
GraphicsMode
Defined in: protocol/src/packet/UpdateClientOptionsPacket.ts:4
The client's graphics setting, as GraphicsMode numbers it.
Enumeration Members
Advanced
Advanced:
2
Defined in: protocol/src/packet/UpdateClientOptionsPacket.ts:7
Fancy
Fancy:
1
Defined in: protocol/src/packet/UpdateClientOptionsPacket.ts:6
RayTraced
RayTraced:
3
Defined in: protocol/src/packet/UpdateClientOptionsPacket.ts:8
Simple
Simple:
0
Defined in: protocol/src/packet/UpdateClientOptionsPacket.ts:5
GraphicsOverrideParameterType
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:11
GraphicsOverrideParameterType: which rendering parameter a GraphicsOverrideParameterPacket sets, written as a uint8 with these values. Mojang's enum dump and gophertunnel agree on the numbering.
Enumeration Members
AMBIENT_COLOR
AMBIENT_COLOR:
47
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:107
Docs: AmbientColor, lighting.
AMBIENT_ILLUMINANCE
AMBIENT_ILLUMINANCE:
48
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:109
Docs: AmbientIlluminance, lighting.
CDOM
CDOM:
11
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:35
Docs: CDOM, the water's colored dissolved organic matter.
CHLOROPHYLL
CHLOROPHYLL:
10
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:33
Docs: Chlorophyll, a water parameter.
EMISSIVE_DESATURATION
EMISSIVE_DESATURATION:
49
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:111
Docs: EmissiveDesaturation, lighting.
FLASH_COLOR
FLASH_COLOR:
45
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:103
Docs: FlashColor, lighting.
FLASH_ILLUMINANCE
FLASH_ILLUMINANCE:
46
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:105
Docs: FlashIlluminance, lighting.
HIGHLIGHTS_CONTRAST
HIGHLIGHTS_CONTRAST:
24
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:61
Docs: HighlightsContrast, color grading.
HIGHLIGHTS_GAIN
HIGHLIGHTS_GAIN:
26
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:65
Docs: HighlightsGain, color grading.
HIGHLIGHTS_GAMMA
HIGHLIGHTS_GAMMA:
27
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:67
Docs: HighlightsGamma, color grading.
HIGHLIGHTS_MIN
HIGHLIGHTS_MIN:
38
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:89
Docs: HighlightsMin, color grading.
HIGHLIGHTS_OFFSET
HIGHLIGHTS_OFFSET:
28
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:69
Docs: HighlightsOffset, color grading.
HIGHLIGHTS_SATURATION
HIGHLIGHTS_SATURATION:
29
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:71
Docs: HighlightsSaturation, color grading.
HORIZON_BLEND_MAX
HORIZON_BLEND_MAX:
3
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:19
Docs: HorizonBlendMax.
HORIZON_BLEND_MIE_START
HORIZON_BLEND_MIE_START:
5
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:23
Docs: HorizonBlendMieStart.
HORIZON_BLEND_MIN
HORIZON_BLEND_MIN:
2
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:17
Docs: HorizonBlendMin.
HORIZON_BLEND_START
HORIZON_BLEND_START:
4
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:21
Docs: HorizonBlendStart.
MIDTONES_CONTRAST
MIDTONES_CONTRAST:
23
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:59
Docs: MidtonesContrast, color grading.
MIDTONES_GAIN
MIDTONES_GAIN:
30
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:73
Docs: MidtonesGain, color grading.
MIDTONES_GAMMA
MIDTONES_GAMMA:
31
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:75
Docs: MidtonesGamma, color grading.
MIDTONES_OFFSET
MIDTONES_OFFSET:
32
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:77
Docs: MidtonesOffset, color grading.
MIDTONES_SATURATION
MIDTONES_SATURATION:
33
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:79
Docs: MidtonesSaturation, color grading.
MOON_COLOR
MOON_COLOR:
43
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:99
Docs: MoonColor, lighting.
MOON_ILLUMINANCE
MOON_ILLUMINANCE:
44
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:101
Docs: MoonIlluminance, lighting.
MOON_MIE_STRENGTH
MOON_MIE_STRENGTH:
8
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:29
Docs: MoonMieStrength.
ORBITAL_OFFSET_DEGREES
ORBITAL_OFFSET_DEGREES:
51
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:115
Docs: OrbitalOffsetDegrees, lighting.
RAYLEIGH_STRENGTH
RAYLEIGH_STRENGTH:
6
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:25
Docs: RayleighStrength.
SHADOWS_CONTRAST
SHADOWS_CONTRAST:
25
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:63
Docs: ShadowsContrast, color grading.
SHADOWS_GAIN
SHADOWS_GAIN:
34
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:81
Docs: ShadowsGain, color grading.
SHADOWS_GAMMA
SHADOWS_GAMMA:
35
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:83
Docs: ShadowsGamma, color grading.
SHADOWS_MAX
SHADOWS_MAX:
39
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:91
Docs: ShadowsMax, color grading.
SHADOWS_OFFSET
SHADOWS_OFFSET:
36
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:85
Docs: ShadowsOffset, color grading.
SHADOWS_SATURATION
SHADOWS_SATURATION:
37
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:87
Docs: ShadowsSaturation, color grading.
SKY_HORIZON_COLOR
SKY_HORIZON_COLOR:
1
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:15
Docs: SkyHorizonColor.
SKY_INTENSITY
SKY_INTENSITY:
50
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:113
Docs: SkyIntensity, lighting.
SKY_ZENITH_COLOR
SKY_ZENITH_COLOR:
0
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:13
Docs: SkyZenithColor.
SUN_COLOR
SUN_COLOR:
41
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:95
Docs: SunColor, lighting.
SUN_GLARE_SHAPE
SUN_GLARE_SHAPE:
9
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:31
Docs: SunGlareShape.
SUN_ILLUMINANCE
SUN_ILLUMINANCE:
42
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:97
Docs: SunIlluminance, lighting.
SUN_MIE_STRENGTH
SUN_MIE_STRENGTH:
7
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:27
Docs: SunMieStrength.
SUSPENDED_SEDIMENT
SUSPENDED_SEDIMENT:
12
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:37
Docs: SuspendedSediment, a water parameter.
TEMPERATURE
TEMPERATURE:
40
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:93
Docs: Temperature, color grading.
WAVES_DEPTH
WAVES_DEPTH:
13
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:39
Docs: WavesDepth.
WAVES_DIRECTION_INCREMENT
WAVES_DIRECTION_INCREMENT:
22
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:57
Docs: WavesDirectionIncrement.
WAVES_FREQUENCY
WAVES_FREQUENCY:
14
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:41
Docs: WavesFrequency.
WAVES_FREQUENCY_SCALING
WAVES_FREQUENCY_SCALING:
15
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:43
Docs: WavesFrequencyScaling.
WAVES_MIX
WAVES_MIX:
20
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:53
Docs: WavesMix.
WAVES_OCTAVES
WAVES_OCTAVES:
19
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:51
Docs: WavesOctaves.
WAVES_PULL
WAVES_PULL:
21
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:55
Docs: WavesPull.
WAVES_SHAPE
WAVES_SHAPE:
18
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:49
Docs: WavesShape.
WAVES_SPEED
WAVES_SPEED:
16
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:45
Docs: WavesSpeed.
WAVES_SPEED_SCALING
WAVES_SPEED_SCALING:
17
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:47
Docs: WavesSpeedScaling.
HandSlot
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:35
Which hand an item was used from. The docs' HandSlot.
Enumeration Members
MAINHAND
MAINHAND:
0
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:36
OFFHAND
OFFHAND:
1
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:37
HeightMapDataType
Defined in: protocol/src/structure/SubChunkHeightmapData.ts:11
The docs enum HeightMapDataType: what a sub chunk contributes to the client's heightmap.
AllCopied is only valid for Render Height Map Type and means the render heightmap equals the regular one.
Enumeration Members
ALL_COPIED
ALL_COPIED:
4
Defined in: protocol/src/structure/SubChunkHeightmapData.ts:21
The render heightmap is a copy of the regular heightmap.
ALL_TOO_HIGH
ALL_TOO_HIGH:
2
Defined in: protocol/src/structure/SubChunkHeightmapData.ts:17
Every column's surface lies above this sub chunk.
ALL_TOO_LOW
ALL_TOO_LOW:
3
Defined in: protocol/src/structure/SubChunkHeightmapData.ts:19
Every column's surface lies below this sub chunk.
HAS_DATA
HAS_DATA:
1
Defined in: protocol/src/structure/SubChunkHeightmapData.ts:15
A 16 by 16 heightmap follows.
NO_DATA
NO_DATA:
0
Defined in: protocol/src/structure/SubChunkHeightmapData.ts:13
No heightmap information.
HudElement
Defined in: protocol/src/packet/SetHudPacket.ts:7
A HudElement the /hud command can hide. The values are the ones the wire carries.
Enumeration Members
AirBubbles
AirBubbles:
9
Defined in: protocol/src/packet/SetHudPacket.ts:17
Armor
Armor:
1
Defined in: protocol/src/packet/SetHudPacket.ts:9
Crosshair
Crosshair:
4
Defined in: protocol/src/packet/SetHudPacket.ts:12
Health
Health:
6
Defined in: protocol/src/packet/SetHudPacket.ts:14
HorseHealth
HorseHealth:
10
Defined in: protocol/src/packet/SetHudPacket.ts:18
HotBar
HotBar:
5
Defined in: protocol/src/packet/SetHudPacket.ts:13
Hunger
Hunger:
8
Defined in: protocol/src/packet/SetHudPacket.ts:16
ItemText
ItemText:
12
Defined in: protocol/src/packet/SetHudPacket.ts:20
PaperDoll
PaperDoll:
0
Defined in: protocol/src/packet/SetHudPacket.ts:8
ProgressBar
ProgressBar:
7
Defined in: protocol/src/packet/SetHudPacket.ts:15
StatusEffects
StatusEffects:
11
Defined in: protocol/src/packet/SetHudPacket.ts:19
ToolTips
ToolTips:
2
Defined in: protocol/src/packet/SetHudPacket.ts:10
TouchControls
TouchControls:
3
Defined in: protocol/src/packet/SetHudPacket.ts:11
HudVisibility
Defined in: protocol/src/packet/SetHudPacket.ts:24
A HudVisibility: whether the listed elements are hidden or restored to the player's own settings.
Enumeration Members
Hide
Hide:
0
Defined in: protocol/src/packet/SetHudPacket.ts:25
Reset
Reset:
1
Defined in: protocol/src/packet/SetHudPacket.ts:26
InputMode
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:106
The input device, as the packet's Input Mode field numbers it.
Enumeration Members
Count
Count:
5
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:114
One past the last mode; a client cannot send this value.
GamePad
GamePad:
3
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:110
MotionController_Deprecated
MotionController_Deprecated:
4
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:112
Retained in the enum although the docs' member list omits it.
Mouse
Mouse:
1
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:108
Touch
Touch:
2
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:109
Undefined
Undefined:
0
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:107
InteractAction
Defined in: protocol/src/packet/InteractPacket.ts:15
The docs' InteractPacket::Action: what the client did to the target actor, written as a uint8.
The 1.26.50 docs page numbers the members 1 to 4, but clients send 3 to 6, which is what the page's own 2207 changelog and gophertunnel record.
Enumeration Members
InteractUpdate
InteractUpdate:
4
Defined in: protocol/src/packet/InteractPacket.ts:18
Invalid
Invalid:
0
Defined in: protocol/src/packet/InteractPacket.ts:16
NpcOpen
NpcOpen:
5
Defined in: protocol/src/packet/InteractPacket.ts:19
OpenInventory
OpenInventory:
6
Defined in: protocol/src/packet/InteractPacket.ts:20
StopRiding
StopRiding:
3
Defined in: protocol/src/packet/InteractPacket.ts:17
InventoryLayout
Defined in: minecraft/src/generated/v2193/InventoryLayout.ts:8
InventoryLayout, from Mojang's published protocol documentation.
Generated - do not edit. Change datagen/manifest.json and run pnpm generate. Source: Mojang/bedrock-protocol-docs release v1.26.51 (Minecraft 1.26.51, protocol 2193) Upstream name: InventoryLayout
Enumeration Members
DEFAULT
DEFAULT:
2
Defined in: minecraft/src/generated/v2193/InventoryLayout.ts:11
INVENTORY_ONLY
INVENTORY_ONLY:
1
Defined in: minecraft/src/generated/v2193/InventoryLayout.ts:10
NONE
NONE:
0
Defined in: minecraft/src/generated/v2193/InventoryLayout.ts:9
RECIPE_BOOK_ONLY
RECIPE_BOOK_ONLY:
3
Defined in: minecraft/src/generated/v2193/InventoryLayout.ts:12
InventoryLeftTab
Defined in: minecraft/src/generated/v2193/InventoryLeftTab.ts:8
InventoryLeftTab, from Mojang's published protocol documentation.
Generated - do not edit. Change datagen/manifest.json and run pnpm generate. Source: Mojang/bedrock-protocol-docs release v1.26.51 (Minecraft 1.26.51, protocol 2193) Upstream name: InventoryLeftTabIndex
Enumeration Members
NONE
NONE:
0
Defined in: minecraft/src/generated/v2193/InventoryLeftTab.ts:9
RECIPE_CONSTRUCTION
RECIPE_CONSTRUCTION:
1
Defined in: minecraft/src/generated/v2193/InventoryLeftTab.ts:10
RECIPE_EQUIPMENT
RECIPE_EQUIPMENT:
2
Defined in: minecraft/src/generated/v2193/InventoryLeftTab.ts:11
RECIPE_ITEMS
RECIPE_ITEMS:
3
Defined in: minecraft/src/generated/v2193/InventoryLeftTab.ts:12
RECIPE_NATURE
RECIPE_NATURE:
4
Defined in: minecraft/src/generated/v2193/InventoryLeftTab.ts:13
RECIPE_SEARCH
RECIPE_SEARCH:
5
Defined in: minecraft/src/generated/v2193/InventoryLeftTab.ts:14
SURVIVAL
SURVIVAL:
6
Defined in: minecraft/src/generated/v2193/InventoryLeftTab.ts:15
InventoryRightTab
Defined in: minecraft/src/generated/v2193/InventoryRightTab.ts:8
InventoryRightTab, from Mojang's published protocol documentation.
Generated - do not edit. Change datagen/manifest.json and run pnpm generate. Source: Mojang/bedrock-protocol-docs release v1.26.51 (Minecraft 1.26.51, protocol 2193) Upstream name: InventoryRightTabIndex
Enumeration Members
ARMOR
ARMOR:
3
Defined in: minecraft/src/generated/v2193/InventoryRightTab.ts:12
CRAFTING
CRAFTING:
2
Defined in: minecraft/src/generated/v2193/InventoryRightTab.ts:11
FULL_SCREEN
FULL_SCREEN:
1
Defined in: minecraft/src/generated/v2193/InventoryRightTab.ts:10
NONE
NONE:
0
Defined in: minecraft/src/generated/v2193/InventoryRightTab.ts:9
InventorySourceType
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:77
The docs' InventorySourceType: which inventory an action's slot belongs to.
The docs name five: Container Inventory, Global Inventory, World Interaction, Creative Inventory and Non Implemented Feature TODO. Every member is a wire value; a source the client sends that is not one of these stays on the action as the number it was.
Enumeration Members
CONTAINER
CONTAINER:
0
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:79
Container Inventory.
CREATIVE
CREATIVE:
3
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:85
Creative Inventory.
GLOBAL
GLOBAL:
1
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:81
Global Inventory.
NON_IMPLEMENTED_TODO
NON_IMPLEMENTED_TODO:
99999
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:94
Non Implemented Feature TODO.
The 2193 docs page lists this as 4 because the schema carries no values and the page numbers such members in order. The 2207 page's changelog "changes" it to 99999, the value gophertunnel and PocketMine have read and written at every protocol, and the one the client sends.
WORLD
WORLD:
2
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:83
World Interaction.
ItemReleaseActionType
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:63
Why the client let go of a held item in ItemReleaseInventoryTransaction.
Enumeration Members
RELEASE
RELEASE:
0
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:65
A bow fired, or a held item was let go of.
USE
USE:
1
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:67
A crossbow finished charging.
ItemStackRequestActionType
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:8
ItemStackRequestActionType, from Mojang's published protocol documentation.
Generated - do not edit. Change datagen/manifest.json and run pnpm generate. Source: Mojang/bedrock-protocol-docs release v1.26.51 (Minecraft 1.26.51, protocol 2193) Upstream name: ItemStackRequestActionType
Enumeration Members
BEACON_PAYMENT
BEACON_PAYMENT:
10
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:17
CRAFT_REPAIR_AND_DISENCHANT
CRAFT_REPAIR_AND_DISENCHANT:
16
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:23
CRAFTING_CONSUME_INPUT
CRAFTING_CONSUME_INPUT:
5
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:14
CRAFTING_CREATE_SPECIFIC_RESULT
CRAFTING_CREATE_SPECIFIC_RESULT:
6
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:15
CRAFTING_LOOM
CRAFTING_LOOM:
17
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:24
CRAFTING_NON_IMPLEMENTED_DEPRECATED
CRAFTING_NON_IMPLEMENTED_DEPRECATED:
18
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:25
CRAFTING_RECIPE
CRAFTING_RECIPE:
12
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:19
CRAFTING_RECIPE_AUTO
CRAFTING_RECIPE_AUTO:
13
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:20
CRAFTING_RECIPE_OPTIONAL
CRAFTING_RECIPE_OPTIONAL:
15
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:22
CRAFTING_RESULTS_DEPRECATED
CRAFTING_RESULTS_DEPRECATED:
19
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:26
CREATIVE_CREATE
CREATIVE_CREATE:
14
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:21
DESTROY
DESTROY:
4
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:13
DROP
DROP:
3
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:12
LAB_TABLE_COMBINE
LAB_TABLE_COMBINE:
9
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:16
MINE_BLOCK
MINE_BLOCK:
11
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:18
PLACE
PLACE:
1
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:10
SWAP
SWAP:
2
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:11
TAKE
TAKE:
0
Defined in: minecraft/src/generated/v2193/ItemStackRequestActionType.ts:9
ItemStackResponseResult
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:8
ItemStackResponseResult, from Mojang's published protocol documentation.
Generated - do not edit. Change datagen/manifest.json and run pnpm generate. Source: Mojang/bedrock-protocol-docs release v1.26.51 (Minecraft 1.26.51, protocol 2193) Upstream name: ItemStackNetResult
Enumeration Members
ACTION_REQUEST_NOT_ALLOWED
ACTION_REQUEST_NOT_ALLOWED:
3
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:12
CANNOT_CONSUME_ITEM
CANNOT_CONSUME_ITEM:
66
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:75
CANNOT_DESTROY_ITEM
CANNOT_DESTROY_ITEM:
60
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:69
CANNOT_DROP_ITEM
CANNOT_DROP_ITEM:
59
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:68
CANNOT_PLACE_ITEM
CANNOT_PLACE_ITEM:
55
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:64
CANNOT_REMOVE_ITEM
CANNOT_REMOVE_ITEM:
65
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:74
CANNOT_SWAP_ITEM
CANNOT_SWAP_ITEM:
54
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:63
CONSUMED_ITEM_NOT_ALLOWED
CONSUMED_ITEM_NOT_ALLOWED:
27
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:36
CONSUMED_ITEM_OUT_OF_ALLOWED_SLOT_RANGE
CONSUMED_ITEM_OUT_OF_ALLOWED_SLOT_RANGE:
26
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:35
CONSUMED_TOO_MUCH_FROM_SLOT
CONSUMED_TOO_MUCH_FROM_SLOT:
21
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:30
DST_CONTAINER_AND_SLOT_EQUAL_TO_SRC_CONTAINER_AND_SLOT
DST_CONTAINER_AND_SLOT_EQUAL_TO_SRC_CONTAINER_AND_SLOT:
48
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:57
DST_CONTAINER_EQUAL_TO_CREATED_OUTPUT_CONTAINER
DST_CONTAINER_EQUAL_TO_CREATED_OUTPUT_CONTAINER:
47
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:56
EMPTY_CRAFT_RESULTS
EMPTY_CRAFT_RESULTS:
36
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:45
ERROR
ERROR:
1
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:10
EXPECTED_ANYWHERE_ITEM_NOT_FULLY_CONSUMED
EXPECTED_ANYWHERE_ITEM_NOT_FULLY_CONSUMED:
19
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:28
EXPECTED_ITEM_SLOT_NOT_FULLY_CONSUMED
EXPECTED_ITEM_SLOT_NOT_FULLY_CONSUMED:
18
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:27
FAILED_TO_CRAFT_CREATIVE
FAILED_TO_CRAFT_CREATIVE:
30
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:39
FAILED_TO_ENCHANT
FAILED_TO_ENCHANT:
37
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:46
FAILED_TO_FIND_RECIPE_BY_NET_ID
FAILED_TO_FIND_RECIPE_BY_NET_ID:
32
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:41
FAILED_TO_GET_LEVEL_RECIPE
FAILED_TO_GET_LEVEL_RECIPE:
31
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:40
FAILED_TO_INIT_SPARSE_CONTAINER
FAILED_TO_INIT_SPARSE_CONTAINER:
16
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:25
FAILED_TO_MATCH_EXPECTED_ALLOWED_ANYWHERE_CONSUMED_ITEM
FAILED_TO_MATCH_EXPECTED_ALLOWED_ANYWHERE_CONSUMED_ITEM:
25
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:34
FAILED_TO_MATCH_EXPECTED_SLOT_CONSUMED_ITEM
FAILED_TO_MATCH_EXPECTED_SLOT_CONSUMED_ITEM:
24
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:33
FAILED_TO_SET_CREATED_ITEM_OUTPUT_SLOT
FAILED_TO_SET_CREATED_ITEM_OUTPUT_SLOT:
14
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:23
FAILED_TO_VALIDATE_DST_SLOT
FAILED_TO_VALIDATE_DST_SLOT:
50
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:59
FAILED_TO_VALIDATE_SRC_SLOT
FAILED_TO_VALIDATE_SRC_SLOT:
49
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:58
INSUFFICIENT_PLAYER_LEVEL_TO_ENCHANT
INSUFFICIENT_PLAYER_LEVEL_TO_ENCHANT:
39
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:48
INVALID_ADJUSTED_AMOUNT
INVALID_ADJUSTED_AMOUNT:
51
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:60
INVALID_CRAFT_REQUEST
INVALID_CRAFT_REQUEST:
7
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:16
INVALID_CRAFT_REQUEST_SCREEN
INVALID_CRAFT_REQUEST_SCREEN:
8
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:17
INVALID_CRAFT_RESULT
INVALID_CRAFT_RESULT:
9
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:18
INVALID_CRAFT_RESULT_INDEX
INVALID_CRAFT_RESULT_INDEX:
10
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:19
INVALID_CRAFT_RESULT_ITEM
INVALID_CRAFT_RESULT_ITEM:
11
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:20
INVALID_CRAFT_RESULT_STACK_SIZE
INVALID_CRAFT_RESULT_STACK_SIZE:
64
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:73
INVALID_EXPERIMENTAL_RECIPE_REQUEST
INVALID_EXPERIMENTAL_RECIPE_REQUEST:
29
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:38
INVALID_ITEM_NET_ID
INVALID_ITEM_NET_ID:
12
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:21
INVALID_ITEM_SET_TYPE
INVALID_ITEM_SET_TYPE:
52
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:61
INVALID_NUM_CRAFTS
INVALID_NUM_CRAFTS:
63
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:72
INVALID_REGION
INVALID_REGION:
58
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:67
INVALID_REMOVED_AMOUNT
INVALID_REMOVED_AMOUNT:
57
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:66
INVALID_REQUEST_ACTION_TYPE
INVALID_REQUEST_ACTION_TYPE:
2
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:11
INVALID_REQUEST_CRAFT_ACTION_TYPE
INVALID_REQUEST_CRAFT_ACTION_TYPE:
6
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:15
INVALID_SOURCE_CONTAINER
INVALID_SOURCE_CONTAINER:
61
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:70
INVALID_TRANSFER_AMOUNT
INVALID_TRANSFER_AMOUNT:
53
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:62
ITEM_ALREADY_CONSUMED_FROM_SLOT
ITEM_ALREADY_CONSUMED_FROM_SLOT:
20
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:29
ITEM_NOT_CONSUMED
ITEM_NOT_CONSUMED:
62
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:71
ITEM_REQUEST_ACTION_HANDLER_COMMIT_FAILED
ITEM_REQUEST_ACTION_HANDLER_COMMIT_FAILED:
5
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:14
MISMATCH_SLOT_EXPECTED_CONSUMED_ITEM
MISMATCH_SLOT_EXPECTED_CONSUMED_ITEM:
22
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:31
MISMATCH_SLOT_EXPECTED_CONSUMED_ITEM_NET_ID_VARIANT
MISMATCH_SLOT_EXPECTED_CONSUMED_ITEM_NET_ID_VARIANT:
23
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:32
MISMATCHED_CRAFTING_SIZE
MISMATCHED_CRAFTING_SIZE:
33
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:42
MISMATCHED_RECIPE_FOR_INPUT_GRID_ITEMS
MISMATCHED_RECIPE_FOR_INPUT_GRID_ITEMS:
35
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:44
MISSING_ACTOR
MISSING_ACTOR:
41
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:50
MISSING_CREATED_OUTPUT_CONTAINER
MISSING_CREATED_OUTPUT_CONTAINER:
13
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:22
MISSING_INPUT_ITEM
MISSING_INPUT_ITEM:
38
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:47
MISSING_INPUT_SPARSE_CONTAINER
MISSING_INPUT_SPARSE_CONTAINER:
34
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:43
MISSING_MATERIAL_ITEM
MISSING_MATERIAL_ITEM:
40
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:49
OK
OK:
0
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:9
PLAYER_NOT_IN_CREATIVE_MODE
PLAYER_NOT_IN_CREATIVE_MODE:
28
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:37
PRIMARY_EFFECT_OUT_OF_RANGE
PRIMARY_EFFECT_OUT_OF_RANGE:
43
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:52
PRIMARY_EFFECT_UNAVAILABLE
PRIMARY_EFFECT_UNAVAILABLE:
44
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:53
REQUEST_ALREADY_IN_PROGRESS
REQUEST_ALREADY_IN_PROGRESS:
15
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:24
RESULT_TRANSFER_FAILED
RESULT_TRANSFER_FAILED:
17
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:26
SCREEN_HANDLER_END_REQUEST_FAILED
SCREEN_HANDLER_END_REQUEST_FAILED:
4
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:13
SCREEN_STACK_ERROR
SCREEN_STACK_ERROR:
67
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:76
SECONDARY_EFFECT_OUT_OF_RANGE
SECONDARY_EFFECT_OUT_OF_RANGE:
45
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:54
SECONDARY_EFFECT_UNAVAILABLE
SECONDARY_EFFECT_UNAVAILABLE:
46
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:55
UNHANDLED_ITEM_SET_TYPE
UNHANDLED_ITEM_SET_TYPE:
56
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:65
UNKNOWN_PRIMARY_EFFECT
UNKNOWN_PRIMARY_EFFECT:
42
Defined in: minecraft/src/generated/v2193/ItemStackResponseResult.ts:51
ItemUseActionType
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:41
What the client did with the item in hand in ItemUseInventoryTransaction.
Enumeration Members
DESTROY
DESTROY:
2
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:47
Broke a block.
PLACE
PLACE:
0
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:43
Clicked a block with the item.
USE
USE:
1
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:45
Clicked the air with the item.
USE_AS_ATTACK
USE_AS_ATTACK:
3
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:49
Swung at nothing in particular.
ItemUseMethod
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:13
How an item was used, as the Item Use Method int32 numbers it.
Mojang's page for protocol 2193 leaves the field a bare int32 and lists no members. The values are those of ItemUseMethod in Mojang's enum snapshot at packages/minecraft/datagen/snapshot/v2193/enums.html, which gophertunnel reads the same way.
Enumeration Members
Attack
Attack:
2
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:17
BrushingCompleted
BrushingCompleted:
15
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:30
Consume
Consume:
3
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:18
Dyed
Dyed:
13
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:28
Eat
Eat:
1
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:16
EquipArmor
EquipArmor:
0
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:15
FillBottle
FillBottle:
7
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:22
FillBucket
FillBucket:
8
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:23
Interact
Interact:
11
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:26
OpenedVault
OpenedVault:
16
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:31
Place
Place:
6
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:21
PourBucket
PourBucket:
9
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:24
Retrieved
Retrieved:
12
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:27
Shoot
Shoot:
5
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:20
Throw
Throw:
4
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:19
Traded
Traded:
14
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:29
Unknown
Unknown:
-1
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:14
UseTool
UseTool:
10
Defined in: protocol/src/packet/CompletedUsingItemPacket.ts:25
ItemUseOnActorActionType
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:53
What the client meant by clicking an entity in ItemUseOnActorInventoryTransaction.
Enumeration Members
ATTACK
ATTACK:
1
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:57
Hit the entity.
INTERACT
INTERACT:
0
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:55
Right-clicked the entity for its regular interaction.
ITEM_INTERACT
ITEM_INTERACT:
2
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:59
Used the held item directly on the entity, as with spawn eggs.
ItemVersion
Defined in: protocol/src/structure/ItemData.ts:6
The docs enum ItemVersion, which tells the client how to treat an ItemData entry.
Enumeration Members
DATA_DRIVEN
DATA_DRIVEN:
1
Defined in: protocol/src/structure/ItemData.ts:10
An item defined by the components in Item Component Data.
LEGACY
LEGACY:
0
Defined in: protocol/src/structure/ItemData.ts:8
A built-in item the client already knows.
NONE
NONE:
2
Defined in: protocol/src/structure/ItemData.ts:12
No version.
LabTableReactionType
Defined in: protocol/src/packet/LabTablePacket.ts:15
The reaction effect produced by an Education Edition chemistry lab table.
Enumeration Members
Bleach
Bleach:
2
Defined in: protocol/src/packet/LabTablePacket.ts:18
ElephantToothpaste
ElephantToothpaste:
3
Defined in: protocol/src/packet/LabTablePacket.ts:19
Fertilizer
Fertilizer:
4
Defined in: protocol/src/packet/LabTablePacket.ts:20
HeatBlock
HeatBlock:
5
Defined in: protocol/src/packet/LabTablePacket.ts:21
IceBomb
IceBomb:
1
Defined in: protocol/src/packet/LabTablePacket.ts:17
MagnesiumSalts
MagnesiumSalts:
6
Defined in: protocol/src/packet/LabTablePacket.ts:22
MiscExplosion
MiscExplosion:
8
Defined in: protocol/src/packet/LabTablePacket.ts:24
MiscFire
MiscFire:
7
Defined in: protocol/src/packet/LabTablePacket.ts:23
MiscLargeSmoke
MiscLargeSmoke:
12
Defined in: protocol/src/packet/LabTablePacket.ts:28
MiscLava
MiscLava:
9
Defined in: protocol/src/packet/LabTablePacket.ts:25
MiscMystical
MiscMystical:
10
Defined in: protocol/src/packet/LabTablePacket.ts:26
MiscSmoke
MiscSmoke:
11
Defined in: protocol/src/packet/LabTablePacket.ts:27
None
None:
0
Defined in: protocol/src/packet/LabTablePacket.ts:16
LabTableType
Defined in: protocol/src/packet/LabTablePacket.ts:8
What the Education Edition chemistry lab table was asked to do.
Enumeration Members
Reset
Reset:
2
Defined in: protocol/src/packet/LabTablePacket.ts:11
StartCombine
StartCombine:
0
Defined in: protocol/src/packet/LabTablePacket.ts:9
StartReaction
StartReaction:
1
Defined in: protocol/src/packet/LabTablePacket.ts:10
LegacyTelemetryEventType
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:10
The events a LegacyTelemetryEventPacket reports, numbered by its Event Type varint32.
The members the docs mark _OBSOLETE keep their slot so the numbering of the rest stays right; nothing sends them. They are spelled with an Obsolete suffix here.
Enumeration Members
Achievement
Achievement:
0
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:11
ActorDefinition
ActorDefinition:
18
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:29
AgentCommandObsolete
AgentCommandObsolete:
8
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:19
AgentCreated
AgentCreated:
9
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:20
BellUsed
BellUsed:
17
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:28
BossKilled
BossKilled:
7
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:18
CarefulRestoration
CarefulRestoration:
30
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:41
CauldronUsed
CauldronUsed:
5
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:16
CodeBuilderRuntimeAction
CodeBuilderRuntimeAction:
26
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:37
CodeBuilderScoreboard
CodeBuilderScoreboard:
27
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:38
ComposterUsed
ComposterUsed:
16
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:27
FishBucketedObsolete
FishBucketedObsolete:
12
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:23
HoneyHarvested
HoneyHarvested:
22
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:33
Interaction
Interaction:
1
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:12
ItemUsed
ItemUsed:
31
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:42
MobBorn
MobBorn:
13
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:24
MobKilled
MobKilled:
4
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:15
PatternRemovedObsolete
PatternRemovedObsolete:
10
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:21
PetDiedObsolete
PetDiedObsolete:
14
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:25
PiglinBarter
PiglinBarter:
24
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:35
PlayerDied
PlayerDied:
6
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:17
PlayerMovementAnomalyObsolete
PlayerMovementAnomalyObsolete:
20
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:31
PlayerMovementCorrectedObsolete
PlayerMovementCorrectedObsolete:
21
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:32
PlayerWaxedOrUnwaxedCopper
PlayerWaxedOrUnwaxedCopper:
25
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:36
POICauldronUsed
POICauldronUsed:
15
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:26
PortalCreated
PortalCreated:
2
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:13
PortalUsed
PortalUsed:
3
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:14
RaidUpdate
RaidUpdate:
19
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:30
SlashCommand
SlashCommand:
11
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:22
SneakCloseToSculkSensor
SneakCloseToSculkSensor:
29
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:40
StriderRiddenInLavaInOverworld
StriderRiddenInLavaInOverworld:
28
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:39
TargetBlockHit
TargetBlockHit:
23
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:34
LessonAction
Defined in: protocol/src/packet/LessonProgressPacket.ts:9
The docs' Lesson Action, numbered from 0 as the datagen snapshot lists it.
Enumeration Members
Complete
Complete:
1
Defined in: protocol/src/packet/LessonProgressPacket.ts:13
Docs: Complete.
Restart
Restart:
2
Defined in: protocol/src/packet/LessonProgressPacket.ts:15
Docs: Restart.
Start
Start:
0
Defined in: protocol/src/packet/LessonProgressPacket.ts:11
Docs: Start.
MapDecorationType
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:8
The artwork drawn for a map decoration, sent as an int8.
Enumeration Members
AbandonedCamp
AbandonedCamp:
25
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:34
BuriedAncientCity
BuriedAncientCity:
26
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:35
BuriedMineshaft
BuriedMineshaft:
27
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:36
DesertPyramid
DesertPyramid:
28
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:37
JungleTemple
JungleTemple:
22
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:31
Mansion
Mansion:
14
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:23
MarkerBlue
MarkerBlue:
3
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:12
MarkerGreen
MarkerGreen:
1
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:10
MarkerOrange
MarkerOrange:
9
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:18
MarkerPink
MarkerPink:
8
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:17
MarkerRed
MarkerRed:
2
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:11
MarkerSign
MarkerSign:
7
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:16
MarkerTeal
MarkerTeal:
11
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:20
MarkerWhite
MarkerWhite:
0
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:9
MarkerYellow
MarkerYellow:
10
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:19
Monument
Monument:
15
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:24
NoDraw
NoDraw:
16
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:25
SmallSquareWhite
SmallSquareWhite:
13
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:22
SquareWhite
SquareWhite:
6
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:15
TrialChambers
TrialChambers:
24
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:33
TriangleGreen
TriangleGreen:
12
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:21
TriangleRed
TriangleRed:
5
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:14
VillageDesert
VillageDesert:
17
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:26
VillagePlains
VillagePlains:
18
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:27
VillageSavanna
VillageSavanna:
19
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:28
VillageSnowy
VillageSnowy:
20
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:29
VillageTaiga
VillageTaiga:
21
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:30
WarmOceanRuins
WarmOceanRuins:
29
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:38
WitchHut
WitchHut:
23
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:32
XWhite
XWhite:
4
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:13
MapItemTrackedActorType
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:42
What a map decoration follows, as a little-endian int32.
Enumeration Members
BlockEntity
BlockEntity:
1
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:44
Entity
Entity:
0
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:43
Other
Other:
2
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:45
MatchmakingState
Defined in: protocol/src/wire/definitions/added2225.ts:29
MatchmakingState, the uint8 the matchmaking packet leads with.
Enumeration Members
Canceled
Canceled:
3
Defined in: protocol/src/wire/definitions/added2225.ts:33
Idle
Idle:
0
Defined in: protocol/src/wire/definitions/added2225.ts:30
MatchFound
MatchFound:
2
Defined in: protocol/src/wire/definitions/added2225.ts:32
Matchmaking
Matchmaking:
1
Defined in: protocol/src/wire/definitions/added2225.ts:31
PlayerLeftParty
PlayerLeftParty:
4
Defined in: protocol/src/wire/definitions/added2225.ts:34
PlayerLeftServer
PlayerLeftServer:
5
Defined in: protocol/src/wire/definitions/added2225.ts:35
RequeueAsParty
RequeueAsParty:
8
Defined in: protocol/src/wire/definitions/added2225.ts:38
ServerShutdown
ServerShutdown:
6
Defined in: protocol/src/wire/definitions/added2225.ts:36
TimedOut
TimedOut:
7
Defined in: protocol/src/wire/definitions/added2225.ts:37
Mirror
Defined in: protocol/src/structure/StructureSettings.ts:21
The axes a structure is mirrored across, written as one byte.
Enumeration Members
None
None:
0
Defined in: protocol/src/structure/StructureSettings.ts:22
X
X:
1
Defined in: protocol/src/structure/StructureSettings.ts:23
XZ
XZ:
3
Defined in: protocol/src/structure/StructureSettings.ts:25
Z
Z:
2
Defined in: protocol/src/structure/StructureSettings.ts:24
MobEffectEvent
Defined in: protocol/src/packet/MobEffectPacket.ts:9
What a MobEffectPacket does to the effect it names, as the Event ID byte numbers it.
Enumeration Members
Add
Add:
1
Defined in: protocol/src/packet/MobEffectPacket.ts:11
Invalid
Invalid:
0
Defined in: protocol/src/packet/MobEffectPacket.ts:10
Remove
Remove:
3
Defined in: protocol/src/packet/MobEffectPacket.ts:13
Update
Update:
2
Defined in: protocol/src/packet/MobEffectPacket.ts:12
ModalFormCancelReason
Defined in: protocol/src/packet/ModalFormResponsePacket.ts:6
Why a form closed without a response.
Enumeration Members
UserBusy
UserBusy:
1
Defined in: protocol/src/packet/ModalFormResponsePacket.ts:8
UserClosed
UserClosed:
0
Defined in: protocol/src/packet/ModalFormResponsePacket.ts:7
MovementEffectType
Defined in: protocol/src/packet/MovementEffectPacket.ts:7
The MovementEffectType enum behind Effect ID, numbered as the docs and gophertunnel list it.
Enumeration Members
DOLPHIN_BOOST
DOLPHIN_BOOST:
1
Defined in: protocol/src/packet/MovementEffectPacket.ts:11
The speed boost from swimming near a dolphin.
GEYSER_BOOST
GEYSER_BOOST:
2
Defined in: protocol/src/packet/MovementEffectPacket.ts:13
The upward boost from a geyser.
GLIDE_BOOST
GLIDE_BOOST:
0
Defined in: protocol/src/packet/MovementEffectPacket.ts:9
The boost a firework rocket gives a gliding player.
MultiplayerSettingsPacketType
Defined in: protocol/src/packet/MultiplayerSettingsPacket.ts:7
What a MultiplayerSettingsPacket asks for, as the PacketType varint32 numbers it.
Enumeration Members
DisableMultiplayer
DisableMultiplayer:
1
Defined in: protocol/src/packet/MultiplayerSettingsPacket.ts:9
EnableMultiplayer
EnableMultiplayer:
0
Defined in: protocol/src/packet/MultiplayerSettingsPacket.ts:8
RefreshJoincode
RefreshJoincode:
2
Defined in: protocol/src/packet/MultiplayerSettingsPacket.ts:10
NewInteractionModel
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:128
How the client selects a block target.
Enumeration Members
Classic
Classic:
2
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:131
Count
Count:
3
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:133
One past the last model; a client cannot send this value.
Crosshair
Crosshair:
1
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:130
Touch
Touch:
0
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:129
NoiseAlignmentType
Defined in: protocol/src/structure/NoiseAlignment.ts:6
The docs enum NoiseAlignmentType: what a noise-driven transition lines its noise up with.
Enumeration Members
MIN_LOCAL_TRANSITION_END
MIN_LOCAL_TRANSITION_END:
0
Defined in: protocol/src/structure/NoiseAlignment.ts:8
minLocalTransitionEnd: align with the earliest local transition end.
NpcDialogueActionType
Defined in: protocol/src/packet/NpcDialoguePacket.ts:12
The NpcDialogueActionType enum carried by NpcDialoguePacket, numbered as the protocol 2193 docs list them.
Enumeration Members
Close
Close:
1
Defined in: protocol/src/packet/NpcDialoguePacket.ts:16
Docs: Close. Dismisses it.
Open
Open:
0
Defined in: protocol/src/packet/NpcDialoguePacket.ts:14
Docs: Open. Shows the dialogue window.
NpcRequestType
Defined in: protocol/src/packet/NpcRequestPacket.ts:7
What the player asked the NPC to do, as the Request Type byte numbers it.
Enumeration Members
ExecuteAction
ExecuteAction:
1
Defined in: protocol/src/packet/NpcRequestPacket.ts:9
ExecuteClosingCommands
ExecuteClosingCommands:
2
Defined in: protocol/src/packet/NpcRequestPacket.ts:10
ExecuteOpeningCommands
ExecuteOpeningCommands:
6
Defined in: protocol/src/packet/NpcRequestPacket.ts:14
SetActions
SetActions:
0
Defined in: protocol/src/packet/NpcRequestPacket.ts:8
SetInteractText
SetInteractText:
5
Defined in: protocol/src/packet/NpcRequestPacket.ts:13
SetName
SetName:
3
Defined in: protocol/src/packet/NpcRequestPacket.ts:11
SetSkin
SetSkin:
4
Defined in: protocol/src/packet/NpcRequestPacket.ts:12
ObjectiveSortOrder
Defined in: protocol/src/packet/SetDisplayObjectivePacket.ts:7
Which way the client orders an objective's lines, as the SortOrder ZigZag varint32 numbers it.
Enumeration Members
Ascending
Ascending:
0
Defined in: protocol/src/packet/SetDisplayObjectivePacket.ts:8
Descending
Descending:
1
Defined in: protocol/src/packet/SetDisplayObjectivePacket.ts:9
PackSettingValueType
Defined in: protocol/src/packet/ServerboundPackSettingChangePacket.ts:11
Selectors for the PackSettingValue alternatives, in wire order.
Enumeration Members
Bool
Bool:
1
Defined in: protocol/src/packet/ServerboundPackSettingChangePacket.ts:13
Float
Float:
0
Defined in: protocol/src/packet/ServerboundPackSettingChangePacket.ts:12
String
String:
2
Defined in: protocol/src/packet/ServerboundPackSettingChangePacket.ts:14
StringList
StringList:
3
Defined in: protocol/src/packet/ServerboundPackSettingChangePacket.ts:15
PackType
Defined in: protocol/src/packet/ResourcePackDataInfoPacket.ts:13
The docs' PackType: what kind of pack is about to be sent, as the Pack Type byte numbers it.
The packet docs give the field as a bare uint8. The names and numbers are Mojang's PackType enum in the datagen snapshot behind @jsprismarine/minecraft (packages/minecraft/datagen/snapshot/v2193/enums.html); gophertunnel uses the same numbers.
Enumeration Members
Addon
Addon:
1
Defined in: protocol/src/packet/ResourcePackDataInfoPacket.ts:15
Behavior
Behavior:
4
Defined in: protocol/src/packet/ResourcePackDataInfoPacket.ts:18
Cached
Cached:
2
Defined in: protocol/src/packet/ResourcePackDataInfoPacket.ts:16
CopyProtected
CopyProtected:
3
Defined in: protocol/src/packet/ResourcePackDataInfoPacket.ts:17
Invalid
Invalid:
0
Defined in: protocol/src/packet/ResourcePackDataInfoPacket.ts:14
PersonaPiece
PersonaPiece:
5
Defined in: protocol/src/packet/ResourcePackDataInfoPacket.ts:19
Resources
Resources:
6
Defined in: protocol/src/packet/ResourcePackDataInfoPacket.ts:20
Skins
Skins:
7
Defined in: protocol/src/packet/ResourcePackDataInfoPacket.ts:21
WorldTemplate
WorldTemplate:
8
Defined in: protocol/src/packet/ResourcePackDataInfoPacket.ts:22
PacketIdentifier
Defined in: protocol/src/PacketIdentifier.ts:9
The id every Bedrock packet travels under, as the first ten bits of its header.
One member per packet the 1.26.51 (protocol 2193) documentation lists, with the value the documentation gives it; the gaps are ids Mojang has retired. Derived from the [cereal:packet] property of each *Packet.json schema in the release metadata. https://mojang.github.io/bedrock-protocol-docs/1.26.51/
Enumeration Members
ACTOR_EVENT
ACTOR_EVENT:
27
Defined in: protocol/src/PacketIdentifier.ts:33
ACTOR_PICK_REQUEST
ACTOR_PICK_REQUEST:
35
Defined in: protocol/src/PacketIdentifier.ts:41
ADD_ACTOR
ADD_ACTOR:
13
Defined in: protocol/src/PacketIdentifier.ts:22
ADD_BEHAVIOR_TREE
ADD_BEHAVIOR_TREE:
89
Defined in: protocol/src/PacketIdentifier.ts:90
ADD_ITEM_ACTOR
ADD_ITEM_ACTOR:
15
Defined in: protocol/src/PacketIdentifier.ts:24
ADD_PAINTING
ADD_PAINTING:
22
Defined in: protocol/src/PacketIdentifier.ts:30
ADD_PLAYER
ADD_PLAYER:
12
Defined in: protocol/src/PacketIdentifier.ts:21
ADD_VOLUME_ENTITY
ADD_VOLUME_ENTITY:
166
Defined in: protocol/src/PacketIdentifier.ts:162
AGENT_ACTION_EVENT
AGENT_ACTION_EVENT:
181
Defined in: protocol/src/PacketIdentifier.ts:176
AGENT_ANIMATION
AGENT_ANIMATION:
304
Defined in: protocol/src/PacketIdentifier.ts:197
ANIMATE
ANIMATE:
44
Defined in: protocol/src/PacketIdentifier.ts:49
ANIMATE_ENTITY
ANIMATE_ENTITY:
158
Defined in: protocol/src/PacketIdentifier.ts:154
ANVIL_DAMAGE
ANVIL_DAMAGE:
141
Defined in: protocol/src/PacketIdentifier.ts:136
AUTOMATION_CLIENT_CONNECT
AUTOMATION_CLIENT_CONNECT:
95
Defined in: protocol/src/PacketIdentifier.ts:96
AVAILABLE_ACTOR_IDENTIFIERS
AVAILABLE_ACTOR_IDENTIFIERS:
119
Defined in: protocol/src/PacketIdentifier.ts:118
AVAILABLE_COMMANDS
AVAILABLE_COMMANDS:
76
Defined in: protocol/src/PacketIdentifier.ts:77
AWARD_ACHIEVEMENT
AWARD_ACHIEVEMENT:
309
Defined in: protocol/src/PacketIdentifier.ts:202
BIOME_DEFINITION_LIST
BIOME_DEFINITION_LIST:
122
Defined in: protocol/src/PacketIdentifier.ts:121
Every biome the client can render; a 2193 client cannot finish world generation without it.
BLOCK_ACTOR_DATA
BLOCK_ACTOR_DATA:
56
Defined in: protocol/src/PacketIdentifier.ts:59
BLOCK_EVENT
BLOCK_EVENT:
26
Defined in: protocol/src/PacketIdentifier.ts:32
BLOCK_PICK_REQUEST
BLOCK_PICK_REQUEST:
34
Defined in: protocol/src/PacketIdentifier.ts:40
BOOK_EDIT
BOOK_EDIT:
97
Defined in: protocol/src/PacketIdentifier.ts:98
BOSS_EVENT
BOSS_EVENT:
74
Defined in: protocol/src/PacketIdentifier.ts:75
CAMERA
CAMERA:
73
Defined in: protocol/src/PacketIdentifier.ts:74
CAMERA_AIM_ASSIST
CAMERA_AIM_ASSIST:
316
Defined in: protocol/src/PacketIdentifier.ts:209
CAMERA_AIM_ASSIST_ACTOR_PRIORITY
CAMERA_AIM_ASSIST_ACTOR_PRIORITY:
339
Defined in: protocol/src/PacketIdentifier.ts:231
CAMERA_AIM_ASSIST_PRESETS
CAMERA_AIM_ASSIST_PRESETS:
320
Defined in: protocol/src/PacketIdentifier.ts:212
CAMERA_INSTRUCTION
CAMERA_INSTRUCTION:
300
Defined in: protocol/src/PacketIdentifier.ts:194
CAMERA_PRESETS
CAMERA_PRESETS:
198
Defined in: protocol/src/PacketIdentifier.ts:192
CAMERA_SHAKE
CAMERA_SHAKE:
159
Defined in: protocol/src/PacketIdentifier.ts:155
CAMERA_SPLINE
CAMERA_SPLINE:
338
Defined in: protocol/src/PacketIdentifier.ts:230
CHANGE_DIMENSION
CHANGE_DIMENSION:
61
Defined in: protocol/src/PacketIdentifier.ts:63
CHANGE_MOB_PROPERTY
CHANGE_MOB_PROPERTY:
182
Defined in: protocol/src/PacketIdentifier.ts:177
CHUNK_RADIUS_UPDATED
CHUNK_RADIUS_UPDATED:
70
Defined in: protocol/src/PacketIdentifier.ts:72
CLIENT_CACHE_BLOB_STATUS
CLIENT_CACHE_BLOB_STATUS:
135
Defined in: protocol/src/PacketIdentifier.ts:130
CLIENT_CACHE_MISS_RESPONSE
CLIENT_CACHE_MISS_RESPONSE:
136
Defined in: protocol/src/PacketIdentifier.ts:131
CLIENT_CACHE_STATUS
CLIENT_CACHE_STATUS:
129
Defined in: protocol/src/PacketIdentifier.ts:125
CLIENT_CAMERA_AIM_ASSIST
CLIENT_CAMERA_AIM_ASSIST:
321
Defined in: protocol/src/PacketIdentifier.ts:213
CLIENT_MOVEMENT_PREDICTION_SYNC
CLIENT_MOVEMENT_PREDICTION_SYNC:
322
Defined in: protocol/src/PacketIdentifier.ts:214
CLIENT_TO_SERVER_HANDSHAKE
CLIENT_TO_SERVER_HANDSHAKE:
4
Defined in: protocol/src/PacketIdentifier.ts:13
CLIENTBOUND_ATTRIBUTE_LAYER_SYNC
CLIENTBOUND_ATTRIBUTE_LAYER_SYNC:
345
Defined in: protocol/src/PacketIdentifier.ts:237
CLIENTBOUND_CLOSE_FORM
CLIENTBOUND_CLOSE_FORM:
310
Defined in: protocol/src/PacketIdentifier.ts:203
CLIENTBOUND_CONTROL_SCHEME_SET
CLIENTBOUND_CONTROL_SCHEME_SET:
327
Defined in: protocol/src/PacketIdentifier.ts:219
CLIENTBOUND_DATA_DRIVEN_UI_CLOSE_SCREEN
CLIENTBOUND_DATA_DRIVEN_UI_CLOSE_SCREEN:
334
Defined in: protocol/src/PacketIdentifier.ts:226
CLIENTBOUND_DATA_DRIVEN_UI_RELOAD
CLIENTBOUND_DATA_DRIVEN_UI_RELOAD:
335
Defined in: protocol/src/PacketIdentifier.ts:227
CLIENTBOUND_DATA_DRIVEN_UI_SHOW_SCREEN
CLIENTBOUND_DATA_DRIVEN_UI_SHOW_SCREEN:
333
Defined in: protocol/src/PacketIdentifier.ts:225
CLIENTBOUND_DATA_STORE
CLIENTBOUND_DATA_STORE:
330
Defined in: protocol/src/PacketIdentifier.ts:222
CLIENTBOUND_DEBUG_RENDERER
CLIENTBOUND_DEBUG_RENDERER:
164
Defined in: protocol/src/PacketIdentifier.ts:160
CLIENTBOUND_MAP_ITEM_DATA
CLIENTBOUND_MAP_ITEM_DATA:
67
Defined in: protocol/src/PacketIdentifier.ts:69
CLIENTBOUND_TEXTURE_SHIFT
CLIENTBOUND_TEXTURE_SHIFT:
336
Defined in: protocol/src/PacketIdentifier.ts:228
CLIENTBOUND_UPDATE_SOUND_DATA
CLIENTBOUND_UPDATE_SOUND_DATA:
348
Defined in: protocol/src/PacketIdentifier.ts:240
CODE_BUILDER
CODE_BUILDER:
150
Defined in: protocol/src/PacketIdentifier.ts:146
CODE_BUILDER_SOURCE
CODE_BUILDER_SOURCE:
178
Defined in: protocol/src/PacketIdentifier.ts:173
COMMAND_BLOCK_UPDATE
COMMAND_BLOCK_UPDATE:
78
Defined in: protocol/src/PacketIdentifier.ts:79
COMMAND_OUTPUT
COMMAND_OUTPUT:
79
Defined in: protocol/src/PacketIdentifier.ts:80
COMMAND_REQUEST
COMMAND_REQUEST:
77
Defined in: protocol/src/PacketIdentifier.ts:78
COMPLETED_USING_ITEM
COMPLETED_USING_ITEM:
142
Defined in: protocol/src/PacketIdentifier.ts:137
CONTAINER_CLOSE
CONTAINER_CLOSE:
47
Defined in: protocol/src/PacketIdentifier.ts:52
CONTAINER_OPEN
CONTAINER_OPEN:
46
Defined in: protocol/src/PacketIdentifier.ts:51
CONTAINER_REGISTRY_CLEANUP
CONTAINER_REGISTRY_CLEANUP:
317
Defined in: protocol/src/PacketIdentifier.ts:210
CONTAINER_SET_DATA
CONTAINER_SET_DATA:
51
Defined in: protocol/src/PacketIdentifier.ts:56
CORRECT_PLAYER_MOVE_PREDICTION
CORRECT_PLAYER_MOVE_PREDICTION:
161
Defined in: protocol/src/PacketIdentifier.ts:157
CRAFTING_DATA
CRAFTING_DATA:
52
Defined in: protocol/src/PacketIdentifier.ts:57
CREATE_PHOTO
CREATE_PHOTO:
171
Defined in: protocol/src/PacketIdentifier.ts:167
CREATIVE_CONTENT
CREATIVE_CONTENT:
145
Defined in: protocol/src/PacketIdentifier.ts:141
CURRENT_STRUCTURE_FEATURE
CURRENT_STRUCTURE_FEATURE:
314
Defined in: protocol/src/PacketIdentifier.ts:207
DEATH_INFO
DEATH_INFO:
189
Defined in: protocol/src/PacketIdentifier.ts:184
DEBUG_INFO
DEBUG_INFO:
155
Defined in: protocol/src/PacketIdentifier.ts:151
DIMENSION_DATA
DIMENSION_DATA:
180
Defined in: protocol/src/PacketIdentifier.ts:175
DISCONNECT
DISCONNECT:
5
Defined in: protocol/src/PacketIdentifier.ts:14
EDITOR_NETWORK
EDITOR_NETWORK:
190
Defined in: protocol/src/PacketIdentifier.ts:185
EDU_URI_RESOURCE
EDU_URI_RESOURCE:
170
Defined in: protocol/src/PacketIdentifier.ts:166
EDUCATION_SETTINGS
EDUCATION_SETTINGS:
137
Defined in: protocol/src/PacketIdentifier.ts:132
EMOTE
EMOTE:
138
Defined in: protocol/src/PacketIdentifier.ts:133
EMOTE_LIST
EMOTE_LIST:
152
Defined in: protocol/src/PacketIdentifier.ts:148
FEATURE_REGISTRY
FEATURE_REGISTRY:
191
Defined in: protocol/src/PacketIdentifier.ts:186
GAME_RULES_CHANGED
GAME_RULES_CHANGED:
72
Defined in: protocol/src/PacketIdentifier.ts:73
GAME_TEST_REQUEST
GAME_TEST_REQUEST:
194
Defined in: protocol/src/PacketIdentifier.ts:189
GAME_TEST_RESULTS
GAME_TEST_RESULTS:
195
Defined in: protocol/src/PacketIdentifier.ts:190
GRAPHICS_OVERRIDE_PARAMETER
GRAPHICS_OVERRIDE_PARAMETER:
331
Defined in: protocol/src/PacketIdentifier.ts:223
GUI_DATA_PICK_ITEM
GUI_DATA_PICK_ITEM:
54
Defined in: protocol/src/PacketIdentifier.ts:58
HURT_ARMOR
HURT_ARMOR:
38
Defined in: protocol/src/PacketIdentifier.ts:43
INTERACT
INTERACT:
33
Defined in: protocol/src/PacketIdentifier.ts:39
INVENTORY_CONTENT
INVENTORY_CONTENT:
49
Defined in: protocol/src/PacketIdentifier.ts:54
INVENTORY_SLOT
INVENTORY_SLOT:
50
Defined in: protocol/src/PacketIdentifier.ts:55
INVENTORY_TRANSACTION
INVENTORY_TRANSACTION:
30
Defined in: protocol/src/PacketIdentifier.ts:36
ITEM_REGISTRY
ITEM_REGISTRY:
162
Defined in: protocol/src/PacketIdentifier.ts:159
The item table. Called ItemComponent before 1.21.60, when it carried only components.
ITEM_STACK_REQUEST
ITEM_STACK_REQUEST:
147
Defined in: protocol/src/PacketIdentifier.ts:143
ITEM_STACK_RESPONSE
ITEM_STACK_RESPONSE:
148
Defined in: protocol/src/PacketIdentifier.ts:144
JIGSAW_STRUCTURE_DATA
JIGSAW_STRUCTURE_DATA:
313
Defined in: protocol/src/PacketIdentifier.ts:206
The jigsaw structure rules, which a client at 2193 must be sent before StartGame.
LAB_TABLE
LAB_TABLE:
109
Defined in: protocol/src/PacketIdentifier.ts:110
LECTERN_UPDATE
LECTERN_UPDATE:
125
Defined in: protocol/src/PacketIdentifier.ts:124
LEGACY_TELEMETRY_EVENT
LEGACY_TELEMETRY_EVENT:
65
Defined in: protocol/src/PacketIdentifier.ts:67
LESSON_PROGRESS
LESSON_PROGRESS:
183
Defined in: protocol/src/PacketIdentifier.ts:178
LEVEL_CHUNK
LEVEL_CHUNK:
58
Defined in: protocol/src/PacketIdentifier.ts:60
LEVEL_EVENT
LEVEL_EVENT:
25
Defined in: protocol/src/PacketIdentifier.ts:31
LEVEL_EVENT_GENERIC
LEVEL_EVENT_GENERIC:
124
Defined in: protocol/src/PacketIdentifier.ts:123
LEVEL_SOUND_EVENT
LEVEL_SOUND_EVENT:
123
Defined in: protocol/src/PacketIdentifier.ts:122
LOCATOR_BAR
LOCATOR_BAR:
341
Defined in: protocol/src/PacketIdentifier.ts:233
LOGIN
LOGIN:
1
Defined in: protocol/src/PacketIdentifier.ts:10
MAP_CREATE_LOCKED_COPY
MAP_CREATE_LOCKED_COPY:
131
Defined in: protocol/src/PacketIdentifier.ts:127
MAP_INFO_REQUEST
MAP_INFO_REQUEST:
68
Defined in: protocol/src/PacketIdentifier.ts:70
MOB_ARMOR_EQUIPMENT
MOB_ARMOR_EQUIPMENT:
32
Defined in: protocol/src/PacketIdentifier.ts:38
MOB_EFFECT
MOB_EFFECT:
28
Defined in: protocol/src/PacketIdentifier.ts:34
MOB_EQUIPMENT
MOB_EQUIPMENT:
31
Defined in: protocol/src/PacketIdentifier.ts:37
MODAL_FORM_REQUEST
MODAL_FORM_REQUEST:
100
Defined in: protocol/src/PacketIdentifier.ts:101
MODAL_FORM_RESPONSE
MODAL_FORM_RESPONSE:
101
Defined in: protocol/src/PacketIdentifier.ts:102
MOTION_PREDICTION_HINTS
MOTION_PREDICTION_HINTS:
157
Defined in: protocol/src/PacketIdentifier.ts:153
MOVE_ACTOR_ABSOLUTE
MOVE_ACTOR_ABSOLUTE:
18
Defined in: protocol/src/PacketIdentifier.ts:27
MOVE_ACTOR_DELTA
MOVE_ACTOR_DELTA:
111
Defined in: protocol/src/PacketIdentifier.ts:112
MOVE_PLAYER
MOVE_PLAYER:
19
Defined in: protocol/src/PacketIdentifier.ts:28
MOVEMENT_EFFECT
MOVEMENT_EFFECT:
318
Defined in: protocol/src/PacketIdentifier.ts:211
MULTIPLAYER_SETTINGS
MULTIPLAYER_SETTINGS:
139
Defined in: protocol/src/PacketIdentifier.ts:134
NETWORK_CHUNK_PUBLISHER_UPDATE
NETWORK_CHUNK_PUBLISHER_UPDATE:
121
Defined in: protocol/src/PacketIdentifier.ts:119
NETWORK_SETTINGS
NETWORK_SETTINGS:
143
Defined in: protocol/src/PacketIdentifier.ts:138
NETWORK_STACK_LATENCY
NETWORK_STACK_LATENCY:
115
Defined in: protocol/src/PacketIdentifier.ts:116
NPC_DIALOGUE
NPC_DIALOGUE:
169
Defined in: protocol/src/PacketIdentifier.ts:165
NPC_REQUEST
NPC_REQUEST:
98
Defined in: protocol/src/PacketIdentifier.ts:99
ON_SCREEN_TEXTURE_ANIMATION
ON_SCREEN_TEXTURE_ANIMATION:
130
Defined in: protocol/src/PacketIdentifier.ts:126
OPEN_SIGN
OPEN_SIGN:
303
Defined in: protocol/src/PacketIdentifier.ts:196
PACKET_VIOLATION_WARNING
PACKET_VIOLATION_WARNING:
156
Defined in: protocol/src/PacketIdentifier.ts:152
PARTY_CHANGED
PARTY_CHANGED:
342
Defined in: protocol/src/PacketIdentifier.ts:234
PARTY_DESTINATION_COOKIE_RESPONSE
PARTY_DESTINATION_COOKIE_RESPONSE:
350
Defined in: protocol/src/PacketIdentifier.ts:242
PHOTO_TRANSFER
PHOTO_TRANSFER:
99
Defined in: protocol/src/PacketIdentifier.ts:100
PLAY_SOUND
PLAY_SOUND:
86
Defined in: protocol/src/PacketIdentifier.ts:87
PLAY_STATUS
PLAY_STATUS:
2
Defined in: protocol/src/PacketIdentifier.ts:11
PLAYER_ACTION
PLAYER_ACTION:
36
Defined in: protocol/src/PacketIdentifier.ts:42
PLAYER_ARMOR_DAMAGE
PLAYER_ARMOR_DAMAGE:
149
Defined in: protocol/src/PacketIdentifier.ts:145
PLAYER_AUTH_INPUT
PLAYER_AUTH_INPUT:
144
Defined in: protocol/src/PacketIdentifier.ts:140
Where the player is and what they pressed, every tick. The only movement packet a client sends now.
PLAYER_ENCHANT_OPTIONS
PLAYER_ENCHANT_OPTIONS:
146
Defined in: protocol/src/PacketIdentifier.ts:142
PLAYER_FOG
PLAYER_FOG:
160
Defined in: protocol/src/PacketIdentifier.ts:156
PLAYER_HOTBAR
PLAYER_HOTBAR:
48
Defined in: protocol/src/PacketIdentifier.ts:53
PLAYER_LIST
PLAYER_LIST:
63
Defined in: protocol/src/PacketIdentifier.ts:65
PLAYER_LOCATION
PLAYER_LOCATION:
326
Defined in: protocol/src/PacketIdentifier.ts:218
PLAYER_SKIN
PLAYER_SKIN:
93
Defined in: protocol/src/PacketIdentifier.ts:94
PLAYER_START_ITEM_COOLDOWN
PLAYER_START_ITEM_COOLDOWN:
176
Defined in: protocol/src/PacketIdentifier.ts:171
PLAYER_TOGGLE_CRAFTER_SLOT_REQUEST
PLAYER_TOGGLE_CRAFTER_SLOT_REQUEST:
306
Defined in: protocol/src/PacketIdentifier.ts:199
PLAYER_UPDATE_ENTITY_OVERRIDES
PLAYER_UPDATE_ENTITY_OVERRIDES:
325
Defined in: protocol/src/PacketIdentifier.ts:217
PLAYER_VIDEO_CAPTURE
PLAYER_VIDEO_CAPTURE:
324
Defined in: protocol/src/PacketIdentifier.ts:216
POSITION_TRACKING_DB_CLIENT_REQUEST
POSITION_TRACKING_DB_CLIENT_REQUEST:
154
Defined in: protocol/src/PacketIdentifier.ts:150
POSITION_TRACKING_DB_SERVER_BROADCAST
POSITION_TRACKING_DB_SERVER_BROADCAST:
153
Defined in: protocol/src/PacketIdentifier.ts:149
PRIMITIVE_SHAPES
PRIMITIVE_SHAPES:
328
Defined in: protocol/src/PacketIdentifier.ts:220
PURCHASE_RECEIPT
PURCHASE_RECEIPT:
92
Defined in: protocol/src/PacketIdentifier.ts:93
RECORD_STARTED
RECORD_STARTED:
352
Defined in: protocol/src/PacketIdentifier.ts:244
REFRESH_ENTITLEMENTS
REFRESH_ENTITLEMENTS:
305
Defined in: protocol/src/PacketIdentifier.ts:198
REMOVE_ACTOR
REMOVE_ACTOR:
14
Defined in: protocol/src/PacketIdentifier.ts:23
REMOVE_OBJECTIVE
REMOVE_OBJECTIVE:
106
Defined in: protocol/src/PacketIdentifier.ts:107
REMOVE_VOLUME_ENTITY
REMOVE_VOLUME_ENTITY:
167
Defined in: protocol/src/PacketIdentifier.ts:163
REQUEST_ABILITY
REQUEST_ABILITY:
184
Defined in: protocol/src/PacketIdentifier.ts:179
REQUEST_CHUNK_RADIUS
REQUEST_CHUNK_RADIUS:
69
Defined in: protocol/src/PacketIdentifier.ts:71
REQUEST_NETWORK_SETTINGS
REQUEST_NETWORK_SETTINGS:
193
Defined in: protocol/src/PacketIdentifier.ts:188
REQUEST_PERMISSIONS
REQUEST_PERMISSIONS:
185
Defined in: protocol/src/PacketIdentifier.ts:180
RESOURCE_PACK_CHUNK_DATA
RESOURCE_PACK_CHUNK_DATA:
83
Defined in: protocol/src/PacketIdentifier.ts:84
RESOURCE_PACK_CHUNK_REQUEST
RESOURCE_PACK_CHUNK_REQUEST:
84
Defined in: protocol/src/PacketIdentifier.ts:85
RESOURCE_PACK_CLIENT_RESPONSE
RESOURCE_PACK_CLIENT_RESPONSE:
8
Defined in: protocol/src/PacketIdentifier.ts:17
RESOURCE_PACK_DATA_INFO
RESOURCE_PACK_DATA_INFO:
82
Defined in: protocol/src/PacketIdentifier.ts:83
RESOURCE_PACK_STACK
RESOURCE_PACK_STACK:
7
Defined in: protocol/src/PacketIdentifier.ts:16
RESOURCE_PACKS_INFO
RESOURCE_PACKS_INFO:
6
Defined in: protocol/src/PacketIdentifier.ts:15
RESOURCE_PACKS_READY_FOR_VALIDATION
RESOURCE_PACKS_READY_FOR_VALIDATION:
340
Defined in: protocol/src/PacketIdentifier.ts:232
RESPAWN
RESPAWN:
45
Defined in: protocol/src/PacketIdentifier.ts:50
SCRIPT_MESSAGE
SCRIPT_MESSAGE:
177
Defined in: protocol/src/PacketIdentifier.ts:172
SEND_PARTY_DESTINATION_COOKIE
SEND_PARTY_DESTINATION_COOKIE:
349
Defined in: protocol/src/PacketIdentifier.ts:241
SERVER_PLAYER_POST_MOVE_POSITION
SERVER_PLAYER_POST_MOVE_POSITION:
16
Defined in: protocol/src/PacketIdentifier.ts:25
SERVER_PRESENCE_INFO
SERVER_PRESENCE_INFO:
347
Defined in: protocol/src/PacketIdentifier.ts:239
SERVER_SETTINGS_REQUEST
SERVER_SETTINGS_REQUEST:
102
Defined in: protocol/src/PacketIdentifier.ts:103
SERVER_SETTINGS_RESPONSE
SERVER_SETTINGS_RESPONSE:
103
Defined in: protocol/src/PacketIdentifier.ts:104
SERVER_STATS
SERVER_STATS:
192
Defined in: protocol/src/PacketIdentifier.ts:187
SERVER_STORE_INFO
SERVER_STORE_INFO:
346
Defined in: protocol/src/PacketIdentifier.ts:238
SERVER_TO_CLIENT_HANDSHAKE
SERVER_TO_CLIENT_HANDSHAKE:
3
Defined in: protocol/src/PacketIdentifier.ts:12
SERVERBOUND_DATA_DRIVEN_SCREEN_CLOSED
SERVERBOUND_DATA_DRIVEN_SCREEN_CLOSED:
343
Defined in: protocol/src/PacketIdentifier.ts:235
SERVERBOUND_DATA_STORE
SERVERBOUND_DATA_STORE:
332
Defined in: protocol/src/PacketIdentifier.ts:224
SERVERBOUND_DIAGNOSTICS
SERVERBOUND_DIAGNOSTICS:
315
Defined in: protocol/src/PacketIdentifier.ts:208
SERVERBOUND_LOADING_SCREEN
SERVERBOUND_LOADING_SCREEN:
312
Defined in: protocol/src/PacketIdentifier.ts:204
SERVERBOUND_PACK_SETTING_CHANGE
SERVERBOUND_PACK_SETTING_CHANGE:
329
Defined in: protocol/src/PacketIdentifier.ts:221
SET_ACTOR_DATA
SET_ACTOR_DATA:
39
Defined in: protocol/src/PacketIdentifier.ts:44
SET_ACTOR_LINK
SET_ACTOR_LINK:
41
Defined in: protocol/src/PacketIdentifier.ts:46
SET_ACTOR_MOTION
SET_ACTOR_MOTION:
40
Defined in: protocol/src/PacketIdentifier.ts:45
SET_COMMANDS_ENABLED
SET_COMMANDS_ENABLED:
59
Defined in: protocol/src/PacketIdentifier.ts:61
SET_DEFAULT_GAME_TYPE
SET_DEFAULT_GAME_TYPE:
105
Defined in: protocol/src/PacketIdentifier.ts:106
SET_DIFFICULTY
SET_DIFFICULTY:
60
Defined in: protocol/src/PacketIdentifier.ts:62
SET_DISPLAY_OBJECTIVE
SET_DISPLAY_OBJECTIVE:
107
Defined in: protocol/src/PacketIdentifier.ts:108
SET_HEALTH
SET_HEALTH:
42
Defined in: protocol/src/PacketIdentifier.ts:47
SET_HUD
SET_HUD:
308
Defined in: protocol/src/PacketIdentifier.ts:201
SET_LAST_HURT_BY
SET_LAST_HURT_BY:
96
Defined in: protocol/src/PacketIdentifier.ts:97
SET_LOCAL_PLAYER_AS_INITIALIZED
SET_LOCAL_PLAYER_AS_INITIALIZED:
113
Defined in: protocol/src/PacketIdentifier.ts:114
SET_PLAYER_FURNACE_OPTIONS
SET_PLAYER_FURNACE_OPTIONS:
351
Defined in: protocol/src/PacketIdentifier.ts:243
SET_PLAYER_GAME_TYPE
SET_PLAYER_GAME_TYPE:
62
Defined in: protocol/src/PacketIdentifier.ts:64
SET_PLAYER_INVENTORY_OPTIONS
SET_PLAYER_INVENTORY_OPTIONS:
307
Defined in: protocol/src/PacketIdentifier.ts:200
SET_SCORE
SET_SCORE:
108
Defined in: protocol/src/PacketIdentifier.ts:109
SET_SCOREBOARD_IDENTITY
SET_SCOREBOARD_IDENTITY:
112
Defined in: protocol/src/PacketIdentifier.ts:113
SET_SPAWN_POSITION
SET_SPAWN_POSITION:
43
Defined in: protocol/src/PacketIdentifier.ts:48
SET_TIME
SET_TIME:
10
Defined in: protocol/src/PacketIdentifier.ts:19
SET_TITLE
SET_TITLE:
88
Defined in: protocol/src/PacketIdentifier.ts:89
SETTINGS_COMMAND
SETTINGS_COMMAND:
140
Defined in: protocol/src/PacketIdentifier.ts:135
SHOW_CREDITS
SHOW_CREDITS:
75
Defined in: protocol/src/PacketIdentifier.ts:76
SHOW_PROFILE
SHOW_PROFILE:
104
Defined in: protocol/src/PacketIdentifier.ts:105
SHOW_STORE_OFFER
SHOW_STORE_OFFER:
91
Defined in: protocol/src/PacketIdentifier.ts:92
SIMPLE_EVENT
SIMPLE_EVENT:
64
Defined in: protocol/src/PacketIdentifier.ts:66
SIMULATION_TYPE
SIMULATION_TYPE:
168
Defined in: protocol/src/PacketIdentifier.ts:164
SPAWN_EXPERIENCE_ORB
SPAWN_EXPERIENCE_ORB:
66
Defined in: protocol/src/PacketIdentifier.ts:68
SPAWN_PARTICLE_EFFECT
SPAWN_PARTICLE_EFFECT:
118
Defined in: protocol/src/PacketIdentifier.ts:117
START_GAME
START_GAME:
11
Defined in: protocol/src/PacketIdentifier.ts:20
STOP_SOUND
STOP_SOUND:
87
Defined in: protocol/src/PacketIdentifier.ts:88
STRUCTURE_BLOCK_UPDATE
STRUCTURE_BLOCK_UPDATE:
90
Defined in: protocol/src/PacketIdentifier.ts:91
STRUCTURE_TEMPLATE_DATA_REQUEST
STRUCTURE_TEMPLATE_DATA_REQUEST:
132
Defined in: protocol/src/PacketIdentifier.ts:128
STRUCTURE_TEMPLATE_DATA_RESPONSE
STRUCTURE_TEMPLATE_DATA_RESPONSE:
133
Defined in: protocol/src/PacketIdentifier.ts:129
SUB_CHUNK
SUB_CHUNK:
174
Defined in: protocol/src/PacketIdentifier.ts:169
SUB_CHUNK_REQUEST
SUB_CHUNK_REQUEST:
175
Defined in: protocol/src/PacketIdentifier.ts:170
SUB_CLIENT_LOGIN
SUB_CLIENT_LOGIN:
94
Defined in: protocol/src/PacketIdentifier.ts:95
SYNC_ACTOR_PROPERTY
SYNC_ACTOR_PROPERTY:
165
Defined in: protocol/src/PacketIdentifier.ts:161
SYNC_WORLD_CLOCKS
SYNC_WORLD_CLOCKS:
344
Defined in: protocol/src/PacketIdentifier.ts:236
TAKE_ITEM_ACTOR
TAKE_ITEM_ACTOR:
17
Defined in: protocol/src/PacketIdentifier.ts:26
TEXT
TEXT:
9
Defined in: protocol/src/PacketIdentifier.ts:18
TICKING_AREAS_LOAD_STATUS
TICKING_AREAS_LOAD_STATUS:
179
Defined in: protocol/src/PacketIdentifier.ts:174
TOAST_REQUEST
TOAST_REQUEST:
186
Defined in: protocol/src/PacketIdentifier.ts:181
TRANSFER
TRANSFER:
85
Defined in: protocol/src/PacketIdentifier.ts:86
TRIM_DATA
TRIM_DATA:
302
Defined in: protocol/src/PacketIdentifier.ts:195
UNLOCKED_RECIPES
UNLOCKED_RECIPES:
199
Defined in: protocol/src/PacketIdentifier.ts:193
UPDATE_ABILITIES
UPDATE_ABILITIES:
187
Defined in: protocol/src/PacketIdentifier.ts:182
UPDATE_ADVENTURE_SETTINGS
UPDATE_ADVENTURE_SETTINGS:
188
Defined in: protocol/src/PacketIdentifier.ts:183
UPDATE_ATTRIBUTES
UPDATE_ATTRIBUTES:
29
Defined in: protocol/src/PacketIdentifier.ts:35
UPDATE_BLOCK
UPDATE_BLOCK:
21
Defined in: protocol/src/PacketIdentifier.ts:29
UPDATE_BLOCK_SYNCED
UPDATE_BLOCK_SYNCED:
110
Defined in: protocol/src/PacketIdentifier.ts:111
UPDATE_CLIENT_INPUT_LOCKS
UPDATE_CLIENT_INPUT_LOCKS:
196
Defined in: protocol/src/PacketIdentifier.ts:191
UPDATE_CLIENT_OPTIONS
UPDATE_CLIENT_OPTIONS:
323
Defined in: protocol/src/PacketIdentifier.ts:215
UPDATE_EQUIP
UPDATE_EQUIP:
81
Defined in: protocol/src/PacketIdentifier.ts:82
UPDATE_PLAYER_GAME_TYPE
UPDATE_PLAYER_GAME_TYPE:
151
Defined in: protocol/src/PacketIdentifier.ts:147
UPDATE_SOFT_ENUM
UPDATE_SOFT_ENUM:
114
Defined in: protocol/src/PacketIdentifier.ts:115
UPDATE_SUB_CHUNK_BLOCKS
UPDATE_SUB_CHUNK_BLOCKS:
172
Defined in: protocol/src/PacketIdentifier.ts:168
UPDATE_TRADE
UPDATE_TRADE:
80
Defined in: protocol/src/PacketIdentifier.ts:81
VOXEL_SHAPES
VOXEL_SHAPES:
337
Defined in: protocol/src/PacketIdentifier.ts:229
PacketViolationSeverity
Defined in: protocol/src/packet/PacketViolationWarningPacket.ts:23
What the client does about the violation, as the Violation Severity varint32 numbers it.
Numbered from -1 for the same reason as PacketViolationType.
Enumeration Members
FinalWarning
FinalWarning:
1
Defined in: protocol/src/packet/PacketViolationWarningPacket.ts:26
TerminatingConnection
TerminatingConnection:
2
Defined in: protocol/src/packet/PacketViolationWarningPacket.ts:27
Unknown
Unknown:
-1
Defined in: protocol/src/packet/PacketViolationWarningPacket.ts:24
Warning
Warning:
0
Defined in: protocol/src/packet/PacketViolationWarningPacket.ts:25
PacketViolationType
Defined in: protocol/src/packet/PacketViolationWarningPacket.ts:13
What the client objected to, as the Violation Type varint32 numbers it.
The numbering starts at -1. The 1.26.51 page prints the members from 0, and its 1.26.60-preview.21 changelog then "moves" Unknown to -1 and PacketMalformed to 0, which are the values gophertunnel has used since the packet appeared.
Enumeration Members
PacketMalformed
PacketMalformed:
0
Defined in: protocol/src/packet/PacketViolationWarningPacket.ts:15
Unknown
Unknown:
-1
Defined in: protocol/src/packet/PacketViolationWarningPacket.ts:14
PartyDestinationCookieIntent
Defined in: protocol/src/packet/SendPartyDestinationCookiePacket.ts:12
PartyDestinationCookieIntent: why the server hands the client a cookie. The schema types it as an int8 without Enum-as-Value, so Cereal writes the member name as a string, which is what gophertunnel at protocol 2193 sends. Mojang's enum table numbers the members Notify 0, OptIn 1 and OptOut 2; those numbers never reach the wire.
Enumeration Members
Notify
Notify:
"Notify"
Defined in: protocol/src/packet/SendPartyDestinationCookiePacket.ts:13
OptIn
OptIn:
"OptIn"
Defined in: protocol/src/packet/SendPartyDestinationCookiePacket.ts:14
OptOut
OptOut:
"OptOut"
Defined in: protocol/src/packet/SendPartyDestinationCookiePacket.ts:15
PhotoType
Defined in: protocol/src/packet/PhotoTransferPacket.ts:5
Where a photo lives, as the Type and Source Type bytes number it.
Enumeration Members
Book
Book:
2
Defined in: protocol/src/packet/PhotoTransferPacket.ts:8
PhotoItem
PhotoItem:
1
Defined in: protocol/src/packet/PhotoTransferPacket.ts:7
Portfolio
Portfolio:
0
Defined in: protocol/src/packet/PhotoTransferPacket.ts:6
PlayStatus
Defined in: protocol/src/packet/PlayStatusPacket.ts:12
The docs' PlayStatus enum, the Status of a PlayStatusPacket, with the docs' member names and the values the protocol 2193 docs list.
Enumeration Members
LoginFailed_ClientOld
LoginFailed_ClientOld:
1
Defined in: protocol/src/packet/PlayStatusPacket.ts:14
LoginFailed_EditionMismatchEduToVanilla
LoginFailed_EditionMismatchEduToVanilla:
5
Defined in: protocol/src/packet/PlayStatusPacket.ts:18
LoginFailed_EditionMismatchVanillaToEdu
LoginFailed_EditionMismatchVanillaToEdu:
6
Defined in: protocol/src/packet/PlayStatusPacket.ts:19
LoginFailed_EditorMismatchEditorToVanilla
LoginFailed_EditorMismatchEditorToVanilla:
8
Defined in: protocol/src/packet/PlayStatusPacket.ts:21
LoginFailed_EditorMismatchVanillaToEditor
LoginFailed_EditorMismatchVanillaToEditor:
9
Defined in: protocol/src/packet/PlayStatusPacket.ts:22
LoginFailed_InvalidTenant
LoginFailed_InvalidTenant:
4
Defined in: protocol/src/packet/PlayStatusPacket.ts:17
LoginFailed_ServerFullSubClient
LoginFailed_ServerFullSubClient:
7
Defined in: protocol/src/packet/PlayStatusPacket.ts:20
LoginFailed_ServerOld
LoginFailed_ServerOld:
2
Defined in: protocol/src/packet/PlayStatusPacket.ts:15
LoginSuccess
LoginSuccess:
0
Defined in: protocol/src/packet/PlayStatusPacket.ts:13
PlayerSpawn
PlayerSpawn:
3
Defined in: protocol/src/packet/PlayStatusPacket.ts:16
PlayerActionType
Defined in: protocol/src/packet/PlayerActionPacket.ts:15
The docs' PlayerActionType, the Action field of PlayerActionPacket, numbered as the 1.26.51 client writes it. Member names are the docs' names; GetUpdatedBlock, DropItem, ChangeSkin, SetEnchantmentSeed and InteractBlock are values the docs leave unnamed. Values 36 and 39 (Count) are not named in the docs and are left out.
See
https://mojang.github.io/bedrock-protocol-docs/1.26.51/packets/player-action-packet/
Enumeration Members
AbortDestroyBlock
AbortDestroyBlock:
1
Defined in: protocol/src/packet/PlayerActionPacket.ts:17
ChangeDimensionAck
ChangeDimensionAck:
14
Defined in: protocol/src/packet/PlayerActionPacket.ts:30
ChangeSkin
ChangeSkin:
19
Defined in: protocol/src/packet/PlayerActionPacket.ts:35
ContinueDestroyBlock
ContinueDestroyBlock:
27
Defined in: protocol/src/packet/PlayerActionPacket.ts:43
CrackBlock
CrackBlock:
18
Defined in: protocol/src/packet/PlayerActionPacket.ts:34
CreativeDestroyBlock
CreativeDestroyBlock:
13
Defined in: protocol/src/packet/PlayerActionPacket.ts:29
DenyDestroyBlock
DenyDestroyBlock:
17
Defined in: protocol/src/packet/PlayerActionPacket.ts:33
DropItem
DropItem:
4
Defined in: protocol/src/packet/PlayerActionPacket.ts:20
GetUpdatedBlock
GetUpdatedBlock:
3
Defined in: protocol/src/packet/PlayerActionPacket.ts:19
HandledTeleport
HandledTeleport:
30
Defined in: protocol/src/packet/PlayerActionPacket.ts:46
InteractBlock
InteractBlock:
25
Defined in: protocol/src/packet/PlayerActionPacket.ts:41
InternalUpdate
InternalUpdate:
38
Defined in: protocol/src/packet/PlayerActionPacket.ts:55
Reserved by the client for its own bookkeeping; carries no gameplay meaning.
MissedSwing
MissedSwing:
31
Defined in: protocol/src/packet/PlayerActionPacket.ts:48
The client swung at nothing.
PredictDestroyBlock
PredictDestroyBlock:
26
Defined in: protocol/src/packet/PlayerActionPacket.ts:42
Respawn
Respawn:
7
Defined in: protocol/src/packet/PlayerActionPacket.ts:23
SetEnchantmentSeed
SetEnchantmentSeed:
20
Defined in: protocol/src/packet/PlayerActionPacket.ts:36
StartCrawling
StartCrawling:
32
Defined in: protocol/src/packet/PlayerActionPacket.ts:49
StartDestroyBlock
StartDestroyBlock:
0
Defined in: protocol/src/packet/PlayerActionPacket.ts:16
StartFlying
StartFlying:
34
Defined in: protocol/src/packet/PlayerActionPacket.ts:51
StartGliding
StartGliding:
15
Defined in: protocol/src/packet/PlayerActionPacket.ts:31
StartItemUseOn
StartItemUseOn:
28
Defined in: protocol/src/packet/PlayerActionPacket.ts:44
StartJump
StartJump:
8
Defined in: protocol/src/packet/PlayerActionPacket.ts:24
StartSleeping
StartSleeping:
5
Defined in: protocol/src/packet/PlayerActionPacket.ts:21
StartSneaking
StartSneaking:
11
Defined in: protocol/src/packet/PlayerActionPacket.ts:27
StartSpinAttack
StartSpinAttack:
23
Defined in: protocol/src/packet/PlayerActionPacket.ts:39
StartSprinting
StartSprinting:
9
Defined in: protocol/src/packet/PlayerActionPacket.ts:25
StartSwimming
StartSwimming:
21
Defined in: protocol/src/packet/PlayerActionPacket.ts:37
StartUsingItem
StartUsingItem:
37
Defined in: protocol/src/packet/PlayerActionPacket.ts:53
StopCrawling
StopCrawling:
33
Defined in: protocol/src/packet/PlayerActionPacket.ts:50
StopDestroyBlock
StopDestroyBlock:
2
Defined in: protocol/src/packet/PlayerActionPacket.ts:18
StopFlying
StopFlying:
35
Defined in: protocol/src/packet/PlayerActionPacket.ts:52
StopGliding
StopGliding:
16
Defined in: protocol/src/packet/PlayerActionPacket.ts:32
StopItemUseOn
StopItemUseOn:
29
Defined in: protocol/src/packet/PlayerActionPacket.ts:45
StopSleeping
StopSleeping:
6
Defined in: protocol/src/packet/PlayerActionPacket.ts:22
StopSneaking
StopSneaking:
12
Defined in: protocol/src/packet/PlayerActionPacket.ts:28
StopSpinAttack
StopSpinAttack:
24
Defined in: protocol/src/packet/PlayerActionPacket.ts:40
StopSprinting
StopSprinting:
10
Defined in: protocol/src/packet/PlayerActionPacket.ts:26
StopSwimming
StopSwimming:
22
Defined in: protocol/src/packet/PlayerActionPacket.ts:38
PlayerAuthInputData
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:32
Input flags listed by Mojang for PlayerAuthInputPacket.
Enumeration Members
ASCEND
ASCEND:
0
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:33
ASCEND_BLOCK
ASCEND_BLOCK:
21
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:53
AUTO_JUMPING_IN_WATER
AUTO_JUMPING_IN_WATER:
7
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:39
BLOCK_BREAKING_DELAY_ENABLED
BLOCK_BREAKING_DELAY_ENABLED:
48
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:80
CHANGE_HEIGHT
CHANGE_HEIGHT:
5
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:37
CLIENT_ACK_SERVER_DATA
CLIENT_ACK_SERVER_DATA:
44
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:76
DESCEND
DESCEND:
1
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:34
DESCEND_BLOCK
DESCEND_BLOCK:
22
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:54
DOWN
DOWN:
11
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:43
DOWN_LEFT
DOWN_LEFT:
51
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:83
DOWN_RIGHT
DOWN_RIGHT:
52
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:84
EMOTING
EMOTING:
38
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:70
HANDLED_TELEPORT
HANDLED_TELEPORT:
37
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:69
HORIZONTAL_COLLISION
HORIZONTAL_COLLISION:
49
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:81
INTERNAL_UPDATE
INTERNAL_UPDATE:
65
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:95
IS_HOTBAR_ONLY_TOUCH
IS_HOTBAR_ONLY_TOUCH:
58
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:88
IS_IN_CLIENT_PREDICTED_VEHICLE
IS_IN_CLIENT_PREDICTED_VEHICLE:
45
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:77
JUMP_CURRENT_RAW
JUMP_CURRENT_RAW:
61
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:91
JUMP_DOWN
JUMP_DOWN:
3
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:35
JUMP_PRESSED_RAW
JUMP_PRESSED_RAW:
60
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:90
JUMP_RELEASED_RAW
JUMP_RELEASED_RAW:
59
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:89
JUMPING
JUMPING:
6
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:38
LEFT
LEFT:
12
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:44
MISSED_SWING
MISSED_SWING:
39
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:71
PADDLING_LEFT
PADDLING_LEFT:
46
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:78
PADDLING_RIGHT
PADDLING_RIGHT:
47
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:79
PERFORM_BLOCK_ACTIONS
PERFORM_BLOCK_ACTIONS:
35
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:67
PERFORM_ITEM_INTERACTION
PERFORM_ITEM_INTERACTION:
34
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:66
PERFORM_ITEM_STACK_REQUEST
PERFORM_ITEM_STACK_REQUEST:
36
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:68
PERSIST_SNEAK
PERSIST_SNEAK:
24
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:56
RIGHT
RIGHT:
13
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:45
SNEAK_CURRENT_RAW
SNEAK_CURRENT_RAW:
64
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:94
SNEAK_DOWN
SNEAK_DOWN:
9
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:41
SNEAK_PRESSED_RAW
SNEAK_PRESSED_RAW:
63
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:93
SNEAK_RELEASED_RAW
SNEAK_RELEASED_RAW:
62
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:92
SNEAK_TOGGLE_DOWN
SNEAK_TOGGLE_DOWN:
23
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:55
SNEAKING
SNEAKING:
8
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:40
SPRINT_DOWN
SPRINT_DOWN:
4
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:36
SPRINTING
SPRINTING:
20
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:52
START_CRAWLING
START_CRAWLING:
40
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:72
START_FLYING
START_FLYING:
42
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:74
START_GLIDING
START_GLIDING:
32
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:64
START_JUMPING
START_JUMPING:
31
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:63
START_SNEAKING
START_SNEAKING:
27
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:59
START_SPIN_ATTACK
START_SPIN_ATTACK:
56
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:86
START_SPRINTING
START_SPRINTING:
25
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:57
START_SWIMMING
START_SWIMMING:
29
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:61
START_USING_ITEM
START_USING_ITEM:
53
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:85
STOP_CRAWLING
STOP_CRAWLING:
41
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:73
STOP_FLYING
STOP_FLYING:
43
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:75
STOP_GLIDING
STOP_GLIDING:
33
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:65
STOP_SNEAKING
STOP_SNEAKING:
28
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:60
STOP_SPIN_ATTACK
STOP_SPIN_ATTACK:
57
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:87
STOP_SPRINTING
STOP_SPRINTING:
26
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:58
STOP_SWIMMING
STOP_SWIMMING:
30
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:62
UP
UP:
10
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:42
UP_LEFT
UP_LEFT:
14
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:46
UP_RIGHT
UP_RIGHT:
15
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:47
VERTICAL_COLLISION
VERTICAL_COLLISION:
50
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:82
WANT_DOWN
WANT_DOWN:
17
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:49
WANT_DOWN_SLOW
WANT_DOWN_SLOW:
18
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:50
WANT_UP
WANT_UP:
16
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:48
WANT_UP_SLOW
WANT_UP_SLOW:
19
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:51
PlayerListAction
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:185
The Action byte of a player list entry: 0 adds a player, 1 removes one.
The 1.26.50 docs page lists both values as 0. The client reads Add as 0 and Remove as 1, and the 1.26.60 page corrects the table. The variant selector written before the byte is numbered the other way round: Add selects 1 and Remove selects 0.
Enumeration Members
TYPE_ADD
TYPE_ADD:
0
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:186
TYPE_REMOVE
TYPE_REMOVE:
1
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:187
PlayerLocationPacketType
Defined in: protocol/src/packet/PlayerLocationPacket.ts:8
The two alternatives in a player location update.
Enumeration Members
PLAYER_LOCATION_COORDINATES
PLAYER_LOCATION_COORDINATES:
0
Defined in: protocol/src/packet/PlayerLocationPacket.ts:10
A player position follows.
PLAYER_LOCATION_HIDE
PLAYER_LOCATION_HIDE:
1
Defined in: protocol/src/packet/PlayerLocationPacket.ts:12
The player should be hidden; no position follows.
PlayerVideoCaptureAction
Defined in: protocol/src/packet/PlayerVideoCapturePacket.ts:7
Which alternative a PlayerVideoCapturePacket carries, as the byte that opens the payload.
Enumeration Members
START
START:
1
Defined in: protocol/src/packet/PlayerVideoCapturePacket.ts:11
Start Video Capture: FrameRate and FilePrefix follow.
STOP
STOP:
0
Defined in: protocol/src/packet/PlayerVideoCapturePacket.ts:9
Stop Video Capture: no further fields.
PositionMode
Defined in: protocol/src/packet/MovePlayerPacket.ts:10
Position Mode, which tells the client how to apply this move.
See
https://mojang.github.io/bedrock-protocol-docs/1.26.51/packets/move-player-packet/
Enumeration Members
Normal
Normal:
0
Defined in: protocol/src/packet/MovePlayerPacket.ts:12
Ordinary movement. Clients also send this mode to the server.
OnlyHeadRot
OnlyHeadRot:
3
Defined in: protocol/src/packet/MovePlayerPacket.ts:18
Updates the head rotation while the player is in a vehicle.
Respawn
Respawn:
1
Defined in: protocol/src/packet/MovePlayerPacket.ts:14
Places the player at the spawn position. Sent by the server.
Teleport
Teleport:
2
Defined in: protocol/src/packet/MovePlayerPacket.ts:16
Moves the player to a new location; carries Teleportation Cause and Source Actor Type.
PositionTrackingDBClientRequestAction
Defined in: protocol/src/packet/PositionTrackingDBClientRequestPacket.ts:7
What a PositionTrackingDBClientRequestPacket asks for, as the Action uint8 numbers it.
Enumeration Members
Query
Query:
0
Defined in: protocol/src/packet/PositionTrackingDBClientRequestPacket.ts:8
PositionTrackingDBServerBroadcastAction
Defined in: protocol/src/packet/PositionTrackingDBServerBroadcastPacket.ts:6
The result of a position tracking lookup, as the Action uint8 numbers it.
Enumeration Members
Destroy
Destroy:
1
Defined in: protocol/src/packet/PositionTrackingDBServerBroadcastPacket.ts:8
NotFound
NotFound:
2
Defined in: protocol/src/packet/PositionTrackingDBServerBroadcastPacket.ts:9
Update
Update:
0
Defined in: protocol/src/packet/PositionTrackingDBServerBroadcastPacket.ts:7
PrimitiveShapeExtraDataType
Defined in: protocol/src/structure/PrimitiveShapeData.ts:30
Which alternative of Extra Shape Data a shape carries. The value is the alternative's index in the schema's oneOf, written as the varuint32 selector. It is not a PrimitiveShapeType: Line is shape type 0 but extra data alternative 4, and Circle has no extra data of its own (it uses SphereDataPayload).
Enumeration Members
Arrow
Arrow:
1
Defined in: protocol/src/structure/PrimitiveShapeData.ts:33
Box
Box:
3
Defined in: protocol/src/structure/PrimitiveShapeData.ts:35
Cone
Cone:
9
Defined in: protocol/src/structure/PrimitiveShapeData.ts:41
Cylinder
Cylinder:
6
Defined in: protocol/src/structure/PrimitiveShapeData.ts:38
Ellipsoid
Ellipsoid:
8
Defined in: protocol/src/structure/PrimitiveShapeData.ts:40
Line
Line:
4
Defined in: protocol/src/structure/PrimitiveShapeData.ts:36
None
None:
0
Defined in: protocol/src/structure/PrimitiveShapeData.ts:32
The null alternative: no extra data. A shape with no Shape Type and no extra data is a removal.
Pyramid
Pyramid:
7
Defined in: protocol/src/structure/PrimitiveShapeData.ts:39
Sphere
Sphere:
5
Defined in: protocol/src/structure/PrimitiveShapeData.ts:37
Text
Text:
2
Defined in: protocol/src/structure/PrimitiveShapeData.ts:34
PrimitiveShapeType
Defined in: protocol/src/structure/PrimitiveShapeData.ts:11
A ScriptModuleMinecraft::ScriptPrimitiveShapeType, the Shape Type byte of a debug shape. The values are the ones the wire carries.
Enumeration Members
Arrow
Arrow:
5
Defined in: protocol/src/structure/PrimitiveShapeData.ts:17
Box
Box:
1
Defined in: protocol/src/structure/PrimitiveShapeData.ts:13
Circle
Circle:
3
Defined in: protocol/src/structure/PrimitiveShapeData.ts:15
Cone
Cone:
9
Defined in: protocol/src/structure/PrimitiveShapeData.ts:21
Cylinder
Cylinder:
6
Defined in: protocol/src/structure/PrimitiveShapeData.ts:18
Ellipsoid
Ellipsoid:
8
Defined in: protocol/src/structure/PrimitiveShapeData.ts:20
Line
Line:
0
Defined in: protocol/src/structure/PrimitiveShapeData.ts:12
Pyramid
Pyramid:
7
Defined in: protocol/src/structure/PrimitiveShapeData.ts:19
Sphere
Sphere:
2
Defined in: protocol/src/structure/PrimitiveShapeData.ts:14
Text
Text:
4
Defined in: protocol/src/structure/PrimitiveShapeData.ts:16
RecipeUnlockingContext
Defined in: protocol/src/packet/CraftingDataPacket.ts:14
The docs' RecipeUnlockingContext: what has to be true before a recipe shows up in the book.
Enumeration Members
ALWAYS_UNLOCKED
ALWAYS_UNLOCKED:
1
Defined in: protocol/src/packet/CraftingDataPacket.ts:17
NONE
NONE:
0
Defined in: protocol/src/packet/CraftingDataPacket.ts:16
Unlocked by holding the ingredients, which are then listed.
PLAYER_HAS_MANY_ITEMS
PLAYER_HAS_MANY_ITEMS:
3
Defined in: protocol/src/packet/CraftingDataPacket.ts:19
PLAYER_IN_WATER
PLAYER_IN_WATER:
2
Defined in: protocol/src/packet/CraftingDataPacket.ts:18
RequestAbilityValueType
Defined in: protocol/src/packet/RequestAbilityPacket.ts:9
Which of the two value slots in a RequestAbilityPacket carries the request.
Enumeration Members
Bool
Bool:
1
Defined in: protocol/src/packet/RequestAbilityPacket.ts:11
Float
Float:
2
Defined in: protocol/src/packet/RequestAbilityPacket.ts:12
Unset
Unset:
0
Defined in: protocol/src/packet/RequestAbilityPacket.ts:10
ResourcePackStatus
Defined in: protocol/src/packet/ResourcePackClientResponsePacket.ts:23
The client's answer in a ResourcePackClientResponsePacket, numbered one above the wire's alternative index so that None can stand for no answer yet.
The docs page is https://mojang.github.io/bedrock-protocol-docs/1.26.51/packets/resource-pack-client-response-packet/ and names the alternatives differently:
Nonehas no wire form. Encoding it throws.RefusedisCancel, alternative 0.SendPacksisDownloading, alternative 1, the only one followed by aDownloading Packslist.HaveAllPacksisDownloadingFinished, alternative 2.CompletedisResourcePackStackFinished, alternative 3.
ResourcePackResponse from @jsprismarine/minecraft is the generated equivalent, with the docs names and the same values (CANCEL = 1 through RESOURCE_PACK_STACK_FINISHED = 4). This enum stays exported under its own names because the client package depends on them.
See
https://mojang.github.io/bedrock-protocol-docs/1.26.51/packets/resource-pack-client-response-packet/
Enumeration Members
Completed
Completed:
4
Defined in: protocol/src/packet/ResourcePackClientResponsePacket.ts:28
HaveAllPacks
HaveAllPacks:
3
Defined in: protocol/src/packet/ResourcePackClientResponsePacket.ts:27
None
None:
0
Defined in: protocol/src/packet/ResourcePackClientResponsePacket.ts:24
Refused
Refused:
1
Defined in: protocol/src/packet/ResourcePackClientResponsePacket.ts:25
SendPacks
SendPacks:
2
Defined in: protocol/src/packet/ResourcePackClientResponsePacket.ts:26
RewindType
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:8
What the movement correction rewinds, as the PredictionType byte numbers it.
Enumeration Members
Player
Player:
0
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:9
Vehicle
Vehicle:
1
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:10
Rotation
Defined in: protocol/src/packet/GameTestRequestPacket.ts:15
The docs' Rotation, how far a structure is turned when it is placed.
Clockwise90, Clockwise180 and CounterClockwise90 are other names for 1, 2 and 3, not members 4, 5 and 6 as the rendered page lists them. The datagen snapshot in packages/minecraft numbers them that way, and the page's own 2207 changelog "moves" them back down to 1, 2 and 3.
Enumeration Members
Clockwise180
Clockwise180:
2
Defined in: protocol/src/packet/GameTestRequestPacket.ts:27
Docs: Clockwise180, the same value as Rotation.Rotate180.
Clockwise90
Clockwise90:
1
Defined in: protocol/src/packet/GameTestRequestPacket.ts:25
Docs: Clockwise90, the same value as Rotation.Rotate90.
CounterClockwise90
CounterClockwise90:
3
Defined in: protocol/src/packet/GameTestRequestPacket.ts:29
Docs: CounterClockwise90, the same value as Rotation.Rotate270.
None
None:
0
Defined in: protocol/src/packet/GameTestRequestPacket.ts:17
Docs: None.
Rotate180
Rotate180:
2
Defined in: protocol/src/packet/GameTestRequestPacket.ts:21
Docs: Rotate180.
Rotate270
Rotate270:
3
Defined in: protocol/src/packet/GameTestRequestPacket.ts:23
Docs: Rotate270.
Rotate90
Rotate90:
1
Defined in: protocol/src/packet/GameTestRequestPacket.ts:19
Docs: Rotate90.
ScorePacketEntryAction
Defined in: protocol/src/wire/definitions/scoreboard.ts:13
Which alternative of the Score Info oneOf an entry is, as the varuint32 selector numbers it.
Enumeration Members
ChangeEntity
ChangeEntity:
2
Defined in: protocol/src/wire/definitions/scoreboard.ts:16
ChangeFakePlayer
ChangeFakePlayer:
3
Defined in: protocol/src/wire/definitions/scoreboard.ts:17
ChangePlayer
ChangePlayer:
1
Defined in: protocol/src/wire/definitions/scoreboard.ts:15
Remove
Remove:
0
Defined in: protocol/src/wire/definitions/scoreboard.ts:14
ScoreboardIdentityPacketType
Defined in: protocol/src/packet/SetScoreboardIdentityPacket.ts:9
Whether the entries attach an identity or drop one, as the leading byte numbers it.
Enumeration Members
Remove
Remove:
1
Defined in: protocol/src/packet/SetScoreboardIdentityPacket.ts:11
Update
Update:
0
Defined in: protocol/src/packet/SetScoreboardIdentityPacket.ts:10
ServerWaypointGroupAction
Defined in: protocol/src/structure/LocatorBarWaypointPayload.ts:10
ServerWaypointGroup::Action: what a LocatorBarPacket entry does to the waypoint it names. The docs' values: None = 0, Add = 1, Remove = 2, Update = 3.
Enumeration Members
Add
Add:
1
Defined in: protocol/src/structure/LocatorBarWaypointPayload.ts:12
None
None:
0
Defined in: protocol/src/structure/LocatorBarWaypointPayload.ts:11
Remove
Remove:
2
Defined in: protocol/src/structure/LocatorBarWaypointPayload.ts:13
Update
Update:
3
Defined in: protocol/src/structure/LocatorBarWaypointPayload.ts:14
ServerboundLoadingScreenPacketType
Defined in: protocol/src/packet/ServerboundLoadingScreenPacket.ts:9
The loading screen edge reported by the client.
Enumeration Members
EndLoadingScreen
EndLoadingScreen:
2
Defined in: protocol/src/packet/ServerboundLoadingScreenPacket.ts:12
StartLoadingScreen
StartLoadingScreen:
1
Defined in: protocol/src/packet/ServerboundLoadingScreenPacket.ts:11
Unknown
Unknown:
0
Defined in: protocol/src/packet/ServerboundLoadingScreenPacket.ts:10
ShowStoreOfferRedirectType
Defined in: protocol/src/packet/ShowStoreOfferPacket.ts:5
Which page the client opens for the offer, as the Redirect Type byte numbers it.
Enumeration Members
DressingRoomOffer
DressingRoomOffer:
1
Defined in: protocol/src/packet/ShowStoreOfferPacket.ts:7
MarketplaceOffer
MarketplaceOffer:
0
Defined in: protocol/src/packet/ShowStoreOfferPacket.ts:6
ThirdPartyServerPage
ThirdPartyServerPage:
2
Defined in: protocol/src/packet/ShowStoreOfferPacket.ts:8
SimpleEventSubtype
Defined in: protocol/src/packet/SimpleEventPacket.ts:9
The requests a SimpleEventPacket can carry, as the Type uint16 numbers them.
Enumeration Members
DisableCommands
DisableCommands:
2
Defined in: protocol/src/packet/SimpleEventPacket.ts:12
EnableCommands
EnableCommands:
1
Defined in: protocol/src/packet/SimpleEventPacket.ts:11
UninitializedSubtype
UninitializedSubtype:
0
Defined in: protocol/src/packet/SimpleEventPacket.ts:10
UnlockWorldTemplateSettings
UnlockWorldTemplateSettings:
3
Defined in: protocol/src/packet/SimpleEventPacket.ts:13
SimulationType
Defined in: protocol/src/packet/SimulationTypePacket.ts:12
The SimulationType enum carried by SimulationTypePacket, numbered as the protocol 2193 docs and Mojang's enum snapshot list them.
Enumeration Members
Editor
Editor:
1
Defined in: protocol/src/packet/SimulationTypePacket.ts:16
Docs: Editor.
Game
Game:
0
Defined in: protocol/src/packet/SimulationTypePacket.ts:14
Docs: Game.
Invalid
Invalid:
3
Defined in: protocol/src/packet/SimulationTypePacket.ts:20
Docs: INVALID.
Test
Test:
2
Defined in: protocol/src/packet/SimulationTypePacket.ts:18
Docs: Test.
SoftEnumUpdateType
Defined in: protocol/src/packet/UpdateSoftEnumPacket.ts:7
What to do with the values in a soft enum update.
Enumeration Members
ADD
ADD:
0
Defined in: protocol/src/packet/UpdateSoftEnumPacket.ts:9
Add these values to the enum the client already has.
REMOVE
REMOVE:
1
Defined in: protocol/src/packet/UpdateSoftEnumPacket.ts:11
Remove these values from the enum.
REPLACE
REPLACE:
2
Defined in: protocol/src/packet/UpdateSoftEnumPacket.ts:13
Replace the enum's current values with these values.
SoundDataUpdateType
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:11
Which change a sound update carries. The value is the alternative index on the wire: the position in the schema's oneOf of Stop, SetVolume, SetPitch, Fade, SeekTo, Pause and Resume.
Enumeration Members
Fade
Fade:
3
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:15
Pause
Pause:
5
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:17
Resume
Resume:
6
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:18
SeekTo
SeekTo:
4
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:16
SetPitch
SetPitch:
2
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:14
SetVolume
SetVolume:
1
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:13
Stop
Stop:
0
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:12
SoundName
Defined in: protocol/src/packet/PlaySoundPacket.ts:8
Sound names this packet and the /playsound command accept, a subset of the client's sound definitions.
Enumeration Members
AMBIENT_BASALT_DELTAS_MOOD
AMBIENT_BASALT_DELTAS_MOOD:
"ambient.basalt_deltas.mood"
Defined in: protocol/src/packet/PlaySoundPacket.ts:10
AMBIENT_CAVE
AMBIENT_CAVE:
"ambient.cave"
Defined in: protocol/src/packet/PlaySoundPacket.ts:11
AMBIENT_CRIMSON_FOREST_MOOD
AMBIENT_CRIMSON_FOREST_MOOD:
"ambient.crimson_forest.mood"
Defined in: protocol/src/packet/PlaySoundPacket.ts:12
AMBIENT_NETHER_WASTES_MOOD
AMBIENT_NETHER_WASTES_MOOD:
"ambient.nether_wastes.mood"
Defined in: protocol/src/packet/PlaySoundPacket.ts:13
AMBIENT_SOULSAND_VALLEY_MOOD
AMBIENT_SOULSAND_VALLEY_MOOD:
"ambient.soulsand_valley.mood"
Defined in: protocol/src/packet/PlaySoundPacket.ts:14
AMBIENT_WARPED_FOREST_MOOD
AMBIENT_WARPED_FOREST_MOOD:
"ambient.warped_forest.mood"
Defined in: protocol/src/packet/PlaySoundPacket.ts:15
AMBIENT_WEATHER_LIGHTNING_IMPACT
AMBIENT_WEATHER_LIGHTNING_IMPACT:
"ambient.weather.lightning.impact"
Defined in: protocol/src/packet/PlaySoundPacket.ts:16
AMBIENT_WEATHER_RAIN
AMBIENT_WEATHER_RAIN:
"ambient.weather.rain"
Defined in: protocol/src/packet/PlaySoundPacket.ts:17
AMBIENT_WEATHER_THUNDER
AMBIENT_WEATHER_THUNDER:
"ambient.weather.thunder"
Defined in: protocol/src/packet/PlaySoundPacket.ts:18
ARMOR_EQUIP_CHAIN
ARMOR_EQUIP_CHAIN:
"armor.equip_chain"
Defined in: protocol/src/packet/PlaySoundPacket.ts:22
ARMOR_EQUIP_DIAMOND
ARMOR_EQUIP_DIAMOND:
"armor.equip_diamond"
Defined in: protocol/src/packet/PlaySoundPacket.ts:23
ARMOR_EQUIP_GENERIC
ARMOR_EQUIP_GENERIC:
"armor.equip_generic"
Defined in: protocol/src/packet/PlaySoundPacket.ts:24
ARMOR_EQUIP_GOLD
ARMOR_EQUIP_GOLD:
"armor.equip_gold"
Defined in: protocol/src/packet/PlaySoundPacket.ts:25
ARMOR_EQUIP_IRON
ARMOR_EQUIP_IRON:
"armor.equip_iron"
Defined in: protocol/src/packet/PlaySoundPacket.ts:26
ARMOR_EQUIP_LEATHER
ARMOR_EQUIP_LEATHER:
"armor.equip_leather"
Defined in: protocol/src/packet/PlaySoundPacket.ts:27
ARMOR_EQUIP_NETHERITE
ARMOR_EQUIP_NETHERITE:
"armor.equip_netherite"
Defined in: protocol/src/packet/PlaySoundPacket.ts:21
BEACON_ACTIVATE
BEACON_ACTIVATE:
"beacon.activate"
Defined in: protocol/src/packet/PlaySoundPacket.ts:30
BEACON_AMBIENT
BEACON_AMBIENT:
"beacon.ambient"
Defined in: protocol/src/packet/PlaySoundPacket.ts:31
BEACON_DEACTIVATE
BEACON_DEACTIVATE:
"beacon.deactivate"
Defined in: protocol/src/packet/PlaySoundPacket.ts:32
BEACON_POWER
BEACON_POWER:
"beacon.power"
Defined in: protocol/src/packet/PlaySoundPacket.ts:33
BLOCK_BAMBOO_BREAK
BLOCK_BAMBOO_BREAK:
"block.bamboo.break"
Defined in: protocol/src/packet/PlaySoundPacket.ts:36
BLOCK_BAMBOO_FALL
BLOCK_BAMBOO_FALL:
"block.bamboo.fall"
Defined in: protocol/src/packet/PlaySoundPacket.ts:37
BLOCK_BAMBOO_HIT
BLOCK_BAMBOO_HIT:
"block.bamboo.hit"
Defined in: protocol/src/packet/PlaySoundPacket.ts:38
BLOCK_BAMBOO_PLACE
BLOCK_BAMBOO_PLACE:
"block.bamboo.place"
Defined in: protocol/src/packet/PlaySoundPacket.ts:39
BLOCK_BAMBOO_SAPLING_BREAK
BLOCK_BAMBOO_SAPLING_BREAK:
"block.bamboo_sapling.break"
Defined in: protocol/src/packet/PlaySoundPacket.ts:41
BLOCK_BAMBOO_SAPLING_PLACE
BLOCK_BAMBOO_SAPLING_PLACE:
"block.bamboo_sapling.place"
Defined in: protocol/src/packet/PlaySoundPacket.ts:42
BLOCK_BAMBOO_STEP
BLOCK_BAMBOO_STEP:
"block.bamboo.step"
Defined in: protocol/src/packet/PlaySoundPacket.ts:40
BLOCK_BARREL_CLOSE
BLOCK_BARREL_CLOSE:
"block.barrel.close"
Defined in: protocol/src/packet/PlaySoundPacket.ts:43
BLOCK_BARREL_OPEN
BLOCK_BARREL_OPEN:
"block.barrel.open"
Defined in: protocol/src/packet/PlaySoundPacket.ts:44
BLOCK_BEEHIVE_DRIP
BLOCK_BEEHIVE_DRIP:
"block.beehive.drip"
Defined in: protocol/src/packet/PlaySoundPacket.ts:45
BLOCK_BEEHIVE_ENTER
BLOCK_BEEHIVE_ENTER:
"block.beehive.enter"
Defined in: protocol/src/packet/PlaySoundPacket.ts:46
BLOCK_BEEHIVE_EXIT
BLOCK_BEEHIVE_EXIT:
"block.beehive.exit"
Defined in: protocol/src/packet/PlaySoundPacket.ts:47
BLOCK_BEEHIVE_SHEAR
BLOCK_BEEHIVE_SHEAR:
"block.beehive.shear"
Defined in: protocol/src/packet/PlaySoundPacket.ts:48
BLOCK_BEEHIVE_WORK
BLOCK_BEEHIVE_WORK:
"block.beehive.work"
Defined in: protocol/src/packet/PlaySoundPacket.ts:49
BLOCK_BELL_HIT
BLOCK_BELL_HIT:
"block.bell.hit"
Defined in: protocol/src/packet/PlaySoundPacket.ts:50
BLOCK_BLASTFURNACE_FIRE_CRACKLE
BLOCK_BLASTFURNACE_FIRE_CRACKLE:
"block.blastfurnace.fire_crackle"
Defined in: protocol/src/packet/PlaySoundPacket.ts:51
BLOCK_CAMPFIRE_CRACKLE
BLOCK_CAMPFIRE_CRACKLE:
"block.campfire.crackle"
Defined in: protocol/src/packet/PlaySoundPacket.ts:52
BLOCK_CARTOGRAPHY_TABLE_USE
BLOCK_CARTOGRAPHY_TABLE_USE:
"block.cartography_table.use"
Defined in: protocol/src/packet/PlaySoundPacket.ts:53
BLOCK_CHORUSFLOWER_DEATH
BLOCK_CHORUSFLOWER_DEATH:
"block.chorusflower.death"
Defined in: protocol/src/packet/PlaySoundPacket.ts:54
BLOCK_CHORUSFLOWER_GROW
BLOCK_CHORUSFLOWER_GROW:
"block.chorusflower.grow"
Defined in: protocol/src/packet/PlaySoundPacket.ts:55
BLOCK_COMPOSTER_EMPTY
BLOCK_COMPOSTER_EMPTY:
"block.composter.empty"
Defined in: protocol/src/packet/PlaySoundPacket.ts:56
BLOCK_COMPOSTER_FILL
BLOCK_COMPOSTER_FILL:
"block.composter.fill"
Defined in: protocol/src/packet/PlaySoundPacket.ts:57
BLOCK_COMPOSTER_FILL_SUCCESS
BLOCK_COMPOSTER_FILL_SUCCESS:
"block.composter.fill_success"
Defined in: protocol/src/packet/PlaySoundPacket.ts:58
BLOCK_COMPOSTER_READY
BLOCK_COMPOSTER_READY:
"block.composter.ready"
Defined in: protocol/src/packet/PlaySoundPacket.ts:59
BLOCK_END_PORTAL_FRAME_FILL
BLOCK_END_PORTAL_FRAME_FILL:
"block.end_portal_frame.fill"
Defined in: protocol/src/packet/PlaySoundPacket.ts:61
BLOCK_END_PORTAL_SPAWN
BLOCK_END_PORTAL_SPAWN:
"block.end_portal.spawn"
Defined in: protocol/src/packet/PlaySoundPacket.ts:60
BLOCK_FALSE_PERMISSIONS
BLOCK_FALSE_PERMISSIONS:
"block.false_permissions"
Defined in: protocol/src/packet/PlaySoundPacket.ts:62
BLOCK_FURNACE_LIT
BLOCK_FURNACE_LIT:
"block.furnace.lit"
Defined in: protocol/src/packet/PlaySoundPacket.ts:63
BLOCK_GRINDSTONE_USE
BLOCK_GRINDSTONE_USE:
"block.grindstone.use"
Defined in: protocol/src/packet/PlaySoundPacket.ts:64
SpawnPositionType
Defined in: protocol/src/packet/SetSpawnPositionPacket.ts:10
Known values for the Spawn Position Type field.
Enumeration Members
PlayerRespawn
PlayerRespawn:
0
Defined in: protocol/src/packet/SetSpawnPositionPacket.ts:12
The position is a player's respawn point.
WorldSpawn
WorldSpawn:
1
Defined in: protocol/src/packet/SetSpawnPositionPacket.ts:14
The position is the world's default spawn point.
StructureBlockType
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:10
Which structure block mode the editor selected.
Enumeration Members
Corner
Corner:
3
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:14
Data
Data:
0
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:11
Export
Export:
5
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:16
Invalid
Invalid:
4
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:15
Load
Load:
2
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:13
Save
Save:
1
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:12
StructureRedstoneSaveMode
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:20
Where a redstone-triggered save writes the structure.
Enumeration Members
SavesToDisk
SavesToDisk:
1
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:22
SavesToMemory
SavesToMemory:
0
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:21
StructureRotation
Defined in: protocol/src/structure/StructureSettings.ts:7
The quarter-turn applied when a structure is placed, written as one byte.
Enumeration Members
Clockwise180
Clockwise180:
2
Defined in: protocol/src/structure/StructureSettings.ts:15
The same value as StructureRotation.Rotate180.
Clockwise90
Clockwise90:
1
Defined in: protocol/src/structure/StructureSettings.ts:13
The same value as StructureRotation.Rotate90.
CounterClockwise90
CounterClockwise90:
3
Defined in: protocol/src/structure/StructureSettings.ts:17
The same value as StructureRotation.Rotate270.
None
None:
0
Defined in: protocol/src/structure/StructureSettings.ts:8
Rotate180
Rotate180:
2
Defined in: protocol/src/structure/StructureSettings.ts:10
Rotate270
Rotate270:
3
Defined in: protocol/src/structure/StructureSettings.ts:11
Rotate90
Rotate90:
1
Defined in: protocol/src/structure/StructureSettings.ts:9
StructureTemplateRequestOperation
Defined in: protocol/src/packet/StructureTemplateDataRequestPacket.ts:10
What the client asked the structure block server to do.
Enumeration Members
ExportFromLoadMode
ExportFromLoadMode:
2
Defined in: protocol/src/packet/StructureTemplateDataRequestPacket.ts:13
ExportFromSaveMode
ExportFromSaveMode:
1
Defined in: protocol/src/packet/StructureTemplateDataRequestPacket.ts:12
None
None:
0
Defined in: protocol/src/packet/StructureTemplateDataRequestPacket.ts:11
QuerySavedStructure
QuerySavedStructure:
3
Defined in: protocol/src/packet/StructureTemplateDataRequestPacket.ts:14
StructureTemplateResponseType
Defined in: protocol/src/packet/StructureTemplateDataResponsePacket.ts:10
Which structure operation the response answers.
Enumeration Members
Export
Export:
1
Defined in: protocol/src/packet/StructureTemplateDataResponsePacket.ts:12
None
None:
0
Defined in: protocol/src/packet/StructureTemplateDataResponsePacket.ts:11
Query
Query:
2
Defined in: protocol/src/packet/StructureTemplateDataResponsePacket.ts:13
SubChunkRequestResult
Defined in: protocol/src/packet/SubChunkPacket.ts:19
The semantic SubChunkRequestResult values used by the server and clients.
Protocol 2193 writes SUCCESS as 0 and SUCCESS_ALL_AIR as 5. Protocol 2207 shifted the six wire values up by one and reserves 0 for UNDEFINED; the packet codec applies that version difference while keeping this API stable.
Enumeration Members
INDEX_OUT_OF_BOUNDS
INDEX_OUT_OF_BOUNDS:
5
Defined in: protocol/src/packet/SubChunkPacket.ts:31
The sub chunk y lies outside the dimension's range.
LEVEL_CHUNK_DOESNT_EXIST
LEVEL_CHUNK_DOESNT_EXIST:
2
Defined in: protocol/src/packet/SubChunkPacket.ts:25
The server has no chunk at that column.
PLAYER_DOESNT_EXIST
PLAYER_DOESNT_EXIST:
4
Defined in: protocol/src/packet/SubChunkPacket.ts:29
The requesting player is unknown, for example already logged off.
SUCCESS
SUCCESS:
1
Defined in: protocol/src/packet/SubChunkPacket.ts:23
Serialized Sub Chunk holds the sub chunk.
SUCCESS_ALL_AIR
SUCCESS_ALL_AIR:
6
Defined in: protocol/src/packet/SubChunkPacket.ts:33
The sub chunk is all air, so no Serialized Sub Chunk is needed.
UNDEFINED
UNDEFINED:
0
Defined in: protocol/src/packet/SubChunkPacket.ts:21
No result; never sent on purpose.
WRONG_DIMENSION
WRONG_DIMENSION:
3
Defined in: protocol/src/packet/SubChunkPacket.ts:27
The player was in another dimension when the request arrived.
SyncWorldClocksDataType
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:10
Which alternative of the Data variant a SyncWorldClocksPacket carries. The value is the alternative's index in the schema's oneOf, written as the varuint32 selector on the wire.
Enumeration Members
AddTimeMarker
AddTimeMarker:
2
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:16
AddTimeMarkerData: new time markers for one clock.
InitializeRegistry
InitializeRegistry:
1
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:14
InitializeRegistryData: the full definition of every clock, sent on join.
RemoveTimeMarker
RemoveTimeMarker:
3
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:18
RemoveTimeMarkerData: time marker ids removed from one clock.
SyncState
SyncState:
0
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:12
SyncStateData: the current time and paused flag of every clock.
TextPacketType
Defined in: protocol/src/packet/TextPacket.ts:10
The docs' TextPacketType, the "Message Type" of a text packet. The values are the global ones the wire carries; member names are the docs' names in PascalCase.
Enumeration Members
Announcement
Announcement:
8
Defined in: protocol/src/packet/TextPacket.ts:19
Chat
Chat:
1
Defined in: protocol/src/packet/TextPacket.ts:12
JukeboxPopup
JukeboxPopup:
4
Defined in: protocol/src/packet/TextPacket.ts:15
Popup
Popup:
3
Defined in: protocol/src/packet/TextPacket.ts:14
Raw
Raw:
0
Defined in: protocol/src/packet/TextPacket.ts:11
SystemMessage
SystemMessage:
6
Defined in: protocol/src/packet/TextPacket.ts:17
TextObject
TextObject:
10
Defined in: protocol/src/packet/TextPacket.ts:21
TextObjectAnnouncement
TextObjectAnnouncement:
11
Defined in: protocol/src/packet/TextPacket.ts:22
TextObjectWhisper
TextObjectWhisper:
9
Defined in: protocol/src/packet/TextPacket.ts:20
Tip
Tip:
5
Defined in: protocol/src/packet/TextPacket.ts:16
Translate
Translate:
2
Defined in: protocol/src/packet/TextPacket.ts:13
Whisper
Whisper:
7
Defined in: protocol/src/packet/TextPacket.ts:18
TextureShiftAction
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:7
The Action ID of a texture shift update. The values are the ones the wire carries.
Enumeration Members
Initialize
Initialize:
1
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:9
Invalid
Invalid:
0
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:8
SetEnabled
SetEnabled:
3
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:12
Start
Start:
2
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:11
Begins a shift from From Step to To Step. Enabled says whether it begins enabled.
Sync
Sync:
4
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:13
TransactionType
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:26
The Transaction variant index, the docs' ComplexInventoryTransaction::Type.
It selects which body follows the Actions list. Normal and Mismatch have no body of their own. A 2193 client moves items between slots through ItemStackRequestPacket, so what it still sends here is USE_ITEM, USE_ITEM_ON_ENTITY and RELEASE_ITEM.
Enumeration Members
MISMATCH
MISMATCH:
1
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:28
NORMAL
NORMAL:
0
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:27
RELEASE_ITEM
RELEASE_ITEM:
4
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:31
USE_ITEM
USE_ITEM:
2
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:29
USE_ITEM_ON_ENTITY
USE_ITEM_ON_ENTITY:
3
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:30
UnlockedRecipesType
Defined in: protocol/src/packet/UnlockedRecipesPacket.ts:12
The docs' UnlockedRecipesPacketPayload::PacketType, what the client should do with the Unlocked Recipes List. Numbered from 0 as the datagen snapshot and the rendered page agree.
Enumeration Members
EMPTY
EMPTY:
0
Defined in: protocol/src/packet/UnlockedRecipesPacket.ts:14
Nothing to apply.
INITIALLY_UNLOCKED_RECIPES
INITIALLY_UNLOCKED_RECIPES:
1
Defined in: protocol/src/packet/UnlockedRecipesPacket.ts:16
The full set of recipes the player already has, sent once on load.
NEWLY_UNLOCKED_RECIPES
NEWLY_UNLOCKED_RECIPES:
2
Defined in: protocol/src/packet/UnlockedRecipesPacket.ts:18
Recipes unlocked since the last packet.
REMOVE_ALL_UNLOCKED_RECIPES
REMOVE_ALL_UNLOCKED_RECIPES:
4
Defined in: protocol/src/packet/UnlockedRecipesPacket.ts:22
Lock every recipe. The list is ignored.
REMOVE_UNLOCKED_RECIPES
REMOVE_UNLOCKED_RECIPES:
3
Defined in: protocol/src/packet/UnlockedRecipesPacket.ts:20
Recipes to lock again.
UpdateBlockFlagsType
Defined in: protocol/src/packet/UpdateBlockPacket.ts:20
How the client applies a block change, as the bits of vanilla's BlockUpdateFlag.
Network is the bit a server-driven change carries; a Bedrock Dedicated Server broadcasts its own block changes with Neighbors | Network, and sometimes Priority on top.
Enumeration Members
Neighbors
Neighbors:
1
Defined in: protocol/src/packet/UpdateBlockPacket.ts:23
Let the neighboring blocks react to the change.
Network
Network:
2
Defined in: protocol/src/packet/UpdateBlockPacket.ts:25
The change came over the network.
NoGraphic
NoGraphic:
4
Defined in: protocol/src/packet/UpdateBlockPacket.ts:27
Skip re-rendering the chunk the block is in.
None
None:
0
Defined in: protocol/src/packet/UpdateBlockPacket.ts:21
Priority
Priority:
8
Defined in: protocol/src/packet/UpdateBlockPacket.ts:29
Re-render ahead of other pending chunk updates.
UpdateBlockLayerType
Defined in: protocol/src/packet/UpdateBlockPacket.ts:7
Which of a position's two block layers an update targets.
Enumeration Members
Liquid
Liquid:
1
Defined in: protocol/src/packet/UpdateBlockPacket.ts:11
The waterlogging layer, holding the water or lava the block sits in.
Normal
Normal:
0
Defined in: protocol/src/packet/UpdateBlockPacket.ts:9
The block itself.
Classes
- AbilityLayer
- ActorEventPacket
- ActorLink
- ActorPickRequestPacket
- AddActorPacket
- AddBehaviorTreePacket
- AddItemActorPacket
- AddPaintingPacket
- AddPlayerPacket
- AddVolumeEntityPacket
- AgentActionEventPacket
- AgentAnimationPacket
- AnimateEntityPacket
- AnimatePacket
- AnvilDamagePacket
- AttributeLayerData
- AttributeLayerSettings
- AutomationClientConnectPacket
- AvailableActorIdentifiersPacket
- AvailableCommandsPacket
- AwardAchievementPacket
- BatchCodec
- BiomeDefinitionListPacket
- BlockActorDataPacket
- BlockEventPacket
- BlockPickRequestPacket
- BlockPos
- BookEditPacket
- BossEventPacket
- CameraAimAssistActorPriorityPacket
- CameraAimAssistCategoryDefinition
- CameraAimAssistCategoryPriorities
- CameraAimAssistPacket
- CameraAimAssistPresetDefinition
- CameraAimAssistPresetsPacket
- CameraInstruction
- CameraInstructionPacket
- CameraPacket
- CameraPreset
- CameraPresetsPacket
- CameraShakePacket
- CameraSplineDefinition
- CameraSplinePacket
- ChangeDimensionPacket
- ChangeMobPropertyPacket
- ChunkPos
- ChunkRadiusUpdatedPacket
- ClientCacheBlobStatusPacket
- ClientCacheMissResponsePacket
- ClientCacheStatusPacket
- ClientCameraAimAssistPacket
- ClientMovementPredictionSyncPacket
- ClientStoreEntryPointConfig
- ClientToServerHandshakePacket
- ClientboundAttributeLayerSyncPacket
- ClientboundCloseFormPacket
- ClientboundControlSchemeSetPacket
- ClientboundDataDrivenUICloseScreenPacket
- ClientboundDataDrivenUIReloadPacket
- ClientboundDataDrivenUIShowScreenPacket
- ClientboundDataStorePacket
- ClientboundDebugRendererPacket
- ClientboundMapItemDataPacket
- ClientboundMatchmakingStatePacket
- ClientboundPlayAudioContentPacket
- ClientboundStonecutterSetRecipePacket
- ClientboundTextureShiftPacket
- ClientboundUpdateSoundDataPacket
- CodeBuilderPacket
- CodeBuilderSourcePacket
- CommandBlockUpdatePacket
- CommandChainedSubcommand
- CommandData
- CommandEnum
- CommandEnumConstraint
- CommandOutputPacket
- CommandParameter
- CommandRequestPacket
- CompletedUsingItemPacket
- CompressionCodec
- ContainerClosePacket
- ContainerOpenPacket
- ContainerRegistryCleanupPacket
- ContainerSetDataPacket
- CorrectPlayerMovePredictionPacket
- CraftingDataPacket
- CreatePhotoPacket
- CreativeContentPacket
- CurrentStructureFeaturePacket
- DataItem
- DataStoreUpdate
- DeathInfoPacket
- DebugInfoPacket
- DimensionDataPacket
- DimensionDefinition
- DisconnectPacket
- EditorNetworkPacket
- EduSharedUriResource
- EduUriResourcePacket
- EducationSettingsPacket
- EmoteListPacket
- EmotePacket
- EncryptionCodec
- EnvironmentAttributeData
- Experiments
- FeatureRegistryPacket
- GameRulesChangedPacket
- GameTestRequestPacket
- GameTestResultsPacket
- GraphicsOverrideParameterPacket
- GuiDataPickItemPacket
- HurtArmorPacket
- InteractPacket
- InventoryContentPacket
- InventorySlotPacket
- InventoryTransactionPacket
- ItemData
- ItemInstanceUserData
- ItemRegistryPacket
- ItemStack
- ItemStackRequestPacket
- ItemStackResponsePacket
- JigsawStructureDataPacket
- LabTablePacket
- LecternUpdatePacket
- LegacySlotChange
- LegacyTelemetryEventPacket
- LessonProgressPacket
- LevelChunkPacket
- LevelEventGenericPacket
- LevelEventPacket
- LevelSettings
- LevelSoundEventPacket
- LocatorBarPacket
- LocatorBarWaypointPayload
- LoginPacket
- MapCreateLockedCopyPacket
- MapInfoRequestPacket
- MobArmorEquipmentPacket
- MobEffectPacket
- MobEquipmentPacket
- ModalFormRequestPacket
- ModalFormResponsePacket
- MotionPredictionHintsPacket
- MoveActorAbsolutePacket
- MoveActorDeltaPacket
- MovePlayerPacket
- MovementEffectPacket
- MultiplayerSettingsPacket
- NetworkBinaryStream
- NetworkChunkPublisherUpdatePacket
- NetworkItemStackDescriptor
- NetworkPacket
- NetworkSettingsPacket
- NetworkStackLatencyPacket
- NetworkStructure
- NoiseAlignment
- NpcDialoguePacket
- NpcRequestPacket
- OnScreenTextureAnimationPacket
- OpenSignPacket
- PacketViolationWarningPacket
- PartyChangedPacket
- PartyDestinationCookieResponsePacket
- PhotoTransferPacket
- PlaySoundPacket
- PlayStatusPacket
- PlayerActionPacket
- PlayerArmorDamagePacket
- PlayerAuthInputPacket
- PlayerEnchantOptionsPacket
- PlayerFogPacket
- PlayerHotbarPacket
- PlayerListEntry
- PlayerListPacket
- PlayerLocationPacket
- PlayerPartyInfo
- PlayerSkinPacket
- PlayerStartItemCooldownPacket
- PlayerToggleCrafterSlotRequestPacket
- PlayerUpdateEntityOverridesPacket
- PlayerVideoCapturePacket
- PositionTrackingDBClientRequestPacket
- PositionTrackingDBServerBroadcastPacket
- PresenceConfig
- PrimitiveShapeData
- PrimitiveShapesPacket
- PropertySyncData
- PurchaseReceiptPacket
- RecipeIngredient
- RecordStartedPacket
- RefreshEntitlementsPacket
- RemoveActorPacket
- RemoveObjectivePacket
- RemoveVolumeEntityPacket
- RequestAbilityPacket
- RequestChunkRadiusPacket
- RequestNetworkSettingsPacket
- RequestPermissionsPacket
- ResourcePackChunkDataPacket
- ResourcePackChunkRequestPacket
- ResourcePackClientResponsePacket
- ResourcePackDataInfoPacket
- ResourcePackStackPacket
- ResourcePacksInfoPacket
- ResourcePacksReadyForValidationPacket
- RespawnPacket
- ScriptMessagePacket
- SendPartyDestinationCookiePacket
- SerializableVoxelShape
- SerializedAbilitiesData
- SerializedAbilityLayer
- ServerPlayerPostMovePositionPacket
- ServerPresenceInfoPacket
- ServerSettingsRequestPacket
- ServerSettingsResponsePacket
- ServerStatsPacket
- ServerStoreInfoPacket
- ServerToClientHandshakePacket
- ServerWaypointPayload
- ServerboundCursorItemDragPacket
- ServerboundDataDrivenScreenClosedPacket
- ServerboundDataStorePacket
- ServerboundDiagnosticsPacket
- ServerboundLoadingScreenPacket
- ServerboundMatchmakingCancelPacket
- ServerboundPackSettingChangePacket
- ServerboundRegisterAudioContentPacket
- ServerboundStonecutterSetRecipePacket
- SetActorDataPacket
- SetActorLinkPacket
- SetActorMotionPacket
- SetCommandsEnabledPacket
- SetDefaultGameTypePacket
- SetDifficultyPacket
- SetDisplayObjectivePacket
- SetHealthPacket
- SetHudPacket
- SetLastHurtByPacket
- SetLocalPlayerAsInitializedPacket
- SetPassengerOfBlockPacket
- SetPlayerFurnaceOptionsPacket
- SetPlayerGameTypePacket
- SetPlayerInventoryOptionsPacket
- SetScorePacket
- SetScoreboardIdentityPacket
- SetSpawnPositionPacket
- SetTimePacket
- SetTitlePacket
- SettingsCommandPacket
- ShowCreditsPacket
- ShowProfilePacket
- ShowStoreOfferPacket
- SimpleEventPacket
- SimulationTypePacket
- SpawnExperienceOrbPacket
- SpawnParticleEffectPacket
- SpawnSettings
- StartGamePacket
- StopSoundPacket
- StructureBlockUpdatePacket
- StructureTemplateDataRequestPacket
- StructureTemplateDataResponsePacket
- SubChunkHeightmapData
- SubChunkPacket
- SubChunkPos
- SubChunkPosOffset
- SubChunkRequestPacket
- SubClientLoginPacket
- SyncActorPropertyPacket
- SyncWorldClocksPacket
- SyncedPlayerMovementSettings
- TakeItemActorPacket
- TextPacket
- TickingAreasLoadStatusPacket
- ToastRequestPacket
- TransferPacket
- TrimDataPacket
- UUID
- UnlockedRecipesPacket
- UpdateAbilitiesPacket
- UpdateAdventureSettingsPacket
- UpdateAttributesPacket
- UpdateBlockPacket
- UpdateBlockSyncedPacket
- UpdateClientInputLocksPacket
- UpdateClientOptionsPacket
- UpdateEquipPacket
- UpdatePlayerGameTypePacket
- UpdateSoftEnumPacket
- UpdateSubChunkBlocksPacket
- UpdateSubChunkNetworkBlockInfo
- UpdateTradePacket
- Vec2
- Vec3
- VoxelShapesPacket
Interfaces
AddBehaviorTree
Defined in: protocol/src/packet/AddBehaviorTreePacket.ts:9
JSON text containing the behavior tree sent to an automation client.
Properties
behaviorTreeStructure
behaviorTreeStructure:
string
Defined in: protocol/src/packet/AddBehaviorTreePacket.ts:11
Behavior Tree Structure (JSON), preserved as its serialized string.
AddPainting
Defined in: protocol/src/packet/AddPaintingPacket.ts:8
Data needed to add a painting actor to the client world.
Properties
direction
direction:
number
Defined in: protocol/src/packet/AddPaintingPacket.ts:16
Direction the painting faces on its wall.
motif
motif:
string
Defined in: protocol/src/packet/AddPaintingPacket.ts:18
Client-known painting motif, such as Kebab.
position
position:
Vec3
Defined in: protocol/src/packet/AddPaintingPacket.ts:14
Bottom-left corner of the painting.
targetActorId
targetActorId:
bigint
Defined in: protocol/src/packet/AddPaintingPacket.ts:10
Unique actor id assigned to the painting.
targetRuntimeId
targetRuntimeId:
bigint
Defined in: protocol/src/packet/AddPaintingPacket.ts:12
Runtime id used for this actor in the current session.
AddVolumeEntity
Defined in: protocol/src/packet/AddVolumeEntityPacket.ts:10
The fields of an AddVolumeEntityPacket, in wire order.
Properties
components
components:
NBTTagCompound
Defined in: protocol/src/packet/AddVolumeEntityPacket.ts:14
Components: the volume's components, such as minecraft:fog, as a network NBT compound.
dimension
dimension:
number
Defined in: protocol/src/packet/AddVolumeEntityPacket.ts:24
Dimension Type: 0 for the Overworld, 1 for the Nether, 2 for the End.
engineVersion
engineVersion:
string
Defined in: protocol/src/packet/AddVolumeEntityPacket.ts:26
Engine Version the volume definition was written for, as a semantic version string.
entityNetworkId
entityNetworkId:
number
Defined in: protocol/src/packet/AddVolumeEntityPacket.ts:12
Entity Network Id, the Raw Id the server later removes the volume by.
instanceName
instanceName:
string
Defined in: protocol/src/packet/AddVolumeEntityPacket.ts:18
Instance Name of this volume in the world.
jsonIdentifier
jsonIdentifier:
string
Defined in: protocol/src/packet/AddVolumeEntityPacket.ts:16
JSON Identifier: the volume definition's identifier, for example custom:fog_volume.
maxBounds
maxBounds:
BlockPos
Defined in: protocol/src/packet/AddVolumeEntityPacket.ts:22
Max Bounds: the corner of the volume with the highest coordinates, in blocks.
minBounds
minBounds:
BlockPos
Defined in: protocol/src/packet/AddVolumeEntityPacket.ts:20
Min Bounds: the corner of the volume with the lowest coordinates, in blocks.
AgentActionEvent
Defined in: protocol/src/packet/AgentActionEventPacket.ts:37
The fields of an AgentActionEventPacket, in wire order.
Properties
action
action:
AgentActionType
Defined in: protocol/src/packet/AgentActionEventPacket.ts:41
Action, which kind of agent action this event answers.
requestId
requestId:
string
Defined in: protocol/src/packet/AgentActionEventPacket.ts:39
Request Id, the identifier Code Builder attached to the action it asked for.
response
response:
string
Defined in: protocol/src/packet/AgentActionEventPacket.ts:43
Response, a Json::Value carried as its serialized JSON text.
AgentAnimationData
Defined in: protocol/src/packet/AgentAnimationPacket.ts:15
The fields of an AgentAnimationPacket, in wire order.
Properties
animation
animation:
AgentAnimation
Defined in: protocol/src/packet/AgentAnimationPacket.ts:17
Agent Animation, which animation the agent plays.
runtimeId
runtimeId:
bigint
Defined in: protocol/src/packet/AgentAnimationPacket.ts:19
Runtime Id, the ActorRuntimeID of the agent.
AimAssistActorPriorityData
Defined in: protocol/src/packet/CameraAimAssistActorPriorityPacket.ts:11
One AimAssistActorPriorityData entry: the priority of one actor inside one category of one preset, each named by its position in the registry the client got from CameraAimAssistPresetsPacket.
Properties
actorIndex
actorIndex:
number
Defined in: protocol/src/packet/CameraAimAssistActorPriorityPacket.ts:17
Actor Index, the actor the priority applies to.
categoryIndex
categoryIndex:
number
Defined in: protocol/src/packet/CameraAimAssistActorPriorityPacket.ts:15
Category Index, the position of the category in the client's registry.
presetIndex
presetIndex:
number
Defined in: protocol/src/packet/CameraAimAssistActorPriorityPacket.ts:13
Preset Index, the position of the preset in the client's registry.
priorityValue
priorityValue:
number
Defined in: protocol/src/packet/CameraAimAssistActorPriorityPacket.ts:19
Priority Value. Larger numbers win.
AnimateEntity
Defined in: protocol/src/packet/AnimateEntityPacket.ts:9
One client-side animation and the actors that should play it.
Properties
animation
animation:
string
Defined in: protocol/src/packet/AnimateEntityPacket.ts:11
Name of the animation declared in the resource pack.
blendOutTime
blendOutTime:
number
Defined in: protocol/src/packet/AnimateEntityPacket.ts:21
Time in seconds used to blend out of the animation.
controller
controller:
string
Defined in: protocol/src/packet/AnimateEntityPacket.ts:19
Name of the animation controller that selects animations from its state.
nextState
nextState:
string
Defined in: protocol/src/packet/AnimateEntityPacket.ts:13
Controller state to enter after the animation finishes.
runtimeIds
runtimeIds:
bigint[]
Defined in: protocol/src/packet/AnimateEntityPacket.ts:23
Runtime ids of the actors that play this animation.
stopExpression
stopExpression:
string
Defined in: protocol/src/packet/AnimateEntityPacket.ts:15
Molang condition that stops the animation and transitions to nextState.
stopExpressionVersion
stopExpressionVersion:
number
Defined in: protocol/src/packet/AnimateEntityPacket.ts:17
Numeric Molang version used to evaluate stopExpression.
AnvilDamage
Defined in: protocol/src/packet/AnvilDamagePacket.ts:8
A request to damage the anvil at one block position.
Properties
blockPosition
blockPosition:
BlockPos
Defined in: protocol/src/packet/AnvilDamagePacket.ts:10
The anvil position, encoded as three ZigZag varint32 coordinates.
ArmorSlotAndDamagePair
Defined in: protocol/src/packet/PlayerArmorDamagePacket.ts:13
The damage to apply to one piece of armor.
Properties
armorSlot
armorSlot:
ArmorSlot
Defined in: protocol/src/packet/PlayerArmorDamagePacket.ts:15
Armor Slot, a ZigZag varint32.
damage
damage:
number
Defined in: protocol/src/packet/PlayerArmorDamagePacket.ts:17
Damage, an int16 in little-endian byte order, added to the durability already used.
AudioContentRegistrationEntry
Defined in: protocol/src/wire/definitions/added2225.ts:87
AudioContentRegistrationEntry: one piece of audio content a client registers.
Properties
audioContentId
audioContentId:
string
Defined in: protocol/src/wire/definitions/added2225.ts:89
Audio Content ID.
playbackContent
playbackContent:
SignedAudioContent
Defined in: protocol/src/wire/definitions/added2225.ts:95
Playback Content.
serverContent
serverContent:
SignedAudioContent
Defined in: protocol/src/wire/definitions/added2225.ts:93
Server Content.
sharedMetadata
sharedMetadata:
SignedAudioContent
Defined in: protocol/src/wire/definitions/added2225.ts:91
Shared Metadata.
AuthInputItemUse
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:158
A PackedItemUseLegacyInventoryTransaction, carried when the player uses an item this tick.
It has the same legacy request, actions, and use-item body as InventoryTransactionPacket, but omits the outer transaction type because the field itself identifies the variant.
Extends
Properties
actions
actions:
InventoryActionData[]
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:160
The inventory slots and their old and new network item descriptors.
data
data:
UseItemData
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:162
The use-item body, with the held item as a network stack descriptor.
legacyRequestId
legacyRequestId:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:328
Inherited from
LegacyTransactionRequest.legacyRequestId
legacySlotChanges
legacySlotChanges:
LegacySlotChange[]
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:329
Inherited from
LegacyTransactionRequest.legacySlotChanges
AwardAchievement
Defined in: protocol/src/packet/AwardAchievementPacket.ts:100
The fields of an AwardAchievementPacket, in wire order.
Properties
achievementId
achievementId:
AchievementId
Defined in: protocol/src/packet/AwardAchievementPacket.ts:106
AchievementID: which achievement to award. The docs type it as a bare int32; the numbers are the AchievementId members the telemetry Achievement event also uses, and gophertunnel calls them unknown, so a value outside the enum passes through.
BlockActorData
Defined in: protocol/src/packet/BlockActorDataPacket.ts:11
The complete block actor state sent for one block position.
Properties
actorDataTags
actorDataTags:
NBTTagCompound
Defined in: protocol/src/packet/BlockActorDataPacket.ts:15
Complete user data compound that replaces the client's block actor state.
blockPosition
blockPosition:
BlockPos
Defined in: protocol/src/packet/BlockActorDataPacket.ts:13
Position of the block actor.
BlockCoordinates
Defined in: protocol/src/packet/PlayerActionPacket.ts:59
A BlockPos as protocol 2193 writes it: three ZigZag varint32, y signed like the others.
Properties
x
x:
number
Defined in: protocol/src/packet/PlayerActionPacket.ts:60
y
y:
number
Defined in: protocol/src/packet/PlayerActionPacket.ts:61
z
z:
number
Defined in: protocol/src/packet/PlayerActionPacket.ts:62
BlockEvent
Defined in: protocol/src/packet/BlockEventPacket.ts:8
A block position and the block-defined event pair sent for it.
Properties
blockPosition
blockPosition:
BlockPos
Defined in: protocol/src/packet/BlockEventPacket.ts:10
Block Position where the event happened.
eventType
eventType:
number
Defined in: protocol/src/packet/BlockEventPacket.ts:12
Event Type, interpreted by the block at blockPosition.
eventValue
eventValue:
number
Defined in: protocol/src/packet/BlockEventPacket.ts:14
Event Value, interpreted together with eventType.
BlockPickRequest
Defined in: protocol/src/packet/BlockPickRequestPacket.ts:8
The position and hotbar state the client sends when it picks a block.
Properties
maxSlots
maxSlots:
number
Defined in: protocol/src/packet/BlockPickRequestPacket.ts:14
Empty hotbar slots available to receive the picked item.
position
position:
BlockPos
Defined in: protocol/src/packet/BlockPickRequestPacket.ts:10
Block to pick, encoded as a BlockPos.
withData
withData:
boolean
Defined in: protocol/src/packet/BlockPickRequestPacket.ts:12
Whether the picked item should include the block's data.
BlockProperty
Defined in: protocol/src/packet/StartGamePacket.ts:56
A block the client does not have built in, and the definition it needs to draw it.
Since 1.26.50 this is not only a plugin's blocks: vanilla itself defines some of its blocks in data - the wool stairs and slabs, the concrete slabs - and a real server declares those here too, ninety-odd of them. The definition is carried as bytes rather than modeled: it is network NBT that the server hands on verbatim and the client alone interprets.
Properties
definition
definition:
Buffer
Defined in: protocol/src/packet/StartGamePacket.ts:59
The definition as network NBT (varint string lengths), header byte included.
name
name:
string
Defined in: protocol/src/packet/StartGamePacket.ts:57
BookEdit
Defined in: protocol/src/packet/BookEditPacket.ts:28
Data in a player edit to a book and quill.
Properties
bookSlot
bookSlot:
number
Defined in: protocol/src/packet/BookEditPacket.ts:30
Inventory slot containing the book.
operation
operation:
BookEditOperation
Defined in: protocol/src/packet/BookEditPacket.ts:32
Selected edit and the fields specific to that action.
CameraAimAssist
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:24
The fields of a CameraAimAssistPacket, in wire order.
Properties
action
action:
CameraAimAssistAction
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:34
Action.
distance
distance:
number
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:30
Distance, in blocks, used by the distance target mode. The docs bound it to 1 through 16.
presetId
presetId:
string
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:26
Preset Id, the identifier of a CameraAimAssistPresetDefinition the client already has.
showDebugRender
showDebugRender:
boolean
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:36
Show Debug Render: draws the targeting volume on the client.
targetMode
targetMode:
CameraAimAssistTargetMode
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:32
Target Mode.
viewAngle
viewAngle:
Vec2
Defined in: protocol/src/packet/CameraAimAssistPacket.ts:28
View Angle: the horizontal (x) and vertical (y) half-angles, in degrees, used by the angle target mode.
CameraAimAssistActorPriority
Defined in: protocol/src/packet/CameraAimAssistActorPriorityPacket.ts:23
The fields of a CameraAimAssistActorPriorityPacket, in wire order.
Properties
priorities
priorities:
AimAssistActorPriorityData[]
Defined in: protocol/src/packet/CameraAimAssistActorPriorityPacket.ts:25
Camera Aim-Assist Actor Priority List, one entry per actor override.
CameraAimAssistDefinition
Defined in: protocol/src/structure/CameraPreset.ts:83
A preset's Aim Assist, the docs' SharedTypes::Comprehensive::CameraAimAssistCommandDefinition. Each field is a presence byte, then the value when the byte is 1.
Properties
distance?
optionaldistance?:number
Defined in: protocol/src/structure/CameraPreset.ts:91
Distance, the reach from the cursor searched in DISTANCE mode.
presetId?
optionalpresetId?:string
Defined in: protocol/src/structure/CameraPreset.ts:85
Preset Id, the name of an aim assist preset from CameraAimAssistPresetsPacket.
targetMode?
optionaltargetMode?:AimAssistTargetMode
Defined in: protocol/src/structure/CameraPreset.ts:87
Target Mode, a uint8.
viewAngle?
optionalviewAngle?:Vec2
Defined in: protocol/src/structure/CameraPreset.ts:89
View Angle, the cone around the cursor searched in ANGLE mode.
CameraAimAssistItemSetting
Defined in: protocol/src/structure/CameraAimAssistPresetDefinition.ts:22
One entry of item_settings: the category aim assist uses while the player holds the item.
Properties
category
category:
string
Defined in: protocol/src/structure/CameraAimAssistPresetDefinition.ts:26
The value, a CameraAimAssistCategory Reference naming a category sent in the same packet.
item
item:
string
Defined in: protocol/src/structure/CameraAimAssistPresetDefinition.ts:24
The key, an Item Reference.
CameraAimAssistPresetExclusions
Defined in: protocol/src/structure/CameraAimAssistPresetDefinition.ts:10
The CameraAimAssistPresetExclusionDefinition of a preset: the targets aim assist never selects. Each list is a varuint32 count followed by that many strings.
Properties
blocks
blocks:
string[]
Defined in: protocol/src/structure/CameraAimAssistPresetDefinition.ts:12
blocks, one Block Reference per excluded block.
blockTags
blockTags:
string[]
Defined in: protocol/src/structure/CameraAimAssistPresetDefinition.ts:16
block_tags, excluded block tags.
entities
entities:
string[]
Defined in: protocol/src/structure/CameraAimAssistPresetDefinition.ts:14
entities, one Entity Reference per excluded entity.
entityTypeFamilies
entityTypeFamilies:
string[]
Defined in: protocol/src/structure/CameraAimAssistPresetDefinition.ts:18
entity_type_families, excluded entity type families.
CameraAimAssistPresets
Defined in: protocol/src/packet/CameraAimAssistPresetsPacket.ts:20
The fields of a CameraAimAssistPresetsPacket, in wire order.
Properties
categories
categories:
CameraAimAssistCategoryDefinition[]
Defined in: protocol/src/packet/CameraAimAssistPresetsPacket.ts:22
The list of CameraAimAssistCategoryDefinition entries presets refer to by name.
operation
operation:
CameraAimAssistPresetsOperation
Defined in: protocol/src/packet/CameraAimAssistPresetsPacket.ts:26
Operation.
presets
presets:
CameraAimAssistPresetDefinition[]
Defined in: protocol/src/packet/CameraAimAssistPresetsPacket.ts:24
The list of CameraAimAssistPresetDefinition entries CameraAimAssistPacket and camera presets refer to by identifier.
CameraAimAssistPriority
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:10
One entry of a priority map: a block, entity, block tag or entity type family identifier and the targeting priority it gets. Larger numbers win.
Properties
identifier
identifier:
string
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:12
The key: a Block Reference, Entity Reference, block tag or entity type family name.
priority
priority:
number
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:14
The value, a priority from 0 to 100.
CameraEase
Defined in: protocol/src/structure/CameraInstruction.ts:56
The ease of a set instruction, the docs' CameraInstruction::SetInstruction::EaseOption.
Properties
time
time:
number
Defined in: protocol/src/structure/CameraInstruction.ts:60
time in seconds, float LE.
type
type:
EasingType
Defined in: protocol/src/structure/CameraInstruction.ts:58
type, a uint8.
CameraFadeColor
Defined in: protocol/src/structure/CameraInstruction.ts:96
The Color of a fade, the docs' CameraInstruction::FadeInstruction::ColorOption: three float LE channels from 0 to 1.
Properties
blue
blue:
number
Defined in: protocol/src/structure/CameraInstruction.ts:102
Blue.
green
green:
number
Defined in: protocol/src/structure/CameraInstruction.ts:100
Green.
red
red:
number
Defined in: protocol/src/structure/CameraInstruction.ts:98
Red.
CameraFadeInstruction
Defined in: protocol/src/structure/CameraInstruction.ts:106
The docs' CameraInstruction::FadeInstruction: fade the screen to a color and back.
Properties
color?
optionalcolor?:CameraFadeColor
Defined in: protocol/src/structure/CameraInstruction.ts:110
Color, optional.
time?
optionaltime?:CameraFadeTime
Defined in: protocol/src/structure/CameraInstruction.ts:108
Time, optional.
CameraFadeTime
Defined in: protocol/src/structure/CameraInstruction.ts:86
The Time of a fade, the docs' CameraInstruction::FadeInstruction::TimeOption: three float LE seconds.
Properties
fadeInTime
fadeInTime:
number
Defined in: protocol/src/structure/CameraInstruction.ts:88
Fade In Time.
fadeOutTime
fadeOutTime:
number
Defined in: protocol/src/structure/CameraInstruction.ts:92
Fade Out Time.
holdTime
holdTime:
number
Defined in: protocol/src/structure/CameraInstruction.ts:90
Hold Time.
CameraFovInstruction
Defined in: protocol/src/structure/CameraInstruction.ts:122
The docs' CameraInstruction::FovInstruction: change the field of view over time.
Properties
clear
clear:
boolean
Defined in: protocol/src/structure/CameraInstruction.ts:130
Field of View Clear: drop the override instead of applying one.
easeTime
easeTime:
number
Defined in: protocol/src/structure/CameraInstruction.ts:126
FOV Ease Time in seconds, float LE.
easeType
easeType:
"linear"|"spring"|"in_quad"|"out_quad"|"in_out_quad"|"in_cubic"|"out_cubic"|"in_out_cubic"|"in_quart"|"out_quart"|"in_out_quart"|"in_quint"|"out_quint"|"in_out_quint"|"in_sine"|"out_sine"|"in_out_sine"|"in_expo"|"out_expo"|"in_out_expo"|"in_circ"|"out_circ"|"in_out_circ"|"in_bounce"|"out_bounce"|"in_out_bounce"|"in_back"|"out_back"|"in_out_back"|"in_elastic"|"out_elastic"|"in_out_elastic"
Defined in: protocol/src/structure/CameraInstruction.ts:128
FOV Ease Type, an easing_function written as a string.
fieldOfView
fieldOfView:
number
Defined in: protocol/src/structure/CameraInstruction.ts:124
Field of View in degrees, float LE.
CameraInstructionData
Defined in: protocol/src/structure/CameraInstruction.ts:175
The fields of a CameraInstruction, in wire order. Each is a presence byte, then the value when the byte is 1.
Properties
attachToEntity?
optionalattachToEntity?:bigint
Defined in: protocol/src/structure/CameraInstruction.ts:191
AttachToEntity: the docs' AttachToEntityInstruction, one Entity Actor ID as int64 LE.
clear?
optionalclear?:boolean
Defined in: protocol/src/structure/CameraInstruction.ts:179
Clear: drop every active instruction.
detachFromEntity?
optionaldetachFromEntity?:boolean
Defined in: protocol/src/structure/CameraInstruction.ts:193
DetachFromEntity.
fade?
optionalfade?:CameraFadeInstruction
Defined in: protocol/src/structure/CameraInstruction.ts:181
Fade.
fieldOfView?
optionalfieldOfView?:CameraFovInstruction
Defined in: protocol/src/structure/CameraInstruction.ts:187
FieldOfView.
removeTarget?
optionalremoveTarget?:boolean
Defined in: protocol/src/structure/CameraInstruction.ts:185
RemoveTarget: stop aim assist targeting.
set?
optionalset?:CameraSetInstruction
Defined in: protocol/src/structure/CameraInstruction.ts:177
Set.
spline?
optionalspline?:CameraSplineInstruction
Defined in: protocol/src/structure/CameraInstruction.ts:189
Spline.
target?
optionaltarget?:CameraTargetInstruction
Defined in: protocol/src/structure/CameraInstruction.ts:183
Target.
CameraInstructionPayload
Defined in: protocol/src/packet/CameraInstructionPacket.ts:9
The fields of a CameraInstructionPacket, in wire order.
Properties
cameraInstruction
cameraInstruction:
CameraInstructionData
Defined in: protocol/src/packet/CameraInstructionPacket.ts:11
Camera Instruction: the parts the client applies, in wire order.
CameraPresetData
Defined in: protocol/src/structure/CameraPreset.ts:98
The fields of a CameraPresets entry, in wire order. A field marked optional is a presence byte, then the value when the byte is 1.
Properties
aimAssist?
optionalaimAssist?:CameraAimAssistDefinition
Defined in: protocol/src/structure/CameraPreset.ts:140
Aim Assist, optional.
applyInheritedStartingRotation
applyInheritedStartingRotation:
boolean
Defined in: protocol/src/structure/CameraPreset.ts:144
Apply Inherited Starting Rotation: start at the parent's rotation instead of Starting Rotation.
blockListeningRadius?
optionalblockListeningRadius?:number
Defined in: protocol/src/structure/CameraPreset.ts:124
Block Listening Radius, optional: how far around the camera aim assist considers blocks.
continueTargeting?
optionalcontinueTargeting?:boolean
Defined in: protocol/src/structure/CameraPreset.ts:122
Continue Targeting, optional: keep the aim assist target while it moves.
controlScheme?
optionalcontrolScheme?:ControlScheme
Defined in: protocol/src/structure/CameraPreset.ts:142
Control Scheme, optional, a uint8.
entityOffset?
optionalentityOffset?:Vec3
Defined in: protocol/src/structure/CameraPreset.ts:128
Entity Offset, optional: moves the pivot point away from the entity's center.
horizontalRotationLimit?
optionalhorizontalRotationLimit?:Vec2
Defined in: protocol/src/structure/CameraPreset.ts:118
Horizontal Rotation Limit, optional.
inheritFrom
inheritFrom:
string
Defined in: protocol/src/structure/CameraPreset.ts:102
Inherit From: the parent preset's name, or empty for a root preset.
listener?
optionallistener?:CameraAudioListener
Defined in: protocol/src/structure/CameraPreset.ts:136
Listener, optional, a uint8.
name
name:
string
Defined in: protocol/src/structure/CameraPreset.ts:100
Name: the identifier presets inherit by, and that CameraInstructionPacket selects by list index.
playerEffects?
optionalplayerEffects?:boolean
Defined in: protocol/src/structure/CameraPreset.ts:138
Player Effects, optional: whether the player's status effects render in this camera.
posX?
optionalposX?:number
Defined in: protocol/src/structure/CameraPreset.ts:104
Pos X, optional.
posY?
optionalposY?:number
Defined in: protocol/src/structure/CameraPreset.ts:106
Pos Y, optional.
posZ?
optionalposZ?:number
Defined in: protocol/src/structure/CameraPreset.ts:108
Pos Z, optional.
radius?
optionalradius?:number
Defined in: protocol/src/structure/CameraPreset.ts:130
Radius, optional: how far an orbit camera sits from the player.
rotationSpeed?
optionalrotationSpeed?:number
Defined in: protocol/src/structure/CameraPreset.ts:114
Rotation Speed, optional.
rotX?
optionalrotX?:number
Defined in: protocol/src/structure/CameraPreset.ts:110
Rot X, the pitch in degrees, optional.
rotY?
optionalrotY?:number
Defined in: protocol/src/structure/CameraPreset.ts:112
Rot Y, the yaw in degrees, optional.
snapToTarget?
optionalsnapToTarget?:boolean
Defined in: protocol/src/structure/CameraPreset.ts:116
Snap to Target, optional.
startingRotation?
optionalstartingRotation?:Vec2
Defined in: protocol/src/structure/CameraPreset.ts:146
Starting Rotation, optional: the rotation the camera starts at when the preset applies.
verticalRotationLimit?
optionalverticalRotationLimit?:Vec2
Defined in: protocol/src/structure/CameraPreset.ts:120
Vertical Rotation Limit, optional.
viewOffset?
optionalviewOffset?:Vec2
Defined in: protocol/src/structure/CameraPreset.ts:126
View Offset, optional: shifts the camera from its pivot point on the player.
yawLimitMax?
optionalyawLimitMax?:number
Defined in: protocol/src/structure/CameraPreset.ts:134
Yaw Limit Max, optional.
yawLimitMin?
optionalyawLimitMin?:number
Defined in: protocol/src/structure/CameraPreset.ts:132
Yaw Limit Min, optional.
CameraPresetsPayload
Defined in: protocol/src/packet/CameraPresetsPacket.ts:11
The fields of a CameraPresetsPacket, in wire order.
Properties
cameraPresets
cameraPresets:
CameraPresetData[]
Defined in: protocol/src/packet/CameraPresetsPacket.ts:13
Camera Presets. A set instruction's preset is an index into this list, so the order matters.
CameraSetInstruction
Defined in: protocol/src/structure/CameraInstruction.ts:64
The docs' CameraInstruction::SetInstruction: switch to a preset, with optional overrides.
Properties
default?
optionaldefault?:boolean
Defined in: protocol/src/structure/CameraInstruction.ts:80
default, optional: whether this becomes the player's default camera.
ease?
optionalease?:CameraEase
Defined in: protocol/src/structure/CameraInstruction.ts:68
ease, optional.
entityOffset?
optionalentityOffset?:Vec3
Defined in: protocol/src/structure/CameraInstruction.ts:78
entity_offset, optional: the docs' EntityOffsetOption, three float LE.
facing?
optionalfacing?:Vec3
Defined in: protocol/src/structure/CameraInstruction.ts:74
facing, optional: the docs' FacingOption, a Vec3 the camera looks at.
position?
optionalposition?:Vec3
Defined in: protocol/src/structure/CameraInstruction.ts:70
pos, optional: the docs' PosOption, a Vec3.
preset
preset:
number
Defined in: protocol/src/structure/CameraInstruction.ts:66
preset, a uint32 LE index into the CameraPresetsPacket list.
removeIgnoreStartingValuesComponent
removeIgnoreStartingValuesComponent:
boolean
Defined in: protocol/src/structure/CameraInstruction.ts:82
removeIgnoreStartingValuesComponent, a boolean with no presence byte.
rotation?
optionalrotation?:Vec2
Defined in: protocol/src/structure/CameraInstruction.ts:72
rot, optional: the docs' RotOption, pitch x then yaw y as float LE.
viewOffset?
optionalviewOffset?:Vec2
Defined in: protocol/src/structure/CameraInstruction.ts:76
view_offset, optional: the docs' ViewOffsetOption, two float LE.
CameraSplineInstruction
Defined in: protocol/src/structure/CameraInstruction.ts:154
The docs' CameraInstruction::SplineInstruction: move the camera along a curve.
Properties
curve
curve:
Vec3[]
Defined in: protocol/src/structure/CameraInstruction.ts:160
curve: a varuint32 count, then one Vec3 per control point.
loadFromJson?
optionalloadFromJson?:boolean
Defined in: protocol/src/structure/CameraInstruction.ts:168
loadFromJson, optional.
progressKeyFrames
progressKeyFrames:
CameraSplineProgressKeyFrame[]
Defined in: protocol/src/structure/CameraInstruction.ts:162
progressKeyFrames: a varuint32 count, then the entries.
rotationKeyFrames
rotationKeyFrames:
CameraSplineRotationKeyFrame[]
Defined in: protocol/src/structure/CameraInstruction.ts:164
rotationOption: a varuint32 count, then the entries.
splineIdentifier?
optionalsplineIdentifier?:string
Defined in: protocol/src/structure/CameraInstruction.ts:166
splineIdentifier, optional: a named spline from CameraSplinePacket to load.
totalTime
totalTime:
number
Defined in: protocol/src/structure/CameraInstruction.ts:156
totalTime in seconds, float LE.
type
type:
number
Defined in: protocol/src/structure/CameraInstruction.ts:158
type, a uint8 with no presence byte. The docs give it no enum.
CameraSplineProgressKeyFrame
Defined in: protocol/src/structure/CameraInstruction.ts:134
One progressKeyFrames entry, the docs' CameraInstruction::SplineInstruction::SplineProgressOption.
Properties
easing
easing:
"linear"|"spring"|"in_quad"|"out_quad"|"in_out_quad"|"in_cubic"|"out_cubic"|"in_out_cubic"|"in_quart"|"out_quart"|"in_out_quart"|"in_quint"|"out_quint"|"in_out_quint"|"in_sine"|"out_sine"|"in_out_sine"|"in_expo"|"out_expo"|"in_out_expo"|"in_circ"|"out_circ"|"in_out_circ"|"in_bounce"|"out_bounce"|"in_out_bounce"|"in_back"|"out_back"|"in_out_back"|"in_elastic"|"out_elastic"|"in_out_elastic"
Defined in: protocol/src/structure/CameraInstruction.ts:140
Key frame easing func, an easing_function written as a string.
time
time:
number
Defined in: protocol/src/structure/CameraInstruction.ts:138
Key frame time in seconds, float LE.
value
value:
number
Defined in: protocol/src/structure/CameraInstruction.ts:136
Key frame value, float LE: how far along the curve the camera is.
CameraSplineRotationKeyFrame
Defined in: protocol/src/structure/CameraInstruction.ts:144
One rotationOption entry, the docs' CameraInstruction::SplineInstruction::SplineRotationOption.
Properties
easing
easing:
"linear"|"spring"|"in_quad"|"out_quad"|"in_out_quad"|"in_cubic"|"out_cubic"|"in_out_cubic"|"in_quart"|"out_quart"|"in_out_quart"|"in_quint"|"out_quint"|"in_out_quint"|"in_sine"|"out_sine"|"in_out_sine"|"in_expo"|"out_expo"|"in_out_expo"|"in_circ"|"out_circ"|"in_out_circ"|"in_bounce"|"out_bounce"|"in_out_bounce"|"in_back"|"out_back"|"in_out_back"|"in_elastic"|"out_elastic"|"in_out_elastic"
Defined in: protocol/src/structure/CameraInstruction.ts:150
Key frame easing func, an easing_function written as a string.
time
time:
number
Defined in: protocol/src/structure/CameraInstruction.ts:148
Key frame time in seconds, float LE.
value
value:
Vec3
Defined in: protocol/src/structure/CameraInstruction.ts:146
Key frame value, a Vec3 rotation.
CameraSplines
Defined in: protocol/src/packet/CameraSplinePacket.ts:8
The fields of a CameraSplinePacket, in wire order.
Properties
splines
splines:
CameraSplineDefinition[]
Defined in: protocol/src/packet/CameraSplinePacket.ts:10
Camera Data Splines, one definition per named spline.
CameraTargetInstruction
Defined in: protocol/src/structure/CameraInstruction.ts:114
The docs' CameraInstruction::TargetInstruction: point aim assist at an actor.
Properties
targetActorId
targetActorId:
bigint
Defined in: protocol/src/structure/CameraInstruction.ts:118
Target Actor ID, an int64 LE with no presence byte.
targetCenterOffset?
optionaltargetCenterOffset?:Vec3
Defined in: protocol/src/structure/CameraInstruction.ts:116
Target Center Offset, optional: a Vec3 from the actor's center.
ChangeMobProperty
Defined in: protocol/src/packet/ChangeMobPropertyPacket.ts:9
The fields of a ChangeMobPropertyPacket, in wire order.
Properties
actorUniqueId
actorUniqueId:
bigint
Defined in: protocol/src/packet/ChangeMobPropertyPacket.ts:11
Actor Id, the unique id of the mob whose property changes.
boolValue
boolValue:
boolean
Defined in: protocol/src/packet/ChangeMobPropertyPacket.ts:15
BoolComponent Value, read when the property is a bool property.
floatValue
floatValue:
number
Defined in: protocol/src/packet/ChangeMobPropertyPacket.ts:21
FloatComponent Value, read when the property is a float property.
intValue
intValue:
number
Defined in: protocol/src/packet/ChangeMobPropertyPacket.ts:19
IntComponent Value, read when the property is an int property.
propertyName
propertyName:
string
Defined in: protocol/src/packet/ChangeMobPropertyPacket.ts:13
Property Name, the data-driven property identifier, for example minecraft:climate.
stringValue
stringValue:
string
Defined in: protocol/src/packet/ChangeMobPropertyPacket.ts:17
StringComponent Value, read when the property is an enum property.
ChunkCoord
Defined in: protocol/src/packet/NetworkChunkPublisherUpdatePacket.ts:12
One entry of Server Built Chunks List: an X and a Z chunk coordinate.
Extends
Record<string,number>
Indexable
[
key:string]:number
Properties
x
x:
number
Defined in: protocol/src/packet/NetworkChunkPublisherUpdatePacket.ts:14
X of the chunk column.
z
z:
number
Defined in: protocol/src/packet/NetworkChunkPublisherUpdatePacket.ts:16
Z of the chunk column.
ChunkRadiusUpdated
Defined in: protocol/src/packet/ChunkRadiusUpdatedPacket.ts:9
The view distance the server granted to the client, measured in chunks.
Properties
radius
radius:
number
Defined in: protocol/src/packet/ChunkRadiusUpdatedPacket.ts:11
What the server actually granted, which may be less than was asked for.
ClientCameraAimAssist
Defined in: protocol/src/packet/ClientCameraAimAssistPacket.ts:17
The fields of a ClientCameraAimAssistPacket, in wire order.
Properties
action
action:
ClientCameraAimAssistAction
Defined in: protocol/src/packet/ClientCameraAimAssistPacket.ts:21
Action.
allowAimAssist
allowAimAssist:
boolean
Defined in: protocol/src/packet/ClientCameraAimAssistPacket.ts:23
Allow aim assist: whether the client lets aim assist run at all.
cameraPresetId
cameraPresetId:
string
Defined in: protocol/src/packet/ClientCameraAimAssistPacket.ts:19
Camera Preset Id, the camera preset whose aim_assist field the server looks up.
ClientboundAttributeLayerSync
Defined in: protocol/src/packet/ClientboundAttributeLayerSyncPacket.ts:61
The fields of a ClientboundAttributeLayerSyncPacket, in wire order.
Properties
data
data:
AttributeLayerSyncData
Defined in: protocol/src/packet/ClientboundAttributeLayerSyncPacket.ts:63
Data, the one alternative this packet carries.
ClientboundControlSchemeSet
Defined in: protocol/src/packet/ClientboundControlSchemeSetPacket.ts:8
The fields of a ClientboundControlSchemeSetPacket, in wire order.
Properties
controlScheme
controlScheme:
ControlScheme
Defined in: protocol/src/packet/ClientboundControlSchemeSetPacket.ts:10
Control Scheme the client switches to.
ClientboundDataDrivenUICloseScreen
Defined in: protocol/src/packet/ClientboundDataDrivenUICloseScreenPacket.ts:7
The fields of a ClientboundDataDrivenUICloseScreenPacket, in wire order.
Properties
formId?
optionalformId?:number
Defined in: protocol/src/packet/ClientboundDataDrivenUICloseScreenPacket.ts:9
FormId of the one screen to close. Omit it to close every data-driven screen.
ClientboundDataDrivenUIShowScreen
Defined in: protocol/src/packet/ClientboundDataDrivenUIShowScreenPacket.ts:7
The fields of a ClientboundDataDrivenUIShowScreenPacket, in wire order.
Properties
dataInstanceId?
optionaldataInstanceId?:number
Defined in: protocol/src/packet/ClientboundDataDrivenUIShowScreenPacket.ts:13
DataInstanceId: the id of the data bound to this screen. Omit it when the screen has none.
formId
formId:
number
Defined in: protocol/src/packet/ClientboundDataDrivenUIShowScreenPacket.ts:11
FormId: the id of this instance of the form, which scripting uses to track it.
screenId
screenId:
string
Defined in: protocol/src/packet/ClientboundDataDrivenUIShowScreenPacket.ts:9
ScreenId: which data-driven screen to show, at most 500 characters.
ClientboundDataStore
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:92
The fields of a ClientboundDataStorePacket, in wire order.
Properties
updates
updates:
DataStoreEntry[]
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:94
Updates: the changes, updates, and removals that happened to the data store, at most 500.
ClientboundDebugRenderer
Defined in: protocol/src/packet/ClientboundDebugRendererPacket.ts:26
An instruction to add a debug marker or clear existing markers.
Properties
debugMarkerData
debugMarkerData:
DebugMarkerData|null
Defined in: protocol/src/packet/ClientboundDebugRendererPacket.ts:30
Marker data for adddebugmarkercube, or null when the operation has no marker.
type
type:
string
Defined in: protocol/src/packet/ClientboundDebugRendererPacket.ts:28
Action string understood by the client.
ClientboundMapItemData
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:75
The map identity and optional creation, decoration, and pixel updates.
Properties
creationMapIds
creationMapIds:
bigint[] |null
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:85
Larger scale maps that contain this map, or null when not provided.
decorations
decorations:
MapDecoration[] |null
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:91
Markers to draw, or null when not provided.
dimension
dimension:
number
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:79
Dimension the map covers.
height
height:
number|null
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:95
Height of the pixel region, or null when no texture update is sent.
isLocked
isLocked:
boolean
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:81
Whether a cartography table has locked the map.
mapId
mapId:
bigint
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:77
Stable id of the map item.
mapOrigin
mapOrigin:
BlockPos
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:83
Block at the center of the map.
pixels
pixels:
number[] |null
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:101
Packed ARGB pixels in row order, or null when no texture update is sent.
scale
scale:
number|null
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:87
Map zoom level, or null when not provided.
startX
startX:
number|null
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:97
First pixel column of the texture update, or null when absent.
startY
startY:
number|null
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:99
First pixel row of the texture update, or null when absent.
trackedActorIds
trackedActorIds:
MapItemTrackedActorUniqueId[] |null
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:89
Actor ids the client tracks for the decorations, or null when not provided.
width
width:
number|null
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:93
Width of the pixel region, or null when no texture update is sent.
ClientboundTextureShift
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:17
The fields of a ClientboundTextureShiftPacket, in wire order.
Properties
action
action:
TextureShiftAction
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:19
Action ID.
allSteps
allSteps:
string[]
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:27
All Steps, every step name of the collection.
collectionName
collectionName:
string
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:21
Collection Name, the texture shift collection the update applies to.
currentLengthInTicks
currentLengthInTicks:
bigint
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:29
Current Length In Ticks, how far into the shift the client should be.
enabled
enabled:
boolean
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:33
Enabled. For a TextureShiftAction.Start action, whether the shift begins enabled.
fromStep
fromStep:
string
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:23
From Step, the step the shift starts at.
toStep
toStep:
string
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:25
To Step, the step the shift ends at.
totalLengthInTicks
totalLengthInTicks:
bigint
Defined in: protocol/src/packet/ClientboundTextureShiftPacket.ts:31
Total Length In Ticks, how long the whole shift takes.
ClientboundUpdateSoundData
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:61
The sound handle and seven control slots used to update active playback.
Properties
fade
fade:
SoundDataUpdate
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:71
Fade, the fourth update slot.
pause
pause:
SoundDataUpdate
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:75
Pause, the sixth update slot.
resume
resume:
SoundDataUpdate
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:77
Resume, the seventh and last update slot.
seekTo
seekTo:
SoundDataUpdate
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:73
SeekTo, the fifth update slot.
serverSoundHandle
serverSoundHandle:
bigint
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:63
Server Sound Handle: the ServerSoundHandle a PlaySoundPacket or RecordStartedPacket gave the sound.
setPitch
setPitch:
SoundDataUpdate
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:69
SetPitch, the third update slot.
setVolume
setVolume:
SoundDataUpdate
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:67
SetVolume, the second update slot.
stop
stop:
SoundDataUpdate
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:65
Stop, the first update slot.
CodeBuilderSource
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:47
The fields of a CodeBuilderSourcePacket, in wire order.
Properties
category
category:
CodeBuilderCategory
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:51
Category: which stored value the operation targets.
codeStatus
codeStatus:
CodeBuilderCodeStatus
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:53
CodeStatus: the execution state the client reports or sets.
operation
operation:
CodeBuilderOperation
Defined in: protocol/src/packet/CodeBuilderSourcePacket.ts:49
Operation: what the client asks the code builder storage to do.
CommandBlockUpdate
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:26
The fields the client sends when it closes the command block screen.
Properties
command
command:
string
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:30
Command entered in the editor.
executeOnFirstTick
executeOnFirstTick:
boolean
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:42
Whether a repeating block should execute before its first delay.
filteredName
filteredName:
string
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:36
Filtered form of the name.
lastOutput
lastOutput:
string
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:32
Most recent output shown by the editor.
name
name:
string
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:34
Name shown above the command block.
target
target:
CommandBlockTarget
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:28
The command block minecart or placed command block being edited.
tickDelay
tickDelay:
number
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:40
Delay in ticks between repeating block executions.
trackOutput
trackOutput:
boolean
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:38
Whether the client wants command output displayed.
CommandOutputMessage
Defined in: protocol/src/wire/definitions/commands.ts:74
One line of command output, Mojang's CommandOutputMessage.
Properties
messageId
messageId:
string
Defined in: protocol/src/wire/definitions/commands.ts:79
The message itself, either plain text or the id of a translation such as commands.tp.success.coordinates.
parameters
parameters:
string[]
Defined in: protocol/src/wire/definitions/commands.ts:85
The values filled into the translation's placeholders.
successful
successful:
boolean
Defined in: protocol/src/wire/definitions/commands.ts:82
True when the command succeeded. The client colors a failed message red.
CompressionSettings
Defined in: protocol/src/CompressionCodec.ts:41
Settings for compressing outbound batches and bounding decompressed peer data.
Properties
algorithm
readonlyalgorithm:PacketCompressionAlgorithm
Defined in: protocol/src/CompressionCodec.ts:42
level?
readonlyoptionallevel?:number
Defined in: protocol/src/CompressionCodec.ts:44
zlib only; ignored by the other algorithms.
maxDecompressedLength?
readonlyoptionalmaxDecompressedLength?:number
Defined in: protocol/src/CompressionCodec.ts:52
Maximum number of bytes an inbound compressed batch may expand to.
threshold?
readonlyoptionalthreshold?:number
Defined in: protocol/src/CompressionCodec.ts:50
Payloads shorter than this go out uncompressed, carrying UNCOMPRESSED_BATCH as their prefix. Zero disables compression altogether, which is what Mojang's compressionThreshold of 0 means - not "compress everything from 0 bytes up".
ContainerRegistryCleanup
Defined in: protocol/src/packet/ContainerRegistryCleanupPacket.ts:8
The fields of a ContainerRegistryCleanupPacket, in wire order.
Properties
removedContainers
removedContainers:
FullContainerName[]
Defined in: protocol/src/packet/ContainerRegistryCleanupPacket.ts:10
Removed Containers: one FullContainerName per container the server's registry dropped.
CorrectPlayerMovePrediction
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:14
The corrected movement state and tick for the receiving player.
Properties
onGround
onGround:
boolean
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:28
Whether the corrected state is on the ground.
pos
pos:
Vec3
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:18
Position the client should have reached at the corrected tick.
posDelta
posDelta:
Vec3
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:20
Velocity the client should have reached at the corrected tick.
predictionType
predictionType:
RewindType
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:16
Whether the player or its vehicle is being corrected.
rotationX
rotationX:
number
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:22
First rotation component; meaningful for a vehicle correction.
rotationY
rotationY:
number
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:24
Second rotation component; meaningful for a vehicle correction.
tick
tick:
bigint
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:30
Input tick the client should rewind to.
vehicleAngularVelocity
vehicleAngularVelocity:
number|null
Defined in: protocol/src/packet/CorrectPlayerMovePredictionPacket.ts:26
Vehicle angular velocity, or null when the optional field is absent.
CraftingData
Defined in: protocol/src/packet/CraftingDataPacket.ts:80
The lists CraftingDataPacket carries, and the flag that closes it.
Properties
cleanRecipes
cleanRecipes:
boolean
Defined in: protocol/src/packet/CraftingDataPacket.ts:86
Whether the client should throw away the recipes it already had.
potionMixes
potionMixes: readonly
PotionMix[]
Defined in: protocol/src/packet/CraftingDataPacket.ts:84
shaped
shaped: readonly
ShapedRecipe[]
Defined in: protocol/src/packet/CraftingDataPacket.ts:81
shapeless
shapeless: readonly
ShapelessRecipe[]
Defined in: protocol/src/packet/CraftingDataPacket.ts:82
smithingTransform
smithingTransform: readonly
SmithingTransformRecipe[]
Defined in: protocol/src/packet/CraftingDataPacket.ts:83
CreatePhoto
Defined in: protocol/src/packet/CreatePhotoPacket.ts:9
The fields of a CreatePhotoPacket, in wire order.
Properties
photoItemName
photoItemName:
string
Defined in: protocol/src/packet/CreatePhotoPacket.ts:15
Photo Item Name, the display name the new photo item gets.
photoName
photoName:
string
Defined in: protocol/src/packet/CreatePhotoPacket.ts:13
Photo Name, the file name the photo is stored under.
rawId
rawId:
bigint
Defined in: protocol/src/packet/CreatePhotoPacket.ts:11
Raw ID, the unique id of the player whose portfolio holds the photo.
CreativeContent
Defined in: protocol/src/packet/CreativeContentPacket.ts:62
The two lists the creative menu is made of.
Properties
entries
entries:
CreativeEntry[]
Defined in: protocol/src/packet/CreativeContentPacket.ts:66
The menu itself. Its order is what a creative pick is read against.
groups
groups:
CreativeGroup[]
Defined in: protocol/src/packet/CreativeContentPacket.ts:64
The headings, in the order the client draws them. An entry's group indexes this list.
CreativeEntry
Defined in: protocol/src/packet/CreativeContentPacket.ts:55
One entry of the creative menu, and which heading it sits under.
Properties
group
group:
number
Defined in: protocol/src/packet/CreativeContentPacket.ts:58
An index into CreativeContent.groups.
item
item:
ItemStackData
Defined in: protocol/src/packet/CreativeContentPacket.ts:56
CreativeGroup
Defined in: protocol/src/packet/CreativeContentPacket.ts:47
A heading in the creative menu, with the item shown beside it.
Properties
category
category:
CreativeItemCategory
Defined in: protocol/src/packet/CreativeContentPacket.ts:48
icon
icon:
ItemStackData
Defined in: protocol/src/packet/CreativeContentPacket.ts:51
name
name:
string
Defined in: protocol/src/packet/CreativeContentPacket.ts:50
A translation key such as itemGroup.name.planks, or empty for an anonymous group.
CurrentStructureFeature
Defined in: protocol/src/packet/CurrentStructureFeaturePacket.ts:9
The fields of a CurrentStructureFeaturePacket, in wire order.
Properties
currentStructureFeature
currentStructureFeature:
string
Defined in: protocol/src/packet/CurrentStructureFeaturePacket.ts:14
Current Structure Feature, the identifier of the structure the player stands in, for example "minecraft:village". Empty when the player is not inside any structure.
DataStoreChange
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:65
The fields of a Data Store Change, in wire order.
Properties
dataStoreName
dataStoreName:
string
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:67
Data Store Name.
property
property:
string
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:69
Property, the name of the property in the data store that changed.
updateCount
updateCount:
number
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:71
Update Count: how many times the property has updated.
value
value:
DataStorePropertyValue
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:73
The New Property Value.
DataStoreMapEntry
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:43
One key of a MAP property value and the value it maps to.
Properties
key
key:
string
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:45
The map key.
value
value:
DataStorePropertyValue
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:47
The value the key maps to.
DataStoreRemoval
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:77
The fields of a Data Store Removal, in wire order.
Properties
dataStoreName
dataStoreName:
string
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:79
Data Store Name of the store that was removed.
DataStoreUpdateData
Defined in: protocol/src/structure/DataStoreUpdate.ts:27
The fields of a Data Store Update, in wire order.
Properties
data
data:
DataStoreValue
Defined in: protocol/src/structure/DataStoreUpdate.ts:35
Data, the value that is updating.
dataStoreName
dataStoreName:
string
Defined in: protocol/src/structure/DataStoreUpdate.ts:29
Data Store Name, 1 to 1000 bytes.
path
path:
string
Defined in: protocol/src/structure/DataStoreUpdate.ts:33
Path through the property that needs updating. Empty when the whole property changed.
pathUpdateCount
pathUpdateCount:
number
Defined in: protocol/src/structure/DataStoreUpdate.ts:42
Path Update Count: how many times the path has updated. Resets when the whole property changes.
property
property:
string
Defined in: protocol/src/structure/DataStoreUpdate.ts:31
Property, the name of the property in the data store that changed.
propertyUpdateCount
propertyUpdateCount:
number
Defined in: protocol/src/structure/DataStoreUpdate.ts:40
Property Update Count: how many times the property has updated. Does not increment unless the whole property updates.
DeathInfo
Defined in: protocol/src/packet/DeathInfoPacket.ts:10
The fields of a DeathInfoPacket, in wire order. Both belong to the packet's single Death Cause Message field, a DeathCauseMessageType.
Properties
cause
cause:
string
Defined in: protocol/src/packet/DeathInfoPacket.ts:12
Death Cause Attack Name: the untranslated death message key, for example "death.attack.lava".
messages
messages:
string[]
Defined in: protocol/src/packet/DeathInfoPacket.ts:14
Death Cause Message List: the parameters the client substitutes into the translated message.
DebugMarkerData
Defined in: protocol/src/packet/ClientboundDebugRendererPacket.ts:14
One labeled cube drawn by the client's debug renderer.
Properties
color
color:
number
Defined in: protocol/src/packet/ClientboundDebugRendererPacket.ts:20
ARGB color, written as a little-endian signed int32.
duration
duration:
bigint
Defined in: protocol/src/packet/ClientboundDebugRendererPacket.ts:22
Duration the cube remains visible, in milliseconds.
position
position:
Vec3
Defined in: protocol/src/packet/ClientboundDebugRendererPacket.ts:18
Position where the cube is drawn.
text
text:
string
Defined in: protocol/src/packet/ClientboundDebugRendererPacket.ts:16
Text shown at the marker.
DimensionData
Defined in: protocol/src/packet/DimensionDataPacket.ts:16
The fields of a DimensionDataPacket, in wire order.
Properties
definitions
definitions:
DimensionDataEntry[]
Defined in: protocol/src/packet/DimensionDataPacket.ts:18
Definitions, one entry per data-driven dimension, in the order they go on the wire.
DimensionDataEntry
Defined in: protocol/src/packet/DimensionDataPacket.ts:8
One entry of the Definitions map: the dimension identifier and its definition.
Properties
definition
definition:
DimensionDefinition
Defined in: protocol/src/packet/DimensionDataPacket.ts:12
The DimensionDefinition the key maps to.
id
id:
string
Defined in: protocol/src/packet/DimensionDataPacket.ts:10
The map key: the dimension identifier, for example "minecraft:overworld".
Disconnect
Defined in: protocol/src/packet/DisconnectPacket.ts:8
The fields of a DisconnectPacket, in wire order.
Properties
filteredMessage?
optionalfilteredMessage?:string
Defined in: protocol/src/packet/DisconnectPacket.ts:16
The Filtered Message string, the same text with chat filtering applied. Empty unless the server filters.
message?
optionalmessage?:string
Defined in: protocol/src/packet/DisconnectPacket.ts:14
The Message string. Written as an empty string when absent and skipMessage is false.
reason
reason:
DisconnectReason
Defined in: protocol/src/packet/DisconnectPacket.ts:10
The Reason enum value. The client maps it to the error code on its disconnect screen.
skipMessage
skipMessage:
boolean
Defined in: protocol/src/packet/DisconnectPacket.ts:12
Skip Message. When true no strings are on the wire and the client shows its own generic text.
DisconnectMessages
Defined in: protocol/src/wire/definitions/disconnect.ts:13
The oneOf<DisconnectPacketMessages, null> tail, with the byte that selects it.
Properties
filteredMessage
filteredMessage:
string
Defined in: protocol/src/wire/definitions/disconnect.ts:19
Filtered Message: the same text with chat filtering applied.
message
message:
string
Defined in: protocol/src/wire/definitions/disconnect.ts:17
Message, shown on the disconnect screen. Not on the wire when skipMessage is true.
skipMessage
skipMessage:
boolean
Defined in: protocol/src/wire/definitions/disconnect.ts:15
Skip Message: true picks the null alternative and the packet ends after this byte.
EditorNetwork
Defined in: protocol/src/packet/EditorNetworkPacket.ts:9
The fields of an EditorNetworkPacket, in wire order.
Properties
rawVariantData
rawVariantData:
string
Defined in: protocol/src/packet/EditorNetworkPacket.ts:15
Raw Variant Data, the payload serialized by that type. Opaque to the protocol.
rawVariantName
rawVariantName:
string
Defined in: protocol/src/packet/EditorNetworkPacket.ts:13
Raw Variant Name, the name of the IEditorNetworkPayload type that produced the data.
routeToManager
routeToManager:
boolean
Defined in: protocol/src/packet/EditorNetworkPacket.ts:11
Route To Manager: deliver the payload to the editor's network manager instead of the default receiver.
EduSharedUriResourceData
Defined in: protocol/src/structure/EduSharedUriResource.ts:5
The fields of an EduSharedUriResource, in wire order.
Properties
buttonName
buttonName:
string
Defined in: protocol/src/structure/EduSharedUriResource.ts:7
Button Name, the label of the button the Education Edition client shows.
linkUri
linkUri:
string
Defined in: protocol/src/structure/EduSharedUriResource.ts:9
Link Uri, the address the button opens.
EduUriResource
Defined in: protocol/src/packet/EduUriResourcePacket.ts:9
The fields of an EduUriResourcePacket, in wire order.
Properties
eduSharedUriResource
eduSharedUriResource:
EduSharedUriResourceData
Defined in: protocol/src/packet/EduUriResourcePacket.ts:11
Edu Shared URI Resource, the link and button label every client should show.
EnchantmentInstance
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:11
One enchantment and the level the table offers for it.
Properties
enchantLevel
enchantLevel:
number
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:15
Enchant Level as a uint8.
enchantType
enchantType:
EnchantType
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:13
Enchant Type as a uint8.
EntityDiagnosticTimingInfo
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:12
Simulation time one entity took in the client's last sample window.
Properties
dimension
dimension:
string
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:18
displayName
displayName:
string
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:13
entity
entity:
string
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:14
percentOfTotal
percentOfTotal:
number
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:16
position
position:
Vector3
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:17
timeInNs
timeInNs:
bigint
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:15
EnvironmentAttributeFields
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:86
The fields of an EnvironmentAttributeData, in wire order.
Properties
attribute
attribute:
AttributeValue
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:92
Attribute, the value in effect now.
attributeName
attributeName:
string
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:88
AttributeName, at most 128 characters.
currentTransitionTicks
currentTransitionTicks:
number
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:96
CurrentTransitionTicks elapsed since the transition started.
easing
easing:
"linear"|"spring"|"in_quad"|"out_quad"|"in_out_quad"|"in_cubic"|"out_cubic"|"in_out_cubic"|"in_quart"|"out_quart"|"in_out_quart"|"in_quint"|"out_quint"|"in_out_quint"|"in_sine"|"out_sine"|"in_out_sine"|"in_expo"|"out_expo"|"in_out_expo"|"in_circ"|"out_circ"|"in_out_circ"|"in_bounce"|"out_bounce"|"in_out_bounce"|"in_back"|"out_back"|"in_out_back"|"in_elastic"|"out_elastic"|"in_out_elastic"
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:100
Easing curve the transition follows, an easing_function name such as "in_out_quad".
fromAttribute?
optionalfromAttribute?:AttributeValue
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:90
FromAttribute, the value a running transition started from. Unset when nothing is transitioning.
localTransitionTicks
localTransitionTicks:
number
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:102
LocalTransitionTicks elapsed in the noise-local part of the transition.
noiseAlignment
noiseAlignment:
NoiseAlignment
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:106
NoiseAlignment of that noise.
noiseTransition
noiseTransition:
boolean
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:104
NoiseTransition: whether the layer's noise drives the transition.
toAttribute?
optionaltoAttribute?:AttributeValue
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:94
ToAttribute, the value a running transition ends at. Unset when nothing is transitioning.
totalTransitionTicks
totalTransitionTicks:
number
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:98
TotalTransitionTicks the transition lasts.
Experiment
Defined in: minecraft/src/Experiment.ts:1
Properties
enabled
enabled:
boolean
Defined in: minecraft/src/Experiment.ts:3
name
name:
string
Defined in: minecraft/src/Experiment.ts:2
ExperimentToggle
Defined in: protocol/src/packet/StartGamePacket.ts:37
An experiment name and whether it is enabled for the world.
Properties
enabled
enabled:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:39
name
name:
string
Defined in: protocol/src/packet/StartGamePacket.ts:38
ExternalLinkSettings
Defined in: protocol/src/packet/EducationSettingsPacket.ts:5
A link the Education Edition client offers alongside the world.
Properties
displayName
displayName:
string
Defined in: protocol/src/packet/EducationSettingsPacket.ts:7
url
url:
string
Defined in: protocol/src/packet/EducationSettingsPacket.ts:6
FeatureRegistry
Defined in: protocol/src/packet/FeatureRegistryPacket.ts:15
The fields of a FeatureRegistryPacket, in wire order.
Properties
features
features:
FeatureRegistryEntry[]
Defined in: protocol/src/packet/FeatureRegistryPacket.ts:17
FeaturesDataList, one entry per feature the client should be able to place itself.
FeatureRegistryEntry
Defined in: protocol/src/packet/FeatureRegistryPacket.ts:7
One FeatureRegistry::FeatureBinaryJsonFormat entry of the FeaturesDataList.
Properties
binaryJson
binaryJson:
string
Defined in: protocol/src/packet/FeatureRegistryPacket.ts:11
Binary Json Output, the feature's JSON definition serialized to a string.
name
name:
string
Defined in: protocol/src/packet/FeatureRegistryPacket.ts:9
Feature Name, the identifier the feature is registered under, for example "minecraft:oak_tree_feature".
FullContainerName
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:30
FullContainerName: a Container Name byte and, when present, the Dynamic ID of that container.
Properties
containerId
containerId:
number
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:32
Container Name, a ContainerUiId value written as a uint8.
dynamicId
dynamicId:
number|null
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:34
Dynamic ID, a uint32 that tells apart several open containers of the same kind. Null when absent.
FullContainerNameData
Defined in: protocol/src/wire/definitions/containers.ts:19
FullContainerName: which kind of container, and which one of that kind.
Named for the wire fields rather than the structure class of the same name, which the NetworkStructure consumers keep.
Properties
containerId
containerId:
number
Defined in: protocol/src/wire/definitions/containers.ts:21
Container Name: a ContainerUiId.
dynamicId
dynamicId:
number|null
Defined in: protocol/src/wire/definitions/containers.ts:23
Dynamic ID: absent unless several containers of the kind are open at once.
FurnaceOptions
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:32
The FurnaceOptions the player picked, in wire order.
Properties
filtering
filtering:
boolean
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:36
Filtering: the recipe book hides recipes the player cannot make.
layout
layout:
FurnaceLayout
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:38
Layout.
leftTab
leftTab:
FurnaceLeftTabIndex
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:34
Left Furnace Tab.
GameRule
Defined in: protocol/src/packet/StartGamePacket.ts:27
A named world rule with its value type, current value, and client editability.
Properties
editable
editable:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:30
Whether a player with the permission may change it from the client.
name
name:
string
Defined in: protocol/src/packet/StartGamePacket.ts:28
type
type:
GameRuleType
Defined in: protocol/src/packet/StartGamePacket.ts:31
value
value:
number|boolean
Defined in: protocol/src/packet/StartGamePacket.ts:33
Ignored for GameRuleType.NONE.
GameTestRequest
Defined in: protocol/src/packet/GameTestRequestPacket.ts:33
The fields of a GameTestRequestPacket, in wire order.
Properties
maxTestsPerBatch
maxTestsPerBatch:
number
Defined in: protocol/src/packet/GameTestRequestPacket.ts:35
MaxTestsPerBatch, how many tests may run at once.
repeatCount
repeatCount:
number
Defined in: protocol/src/packet/GameTestRequestPacket.ts:37
RepeatCount, how many times to run each test.
rotation
rotation:
Rotation
Defined in: protocol/src/packet/GameTestRequestPacket.ts:39
Rotation to place the test structure with.
stopOnFailure
stopOnFailure:
boolean
Defined in: protocol/src/packet/GameTestRequestPacket.ts:41
StopOnFailure: stop the batch at the first failed test.
testName
testName:
string
Defined in: protocol/src/packet/GameTestRequestPacket.ts:47
TestName, the GameTest to run, for example farm:crops.
testPosition
testPosition:
BlockPos
Defined in: protocol/src/packet/GameTestRequestPacket.ts:43
TestPos, the block the first test structure is placed at.
testsPerRow
testsPerRow:
number
Defined in: protocol/src/packet/GameTestRequestPacket.ts:45
TestsPerRow, how many test structures to lay out before starting a new row.
GameTestResults
Defined in: protocol/src/packet/GameTestResultsPacket.ts:9
The fields of a GameTestResultsPacket, in wire order.
Properties
error
error:
string
Defined in: protocol/src/packet/GameTestResultsPacket.ts:13
Error, why the test failed. Empty when it passed.
succeeded
succeeded:
boolean
Defined in: protocol/src/packet/GameTestResultsPacket.ts:11
Succeeded: the test passed.
testName
testName:
string
Defined in: protocol/src/packet/GameTestResultsPacket.ts:15
TestName, the GameTest this result is for, as the request named it.
GatedField
Defined in: protocol/src/wire/define.ts:21
A field whose presence a WireGate decides per protocol version.
Type Parameters
T
T
Properties
fallback
readonlyfallback:T
Defined in: protocol/src/wire/define.ts:25
What the payload holds at versions where the field is not on the wire.
gate
readonlygate:WireGate
Defined in: protocol/src/wire/define.ts:22
of
readonlyof:WireType<T>
Defined in: protocol/src/wire/define.ts:23
GatheringJoinInfo
Defined in: protocol/src/packet/StartGamePacket.ts:63
Optional world and experience identifiers shown in gathering or rich-presence UI.
Properties
creatorId?
optionalcreatorId?:string
Defined in: protocol/src/packet/StartGamePacket.ts:68
experienceId?
optionalexperienceId?:WireUUID
Defined in: protocol/src/packet/StartGamePacket.ts:64
experienceName?
optionalexperienceName?:string
Defined in: protocol/src/packet/StartGamePacket.ts:65
scenarioId?
optionalscenarioId?:string
Defined in: protocol/src/packet/StartGamePacket.ts:70
serverId?
optionalserverId?:string
Defined in: protocol/src/packet/StartGamePacket.ts:71
targetId?
optionaltargetId?:WireUUID
Defined in: protocol/src/packet/StartGamePacket.ts:69
worldId?
optionalworldId?:WireUUID
Defined in: protocol/src/packet/StartGamePacket.ts:66
worldName?
optionalworldName?:string
Defined in: protocol/src/packet/StartGamePacket.ts:67
GatheringsConfig
Defined in: protocol/src/packet/TransferPacket.ts:8
The optional experience metadata sent with a server transfer.
Properties
creatorId
creatorId:
string
Defined in: protocol/src/packet/TransferPacket.ts:18
Identifier of the experience creator.
experienceId
experienceId:
UUID
Defined in: protocol/src/packet/TransferPacket.ts:10
Unique identifier for the experience.
experienceName
experienceName:
string
Defined in: protocol/src/packet/TransferPacket.ts:12
Display name of the experience.
scenarioId
scenarioId:
string|null
Defined in: protocol/src/packet/TransferPacket.ts:22
Identifier of the scenario, when one is supplied.
serverId
serverId:
string|null
Defined in: protocol/src/packet/TransferPacket.ts:24
Identifier of the destination server, when one is supplied.
targetId
targetId:
UUID|null
Defined in: protocol/src/packet/TransferPacket.ts:20
Unique identifier of the target, when one is supplied.
worldId
worldId:
UUID|null
Defined in: protocol/src/packet/TransferPacket.ts:14
Unique identifier for the experience world, when one is supplied.
worldName
worldName:
string|null
Defined in: protocol/src/packet/TransferPacket.ts:16
Display name of the experience world, when one is supplied.
GraphicsOverrideParameter
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:140
The fields of a GraphicsOverrideParameterPacket, in wire order.
Properties
biomeIdentifier
biomeIdentifier:
string
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:148
Biome Identifier: the biome the override applies to.
floatValue?
optionalfloatValue?:number
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:144
Float Value: a single float override. Omit when the parameter is keyframed or a Vec3.
keyframeValues
keyframeValues:
ParameterKeyframeValue[]
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:142
Parameter Keyframe Values, at most 255 entries. Empty when the override is a single value.
parameter
parameter:
GraphicsOverrideParameterType
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:152
Identifier for Parameter: which parameter changes.
playerIdentifier?
optionalplayerIdentifier?:string
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:150
Player Identifier: the player the override applies to. Omit for every player.
resetParameter
resetParameter:
boolean
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:154
Reset Parameter: when true the parameter returns to its default and the value fields are ignored.
vec3Value?
optionalvec3Value?:GraphicsVec3
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:146
Vec3 Value: a single Vec3 override. Omit when the parameter is keyframed or a float.
GraphicsVec3
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:119
Three little-endian floats, the docs' Vec3.
Properties
x
x:
number
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:121
X.
y
y:
number
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:123
Y.
z
z:
number
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:125
Z.
GuiDataPickItem
Defined in: protocol/src/packet/GuiDataPickItemPacket.ts:9
The text shown in the pick-block popup and the hotbar slot it points to.
Properties
itemEffectName
itemEffectName:
string
Defined in: protocol/src/packet/GuiDataPickItemPacket.ts:13
Item Effect Name, the line beneath the title.
itemName
itemName:
string
Defined in: protocol/src/packet/GuiDataPickItemPacket.ts:11
Item Name, the popup title.
slot
slot:
number
Defined in: protocol/src/packet/GuiDataPickItemPacket.ts:15
Slot to hover, encoded as a little-endian int32.
InputVector2
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:137
A two-float vector used for rotations and movement input.
Properties
x
x:
number
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:138
y
y:
number
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:139
InventoryActionData
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:161
One of the docs' Actions: a slot that changes, with the stack it held before and after.
Wire order is Source Type (varuint), Container ID (optional int8), Bit Flags (optional varuint), Slot (varuint), From Item, To Item. The two optionals each carry their own presence byte.
Properties
newItem
newItem:
ItemStackDescriptorData
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:173
To Item.
oldItem
oldItem:
ItemStackDescriptorData
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:171
From Item.
sourceFlags
sourceFlags:
number|null
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:167
Bit Flags.
sourceType
sourceType:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:163
The docs' Source Type, as read. An InventorySourceType when the client sent a known one.
targetSlot
targetSlot:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:169
Slot.
windowId
windowId:
number|null
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:165
Container ID, a single signed byte where it used to be a varint.
InventoryTransaction
Defined in: protocol/src/packet/InventoryTransactionPacket.ts:16
The normalized data carried by an inventory transaction at every protocol version.
Properties
hand
hand:
number
Defined in: protocol/src/packet/InventoryTransactionPacket.ts:26
Hand added to two transaction bodies at protocol 2225.
inventoryActions
inventoryActions:
InventoryActionData[]
Defined in: protocol/src/packet/InventoryTransactionPacket.ts:22
Slot changes the client associates with this transaction.
legacyRequest
legacyRequest:
LegacyTransactionRequest
Defined in: protocol/src/packet/InventoryTransactionPacket.ts:18
Legacy request id and the optional slot list it controls.
transactionData
transactionData:
UseItemData<ItemStackDescriptorData> |UseItemOnEntityData<ItemStackDescriptorData> |ReleaseItemData<ItemStackDescriptorData> |null
Defined in: protocol/src/packet/InventoryTransactionPacket.ts:24
The body selected by transactionType, or null when the variant has no known body.
transactionType
transactionType:
number
Defined in: protocol/src/packet/InventoryTransactionPacket.ts:20
The variant index; unknown values are preserved so the server can reject them.
ItemEnchantOption
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:31
One enchantment table option offered to the player.
Properties
cost
cost:
number
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:33
Experience levels the option costs, encoded as a uint8.
enchantName
enchantName:
string
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:37
Name shown in the Standard Galactic Alphabet.
enchantNetId
enchantNetId:
number
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:39
RecipeNetId returned when the client selects this option.
enchants
enchants:
ItemEnchants
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:35
Enchantments the item receives if this option is selected.
ItemEnchants
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:19
The enchantments in one option, grouped by the equipment that activates them.
Properties
equipActivatedEnchants
equipActivatedEnchants:
EnchantmentInstance[]
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:23
Enchantments active while the item is equipped.
heldActivatedEnchants
heldActivatedEnchants:
EnchantmentInstance[]
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:25
Enchantments active while the item is held.
selfActivatedEnchants
selfActivatedEnchants:
EnchantmentInstance[]
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:27
Enchantments active on the holder.
slot
slot:
number
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:21
Slot index, encoded as a little-endian int32.
ItemInstanceUserDataConfig
Defined in: protocol/src/structure/ItemInstanceUserData.ts:6
The optional parts of an item's user data.
Properties
blockingTick?
optionalblockingTick?:bigint
Defined in: protocol/src/structure/ItemInstanceUserData.ts:12
The tick a shield started blocking on. Only a shield carries one.
canDestroyBlocks?
optionalcanDestroyBlocks?:string[]
Defined in: protocol/src/structure/ItemInstanceUserData.ts:10
Block names the item may break.
canPlaceOnBlocks?
optionalcanPlaceOnBlocks?:string[]
Defined in: protocol/src/structure/ItemInstanceUserData.ts:8
Block names the item may be placed on, such as minecraft:stone.
ItemRegistry
Defined in: protocol/src/packet/ItemRegistryPacket.ts:31
The decoded ItemRegistryPacket: the Item Data array in wire order.
Properties
items
items:
ItemRegistryEntry[]
Defined in: protocol/src/packet/ItemRegistryPacket.ts:33
One entry per item the server declared, in the order the server sent them.
useContextItemData?
optionaluseContextItemData?:boolean
Defined in: protocol/src/packet/ItemRegistryPacket.ts:35
Whether to use the injected vanilla item table instead of the explicit entries.
ItemRegistryEntry
Defined in: protocol/src/packet/ItemRegistryPacket.ts:11
One ItemData entry of ItemRegistryPacket.
Properties
componentBased
componentBased:
boolean
Defined in: protocol/src/packet/ItemRegistryPacket.ts:17
Is Component Based. True when components define the item instead of client built-ins.
componentData?
optionalcomponentData?:NBTTagCompound
Defined in: protocol/src/packet/ItemRegistryPacket.ts:25
Item Component Data, the compound that defines a component-based item. A reader always fills it. A writer may leave it out for an item with no components, which writes the empty compound the field still requires.
componentDataBuffer?
optionalcomponentDataBuffer?:Buffer<ArrayBufferLike>
Defined in: protocol/src/packet/ItemRegistryPacket.ts:27
Already encoded network NBT from a captured item table; written byte for byte.
name
name:
string
Defined in: protocol/src/packet/ItemRegistryPacket.ts:13
Item Name, e.g. minecraft:stick.
runtimeId
runtimeId:
number
Defined in: protocol/src/packet/ItemRegistryPacket.ts:15
Item Id, an int16. Negative for a block's item form.
version
version:
number
Defined in: protocol/src/packet/ItemRegistryPacket.ts:19
Item Version from the docs enum ItemVersion: 0 Legacy, 1 DataDriven, 2 None.
ItemStackData
Defined in: protocol/src/structure/ItemStack.ts:5
One item stack, in the plain form a payload carries it.
Properties
blockRuntimeId
blockRuntimeId:
number
Defined in: protocol/src/structure/ItemStack.ts:13
The hashed runtime id of the block the item places, or 0 when it places none.
count
count:
number
Defined in: protocol/src/structure/ItemStack.ts:9
Stack size.
meta
meta:
number
Defined in: protocol/src/structure/ItemStack.ts:11
Aux value: the damage or the variant.
runtimeId
runtimeId:
number
Defined in: protocol/src/structure/ItemStack.ts:7
Item Id from the item registry, or 0 for an empty stack.
userData?
optionaluserData?:Buffer<ArrayBufferLike>
Defined in: protocol/src/structure/ItemStack.ts:15
User Data Buffer, a serialized ItemInstanceUserData. Empty when absent.
ItemStackDescriptorData
Defined in: protocol/src/wire/structures/ItemStackDescriptor.ts:19
One item stack's six wire fields.
Properties
auxValue
auxValue:
number
Defined in: protocol/src/wire/structures/ItemStackDescriptor.ts:25
Aux value, the stack's metadata, as a varuint32.
blockRuntimeId
blockRuntimeId:
number
Defined in: protocol/src/wire/structures/ItemStackDescriptor.ts:29
Block Runtime Id of the block this stack places, or 0.
id
id:
number
Defined in: protocol/src/wire/structures/ItemStackDescriptor.ts:21
Id, a little-endian int16. 0 is the empty stack.
stackNetId
stackNetId:
number|null
Defined in: protocol/src/wire/structures/ItemStackDescriptor.ts:27
Net Id Variant, present only when the sender tracks the stack.
stackSize
stackSize:
number
Defined in: protocol/src/wire/structures/ItemStackDescriptor.ts:23
Stack size, a little-endian uint16.
userData
userData:
Buffer
Defined in: protocol/src/wire/structures/ItemStackDescriptor.ts:31
User Data Buffer: the ItemInstanceUserData bytes, kept as bytes.
ItemStackRequest
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:79
ItemStackRequest: a batch of actions the client wants applied together and answered together.
Wire order: Client Request Id (varint32), Actions (varuint count, then each action), Strings To Filter (varuint count, then strings), StringsToFilterOrigin (int32 LE).
See
https://mojang.github.io/bedrock-protocol-docs/1.26.51/types/item-stack-request/
Properties
actions
actions:
ItemStackRequestAction[]
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:83
Actions, in the order the client wants them applied.
filterStringCause
filterStringCause:
number
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:87
StringsToFilterOrigin, a TextProcessingEventOrigin value.
filterStrings
filterStrings:
string[]
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:85
Strings To Filter, text the player typed that the server may send to profanity filtering.
requestId
requestId:
number
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:81
Client Request Id. A client makes these up negative and odd; the response names the same id.
ItemStackRequestAction
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:54
One action of a request.
Every action type is decoded, including the ones nothing acts on. An action cannot be skipped without knowing its length, and its length is only known by reading it. A type left unread does not cost that action, it costs the rest of the packet.
Properties
count?
optionalcount?:number
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:57
Amount, for the actions that move or remove a number of items. The docs bound it to 1 to 64.
creativeItemNetId?
optionalcreativeItemNetId?:number
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:61
CREATIVE_CREATE: Creative Item Net Id, which entry of the creative menu, as sent in CreativeContentPacket.
destination?
optionaldestination?:ItemStackRequestSlotInfo
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:59
hotbarSlot?
optionalhotbarSlot?:number
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:67
MINE_BLOCK: Slot, the hotbar slot the block was being mined with.
recipeNetId?
optionalrecipeNetId?:number
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:69
CRAFTING_RECIPE and CRAFTING_RECIPE_AUTO: Recipe Net Id, as numbered by CraftingDataPacket.
repetitions?
optionalrepetitions?:number
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:63
Number of requested crafts, for the crafting actions that carry one.
reservedId?
optionalreservedId?:string
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:65
Reserved Id, carried by protocol 2225's CraftReservedAction.
source?
optionalsource?:ItemStackRequestSlotInfo
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:58
type
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:55
ItemStackRequestSlotInfo
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:38
ItemStackRequestSlotInfo: which container, which slot, and which stack the client thinks is there.
Properties
container
container:
FullContainerName
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:40
Full container name.
slotId
slotId:
number
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:42
Slot, a uint8 index inside the container.
stackNetId
stackNetId:
number
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:44
Net Id Variant, the stack net id the client believes the slot holds.
ItemStackResponse
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:45
The server's answer to one request, matched to it by id.
Properties
containers
containers:
ItemStackResponseContainerInfo[]
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:51
Containers, the containers the request changed. Only written when the result is OK.
requestId
requestId:
number
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:49
Client Request Id, the id of the request this answers.
result
result:
ItemStackResponseResult
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:47
Result, an ItemStackNetResult. Anything but OK carries no containers.
ItemStackResponseContainerInfo
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:37
The slots of one container that the request touched.
Properties
container
container:
FullContainerName
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:39
Full Container Name: which container the slots below belong to.
slots
slots:
ItemStackResponseSlotInfo[]
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:41
Slots, one entry per slot the request changed.
ItemStackResponseSlotInfo
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:23
What a slot holds once the request has been applied.
The docs write two slot indices, Requested Slot and then Slot, and they carry the same number: the slot that actually changed. One field rather than two so they cannot drift - they did, and a crafting slot answered for under Requested Slot 28 and Slot 0 pointed the client at the first square of the grid whichever square had emptied.
Properties
count
count:
number
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:27
Amount, a uint8. Zero means the slot is empty, and then no Item Stack Net Id follows.
customName
customName:
string
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:31
The Unredacted half of Custom Name.
durabilityCorrection
durabilityCorrection:
number
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:33
Durability Correction, a varint32 that has to fit in an int16.
itemStackId
itemStackId:
number
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:29
Item Stack Net Id, the server's id for the stack. Written whenever Amount is above zero.
slot
slot:
number
Defined in: protocol/src/packet/ItemStackResponsePacket.ts:25
Requested Slot and Slot, the slot this answers for, in the client's own numbering.
LabTable
Defined in: protocol/src/packet/LabTablePacket.ts:32
The action, position, and optional reaction carried by a chemistry lab table exchange.
Properties
position
position:
BlockPos
Defined in: protocol/src/packet/LabTablePacket.ts:36
Position of the lab table as a signed BlockPos.
reaction
reaction:
LabTableReactionType
Defined in: protocol/src/packet/LabTablePacket.ts:38
Effect to play for StartReaction; otherwise None.
type
type:
LabTableType
Defined in: protocol/src/packet/LabTablePacket.ts:34
Whether the client started a combination, started a reaction, or reset the table.
LecternUpdate
Defined in: protocol/src/packet/LecternUpdatePacket.ts:8
A player turning to a page in a lectern book.
Properties
newPage
newPage:
number
Defined in: protocol/src/packet/LecternUpdatePacket.ts:10
Zero-based page the client wants shown.
position
position:
BlockPos
Defined in: protocol/src/packet/LecternUpdatePacket.ts:14
Position of the lectern, encoded as a signed BlockPos.
totalPages
totalPages:
number
Defined in: protocol/src/packet/LecternUpdatePacket.ts:12
Number of pages in the book, as the client sees it.
LegacyTransactionRequest
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:327
The Legacy Request ID and the slot list whose presence its validity decides.
Extended by
Properties
legacyRequestId
legacyRequestId:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:328
legacySlotChanges
legacySlotChanges:
LegacySlotChange[]
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:329
LessonProgress
Defined in: protocol/src/packet/LessonProgressPacket.ts:19
The fields of a LessonProgressPacket, in wire order.
Properties
action
action:
LessonAction
Defined in: protocol/src/packet/LessonProgressPacket.ts:21
Lesson Action, what happened to the lesson.
activityId
activityId:
string
Defined in: protocol/src/packet/LessonProgressPacket.ts:25
Activity Id, which lesson the packet is about.
score
score:
number
Defined in: protocol/src/packet/LessonProgressPacket.ts:23
Score the player reached in the lesson.
LevelChunk
Defined in: protocol/src/packet/LevelChunkPacket.ts:10
The fields of a LevelChunkPacket, in wire order.
Properties
blobHashes?
optionalblobHashes?:bigint[]
Defined in: protocol/src/packet/LevelChunkPacket.ts:27
Cache Metadata, one Blob Id per sub chunk and one for the biomes. Empty when the cache is off.
cached
cached:
boolean
Defined in: protocol/src/packet/LevelChunkPacket.ts:25
Cache Enabled: the payload holds only border blocks and block entities and the sub chunks come by blob.
chunkX
chunkX:
number
Defined in: protocol/src/packet/LevelChunkPacket.ts:12
Chunk Position X, in chunks.
chunkZ
chunkZ:
number
Defined in: protocol/src/packet/LevelChunkPacket.ts:14
Chunk Position Z, in chunks.
clientSubChunkRequestsEnabled
clientSubChunkRequestsEnabled:
boolean
Defined in: protocol/src/packet/LevelChunkPacket.ts:23
Whether the Client Request SubChunk Limit is present, which puts the chunk in request mode.
dimension
dimension:
number
Defined in: protocol/src/packet/LevelChunkPacket.ts:16
Dimension Id: 0 for the Overworld, 1 for the Nether, 2 for the End.
isClientBiomeUpdate?
optionalisClientBiomeUpdate?:boolean
Defined in: protocol/src/packet/LevelChunkPacket.ts:37
Whether server biome data overrides the client's, present from protocol 2225.
payload
payload:
Buffer
Defined in: protocol/src/packet/LevelChunkPacket.ts:35
Serialized Chunk Data, left as bytes.
Deliberately not parsed: a bot that is measuring a server does not need to know what is in the terrain, and the parsing is the expensive half. Anything that does want the blocks decodes this itself; the length is right here, so nothing is lost by waiting.
subChunkCount
subChunkCount:
number
Defined in: protocol/src/packet/LevelChunkPacket.ts:21
Sub-chunks Count in plain mode. In request mode this is the Client Request SubChunk Limit instead, the highest sub chunk the client may ask for, and the count goes out as 0.
LevelEvent
Defined in: protocol/src/packet/LevelEventPacket.ts:8
The world event id, its position, and event-specific data.
Properties
data
data:
number
Defined in: protocol/src/packet/LevelEventPacket.ts:14
Event-specific value, such as the block runtime id for a block-breaking effect.
eventId
eventId:
number
Defined in: protocol/src/packet/LevelEventPacket.ts:10
Event identifier; the client selects its sound, particles, or other effect from this.
position
position:
Vec3|null
Defined in: protocol/src/packet/LevelEventPacket.ts:12
Event position, or null to encode the origin used by the server's global events.
LocatorBar
Defined in: protocol/src/packet/LocatorBarPacket.ts:8
The fields of a LocatorBarPacket, in wire order.
Properties
waypoints
waypoints:
LocatorBarWaypointPayload[]
Defined in: protocol/src/packet/LocatorBarPacket.ts:10
Waypoints, one entry per waypoint to add, remove or update, applied in order.
Login
Defined in: protocol/src/packet/LoginPacket.ts:6
The client protocol number and the two JWT strings from its login request.
Properties
chainData
chainData:
string
Defined in: protocol/src/packet/LoginPacket.ts:13
The chain JSON. Either {"chain": [...]} with one JWT per link, or from 1.26.10 the envelope {"Certificate": "<that JSON>", "AuthenticationType": n, "Token": "<JWT>"}. Not parsed here.
clientData
clientData:
string
Defined in: protocol/src/packet/LoginPacket.ts:15
One JWT: skin, device, language, and the address the client dialed.
protocolVersion
protocolVersion:
number
Defined in: protocol/src/packet/LoginPacket.ts:7
MapClientPixel
Defined in: protocol/src/packet/MapInfoRequestPacket.ts:10
One pixel the client sampled from its own chunks and wants the server's map to keep.
Properties
index
index:
number
Defined in: protocol/src/packet/MapInfoRequestPacket.ts:14
Position in the 128 by 128 map, as row times 128 plus column.
pixel
pixel:
number
Defined in: protocol/src/packet/MapInfoRequestPacket.ts:12
The color as the client packs it, a uint32.
MapDecoration
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:49
A marker drawn on a map.
Properties
color
color:
number
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:61
Packed ARGB color written as a little-endian int32.
imageType
imageType:
MapDecorationType
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:51
Artwork used for the marker.
label
label:
string
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:59
Text displayed beside the marker.
rotation
rotation:
number
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:53
Direction, in one of sixteen steps.
x
x:
number
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:55
Pixel offset across the map.
y
y:
number
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:57
Pixel offset down the map.
MapItemTrackedActorUniqueId
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:65
A map marker the client keeps synchronized to an actor or block actor.
Properties
blockPosition
blockPosition:
BlockPos|null
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:71
Block position for a block actor marker, otherwise null.
entityId
entityId:
bigint|null
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:69
Entity id for an entity marker, otherwise null.
type
type:
MapItemTrackedActorType
Defined in: protocol/src/packet/ClientboundMapItemDataPacket.ts:67
Kind of object the marker follows.
MatchmakingStateOptions
Defined in: protocol/src/wire/definitions/added2225.ts:67
MatchmakingStateOptions: who triggered the matchmaking the state belongs to.
Properties
triggeredByLocalPlayer
triggeredByLocalPlayer:
boolean
Defined in: protocol/src/wire/definitions/added2225.ts:71
Triggered By Local Player.
triggeringPlayerName
triggeringPlayerName:
string
Defined in: protocol/src/wire/definitions/added2225.ts:69
Triggering Player Name.
MemoryCategoryCounter
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:6
Live byte count of one Memory::MemoryCategory, which the client writes as a uint8.
Properties
category
category:
number
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:7
currentBytes
currentBytes:
bigint
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:8
MissingBlobData
Defined in: protocol/src/packet/ClientCacheMissResponsePacket.ts:4
One chunk blob and the hash the client files it under.
Properties
blobData
blobData:
Buffer
Defined in: protocol/src/packet/ClientCacheMissResponsePacket.ts:9
Sub chunk or biome data, the same bytes the chunk packet would otherwise have carried.
blobId
blobId:
bigint
Defined in: protocol/src/packet/ClientCacheMissResponsePacket.ts:6
XXHash64 of the payload as a little endian uint64, matching a hash the client reported as missing.
MobArmorEquipment
Defined in: protocol/src/packet/MobArmorEquipmentPacket.ts:9
The five positional armor slots an entity can show to a client.
Properties
body
body:
ItemStackDescriptorData
Defined in: protocol/src/packet/MobArmorEquipmentPacket.ts:21
Body armor, used by horses, llamas, and wolves.
chest
chest:
ItemStackDescriptorData
Defined in: protocol/src/packet/MobArmorEquipmentPacket.ts:15
Torso armor.
feet
feet:
ItemStackDescriptorData
Defined in: protocol/src/packet/MobArmorEquipmentPacket.ts:19
Foot armor.
head
head:
ItemStackDescriptorData
Defined in: protocol/src/packet/MobArmorEquipmentPacket.ts:13
Head armor.
legs
legs:
ItemStackDescriptorData
Defined in: protocol/src/packet/MobArmorEquipmentPacket.ts:17
Leg armor.
runtimeEntityId
runtimeEntityId:
bigint
Defined in: protocol/src/packet/MobArmorEquipmentPacket.ts:11
Runtime id of the entity wearing these items.
MotionPredictionHints
Defined in: protocol/src/packet/MotionPredictionHintsPacket.ts:8
Actor movement state used to seed the client's prediction history.
Properties
motion
motion:
Vec3
Defined in: protocol/src/packet/MotionPredictionHintsPacket.ts:12
Velocity in blocks per tick.
onGround
onGround:
boolean
Defined in: protocol/src/packet/MotionPredictionHintsPacket.ts:14
Whether the actor is currently touching the ground.
runtimeId
runtimeId:
bigint
Defined in: protocol/src/packet/MotionPredictionHintsPacket.ts:10
Runtime id of the actor whose motion is being described.
MovePlayer
Defined in: protocol/src/packet/MovePlayerPacket.ts:22
A player's position, rotation, movement mode, and input tick.
Properties
headYaw
headYaw:
number
Defined in: protocol/src/packet/MovePlayerPacket.ts:32
Head yaw in degrees, usually the same as yaw.
mode
mode:
PositionMode
Defined in: protocol/src/packet/MovePlayerPacket.ts:34
How the receiving client should apply this move.
onGround
onGround:
boolean
Defined in: protocol/src/packet/MovePlayerPacket.ts:36
Whether the player is touching the ground.
pitch
pitch:
number
Defined in: protocol/src/packet/MovePlayerPacket.ts:28
Pitch in degrees.
position
position:
object
Defined in: protocol/src/packet/MovePlayerPacket.ts:26
The player's predicted world position after this movement update.
x
x:
number
y
y:
number
z
z:
number
ridingEntityRuntimeId
ridingEntityRuntimeId:
bigint
Defined in: protocol/src/packet/MovePlayerPacket.ts:38
The riding actor; has no meaning in a client-bound packet.
runtimeEntityId
runtimeEntityId:
bigint
Defined in: protocol/src/packet/MovePlayerPacket.ts:24
The player being moved, or the sending player for a server-bound packet.
teleportCause?
optionalteleportCause?:number
Defined in: protocol/src/packet/MovePlayerPacket.ts:40
The docs' Teleportation Cause. Present only when mode is PositionMode.Teleport.
teleportItemId?
optionalteleportItemId?:number
Defined in: protocol/src/packet/MovePlayerPacket.ts:45
The docs' Source Actor Type: the actor type that caused the teleport. The name is historical. Present only when mode is PositionMode.Teleport.
tick
tick:
bigint
Defined in: protocol/src/packet/MovePlayerPacket.ts:47
The client input tick this movement corresponds to.
yaw
yaw:
number
Defined in: protocol/src/packet/MovePlayerPacket.ts:30
Body yaw in degrees.
MovementEffect
Defined in: protocol/src/packet/MovementEffectPacket.ts:17
The fields of a MovementEffectPacket, in wire order.
Properties
effectDuration
effectDuration:
number
Defined in: protocol/src/packet/MovementEffectPacket.ts:23
Effect Duration in ticks.
effectType
effectType:
MovementEffectType
Defined in: protocol/src/packet/MovementEffectPacket.ts:21
Effect ID, which effect to apply.
targetRuntimeId
targetRuntimeId:
bigint
Defined in: protocol/src/packet/MovementEffectPacket.ts:19
Target Runtime ID of the actor the effect applies to.
tick
tick:
bigint
Defined in: protocol/src/packet/MovementEffectPacket.ts:29
Tick: the most recently processed PlayerInputTick from the target player's PlayerAuthInputPacket, or from the one controlling a client-predicted vehicle. Zero for other actors.
NetworkItemStackDescriptorConfig
Defined in: protocol/src/structure/NetworkItemStackDescriptor.ts:5
The optional parts of a stack descriptor.
Properties
netIdVariant?
optionalnetIdVariant?:number
Defined in: protocol/src/structure/NetworkItemStackDescriptor.ts:7
Net Id Variant, written only when includeNetid is true.
userDataBuffer?
optionaluserDataBuffer?:Buffer<ArrayBufferLike>
Defined in: protocol/src/structure/NetworkItemStackDescriptor.ts:9
User Data Buffer, a serialized ItemInstanceUserData. Defaults to an empty blob.
NetworkSettings
Defined in: protocol/src/packet/NetworkSettingsPacket.ts:18
The fields of a NetworkSettingsPacket, in wire order.
Properties
clientThrottleScalar
clientThrottleScalar:
number
Defined in: protocol/src/packet/NetworkSettingsPacket.ts:36
Client Throttle Scalar: how hard it throttles once it does.
clientThrottleThreshold
clientThrottleThreshold:
number
Defined in: protocol/src/packet/NetworkSettingsPacket.ts:34
Client Throttle Threshold: how many players the client ticks before throttling.
clientThrottlingEnabled
clientThrottlingEnabled:
boolean
Defined in: protocol/src/packet/NetworkSettingsPacket.ts:32
Client Throttle Enabled: whether the client stops ticking players past the threshold.
compressionAlgorithm
compressionAlgorithm:
PacketCompressionAlgorithm
Defined in: protocol/src/packet/NetworkSettingsPacket.ts:30
CompressionAlgorithm, numbered as the 1.26.51 docs list PacketCompressionAlgorithm: ZLib 0, Snappy 1, None 2. @jsprismarine/minecraft carries NONE as 65535, the value protocol 2207 moved it to. Two bytes wide here; each batch then repeats it in one, where none is 0xff.
compressionThreshold
compressionThreshold:
number
Defined in: protocol/src/packet/NetworkSettingsPacket.ts:23
Compression Threshold: the smallest payload, in bytes, that gets compressed. Zero disables compression outright and 1 compresses everything.
NpcDialogue
Defined in: protocol/src/packet/NpcDialoguePacket.ts:20
The fields of an NpcDialoguePacket, in wire order.
Properties
actionJson
actionJson:
string
Defined in: protocol/src/packet/NpcDialoguePacket.ts:35
Action JSON, the buttons the window offers. The server stays authoritative over which actions a button may run.
actionType
actionType:
NpcDialogueActionType
Defined in: protocol/src/packet/NpcDialoguePacket.ts:24
Npc Dialogue Action Type.
dialogue
dialogue:
string
Defined in: protocol/src/packet/NpcDialoguePacket.ts:26
Dialogue, the text shown to the player.
npcId
npcId:
bigint
Defined in: protocol/src/packet/NpcDialoguePacket.ts:22
Npc Id Raw Id, the ActorUniqueID of the NPC whose dialogue the server fires.
npcName
npcName:
string
Defined in: protocol/src/packet/NpcDialoguePacket.ts:30
Npc Name, the name shown above the dialogue.
sceneName
sceneName:
string
Defined in: protocol/src/packet/NpcDialoguePacket.ts:28
Scene Name, the scene the dialogue was pulled from, for the client to reference.
OpenSign
Defined in: protocol/src/packet/OpenSignPacket.ts:8
The fields of an OpenSignPacket, in wire order.
Properties
isFrontSide
isFrontSide:
boolean
Defined in: protocol/src/packet/OpenSignPacket.ts:12
Is Front Side: edit the front face of the sign rather than the back.
position
position:
BlockPos
Defined in: protocol/src/packet/OpenSignPacket.ts:10
Pos, the sign block the client should open the editor for.
PackIdVersion
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:32
A PackIdVersion: the Pack UUID as two little-endian uint64 halves, then the Pack Version string.
Properties
uuidLeastSignificant
uuidLeastSignificant:
bigint
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:36
Least Significant Bits of the uuid.
uuidMostSignificant
uuidMostSignificant:
bigint
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:34
Most Significant Bits of the uuid.
version
version:
string
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:38
The semantic version string, for example "1.2.3".
PacketDefinition
Defined in: protocol/src/wire/define.ts:45
A packet's declarative description: its wire name and its ordered field list.
Type Parameters
F
F extends Record<string, FieldSpec<unknown>> = Record<string, FieldSpec<unknown>>
Properties
fields
readonlyfields:Readonly<F>
Defined in: protocol/src/wire/define.ts:49
The ordered fields, in wire order.
name
readonlyname:string
Defined in: protocol/src/wire/define.ts:47
The packet's name in the id tables, e.g. AnimatePacket.
ParameterKeyframeValue
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:129
One entry of Parameter Keyframe Values: a time of day and the parameter's value then.
Properties
time
time:
number
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:131
The map key, a time of day as a little-endian float.
value
value:
GraphicsVec3
Defined in: protocol/src/packet/GraphicsOverrideParameterPacket.ts:136
The value at that time. A color parameter uses all three components; a float, int, or bool parameter uses x alone.
PartyChanged
Defined in: protocol/src/packet/PartyChangedPacket.ts:8
The fields of a PartyChangedPacket, in wire order.
Properties
partyInfo
partyInfo:
PlayerPartyInfo
Defined in: protocol/src/packet/PartyChangedPacket.ts:10
party_info, the party the client is now in and whether it leads it.
PartyDestinationCookieResponse
Defined in: protocol/src/packet/PartyDestinationCookieResponsePacket.ts:9
The fields of a PartyDestinationCookieResponsePacket, in wire order.
Properties
accepted
accepted:
boolean
Defined in: protocol/src/packet/PartyDestinationCookieResponsePacket.ts:13
accepted: the client took the party destination.
cookie
cookie:
string
Defined in: protocol/src/packet/PartyDestinationCookieResponsePacket.ts:11
cookie: the cookie from the SendPartyDestinationCookiePacket being answered, at most 2048 bytes.
PlaySoundPayload
Defined in: protocol/src/wire/definitions/added2225.ts:120
PlaySoundPacketPayload, carried whole inside the audio content packet.
The last two fields are absent from the schema's required list, so each travels behind a presence byte. Server Sound Handle is a wrapper whose one field is a uint64.
Properties
bypassListenerRangeCheck
bypassListenerRangeCheck:
boolean
Defined in: protocol/src/wire/definitions/added2225.ts:132
Bypass Listener Range Check.
loopCount
loopCount:
number
Defined in: protocol/src/wire/definitions/added2225.ts:130
Loop Count, an int32 with Compression.
name
name:
string
Defined in: protocol/src/wire/definitions/added2225.ts:122
Name.
pitch
pitch:
number
Defined in: protocol/src/wire/definitions/added2225.ts:128
Pitch.
playbackPositionSeconds
playbackPositionSeconds:
number|null
Defined in: protocol/src/wire/definitions/added2225.ts:136
Playback Position Seconds, or null when absent.
position
position:
Vec3Like
Defined in: protocol/src/wire/definitions/added2225.ts:124
Position.
serverSoundHandle
serverSoundHandle:
bigint|null
Defined in: protocol/src/wire/definitions/added2225.ts:134
Server Sound Handle, or null when absent.
volume
volume:
number
Defined in: protocol/src/wire/definitions/added2225.ts:126
Volume.
PlayStatusData
Defined in: protocol/src/packet/PlayStatusPacket.ts:26
The one field of PlayStatusPacket.
Properties
status
status:
PlayStatus
Defined in: protocol/src/packet/PlayStatusPacket.ts:28
The Status field, a PlayStatus value.
PlayerActionData
Defined in: protocol/src/packet/PlayerActionPacket.ts:66
The fields of a PlayerActionPacket, in wire order.
Properties
action
action:
PlayerActionType
Defined in: protocol/src/packet/PlayerActionPacket.ts:68
blockFace
blockFace:
number
Defined in: protocol/src/packet/PlayerActionPacket.ts:71
blockPosition
blockPosition:
BlockCoordinates
Defined in: protocol/src/packet/PlayerActionPacket.ts:69
resultPosition
resultPosition:
BlockCoordinates
Defined in: protocol/src/packet/PlayerActionPacket.ts:70
runtimeEntityId
runtimeEntityId:
bigint
Defined in: protocol/src/packet/PlayerActionPacket.ts:67
PlayerAuthInput
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:166
The fields carried by one client PlayerAuthInputPacket.
Properties
analogMoveVector
analogMoveVector:
InputVector2
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:202
Movement direction before input permissions were applied.
blockActions
blockActions:
PlayerBlockAction[] |null
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:196
Block actions, or null when the presence byte is zero.
cameraOrientation
cameraOrientation:
Vector3
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:204
World-space direction the camera is pointing.
delta
delta:
Vector3
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:190
The client's predicted velocity at the end of the tick.
headYaw
headYaw:
number
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:176
Player Head Rotation.
inputData
inputData:
Set<number>
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:178
Input flags set during this tick. Unknown values are kept for the server to reject.
inputMode
inputMode:
number
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:180
Input Mode.
interactionModel
interactionModel:
number
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:184
New Interaction Model.
interactRotation
interactRotation:
InputVector2
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:186
Where the player is looking for interactions, as pitch and yaw.
itemStackRequest
itemStackRequest:
ItemStackRequest|null
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:194
An inventory request, or null when the presence byte is zero.
itemUseTransaction
itemUseTransaction:
AuthInputItemUse|null
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:192
Item use in this tick, or null when the presence byte is zero.
moveVector
moveVector:
InputVector2
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:174
Desired direction of travel in the player's own frame.
pitch
pitch:
number
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:168
Player Rotation X, the pitch at the start of the tick.
playMode
playMode:
number
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:182
Play Mode.
position
position:
Vector3
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:172
The client's predicted position at the end of the tick.
predictedVehicle
predictedVehicle:
bigint|null
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:200
Predicted vehicle runtime id, or null when the presence byte is zero.
rawMoveVector
rawMoveVector:
InputVector2
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:206
Raw movement direction.
tick
tick:
bigint
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:188
Client simulation frame.
vehicleRotation
vehicleRotation:
InputVector2|null
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:198
Vehicle rotation, or null when the presence byte is zero.
yaw
yaw:
number
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:170
Player Rotation Y, the yaw at the start of the tick.
PlayerBlockAction
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:143
One PlayerBlockActionData: an action, the block position, and its face or action data.
Properties
action
action:
number
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:145
Player Action Type, using the same values as PlayerActionPacket.
face
face:
number
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:149
Facing, or action-specific integer data for AbortDestroyBlock.
position
position:
BlockPos
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:147
Position; StopDestroyBlock sends the default position rather than omitting it.
PlayerEnchantOptions
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:43
The options currently shown by the player's enchantment table.
Properties
options
options:
ItemEnchantOption[]
Defined in: protocol/src/packet/PlayerEnchantOptionsPacket.ts:45
The option list; empty clears the table.
PlayerListBody
Defined in: protocol/src/wire/definitions/playerList.ts:39
The Action and the entries it shapes, as one value.
Properties
entries
entries:
PlayerListEntry[]
Defined in: protocol/src/wire/definitions/playerList.ts:42
type
type:
number
Defined in: protocol/src/wire/definitions/playerList.ts:41
The Action byte: 0 adds a player, 1 removes one.
PlayerListData
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:12
The fields of one player list entry. A Remove entry needs only uuid.
Properties
buildPlatform?
optionalbuildPlatform?:number|null
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:19
color?
optionalcolor?:number
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:25
Player Color as an ARGB integer. Defaults to white.
isHost?
optionalisHost?:boolean
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:22
isSubClient?
optionalisSubClient?:boolean
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:23
isTeacher?
optionalisTeacher?:boolean
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:21
name?
optionalname?:string|null
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:16
platformChatId?
optionalplatformChatId?:string|null
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:18
runtimeId?
optionalruntimeId?:bigint|null
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:15
Written as the entry's Actor Unique ID. The server gives a player one id for both roles.
skin?
optionalskin?:Skin|null
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:20
uuid
uuid:
UUID
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:13
xuid?
optionalxuid?:string
Defined in: protocol/src/wire/structures/PlayerListEntry.ts:17
PlayerStartItemCooldown
Defined in: protocol/src/packet/PlayerStartItemCooldownPacket.ts:9
The fields of a PlayerStartItemCooldownPacket, in wire order.
Properties
durationTicks
durationTicks:
number
Defined in: protocol/src/packet/PlayerStartItemCooldownPacket.ts:16
Duration Ticks: how long the cooldown runs, in game ticks.
itemCategory
itemCategory:
string
Defined in: protocol/src/packet/PlayerStartItemCooldownPacket.ts:14
Item Category: the cooldown group the item belongs to, for example ender_pearl, chorus_fruit, shield or goat_horn. Every item in the group shares the cooldown.
PlayerUpdateEntityOverrides
Defined in: protocol/src/packet/PlayerUpdateEntityOverridesPacket.ts:46
The fields of a PlayerUpdateEntityOverridesPacket, in wire order.
Properties
propertyIndex
propertyIndex:
number
Defined in: protocol/src/packet/PlayerUpdateEntityOverridesPacket.ts:50
Property Index of the entity property the override applies to. Ignored by ClearOverrides.
targetId
targetId:
bigint
Defined in: protocol/src/packet/PlayerUpdateEntityOverridesPacket.ts:48
Target ID, the ActorUniqueID of the entity whose overrides change.
update
update:
EntityOverrideUpdate
Defined in: protocol/src/packet/PlayerUpdateEntityOverridesPacket.ts:52
Update, the one alternative this packet carries.
PotionMix
Defined in: protocol/src/packet/CraftingDataPacket.ts:70
A brewing stand recipe, which carries numeric item ids rather than names.
Six varint32 in wire order: the input's id and aux value, the reagent's, the output's. It is the one entry in this packet that names nothing, so a caller has to resolve the three items against the item registry first.
Properties
inputId
inputId:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:71
inputMeta
inputMeta:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:72
outputId
outputId:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:75
outputMeta
outputMeta:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:76
reagentId
reagentId:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:73
reagentMeta
reagentMeta:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:74
PrimitiveShapeDataFields
Defined in: protocol/src/structure/PrimitiveShapeData.ts:131
The fields of a PrimitiveShapeDataPayload, in wire order. Absent optionals leave the client's current value alone.
Properties
attachedToEntityId?
optionalattachedToEntityId?:bigint
Defined in: protocol/src/structure/PrimitiveShapeData.ts:151
Attached To Entity ID, the ActorUniqueID of the entity the shape follows.
color?
optionalcolor?:number
Defined in: protocol/src/structure/PrimitiveShapeData.ts:147
Color as ARGB packed 0xAARRGGBB in an unsigned 32-bit integer.
dimensionId?
optionaldimensionId?:Dimension
Defined in: protocol/src/structure/PrimitiveShapeData.ts:149
Dimension ID the shape renders in.
extraData
extraData:
PrimitiveShapeExtraData
Defined in: protocol/src/structure/PrimitiveShapeData.ts:153
Extra Shape Data for the shape's type.
location?
optionallocation?:Vec3
Defined in: protocol/src/structure/PrimitiveShapeData.ts:137
Location in the world.
maxRenderDistance?
optionalmaxRenderDistance?:number
Defined in: protocol/src/structure/PrimitiveShapeData.ts:145
Maximum Render Distance from the camera.
networkId
networkId:
bigint
Defined in: protocol/src/structure/PrimitiveShapeData.ts:133
NetworkId that pairs the shape on the server with the one on the client.
rotation?
optionalrotation?:Vec3
Defined in: protocol/src/structure/PrimitiveShapeData.ts:141
Rotation as Euler angles in radians, pitch then yaw then roll.
scale?
optionalscale?:number
Defined in: protocol/src/structure/PrimitiveShapeData.ts:139
Scale.
shapeType?
optionalshapeType?:PrimitiveShapeType
Defined in: protocol/src/structure/PrimitiveShapeData.ts:135
Shape Type. A shape sent without one is removed on the client.
totalTimeLeft?
optionaltotalTimeLeft?:number
Defined in: protocol/src/structure/PrimitiveShapeData.ts:143
Total Time Left in seconds until the client removes the shape; 0 keeps it.
PrimitiveShapes
Defined in: protocol/src/packet/PrimitiveShapesPacket.ts:8
The fields of a PrimitiveShapesPacket, in wire order.
Properties
shapes
shapes:
PrimitiveShapeData[]
Defined in: protocol/src/packet/PrimitiveShapesPacket.ts:10
Array of primitive shapes: new, updated and removed shapes, one PrimitiveShapeData each.
ProtocolBlockDefinition
Defined in: protocol/src/ProtocolContext.ts:24
A block definition that can be placed in StartGamePacket.Block Properties.
Properties
definition
readonlydefinition:Buffer
Defined in: protocol/src/ProtocolContext.ts:28
The complete network-NBT definition, including its root tag.
name
readonlyname:string
Defined in: protocol/src/ProtocolContext.ts:26
The namespaced block identifier.
ProtocolCodec
Defined in: protocol/src/ProtocolCodec.ts:11
One protocol version's view of the wire and its server-supplied data.
Properties
context
readonlycontext:ProtocolContext
Defined in: protocol/src/ProtocolCodec.ts:21
Versioned tables and captures supplied by the server to packet serializers.
ids
readonlyids:Readonly<Record<string,number>>
Defined in: protocol/src/ProtocolCodec.ts:17
Wire id by packet class name.
itemData
readonlyitemData:ProtocolItemData
Defined in: protocol/src/ProtocolCodec.ts:19
Item names and runtime ids supplied by the server for this wire version.
minecraftVersions
readonlyminecraftVersions: readonlystring[]
Defined in: protocol/src/ProtocolCodec.ts:15
Minecraft releases that speak this wire version, in ascending order.
protocolVersion
readonlyprotocolVersion:number
Defined in: protocol/src/ProtocolCodec.ts:13
The protocol version this codec speaks, as RequestNetworkSettingsPacket carries it.
Methods
createPacket()
createPacket(
netId,buffer?):NetworkPacket<unknown> |null
Defined in: protocol/src/ProtocolCodec.ts:29
Builds a packet instance for an inbound wire id.
Parameters
netId
number
The id read from the packet header.
buffer?
Buffer<ArrayBufferLike>
The encoded packet, when decoding inbound bytes.
Returns
NetworkPacket<unknown> | null
The packet, or null for an id with no packet implementation.
netIdOf()
netIdOf(
name):number|undefined
Defined in: protocol/src/ProtocolCodec.ts:43
Finds the wire id assigned to a packet class name.
Parameters
name
string
A packet class name such as 'LoginPacket'.
Returns
number | undefined
The id, or undefined when this version has no such packet.
prepareOutbound()
prepareOutbound(
packet):NetworkPacket<unknown>
Defined in: protocol/src/ProtocolCodec.ts:36
Stamps an outbound packet with the protocol version whose layout it must use.
Parameters
packet
NetworkPacket<unknown>
The packet as the caller built it.
Returns
NetworkPacket<unknown>
The same packet, now associated with this codec's wire version.
ProtocolCodecOptions
Defined in: protocol/src/ProtocolCodec.ts:47
Options needed to create a codec without giving Protocol ownership of the server's content data.
Properties
context
readonlycontext:ProtocolContext
Defined in: protocol/src/ProtocolCodec.ts:51
Captured item, block, and other tables supplied by the server.
definition
readonlydefinition:ProtocolVersionDefinition
Defined in: protocol/src/ProtocolCodec.ts:49
The version's packet ids and Minecraft release names.
ProtocolCodecRegistry
Defined in: protocol/src/ProtocolCodecRegistry.ts:16
A lookup table and derived version summaries for configured codecs.
Properties
codecs
readonlycodecs:ReadonlyMap<number,ProtocolCodec>
Defined in: protocol/src/ProtocolCodecRegistry.ts:18
Codecs keyed by protocol version.
latestCodec
readonlylatestCodec:ProtocolCodec
Defined in: protocol/src/ProtocolCodecRegistry.ts:20
The codec with the highest protocol version.
registeredCodecs
readonlyregisteredCodecs: readonlyProtocolCodec[]
Defined in: protocol/src/ProtocolCodecRegistry.ts:22
Codecs ordered newest protocol first.
supportedMinecraftVersions
readonlysupportedMinecraftVersions: readonlystring[]
Defined in: protocol/src/ProtocolCodecRegistry.ts:24
Minecraft versions supported by the registry, in ascending order.
Methods
codecForProtocol()
codecForProtocol(
protocolVersion):ProtocolCodec|undefined
Defined in: protocol/src/ProtocolCodecRegistry.ts:26
Finds a codec for a client's announced protocol version.
Parameters
protocolVersion
number
Returns
ProtocolCodec | undefined
ProtocolContext
Defined in: protocol/src/ProtocolContext.ts:38
Runtime data supplied by a game server to protocol serializers.
The protocol package owns how these values are encoded. A server owns where they come from and supplies captures or generated registries here, so protocol code does not import the server, its content packages, or bedrock-data.
Properties
biomeDefinitions?
readonlyoptionalbiomeDefinitions?:Buffer<ArrayBufferLike>
Defined in: protocol/src/ProtocolContext.ts:48
Complete payload for BiomeDefinitionListPacket.
blockDefinitions?
readonlyoptionalblockDefinitions?: readonlyProtocolBlockDefinition[]
Defined in: protocol/src/ProtocolContext.ts:44
Vanilla and server-defined blocks to declare during StartGame.
entityIdentifiers?
readonlyoptionalentityIdentifiers?:Buffer<ArrayBufferLike>
Defined in: protocol/src/ProtocolContext.ts:46
Network-NBT actor catalog sent in AvailableActorIdentifiersPacket.
itemData?
readonlyoptionalitemData?:ProtocolItemData
Defined in: protocol/src/ProtocolContext.ts:42
Versioned item ids and captured item component compounds.
jigsawStructureData?
readonlyoptionaljigsawStructureData?:Buffer<ArrayBufferLike>
Defined in: protocol/src/ProtocolContext.ts:50
Complete payload for JigsawStructureDataPacket.
protocolVersion
readonlyprotocolVersion:number
Defined in: protocol/src/ProtocolContext.ts:40
The protocol version negotiated for this connection.
ProtocolItemData
Defined in: protocol/src/ProtocolContext.ts:12
Item names, wire numbers, and captured component compounds for one protocol version.
Properties
components
readonlycomponents:Readonly<Record<string,Buffer>>
Defined in: protocol/src/ProtocolContext.ts:18
Item identifier to its network-NBT Item Component Data, already encoded.
protocolVersion
readonlyprotocolVersion:number
Defined in: protocol/src/ProtocolContext.ts:14
The protocol version this captured item data belongs to.
table
readonlytable:Readonly<Record<string,ProtocolItemTableEntry>>
Defined in: protocol/src/ProtocolContext.ts:16
Item identifier to the exact row sent for it in ItemRegistryPacket.
Methods
nameOf()
nameOf(
runtimeId):string|undefined
Defined in: protocol/src/ProtocolContext.ts:20
Finds the item name associated with a number read from the wire.
Parameters
runtimeId
number
Returns
string | undefined
ProtocolItemTableEntry
Defined in: protocol/src/ProtocolContext.ts:2
One row in the item table a negotiated Bedrock protocol uses.
Properties
component_based
readonlycomponent_based:boolean
Defined in: protocol/src/ProtocolContext.ts:6
Whether the item is defined by components rather than by the client's built-in table.
runtime_id
readonlyruntime_id:number
Defined in: protocol/src/ProtocolContext.ts:4
The number the client associates with this item name; negative for a block item.
version
readonlyversion:number
Defined in: protocol/src/ProtocolContext.ts:8
The ItemVersion value sent in ItemRegistryPacket.
ProtocolVersionDefinition
Defined in: protocol/src/ProtocolVersion.ts:13
Metadata shared by every codec for one Bedrock protocol version.
Properties
ids
readonlyids:Readonly<Record<string,number>>
Defined in: protocol/src/ProtocolVersion.ts:19
Packet class name to wire id for this version.
minecraftVersions
readonlyminecraftVersions: readonlystring[]
Defined in: protocol/src/ProtocolVersion.ts:17
Minecraft releases that use this wire version, in ascending order.
protocolVersion
readonlyprotocolVersion:number
Defined in: protocol/src/ProtocolVersion.ts:15
The number a client sends in RequestNetworkSettingsPacket.
PurchaseReceipt
Defined in: protocol/src/packet/PurchaseReceiptPacket.ts:7
The store purchase receipts the client reports to the server.
Properties
purchaseReceipts
purchaseReceipts:
string[]
Defined in: protocol/src/packet/PurchaseReceiptPacket.ts:9
One string receipt for each purchase the client reports.
RecipeIngredientData
Defined in: protocol/src/structure/RecipeIngredient.ts:39
One slot, in the plain form a payload carries it.
Properties
count
count:
number
Defined in: protocol/src/structure/RecipeIngredient.ts:43
The stack size, a varint32 in this form rather than the docs' StackSize uint16.
descriptor
descriptor:
IngredientDescriptor|null
Defined in: protocol/src/structure/RecipeIngredient.ts:41
Null for the empty slot of a shaped pattern, which still has to be written.
RecordStarted
Defined in: protocol/src/packet/RecordStartedPacket.ts:8
The fields of a RecordStartedPacket, in wire order.
Properties
position
position:
BlockPos
Defined in: protocol/src/packet/RecordStartedPacket.ts:10
Block Position: the jukebox the record plays from.
serverSoundHandle
serverSoundHandle:
bigint
Defined in: protocol/src/packet/RecordStartedPacket.ts:12
Server Sound Handle: the ServerSoundHandle a later ClientboundUpdateSoundDataPacket can change the sound by.
RedactableString
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:26
The unfiltered and optional filtered forms of a user-entered structure name.
Properties
redacted
redacted:
string|null
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:30
Filtered text, or null when the server has no filtered form.
unredacted
unredacted:
string
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:28
Text as the player entered it.
ReleaseItemData
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:275
The docs' ItemReleaseInventoryTransaction: a held item let go of, such as a bow firing.
Wire order is Action Type (varint), Slot (varint), Item, From Position (Vec3). Protocol 2225 appends the packet-level Hand after the position.
Extends
TransactionData<TItem>
Type Parameters
TItem
TItem = ItemStackDescriptorData
Properties
actionType
actionType:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:218
Inherited from
hotbarSlot
hotbarSlot:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:219
Inherited from
itemInHand
itemInHand:
TItem
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:220
Inherited from
kind
kind:
"releaseItem"
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:276
Overrides
playerPosition
playerPosition:
Vector3
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:278
The docs' From Position: where the player stood when sending this.
RemoveVolumeEntity
Defined in: protocol/src/packet/RemoveVolumeEntityPacket.ts:9
The fields of a RemoveVolumeEntityPacket, in wire order.
Properties
dimension
dimension:
number
Defined in: protocol/src/packet/RemoveVolumeEntityPacket.ts:13
Dimension Type the volume is in: 0 for the Overworld, 1 for the Nether, 2 for the End.
entityNetworkId
entityNetworkId:
number
Defined in: protocol/src/packet/RemoveVolumeEntityPacket.ts:11
Entity Network Id, the Raw Id an earlier AddVolumeEntityPacket gave the volume.
RequestChunkRadius
Defined in: protocol/src/packet/RequestChunkRadiusPacket.ts:9
The client's requested view distance and the largest distance it can accept.
Properties
maxRadius
maxRadius:
number
Defined in: protocol/src/packet/RequestChunkRadiusPacket.ts:16
The docs' Max ChunkRadius: the largest it is willing to accept, which the server may reduce it to. Zero means the client did not state one.
radius
radius:
number
Defined in: protocol/src/packet/RequestChunkRadiusPacket.ts:11
The docs' Chunk Radius: how far the client would like to see, in chunks.
RequestNetworkSettings
Defined in: protocol/src/packet/RequestNetworkSettingsPacket.ts:9
The one field of RequestNetworkSettingsPacket.
Properties
protocolVersion
protocolVersion:
number
Defined in: protocol/src/packet/RequestNetworkSettingsPacket.ts:11
ClientNetworkVersion: the protocol version the client speaks.
ResourcePackEntry
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:7
One PackInfoData entry of the Resource Packs list.
Properties
cdnUrl
cdnUrl:
string
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:25
CDN URL the client may download the pack from. Empty when the server serves the chunks.
contentIdentity
contentIdentity:
string
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:17
Content Identity, the marketplace identity string.
contentKey
contentKey:
string
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:13
Content Key, the decryption key for an encrypted pack. Empty for an unencrypted one.
hasScripts
hasScripts:
boolean
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:19
Has Scripts.
id
id:
PackIdVersion
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:9
Pack Id Version.
isAddonPack
isAddonPack:
boolean
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:21
Is Addon Pack.
isRayTracingCapable
isRayTracingCapable:
boolean
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:23
Is Ray Tracing Capable.
sizeBytes
sizeBytes:
bigint
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:11
Pack Size in bytes.
subPackName
subPackName:
string
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:15
Subpack Name. Empty when no subpack is selected.
ResourcePackResponse
Defined in: protocol/src/packet/ResourcePackClientResponsePacket.ts:49
The decoded Response: a status and, for SendPacks only, the packs the client is downloading.
Properties
packIds
packIds:
string[]
Defined in: protocol/src/packet/ResourcePackClientResponsePacket.ts:52
Downloading Packs. Empty for every status other than SendPacks.
status
status:
ResourcePackStatus
Defined in: protocol/src/packet/ResourcePackClientResponsePacket.ts:50
ResourcePackResponseData
Defined in: protocol/src/wire/definitions/resourcePacks.ts:191
The decoded Response: a status and, for SendPacks only, the packs being downloaded.
Properties
packIds
packIds:
string[]
Defined in: protocol/src/wire/definitions/resourcePacks.ts:195
Downloading Packs. Empty for every status other than SendPacks.
status
status:
number
Defined in: protocol/src/wire/definitions/resourcePacks.ts:193
The alternative index plus one, as ResourcePackStatus numbers it.
ResourcePackStack
Defined in: protocol/src/packet/ResourcePackStackPacket.ts:20
The fields of ResourcePackStackPacket, in wire order.
Properties
experiments
experiments:
Experiment[]
Defined in: protocol/src/packet/ResourcePackStackPacket.ts:28
Experiments toggles: active toggles followed by always-on ones.
experimentsAlreadyEnabled
experimentsAlreadyEnabled:
boolean
Defined in: protocol/src/packet/ResourcePackStackPacket.ts:30
ExperimentsEverToggled, whether any experiment was ever toggled in this world.
gameVersion
gameVersion:
string
Defined in: protocol/src/packet/ResourcePackStackPacket.ts:26
Base Game Version, the game version the stack applies to. Vanilla sends *.
includeEditorPacks
includeEditorPacks:
boolean
Defined in: protocol/src/packet/ResourcePackStackPacket.ts:32
Include Editor Packs, whether an Editor world adds the vanilla editor packs to the stack.
texturePackRequired
texturePackRequired:
boolean
Defined in: protocol/src/packet/ResourcePackStackPacket.ts:22
Texture Pack Required. When true the client must download the packs or leave.
texturePacks
texturePacks:
ResourcePackStackEntry[]
Defined in: protocol/src/packet/ResourcePackStackPacket.ts:24
Texture Pack List, applied in order with the first entry on top.
ResourcePackStackEntry
Defined in: protocol/src/packet/ResourcePackStackPacket.ts:10
One entry of the Texture Pack List, as the docs' PackInstanceId.
Properties
subPackName
subPackName:
string
Defined in: protocol/src/packet/ResourcePackStackPacket.ts:16
Sub Pack Name, empty when the pack has no sub pack selected.
uuid
uuid:
string
Defined in: protocol/src/packet/ResourcePackStackPacket.ts:12
Pack ID, the pack's UUID.
version
version:
string
Defined in: protocol/src/packet/ResourcePackStackPacket.ts:14
Version, the pack's SemVer version.
ResourcePacksInfo
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:42
The fields of a ResourcePacksInfoPacket, in wire order.
Properties
forceDisableVibrantVisuals
forceDisableVibrantVisuals:
boolean
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:50
Force Disable Vibrant Visuals: turns deferred rendering off for the session, whatever the client would prefer.
hasAddonPacks
hasAddonPacks:
boolean
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:46
Has Addon Packs: at least one pack is an add-on pack.
hasScripts
hasScripts:
boolean
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:48
Has Scripts: at least one pack carries client scripts.
packs
packs:
ResourcePackEntry[]
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:54
Resource Packs, one entry per pack the client needs.
resourcePackRequired
resourcePackRequired:
boolean
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:44
Resource Pack Required: the client must apply the server's packs to join.
worldTemplate
worldTemplate:
PackIdVersion
Defined in: protocol/src/packet/ResourcePacksInfoPacket.ts:52
World Template Id And Version. All zeroes and an empty version when the world came from no template.
ScoreboardIdentityPacketInfo
Defined in: protocol/src/wire/definitions/scoreboard.ts:184
One scoreboard entry and the player it stands for.
Properties
playerUniqueId?
optionalplayerUniqueId?:bigint
Defined in: protocol/src/wire/definitions/scoreboard.ts:189
Player Unique Id: present on Update, absent on Remove.
scoreboardId
scoreboardId:
bigint
Defined in: protocol/src/wire/definitions/scoreboard.ts:186
Scoreboard Id: the same id SetScorePacket files scores under.
ScriptMessage
Defined in: protocol/src/packet/ScriptMessagePacket.ts:9
The fields of a ScriptMessagePacket, in wire order.
Properties
messageId
messageId:
string
Defined in: protocol/src/packet/ScriptMessagePacket.ts:11
Message Id: the event name a script listens for, by convention namespace:name.
messageValue
messageValue:
string
Defined in: protocol/src/packet/ScriptMessagePacket.ts:13
Message Value: the payload, an arbitrary string the scripts on both ends agree on.
SendPartyDestinationCookie
Defined in: protocol/src/packet/SendPartyDestinationCookiePacket.ts:23
The fields of a SendPartyDestinationCookiePacket, in wire order.
Properties
cookie
cookie:
string
Defined in: protocol/src/packet/SendPartyDestinationCookiePacket.ts:25
cookie: the opaque party destination cookie, at most 2048 bytes.
destinationName
destinationName:
string
Defined in: protocol/src/packet/SendPartyDestinationCookiePacket.ts:29
destination_name: the destination the cookie refers to, at most 64 bytes.
intent
intent:
PartyDestinationCookieIntent
Defined in: protocol/src/packet/SendPartyDestinationCookiePacket.ts:27
intent.
SerializableCells
Defined in: protocol/src/structure/SerializableVoxelShape.ts:9
The VoxelShapes::SerializableCells of a shape: a grid of X Size by Y Size by Z Size cells and a flag per cell saying whether it is solid.
Properties
storage
storage:
number[]
Defined in: protocol/src/structure/SerializableVoxelShape.ts:20
Storage: the solid flags of all xSize * ySize * zSize cells, packed one bit per cell into bytes, as the bytes appear on the wire. Empty for a grid with no cells.
xSize
xSize:
number
Defined in: protocol/src/structure/SerializableVoxelShape.ts:11
X Size, the number of cells along X, 0 to 127.
ySize
ySize:
number
Defined in: protocol/src/structure/SerializableVoxelShape.ts:13
Y Size, the number of cells along Y, 0 to 127.
zSize
zSize:
number
Defined in: protocol/src/structure/SerializableVoxelShape.ts:15
Z Size, the number of cells along Z, 0 to 127.
ServerJoinInformation
Defined in: protocol/src/packet/StartGamePacket.ts:75
Optional store, gathering, and rich-presence details attached to a join.
Properties
gathering?
optionalgathering?:GatheringJoinInfo
Defined in: protocol/src/packet/StartGamePacket.ts:76
presence?
optionalpresence?:object
Defined in: protocol/src/packet/StartGamePacket.ts:78
richPresenceId?
optionalrichPresenceId?:string
storeEntryPoint?
optionalstoreEntryPoint?:object
Defined in: protocol/src/packet/StartGamePacket.ts:77
storeId
storeId:
string
storeName
storeName:
string
ServerPlayerPostMovePosition
Defined in: protocol/src/packet/ServerPlayerPostMovePositionPacket.ts:8
The position the server simulated for its player at the end of movement.
Properties
pos
pos:
Vec3
Defined in: protocol/src/packet/ServerPlayerPostMovePositionPacket.ts:10
Pos, encoded as three little-endian floats.
ServerPresenceInfo
Defined in: protocol/src/packet/ServerPresenceInfoPacket.ts:8
The fields of a ServerPresenceInfoPacket, in wire order.
Properties
presenceConfiguration
presenceConfiguration:
PresenceConfig
Defined in: protocol/src/packet/ServerPresenceInfoPacket.ts:10
presence_configuration, the rich presence the client should show.
ServerStats
Defined in: protocol/src/packet/ServerStatsPacket.ts:9
The fields of a ServerStatsPacket, in wire order.
Properties
networkTime
networkTime:
number
Defined in: protocol/src/packet/ServerStatsPacket.ts:13
NetworkTime, how long the server spent on networking in its last tick.
serverTime
serverTime:
number
Defined in: protocol/src/packet/ServerStatsPacket.ts:11
ServerTime, how long the server spent on its last tick.
ServerStoreInfo
Defined in: protocol/src/packet/ServerStoreInfoPacket.ts:8
The fields of a ServerStoreInfoPacket, in wire order.
Properties
clientStoreEntryPointConfiguration
clientStoreEntryPointConfiguration:
ClientStoreEntryPointConfig
Defined in: protocol/src/packet/ServerStoreInfoPacket.ts:10
client_store_entry_point_configuration, the store the client's marketplace entry point opens.
ServerToClientHandshake
Defined in: protocol/src/packet/ServerToClientHandshakePacket.ts:10
The server-signed JWT that gives the client the server key and ECDH salt.
Properties
jwt
jwt:
string
Defined in: protocol/src/packet/ServerToClientHandshakePacket.ts:15
Handshake WebToken, a JWT signed with the server's ECDSA P-384 key. Its header carries x5u, the server's public key as base64 DER, and its payload carries salt, base64.
ServerboundDataDrivenScreenClosed
Defined in: protocol/src/packet/ServerboundDataDrivenScreenClosedPacket.ts:30
The fields of a ServerboundDataDrivenScreenClosedPacket, in wire order.
Properties
closeReason
closeReason:
DataDrivenScreenClosedReason
Defined in: protocol/src/packet/ServerboundDataDrivenScreenClosedPacket.ts:34
CloseReason: why the screen went away.
formId
formId:
number
Defined in: protocol/src/packet/ServerboundDataDrivenScreenClosedPacket.ts:32
FormId of the screen that closed, as ClientboundDataDrivenUIShowScreenPacket assigned it.
ServerboundDataStore
Defined in: protocol/src/packet/ServerboundDataStorePacket.ts:8
The fields of a ServerboundDataStorePacket, in wire order.
Properties
update
update:
DataStoreUpdate
Defined in: protocol/src/packet/ServerboundDataStorePacket.ts:10
Update, the single data store update the client applies to the server's store.
ServerboundLoadingScreen
Defined in: protocol/src/packet/ServerboundLoadingScreenPacket.ts:16
The screen edge and optional id sent by the client.
Properties
loadingScreenId
loadingScreenId:
number|null
Defined in: protocol/src/packet/ServerboundLoadingScreenPacket.ts:20
The id the server gave this screen, absent for the initial join screen.
loadingScreenType
loadingScreenType:
ServerboundLoadingScreenPacketType
Defined in: protocol/src/packet/ServerboundLoadingScreenPacket.ts:18
Whether the client started or ended a loading screen.
ServerboundPackSettingChange
Defined in: protocol/src/packet/ServerboundPackSettingChangePacket.ts:19
Data sent when the player changes a setting in a resource pack.
Properties
packId
packId:
UUID
Defined in: protocol/src/packet/ServerboundPackSettingChangePacket.ts:21
UUID of the pack whose setting changed.
packSettingName
packSettingName:
string
Defined in: protocol/src/packet/ServerboundPackSettingChangePacket.ts:23
Name of the setting in the pack's settings screen.
packSettingValue
packSettingValue:
PackSettingValue
Defined in: protocol/src/packet/ServerboundPackSettingChangePacket.ts:25
New value, whose JavaScript type selects the wire alternative.
SetHud
Defined in: protocol/src/packet/SetHudPacket.ts:30
The fields of a SetHudPacket, in wire order.
Properties
elements
elements:
HudElement[]
Defined in: protocol/src/packet/SetHudPacket.ts:32
Hud Element: the elements the change applies to.
visibility
visibility:
HudVisibility
Defined in: protocol/src/packet/SetHudPacket.ts:34
Hud Visible: hide the elements, or reset them to what the player configured.
SetLocalPlayerAsInitialized
Defined in: protocol/src/packet/SetLocalPlayerAsInitializedPacket.ts:9
Identifies the local player whose world initialization is complete.
Properties
runtimeEntityId
runtimeEntityId:
bigint
Defined in: protocol/src/packet/SetLocalPlayerAsInitializedPacket.ts:11
Player ID: the runtime id the server gave the player in StartGame.
SetPlayerFurnaceOptions
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:42
The fields of a SetPlayerFurnaceOptionsPacket, in wire order.
Properties
furnaceType
furnaceType:
FurnaceType
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:44
FurnaceType.
options
options:
FurnaceOptions
Defined in: protocol/src/packet/SetPlayerFurnaceOptionsPacket.ts:46
Furnace Options.
SettingsCommand
Defined in: protocol/src/packet/SettingsCommandPacket.ts:9
The command and output preference sent when a player changes a world setting.
Properties
command
command:
string
Defined in: protocol/src/packet/SettingsCommandPacket.ts:11
Full command line the server should run, including its leading slash.
suppressOutput
suppressOutput:
boolean
Defined in: protocol/src/packet/SettingsCommandPacket.ts:13
Whether the client asks the server to suppress command output.
ShapedRecipe
Defined in: protocol/src/packet/CraftingDataPacket.ts:36
A shaped crafting recipe.
Extends
RecipeBase
Properties
height
height:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:38
id
id:
string
Defined in: protocol/src/packet/CraftingDataPacket.ts:28
The recipe's identifier, which the client keys its book on.
Inherited from
RecipeBase.id
netId
netId:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:30
The id this recipe is known by for the rest of the session. Zero is "no recipe".
Inherited from
RecipeBase.netId
outputs
outputs: readonly
ItemStackData[]
Defined in: protocol/src/packet/CraftingDataPacket.ts:41
pattern
pattern: readonly
RecipeIngredientData[]
Defined in: protocol/src/packet/CraftingDataPacket.ts:40
width * height slots in row-major order, holes included as empty slots.
priority
priority:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:43
Which of two matching recipes wins.
station
station:
string
Defined in: protocol/src/packet/CraftingDataPacket.ts:32
The Bedrock block tag of the station, such as crafting_table.
Inherited from
RecipeBase.station
symmetric
symmetric:
boolean
Defined in: protocol/src/packet/CraftingDataPacket.ts:45
Whether the client may match the pattern mirrored.
width
width:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:37
ShapelessRecipe
Defined in: protocol/src/packet/CraftingDataPacket.ts:49
A shapeless crafting recipe, which is also how a stonecutter recipe travels.
Extends
RecipeBase
Properties
id
id:
string
Defined in: protocol/src/packet/CraftingDataPacket.ts:28
The recipe's identifier, which the client keys its book on.
Inherited from
RecipeBase.id
ingredients
ingredients: readonly
RecipeIngredientData[]
Defined in: protocol/src/packet/CraftingDataPacket.ts:50
netId
netId:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:30
The id this recipe is known by for the rest of the session. Zero is "no recipe".
Inherited from
RecipeBase.netId
outputs
outputs: readonly
ItemStackData[]
Defined in: protocol/src/packet/CraftingDataPacket.ts:51
priority
priority:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:52
station
station:
string
Defined in: protocol/src/packet/CraftingDataPacket.ts:32
The Bedrock block tag of the station, such as crafting_table.
Inherited from
RecipeBase.station
SignedAudioContent
Defined in: protocol/src/wire/definitions/added2225.ts:54
SignedAudioContent: one compact JWT describing a piece of audio content.
Properties
compactJwt
compactJwt:
string
Defined in: protocol/src/wire/definitions/added2225.ts:56
Compact JWT.
SimulationTypeData
Defined in: protocol/src/packet/SimulationTypePacket.ts:24
The one field of SimulationTypePacket.
Properties
simType
simType:
SimulationType
Defined in: protocol/src/packet/SimulationTypePacket.ts:26
Sim Type, the simulation the client should switch to.
SmithingTransformRecipe
Defined in: protocol/src/packet/CraftingDataPacket.ts:56
A smithing table recipe that produces a new item.
Extends
RecipeBase
Properties
addition
addition:
RecipeIngredientData
Defined in: protocol/src/packet/CraftingDataPacket.ts:59
base
base:
RecipeIngredientData
Defined in: protocol/src/packet/CraftingDataPacket.ts:58
id
id:
string
Defined in: protocol/src/packet/CraftingDataPacket.ts:28
The recipe's identifier, which the client keys its book on.
Inherited from
RecipeBase.id
netId
netId:
number
Defined in: protocol/src/packet/CraftingDataPacket.ts:30
The id this recipe is known by for the rest of the session. Zero is "no recipe".
Inherited from
RecipeBase.netId
output
output:
ItemStackData
Defined in: protocol/src/packet/CraftingDataPacket.ts:60
station
station:
string
Defined in: protocol/src/packet/CraftingDataPacket.ts:32
The Bedrock block tag of the station, such as crafting_table.
Inherited from
RecipeBase.station
template
template:
RecipeIngredientData
Defined in: protocol/src/packet/CraftingDataPacket.ts:57
SoundDataFade
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:41
Fade: move the volume to a target over a duration.
Properties
duration
duration:
number
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:44
Duration of the fade in seconds.
targetVolume
targetVolume:
number
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:46
Target Volume the fade ends at.
type
type:
Fade
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:42
SoundDataSeekTo
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:50
SeekTo: jump to a playback position.
Properties
seconds
seconds:
number
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:53
Seconds from the start of the sound.
type
type:
SeekTo
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:51
SoundDataSetPitch
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:34
Changes the playback pitch of the sound identified by its server handle.
Properties
pitch
pitch:
number
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:37
Pitch.
type
type:
SetPitch
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:35
SoundDataSetVolume
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:27
Changes the playback volume of the sound identified by its server handle.
Properties
type
type:
SetVolume
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:28
volume
volume:
number
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:30
Volume.
SoundDataSignal
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:22
Stop, Pause or Resume: an update with no fields after the alternative index.
Properties
type
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:23
SpawnExperienceOrb
Defined in: protocol/src/packet/SpawnExperienceOrbPacket.ts:8
Data needed to spawn an experience orb actor.
Properties
position
position:
Vec3
Defined in: protocol/src/packet/SpawnExperienceOrbPacket.ts:10
World position where the client should display the orb.
xpValue
xpValue:
number
Defined in: protocol/src/packet/SpawnExperienceOrbPacket.ts:12
Experience points carried by the orb.
SplineDefinition
Defined in: protocol/src/wire/definitions/cameraSpline.ts:36
One CameraSplineDefinition: a named camera path /camera plays back by name.
Properties
controlPoints
controlPoints:
Vec3Like[]
Defined in: protocol/src/wire/definitions/cameraSpline.ts:44
control_points, the positions the path passes through, in order.
name
name:
string
Defined in: protocol/src/wire/definitions/cameraSpline.ts:38
name, "namespace:name".
progressKeyFrames
progressKeyFrames:
SplineProgressKeyFrame[]
Defined in: protocol/src/wire/definitions/cameraSpline.ts:46
progress_key_frames, when the camera reaches each point of the path.
rotationKeyFrames
rotationKeyFrames:
SplineRotationKeyFrame[]
Defined in: protocol/src/wire/definitions/cameraSpline.ts:48
rotation_key_frames, the camera rotation over time.
splineType
splineType:
string|null
Defined in: protocol/src/wire/definitions/cameraSpline.ts:42
spline_type, or null for the Catmull-Rom default.
totalTime
totalTime:
number
Defined in: protocol/src/wire/definitions/cameraSpline.ts:40
total_time, the playback length in seconds.
SplineDefinitionProgressKeyFrame
Defined in: protocol/src/structure/CameraSplineDefinition.ts:15
One CameraSplineProgressKeyFrame of a definition: how far along the spline the camera is at a given time.
Properties
easing?
optionaleasing?:"linear"|"spring"|"in_quad"|"out_quad"|"in_out_quad"|"in_cubic"|"out_cubic"|"in_out_cubic"|"in_quart"|"out_quart"|"in_out_quart"|"in_quint"|"out_quint"|"in_out_quint"|"in_sine"|"out_sine"|"in_out_sine"|"in_expo"|"out_expo"|"in_out_expo"|"in_circ"|"out_circ"|"in_out_circ"|"in_bounce"|"out_bounce"|"in_out_bounce"|"in_back"|"out_back"|"in_out_back"|"in_elastic"|"out_elastic"|"in_out_elastic"
Defined in: protocol/src/structure/CameraSplineDefinition.ts:21
easing towards this frame, an easing_function name. Linear when omitted.
progress
progress:
number
Defined in: protocol/src/structure/CameraSplineDefinition.ts:17
progress along the spline, 0 at the start and 1 at the end.
time
time:
number
Defined in: protocol/src/structure/CameraSplineDefinition.ts:19
time in seconds at which the camera reaches progress.
SplineDefinitionRotationKeyFrame
Defined in: protocol/src/structure/CameraSplineDefinition.ts:25
One CameraSplineRotationKeyFrame of a definition: the camera rotation at a given time.
Properties
easing?
optionaleasing?:"linear"|"spring"|"in_quad"|"out_quad"|"in_out_quad"|"in_cubic"|"out_cubic"|"in_out_cubic"|"in_quart"|"out_quart"|"in_out_quart"|"in_quint"|"out_quint"|"in_out_quint"|"in_sine"|"out_sine"|"in_out_sine"|"in_expo"|"out_expo"|"in_out_expo"|"in_circ"|"out_circ"|"in_out_circ"|"in_bounce"|"out_bounce"|"in_out_bounce"|"in_back"|"out_back"|"in_out_back"|"in_elastic"|"out_elastic"|"in_out_elastic"
Defined in: protocol/src/structure/CameraSplineDefinition.ts:31
easing towards this frame, an easing_function name. Linear when omitted.
rotation
rotation:
Vec3
Defined in: protocol/src/structure/CameraSplineDefinition.ts:27
rotation as x, y and z angles.
time
time:
number
Defined in: protocol/src/structure/CameraSplineDefinition.ts:29
time in seconds at which the camera reaches rotation.
SplineProgressKeyFrame
Defined in: protocol/src/wire/definitions/cameraSpline.ts:16
One CameraSplineProgressKeyFrame: how far along the spline the camera is at a given time.
Properties
easing
easing:
string|null
Defined in: protocol/src/wire/definitions/cameraSpline.ts:22
easing towards this frame, or null when linear.
progress
progress:
number
Defined in: protocol/src/wire/definitions/cameraSpline.ts:18
progress along the spline, 0 at the start and 1 at the end.
time
time:
number
Defined in: protocol/src/wire/definitions/cameraSpline.ts:20
time in seconds at which the camera reaches progress.
SplineRotationKeyFrame
Defined in: protocol/src/wire/definitions/cameraSpline.ts:26
One CameraSplineRotationKeyFrame: the camera rotation at a given time.
Properties
easing
easing:
string|null
Defined in: protocol/src/wire/definitions/cameraSpline.ts:32
easing towards this frame, or null when linear.
rotation
rotation:
Vec3Like
Defined in: protocol/src/wire/definitions/cameraSpline.ts:28
rotation as x, y and z angles.
time
time:
number
Defined in: protocol/src/wire/definitions/cameraSpline.ts:30
time in seconds at which the camera reaches rotation.
StartGame
Defined in: protocol/src/packet/StartGamePacket.ts:86
The initial player identity, world settings, content definitions, and join metadata sent when the client enters a world. StartGamePacket gets block definitions from its ProtocolContext when this payload omits blockProperties.
Properties
achievementsDisabled
achievementsDisabled:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:106
allowAnonymousBlockDropsInEditorWorlds
allowAnonymousBlockDropsInEditorWorlds:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:157
baseGameVersion
baseGameVersion:
string
Defined in: protocol/src/packet/StartGamePacket.ts:147
blockNetworkIdsAreHashes
blockNetworkIdsAreHashes:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:181
blockProperties?
optionalblockProperties?:BlockProperty[]
Defined in: protocol/src/packet/StartGamePacket.ts:172
Definitions to write in Block Properties. Omit to use the connection's ProtocolContext.blockDefinitions; an empty list sends no definitions.
blockRegistryChecksum
blockRegistryChecksum:
bigint
Defined in: protocol/src/packet/StartGamePacket.ts:178
bonusChestEnabled
bonusChestEnabled:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:133
chatRestrictionLevel
chatRestrictionLevel:
number
Defined in: protocol/src/packet/StartGamePacket.ts:154
clientSideGeneration
clientSideGeneration:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:180
commandsEnabled
commandsEnabled:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:128
confirmedPlatformLockedContent
confirmedPlatformLockedContent:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:123
createdInEditor
createdInEditor:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:108
currentTick
currentTick:
bigint
Defined in: protocol/src/packet/StartGamePacket.ts:166
customSkinsDisabled
customSkinsDisabled:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:145
dayCycleStopTime
dayCycleStopTime:
number
Defined in: protocol/src/packet/StartGamePacket.ts:117
difficulty
difficulty:
number
Defined in: protocol/src/packet/StartGamePacket.ts:104
dimension
dimension:
number
Defined in: protocol/src/packet/StartGamePacket.ts:100
disablePlayerInteractions
disablePlayerInteractions:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:155
editorLevelMigrationVersion?
optionaleditorLevelMigrationVersion?:number
Defined in: protocol/src/packet/StartGamePacket.ts:116
Which editor level migrations the world has had applied, an int8.
Added to the level settings at protocol 2225 and absent from the 2193 wire, so this is undefined on a 2193 packet and set on a 2225 one.
editorWorldType
editorWorldType:
number
Defined in: protocol/src/packet/StartGamePacket.ts:107
educationEditionOffer
educationEditionOffer:
number
Defined in: protocol/src/packet/StartGamePacket.ts:118
educationFeaturesEnabled
educationFeaturesEnabled:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:119
educationProductId
educationProductId:
string
Defined in: protocol/src/packet/StartGamePacket.ts:120
eduSharedUriResource
eduSharedUriResource:
object
Defined in: protocol/src/packet/StartGamePacket.ts:151
buttonName
buttonName:
string
linkUri
linkUri:
string
emoteChatMuted
emoteChatMuted:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:146
enableItemStackNetManager
enableItemStackNetManager:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:174
enchantmentSeed
enchantmentSeed:
number
Defined in: protocol/src/packet/StartGamePacket.ts:167
entityId
entityId:
bigint
Defined in: protocol/src/packet/StartGamePacket.ts:88
The player's own entity id, signed and stable for the session.
experiments
experiments:
ExperimentToggle[]
Defined in: protocol/src/packet/StartGamePacket.ts:131
experimentsEverToggled
experimentsEverToggled:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:132
exportedFromEditor
exportedFromEditor:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:109
forceExperimentalGameplay?
optionalforceExperimentalGameplay?:boolean
Defined in: protocol/src/packet/StartGamePacket.ts:153
Optional on the wire: absent means the world's own setting stands.
gamemode
gamemode:
number
Defined in: protocol/src/packet/StartGamePacket.ts:91
gameRules
gameRules:
GameRule[]
Defined in: protocol/src/packet/StartGamePacket.ts:130
generator
generator:
number
Defined in: protocol/src/packet/StartGamePacket.ts:101
hardcore
hardcore:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:103
hasLockedBehaviorPack
hasLockedBehaviorPack:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:137
hasLockedResourcePack
hasLockedResourcePack:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:138
isFromLockedTemplate
isFromLockedTemplate:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:139
isFromWorldTemplate
isFromWorldTemplate:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:141
isTrial
isTrial:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:162
isWorldTemplateOptionLocked
isWorldTemplateOptionLocked:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:142
lanBroadcast
lanBroadcast:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:125
levelId
levelId:
string
Defined in: protocol/src/packet/StartGamePacket.ts:159
levelName
levelName:
string
Defined in: protocol/src/packet/StartGamePacket.ts:160
lightningLevel
lightningLevel:
number
Defined in: protocol/src/packet/StartGamePacket.ts:122
limitedWorldDepth
limitedWorldDepth:
number
Defined in: protocol/src/packet/StartGamePacket.ts:149
limitedWorldWidth
limitedWorldWidth:
number
Defined in: protocol/src/packet/StartGamePacket.ts:148
multiplayerCorrelationId
multiplayerCorrelationId:
string
Defined in: protocol/src/packet/StartGamePacket.ts:173
multiplayerGame
multiplayerGame:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:124
newNether
newNether:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:150
onlySpawnV1Villagers
onlySpawnV1Villagers:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:143
ownerId
ownerId:
string
Defined in: protocol/src/packet/StartGamePacket.ts:188
personaDisabled
personaDisabled:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:144
pitch
pitch:
number
Defined in: protocol/src/packet/StartGamePacket.ts:93
platformBroadcastSetting
platformBroadcastSetting:
number
Defined in: protocol/src/packet/StartGamePacket.ts:127
playerPermissions
playerPermissions:
number
Defined in: protocol/src/packet/StartGamePacket.ts:135
playerPropertyData
playerPropertyData:
Buffer
Defined in: protocol/src/packet/StartGamePacket.ts:177
Network NBT, handed on as bytes for the same reason a block definition is.
position
position:
Vec3Like
Defined in: protocol/src/packet/StartGamePacket.ts:92
rainLevel
rainLevel:
number
Defined in: protocol/src/packet/StartGamePacket.ts:121
rewindHistorySize
rewindHistorySize:
number
Defined in: protocol/src/packet/StartGamePacket.ts:164
How many ticks of input the client keeps for the server to rewind to.
runtimeEntityId
runtimeEntityId:
bigint
Defined in: protocol/src/packet/StartGamePacket.ts:90
The id everything on the wire refers to this player by.
scenarioId
scenarioId:
string
Defined in: protocol/src/packet/StartGamePacket.ts:186
seed
seed:
bigint
Defined in: protocol/src/packet/StartGamePacket.ts:97
serverAuthoritativeBlockBreaking
serverAuthoritativeBlockBreaking:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:165
serverAuthoritativeSound
serverAuthoritativeSound:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:182
serverChunkTickRange
serverChunkTickRange:
number
Defined in: protocol/src/packet/StartGamePacket.ts:136
serverEditorConnectionPolicy
serverEditorConnectionPolicy:
number
Defined in: protocol/src/packet/StartGamePacket.ts:156
serverId
serverId:
string
Defined in: protocol/src/packet/StartGamePacket.ts:185
serverJoinInformation?
optionalserverJoinInformation?:ServerJoinInformation
Defined in: protocol/src/packet/StartGamePacket.ts:184
Optional on the wire; undefined writes the single byte saying there is none.
serverVersion
serverVersion:
string
Defined in: protocol/src/packet/StartGamePacket.ts:175
spawnBiomeType
spawnBiomeType:
number
Defined in: protocol/src/packet/StartGamePacket.ts:98
spawnPosition
spawnPosition:
Vec3Like
Defined in: protocol/src/packet/StartGamePacket.ts:105
startWithMapEnabled
startWithMapEnabled:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:134
templateContentIdentity
templateContentIdentity:
string
Defined in: protocol/src/packet/StartGamePacket.ts:161
texturePacksRequired
texturePacksRequired:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:129
useMsaGamertagsOnly
useMsaGamertagsOnly:
boolean
Defined in: protocol/src/packet/StartGamePacket.ts:140
userDefinedBiomeName
userDefinedBiomeName:
string
Defined in: protocol/src/packet/StartGamePacket.ts:99
worldGamemode
worldGamemode:
number
Defined in: protocol/src/packet/StartGamePacket.ts:102
worldId
worldId:
string
Defined in: protocol/src/packet/StartGamePacket.ts:187
worldTemplateId
worldTemplateId:
WireUUID
Defined in: protocol/src/packet/StartGamePacket.ts:179
xboxLiveBroadcastSetting
xboxLiveBroadcastSetting:
number
Defined in: protocol/src/packet/StartGamePacket.ts:126
yaw
yaw:
number
Defined in: protocol/src/packet/StartGamePacket.ts:94
StructureBlockUpdate
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:55
The full editor state sent when a player closes a structure block screen.
Properties
blockPosition
blockPosition:
BlockPos
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:57
Position of the structure block.
isWaterlogged
isWaterlogged:
boolean
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:63
Whether placed blocks are waterlogged.
structureData
structureData:
StructureEditorData
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:59
Contents of the editor.
trigger
trigger:
boolean
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:61
Whether to run the structure block immediately.
StructureEditorData
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:37
The contents of the structure block editor.
See
https://mojang.github.io/bedrock-protocol-docs/1.26.51/types/structure-editor-data/
Properties
dataField
dataField:
string
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:41
Function name used by data-mode structure blocks.
redstoneSaveMode
redstoneSaveMode:
StructureRedstoneSaveMode
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:51
Where a redstone-triggered save writes the structure.
shouldIncludePlayers
shouldIncludePlayers:
boolean
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:43
Whether player entities are included.
shouldShowBoundingBox
shouldShowBoundingBox:
boolean
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:45
Whether to show the structure bounds.
structureBlockType
structureBlockType:
StructureBlockType
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:47
Current editor mode.
structureName
structureName:
RedactableString
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:39
Name used to save or load the structure.
structureSettings
structureSettings:
StructureSettings
Defined in: protocol/src/packet/StructureBlockUpdatePacket.ts:49
Bounds and placement settings for the structure.
StructureSettings
Defined in: protocol/src/structure/StructureSettings.ts:39
The palette, bounds, and placement options of a structure.
See
https://mojang.github.io/bedrock-protocol-docs/1.26.51/types/structure-settings/
Properties
animationMode
animationMode:
AnimationMode
Defined in: protocol/src/structure/StructureSettings.ts:59
Animation used when placing the structure.
animationSeconds
animationSeconds:
number
Defined in: protocol/src/structure/StructureSettings.ts:61
Duration of the placement animation, in seconds.
integritySeed
integritySeed:
number
Defined in: protocol/src/structure/StructureSettings.ts:65
Seed used to choose which blocks are removed by integrity.
integrityValue
integrityValue:
number
Defined in: protocol/src/structure/StructureSettings.ts:63
Fraction of blocks to keep when randomly damaging the structure.
lastEditPlayer
lastEditPlayer:
bigint
Defined in: protocol/src/structure/StructureSettings.ts:53
Unique id of the player who last edited these settings.
mirror
mirror:
Mirror
Defined in: protocol/src/structure/StructureSettings.ts:57
Axes to mirror across when placing the structure.
rotation
rotation:
StructureRotation
Defined in: protocol/src/structure/StructureSettings.ts:55
Quarter-turn applied when placing the structure.
rotationPivot
rotationPivot:
Vec3
Defined in: protocol/src/structure/StructureSettings.ts:67
Point the structure rotates around.
shouldAllowNonTickingPlayerAndTickingAreaChunks
shouldAllowNonTickingPlayerAndTickingAreaChunks:
boolean
Defined in: protocol/src/structure/StructureSettings.ts:47
Whether the structure may reach into chunks outside ticking areas and player range.
shouldIgnoreBlocks
shouldIgnoreBlocks:
boolean
Defined in: protocol/src/structure/StructureSettings.ts:45
Whether blocks are omitted from the structure.
shouldIgnoreEntities
shouldIgnoreEntities:
boolean
Defined in: protocol/src/structure/StructureSettings.ts:43
Whether actors are omitted from the structure.
structureOffset
structureOffset:
BlockPos
Defined in: protocol/src/structure/StructureSettings.ts:51
Offset of the structure from its origin.
structurePaletteName
structurePaletteName:
string
Defined in: protocol/src/structure/StructureSettings.ts:41
Palette name; vanilla uses default.
structureSize
structureSize:
BlockPos
Defined in: protocol/src/structure/StructureSettings.ts:49
Size of the structure in blocks.
StructureTemplateDataRequest
Defined in: protocol/src/packet/StructureTemplateDataRequestPacket.ts:18
A request for a saved structure or its export data.
Properties
requestedOperation
requestedOperation:
StructureTemplateRequestOperation
Defined in: protocol/src/packet/StructureTemplateDataRequestPacket.ts:26
Requested structure operation.
structureName
structureName:
string
Defined in: protocol/src/packet/StructureTemplateDataRequestPacket.ts:20
Structure name entered in the structure block.
structurePosition
structurePosition:
BlockPos
Defined in: protocol/src/packet/StructureTemplateDataRequestPacket.ts:22
Position of the structure block.
structureSettings
structureSettings:
StructureSettings
Defined in: protocol/src/packet/StructureTemplateDataRequestPacket.ts:24
Bounds and placement settings supplied by the client.
StructureTemplateDataResponse
Defined in: protocol/src/packet/StructureTemplateDataResponsePacket.ts:17
The template returned for a structure request.
Properties
responseType
responseType:
StructureTemplateResponseType
Defined in: protocol/src/packet/StructureTemplateDataResponsePacket.ts:23
Kind of request this response answers.
structureName
structureName:
string
Defined in: protocol/src/packet/StructureTemplateDataResponsePacket.ts:19
Structure name from the request.
structureTemplate
structureTemplate:
NBTTagCompound|null
Defined in: protocol/src/packet/StructureTemplateDataResponsePacket.ts:21
Template returned to the client, or null when no template was found.
SubChunk
Defined in: protocol/src/packet/SubChunkPacket.ts:59
The fields of a SubChunkPacket, in wire order.
Properties
cacheEnabled
cacheEnabled:
boolean
Defined in: protocol/src/packet/SubChunkPacket.ts:61
Cache Enabled: the client agreed to blob caching and each entry may carry a Blob Id.
centerPos
centerPos:
SubChunkPos
Defined in: protocol/src/packet/SubChunkPacket.ts:65
Center Pos, the absolute sub chunk position every entry's offset is relative to.
dimension
dimension:
number
Defined in: protocol/src/packet/SubChunkPacket.ts:63
Dimension Type: 0 for the Overworld, 1 for the Nether, 2 for the End.
entries
entries:
SubChunkEntry[]
Defined in: protocol/src/packet/SubChunkPacket.ts:67
SubChunk Data, one entry per answered sub chunk.
SubChunkEntry
Defined in: protocol/src/packet/SubChunkPacket.ts:37
One SubChunkPacketData entry of the SubChunk Data list.
Properties
blobId?
optionalblobId?:bigint
Defined in: protocol/src/packet/SubChunkPacket.ts:55
Blob Id, the hash the client fetches the sub chunk by when Cache Enabled is set. The blob covers the whole Serialized Sub Chunk, block entities included, so it differs from the id the same terrain would have in a LevelChunkPacket.
heightMaps
heightMaps:
SubChunkHeightmapData
Defined in: protocol/src/packet/SubChunkPacket.ts:49
Height Map Data.
offset
offset:
SubChunkPosOffset
Defined in: protocol/src/packet/SubChunkPacket.ts:39
SubChunk Pos Offset from Center Pos, in sub chunks.
result
result:
SubChunkRequestResult
Defined in: protocol/src/packet/SubChunkPacket.ts:41
SubChunk Request Result.
serializedSubChunk?
optionalserializedSubChunk?:Buffer<ArrayBufferLike>
Defined in: protocol/src/packet/SubChunkPacket.ts:47
Serialized Sub Chunk, left as bytes: the sub chunk's block storage followed by its block entities, in the same form LevelChunkPacket carries. Absent when a cached blob stands in for the bytes.
SubChunkOffset
Defined in: protocol/src/packet/SubChunkRequestPacket.ts:4
Offset of one requested sub chunk from the center, in sub chunks, each an int8.
Properties
x
x:
number
Defined in: protocol/src/packet/SubChunkRequestPacket.ts:6
Signed X offset from the center, in sub chunks.
y
y:
number
Defined in: protocol/src/packet/SubChunkRequestPacket.ts:8
Signed Y offset from the center, in sub chunks.
z
z:
number
Defined in: protocol/src/packet/SubChunkRequestPacket.ts:10
Signed Z offset from the center, in sub chunks.
SubChunkPosition
Defined in: protocol/src/packet/SubChunkRequestPacket.ts:14
A sub chunk position in sub chunk units, each an int32 LE.
Properties
x
x:
number
Defined in: protocol/src/packet/SubChunkRequestPacket.ts:16
X coordinate of the request center.
y
y:
number
Defined in: protocol/src/packet/SubChunkRequestPacket.ts:18
Y coordinate of the request center.
z
z:
number
Defined in: protocol/src/packet/SubChunkRequestPacket.ts:20
Z coordinate of the request center.
SubChunkRequestMode
Defined in: protocol/src/wire/definitions/levelChunk.ts:28
The sub-chunk count and the optional Client Request SubChunk Limit behind it.
A plain count, then a separate optional limit. The count used to double as a signal: -2 meant the client would ask for sub-chunks itself and was followed by the highest one it could ask for. Since 2168 a count is only a count, and the limit is an optional field of its own, present only in request mode, where the count on the wire is 0 and the payload's count is the limit.
Properties
clientRequestsEnabled
clientRequestsEnabled:
boolean
Defined in: protocol/src/wire/definitions/levelChunk.ts:30
Whether the client fetches the sub-chunks itself through SubChunkRequestPacket.
count
count:
number
Defined in: protocol/src/wire/definitions/levelChunk.ts:32
Sub-chunk count in plain mode; the highest requestable sub-chunk in request mode.
SubClientLogin
Defined in: protocol/src/packet/SubClientLoginPacket.ts:6
The two opaque JWT strings carried by a split-screen sub-client login.
Properties
chainData
chainData:
string
Defined in: protocol/src/packet/SubClientLoginPacket.ts:8
Chain JSON exactly as it arrived; this packet does not verify it.
clientData
clientData:
string
Defined in: protocol/src/packet/SubClientLoginPacket.ts:10
Client data JWT exactly as it arrived; this packet does not verify it.
SyncWorldClocks
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:85
The fields of a SyncWorldClocksPacket, in wire order.
Properties
data
data:
SyncWorldClocksData
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:87
Data, the one alternative this packet carries.
SystemCategory
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:30
Name of the category a system index belongs to.
Properties
categoryName
categoryName:
string
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:31
systemIndex
systemIndex:
bigint
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:32
SystemDiagnosticTimingInfo
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:22
Time one client system took in the last sample window.
Properties
displayName
displayName:
string
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:23
percentOfTotal
percentOfTotal:
number
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:26
systemIndex
systemIndex:
bigint
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:24
timeInNs
timeInNs:
bigint
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:25
TeleportData
Defined in: protocol/src/wire/definitions/movement.ts:14
Teleport Data: why a teleport happened, carried only when the move is a teleport.
Properties
cause
cause:
number
Defined in: protocol/src/wire/definitions/movement.ts:16
Teleportation Cause.
sourceActorType
sourceActorType:
number
Defined in: protocol/src/wire/definitions/movement.ts:18
Source Actor Type: the actor type that caused the teleport.
Text
Defined in: protocol/src/packet/TextPacket.ts:26
The fields of a text packet. Which optional ones are written depends on type.
Properties
filtered
filtered:
string
Defined in: protocol/src/packet/TextPacket.ts:41
"Filtered Message". An empty string is sent as absent and read back from absent.
message
message:
string
Defined in: protocol/src/packet/TextPacket.ts:33
"Message": the text, or a translation key for the parameterized types.
needsTranslation
needsTranslation:
boolean
Defined in: protocol/src/packet/TextPacket.ts:29
"Localize?": whether the client should run the message through its translations.
parameters?
optionalparameters?:string[]
Defined in: protocol/src/packet/TextPacket.ts:35
"Parameter List". Only written for Translate, Popup and JukeboxPopup.
platformChatId
platformChatId:
string
Defined in: protocol/src/packet/TextPacket.ts:39
"Platform Id".
sourceName?
optionalsourceName?:string
Defined in: protocol/src/packet/TextPacket.ts:31
"Player Name". Only written for Chat, Whisper and Announcement.
type
type:
TextPacketType
Defined in: protocol/src/packet/TextPacket.ts:27
xuid
xuid:
string
Defined in: protocol/src/packet/TextPacket.ts:37
"Sender's XUID".
TextBody
Defined in: protocol/src/wire/definitions/chat.ts:45
The Body oneOf of a text packet: the variant index, the message type, and the variant's fields.
Properties
message
message:
string
Defined in: protocol/src/wire/definitions/chat.ts:51
Message: the text, or a translation key for the MessageAndParams types.
parameters
parameters:
string[]
Defined in: protocol/src/wire/definitions/chat.ts:53
Parameter List: carried only by the MessageAndParams types. Empty otherwise.
sourceName
sourceName:
string
Defined in: protocol/src/wire/definitions/chat.ts:49
Player Name: carried only by the AuthorAndMessage types. Empty otherwise.
type
type:
TextPacketType
Defined in: protocol/src/wire/definitions/chat.ts:47
Message Type: a global TextPacketType value, not an index within the variant.
TimeMarker
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:22
One TimeMarkerData: a named point on a clock that repeats every Period ticks.
Properties
id
id:
bigint
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:24
Id, a varuint64.
name
name:
string
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:26
Name, at most 128 characters.
period
period:
number
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:30
Period in ticks between two firings, a little-endian int32.
time
time:
number
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:28
Time in ticks at which the marker fires, a ZigZag varint32.
ToastRequest
Defined in: protocol/src/packet/ToastRequestPacket.ts:9
The fields of a ToastRequestPacket, in wire order.
Properties
content
content:
string
Defined in: protocol/src/packet/ToastRequestPacket.ts:13
Content: the body text of the toast.
title
title:
string
Defined in: protocol/src/packet/ToastRequestPacket.ts:11
Title: the heading of the toast.
TransactionData
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:216
The fields every transaction body shares. The docs call them Action Type, Slot and Item.
Extended by
Type Parameters
TItem
TItem = ItemStackDescriptorData
Properties
actionType
actionType:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:218
hotbarSlot
hotbarSlot:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:219
itemInHand
itemInHand:
TItem
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:220
kind
kind:
TransactionKind
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:217
TransactionPayload
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:333
The variant index, the actions, and the body the variant selects, as one value.
Type Parameters
TItem
TItem = ItemStackDescriptorData
Properties
hand
hand:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:340
The packet-level Hand the 2225 bodies carry; HandSlot.MAINHAND before that.
inventoryActions
inventoryActions:
InventoryActionData[]
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:336
transactionData
transactionData:
UseItemData<TItem> |UseItemOnEntityData<TItem> |ReleaseItemData<TItem> |null
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:338
The body the type selects. Null for Normal, Mismatch and an unknown type.
transactionType
transactionType:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:335
The variant index as read, a TransactionType when the client sent a known one.
Transfer
Defined in: protocol/src/packet/TransferPacket.ts:28
Data carried when sending the client to another server.
Properties
address
address:
string
Defined in: protocol/src/packet/TransferPacket.ts:30
Hostname or IP address for the destination.
gatheringsConfig
gatheringsConfig:
GatheringsConfig|null
Defined in: protocol/src/packet/TransferPacket.ts:36
Additional experience metadata, or null when the server sends none.
port
port:
number
Defined in: protocol/src/packet/TransferPacket.ts:32
Destination port, written as uint16 little-endian.
reloadWorld
reloadWorld:
boolean
Defined in: protocol/src/packet/TransferPacket.ts:34
Whether the client reloads the world after the transfer.
TrimData
Defined in: protocol/src/packet/TrimDataPacket.ts:28
The fields of a TrimDataPacket, in wire order.
Properties
materials
materials:
TrimMaterial[]
Defined in: protocol/src/packet/TrimDataPacket.ts:32
TrimMaterial List, every armor trim material the client may show.
patterns
patterns:
TrimPattern[]
Defined in: protocol/src/packet/TrimDataPacket.ts:30
TrimPattern List, every armor trim pattern the client may show.
TrimMaterial
Defined in: protocol/src/packet/TrimDataPacket.ts:18
One TrimMaterial entry of the TrimMaterial List.
Properties
color
color:
string
Defined in: protocol/src/packet/TrimDataPacket.ts:22
Color, the formatting code the client colors the trim's tooltip line with.
itemName
itemName:
string
Defined in: protocol/src/packet/TrimDataPacket.ts:24
Item Name, the ingredient item that applies the material.
materialId
materialId:
string
Defined in: protocol/src/packet/TrimDataPacket.ts:20
Material Id, the material's name, for example quartz.
TrimPattern
Defined in: protocol/src/packet/TrimDataPacket.ts:10
One TrimPattern entry of the TrimPattern List.
Properties
itemName
itemName:
string
Defined in: protocol/src/packet/TrimDataPacket.ts:12
Item Name, the smithing template item that applies the pattern.
patternId
patternId:
string
Defined in: protocol/src/packet/TrimDataPacket.ts:14
Pattern Id, the pattern's name, for example sentry.
UnlockedRecipes
Defined in: protocol/src/packet/UnlockedRecipesPacket.ts:26
The fields of an UnlockedRecipesPacket, in wire order.
Properties
recipes
recipes:
string[]
Defined in: protocol/src/packet/UnlockedRecipesPacket.ts:30
Unlocked Recipes List, the recipe names the type applies to.
type
type:
UnlockedRecipesType
Defined in: protocol/src/packet/UnlockedRecipesPacket.ts:28
Packet Type.
UpdateBlockSynced
Defined in: protocol/src/packet/UpdateBlockSyncedPacket.ts:18
A block update paired with the moving actor that changes into or out of it.
Properties
actorSyncMessage
actorSyncMessage:
ActorSyncMessage
Defined in: protocol/src/packet/UpdateBlockSyncedPacket.ts:30
Describes whether the actor appears or disappears with this block update.
blockPosition
blockPosition:
BlockPos
Defined in: protocol/src/packet/UpdateBlockSyncedPacket.ts:20
Position of the changed block.
blockRuntimeId
blockRuntimeId:
number
Defined in: protocol/src/packet/UpdateBlockSyncedPacket.ts:22
Runtime id of the block state after the update.
flags
flags:
number
Defined in: protocol/src/packet/UpdateBlockSyncedPacket.ts:24
BlockUpdateFlag bits that control how the client applies the change.
layer
layer:
number
Defined in: protocol/src/packet/UpdateBlockSyncedPacket.ts:26
Block layer: 0 for the block, or 1 for its waterlogging layer.
uniqueActorId
uniqueActorId:
bigint
Defined in: protocol/src/packet/UpdateBlockSyncedPacket.ts:28
Runtime id of the moving block actor.
UpdateClientInputLocks
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:43
The fields of an UpdateClientInputLocksPacket, in wire order.
Properties
locks
locks:
number
Defined in: protocol/src/packet/UpdateClientInputLocksPacket.ts:45
Input Lock ComponentData, the full set of ClientInputLock bits now in force.
UpdateSoftEnum
Defined in: protocol/src/packet/UpdateSoftEnumPacket.ts:17
A command enum update sent to the client.
Properties
enumName
enumName:
string
Defined in: protocol/src/packet/UpdateSoftEnumPacket.ts:19
Name of the soft enum declared in AvailableCommandsPacket.
type
type:
SoftEnumUpdateType
Defined in: protocol/src/packet/UpdateSoftEnumPacket.ts:23
Operation applied to the named enum.
values
values: readonly
string[]
Defined in: protocol/src/packet/UpdateSoftEnumPacket.ts:21
Values to add, remove, or use as the replacement set.
UpdateSubChunkBlocks
Defined in: protocol/src/packet/UpdateSubChunkBlocksPacket.ts:20
The fields of an UpdateSubChunkBlocksPacket, in wire order.
Properties
blocksChanged
blocksChanged:
UpdateSubChunkBlocksChangedInfo
Defined in: protocol/src/packet/UpdateSubChunkBlocksPacket.ts:24
Blocks Changed, the changes in that sub chunk since the last tick.
subChunkBlockPosition
subChunkBlockPosition:
BlockPos
Defined in: protocol/src/packet/UpdateSubChunkBlocksPacket.ts:22
Sub Chunk Block Position, the block position of the sub chunk's origin corner.
UpdateSubChunkBlocksChangedInfo
Defined in: protocol/src/packet/UpdateSubChunkBlocksPacket.ts:12
The Blocks Changed field, an UpdateSubChunkBlocksChangedInfo, in wire order.
Properties
extras
extras:
UpdateSubChunkNetworkBlockInfo[]
Defined in: protocol/src/packet/UpdateSubChunkBlocksPacket.ts:16
Blocks Changed - Extras, the changes on the second layer, which holds waterlogging.
standards
standards:
UpdateSubChunkNetworkBlockInfo[]
Defined in: protocol/src/packet/UpdateSubChunkBlocksPacket.ts:14
Blocks Changed - Standards, the changes on the first block layer.
UpdateTrade
Defined in: protocol/src/packet/UpdateTradePacket.ts:7
The current offers and trading screen state of a villager.
Properties
containerId
containerId:
number
Defined in: protocol/src/packet/UpdateTradePacket.ts:9
Container Id of the trading window.
data
data:
Buffer
Defined in: protocol/src/packet/UpdateTradePacket.ts:27
Network NBT compound containing the offers.
displayName
displayName:
string
Defined in: protocol/src/packet/UpdateTradePacket.ts:21
Display name shown above the trade offers.
entityUniqueId
entityUniqueId:
bigint
Defined in: protocol/src/packet/UpdateTradePacket.ts:17
Unique id of the trader entity.
lastTradingPlayer
lastTradingPlayer:
bigint
Defined in: protocol/src/packet/UpdateTradePacket.ts:19
Unique id of the player who last traded.
size
size:
number
Defined in: protocol/src/packet/UpdateTradePacket.ts:13
Number of offers in the trade list.
traderTier
traderTier:
number
Defined in: protocol/src/packet/UpdateTradePacket.ts:15
Trader tier shown by the screen.
type
type:
number
Defined in: protocol/src/packet/UpdateTradePacket.ts:11
Window type; vanilla uses 15 for trading.
useNewTradeScreen
useNewTradeScreen:
boolean
Defined in: protocol/src/packet/UpdateTradePacket.ts:23
Whether to open the newer trade screen.
usingEconomyTrade
usingEconomyTrade:
boolean
Defined in: protocol/src/packet/UpdateTradePacket.ts:25
Whether the offers use economy trade values.
UseItemData
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:230
The docs' ItemUseInventoryTransaction: the item in hand used on a block or on nothing.
Wire order is Action Type (varint), Trigger Type (uint8), Position (BlockPos), Face (uint8), Slot (varint), Hand (uint8), Item, From Position (Vec3), Click Position (Vec3), Target Block Id (varuint), Client Interact Prediction (uint8), Client Cooldown State (uint8).
Extends
TransactionData<TItem>
Type Parameters
TItem
TItem = ItemStackDescriptorData
Properties
actionType
actionType:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:218
Inherited from
blockFace
blockFace:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:237
The docs' Face.
blockPosition
blockPosition:
Vector3
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:235
The docs' Position: the block that was clicked.
blockRuntimeId
blockRuntimeId:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:245
The docs' Target Block Id: the runtime id of the clicked block's state.
clickPosition
clickPosition:
Vector3
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:243
The docs' Click Position: where on the block face the click landed.
clientCooldownState
clientCooldownState:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:249
Whether the client thinks the item is on cooldown.
clientInteractPrediction
clientInteractPrediction:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:247
What the client has already drawn on its own screen, expecting the server to agree.
hand
hand:
HandSlot
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:239
Which hand the item was in. Added at 2193.
hotbarSlot
hotbarSlot:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:219
Inherited from
itemInHand
itemInHand:
TItem
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:220
Inherited from
kind
kind:
"useItem"
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:231
Overrides
playerPosition
playerPosition:
Vector3
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:241
The docs' From Position: where the player stood when sending this.
triggerType
triggerType:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:233
The docs' Trigger Type: 1 for the player's own input, 2 for a held input replayed each tick.
UseItemOnEntityData
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:259
The docs' ItemUseOnActorInventoryTransaction: the item in hand used on an entity.
Wire order is Runtime Id (varuint64), Action Type (varint), Slot (varint), Item, From Position (Vec3), Hit Position (Vec3). Protocol 2225 inserts the packet-level Hand between the slot and the item.
Extends
TransactionData<TItem>
Type Parameters
TItem
TItem = ItemStackDescriptorData
Properties
actionType
actionType:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:218
Inherited from
clickPosition
clickPosition:
Vector3
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:266
The docs' Hit Position: where on the entity the click landed.
entityRuntimeId
entityRuntimeId:
bigint
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:262
The docs' Runtime Id: the entity that was clicked.
hotbarSlot
hotbarSlot:
number
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:219
Inherited from
itemInHand
itemInHand:
TItem
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:220
Inherited from
kind
kind:
"useItemOnEntity"
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:260
Overrides
playerPosition
playerPosition:
Vector3
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:264
The docs' From Position: where the player stood when sending this.
Vec3Like
Defined in: protocol/src/packet/StartGamePacket.ts:14
Coordinates used by the player position and world spawn fields in StartGamePacket.
Properties
x
x:
number
Defined in: protocol/src/packet/StartGamePacket.ts:15
y
y:
number
Defined in: protocol/src/packet/StartGamePacket.ts:16
z
z:
number
Defined in: protocol/src/packet/StartGamePacket.ts:17
VoxelShapeNameEntry
Defined in: protocol/src/packet/VoxelShapesPacket.ts:11
One entry of the Name Map: a shape name and the handle of its shape.
Properties
handle
handle:
number
Defined in: protocol/src/packet/VoxelShapesPacket.ts:15
The value, a VoxelShapes::RegistryHandle: the index of the shape in Shapes.
name
name:
string
Defined in: protocol/src/packet/VoxelShapesPacket.ts:13
The key, a hashed_string shape name such as "minecraft:unit_cube".
VoxelShapes
Defined in: protocol/src/packet/VoxelShapesPacket.ts:19
The fields of a VoxelShapesPacket, in wire order.
Properties
customShapeCount
customShapeCount:
number
Defined in: protocol/src/packet/VoxelShapesPacket.ts:25
Custom Shape Count, how many of the shapes behavior packs added at world load. 0 without packs.
nameMap
nameMap:
VoxelShapeNameEntry[]
Defined in: protocol/src/packet/VoxelShapesPacket.ts:23
Name Map, the named shapes. A shape without a name is only reachable by handle.
shapes
shapes:
SerializableVoxelShape[]
Defined in: protocol/src/packet/VoxelShapesPacket.ts:21
Shapes, every shape of the registry, in handle order.
WhiskerScopeDataSummary
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:36
Cost summary of one profiler scope.
Properties
indentation
indentation:
string
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:38
label
label:
string
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:37
totalHighCostNs
totalHighCostNs:
bigint
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:39
totalLowCostNs
totalLowCostNs:
bigint
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:41
totalMidCostNs
totalMidCostNs:
bigint
Defined in: protocol/src/packet/ServerboundDiagnosticsPacket.ts:40
WireGate
Defined in: protocol/src/wire/wireGates.ts:17
Whether a field travels at a protocol version.
Properties
reason
readonlyreason:string
Defined in: protocol/src/wire/wireGates.ts:19
Why the wire branches here, for provenance and error messages.
Methods
includedAt()
includedAt(
protocolVersion):boolean
Defined in: protocol/src/wire/wireGates.ts:21
Answers whether the gated field is on the wire at this protocol version.
Parameters
protocolVersion
number
Returns
boolean
WireLayout
Defined in: protocol/src/wire/WireLayout.ts:32
A definition resolved against one protocol version.
Type Parameters
D
D extends PacketDefinition = PacketDefinition
Properties
absent
readonlyabsent: readonly (readonly [string,unknown])[]
Defined in: protocol/src/wire/WireLayout.ts:40
[key, fallback] for each field this version leaves off the wire.
fields
readonlyfields: readonlyResolvedField[]
Defined in: protocol/src/wire/WireLayout.ts:38
The fields on the wire at this version, in wire order.
implementation
readonlyimplementation:"compiled"|"walker"
Defined in: protocol/src/wire/WireLayout.ts:36
Whether this layout uses generated straight-line code or the compatible field walker.
name
readonlyname:string
Defined in: protocol/src/wire/WireLayout.ts:34
The packet's name, as the codec id tables key it.
Methods
decode()
decode(
stream):PayloadOf<D>
Defined in: protocol/src/wire/WireLayout.ts:44
Reads a payload off the stream, filling absent fields with their fallbacks.
Parameters
stream
Returns
PayloadOf<D>
encode()
encode(
stream,payload):void
Defined in: protocol/src/wire/WireLayout.ts:42
Writes a payload's fields in wire order.
Parameters
stream
payload
PayloadOf<D>
Returns
void
WireUUID
Defined in: protocol/src/packet/StartGamePacket.ts:43
A uuid as the wire carries it: two 64 bit halves, little endian, most significant first.
Properties
leastSignificantBits
leastSignificantBits:
bigint
Defined in: protocol/src/packet/StartGamePacket.ts:45
mostSignificantBits
mostSignificantBits:
bigint
Defined in: protocol/src/packet/StartGamePacket.ts:44
WorldClock
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:34
One WorldClockData of an InitializeRegistryData: a clock's full definition.
Properties
id
id:
bigint
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:36
Id, a varuint64.
isPaused
isPaused:
boolean
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:42
IsPaused.
name
name:
string
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:38
Name, at most 128 characters.
time
time:
number
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:40
Time in ticks, a ZigZag varint32.
timeMarkers
timeMarkers:
TimeMarker[]
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:44
TimeMarkers defined on the clock.
WorldClockState
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:48
One SyncWorldClockStateData of a SyncStateData: a clock's current time and paused flag.
Properties
clockId
clockId:
bigint
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:50
ClockId, a varuint64.
isPaused
isPaused:
boolean
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:54
IsPaused.
time
time:
number
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:52
Time in ticks, a ZigZag varint32.
WorldPosition
Defined in: protocol/src/structure/ServerWaypointPayload.ts:11
A WorldPosition: Position as three little-endian floats, then DimensionType as a ZigZag varint32 runtime id. https://mojang.github.io/bedrock-protocol-docs/1.26.51/types/world-position/
Properties
dimensionType
dimensionType:
number
Defined in: protocol/src/structure/ServerWaypointPayload.ts:15
DimensionType, the dimension's runtime id. The vanilla ones are 0 to 2.
position
position:
Vec3
Defined in: protocol/src/structure/ServerWaypointPayload.ts:13
Position, the point in the dimension.
Type Aliases
ActorEventPayload
ActorEventPayload =
PayloadOf<typeofactorEventPacket>
Defined in: protocol/src/wire/definitions/actors.ts:31
Triggers an actor event, with optional coordinates for events that happen away from it.
ActorPickRequestPayload
ActorPickRequestPayload =
PayloadOf<typeofactorPickRequestPacket>
Defined in: protocol/src/wire/definitions/actorPickRequest.ts:21
A creative player middle-clicking an actor to get its spawn egg.
AddActorPayload
AddActorPayload =
PayloadOf<typeofaddActorPacket>
Defined in: protocol/src/wire/definitions/addActor.ts:137
Spawns an actor with its position, motion, attributes, metadata, properties, and links.
AddBehaviorTreePayload
AddBehaviorTreePayload =
PayloadOf<typeofaddBehaviorTreePacket>
Defined in: protocol/src/wire/definitions/addBehaviorTree.ts:18
Sends a behavior tree as JSON text to an automation client.
AddItemActorPayload
AddItemActorPayload =
PayloadOf<typeofaddItemActorPacket>
Defined in: protocol/src/wire/definitions/addItemActor.ts:35
Payload carried by AddItemActorPacket.
AddPlayerPayload
AddPlayerPayload =
PayloadOf<typeofaddPlayerPacket>
Defined in: protocol/src/wire/definitions/addPlayer.ts:126
Spawns a player with identity, skin-related data, position, inventory, abilities, and links.
AgentActionEventPayload
AgentActionEventPayload =
PayloadOf<typeofagentActionEventPacket>
Defined in: protocol/src/wire/definitions/agentActionEvent.ts:18
Tells a Code Builder client how one of its agent's actions turned out.
AgentAnimationPayload
AgentAnimationPayload =
PayloadOf<typeofagentAnimationPacket>
Defined in: protocol/src/wire/definitions/agentAnimation.ts:19
Tells clients that a Code Builder agent played an animation, so each of them replicates it.
AnimateEntityPayload
AnimateEntityPayload =
PayloadOf<typeofanimateEntityPacket>
Defined in: protocol/src/wire/definitions/animateEntity.ts:28
Plays an animation controller on a list of actors.
AnimatePayload
AnimatePayload =
PayloadOf<typeofanimatePacket>
Defined in: protocol/src/wire/definitions/animate.ts:54
Plays an actor animation with its action, optional swing source, and hand.
AttributeLayerSyncData
AttributeLayerSyncData = {
attributeLayers:AttributeLayerData[];type:UpdateAttributeLayers; } | {attributeLayerDimension:number;attributeLayerName:string;attributeLayerSettings:AttributeLayerSettings;type:UpdateAttributeLayerSettings; } | {attributeLayerDimension:number;attributeLayerName:string;attributes:EnvironmentAttributeData[];type:UpdateEnvironmentAttributes; } | {attributeLayerDimension:number;attributeLayerName:string;attributes:string[];type:RemoveEnvironmentAttributes; }
Defined in: protocol/src/packet/ClientboundAttributeLayerSyncPacket.ts:26
The Data variant of a ClientboundAttributeLayerSyncPacket. type picks the alternative and its fields.
Union Members
Type Literal
{ attributeLayers: AttributeLayerData[]; type: UpdateAttributeLayers; }
attributeLayers
attributeLayers:
AttributeLayerData[]
Attribute Layers, one AttributeLayerData per layer.
type
type:
UpdateAttributeLayers
Type Literal
{ attributeLayerDimension: number; attributeLayerName: string; attributeLayerSettings: AttributeLayerSettings; type: UpdateAttributeLayerSettings; }
attributeLayerDimension
attributeLayerDimension:
number
Attribute Layer Dimension: 0 for the Overworld, 1 for the Nether, 2 for the End, custom ones from 1000.
attributeLayerName
attributeLayerName:
string
Attribute Layer Name, at most 128 characters.
attributeLayerSettings
attributeLayerSettings:
AttributeLayerSettings
Attributes Layer Settings (the docs' spelling), the layer's new settings.
type
Type Literal
{ attributeLayerDimension: number; attributeLayerName: string; attributes: EnvironmentAttributeData[]; type: UpdateEnvironmentAttributes; }
attributeLayerDimension
attributeLayerDimension:
number
Attribute Layer Dimension: 0 for the Overworld, 1 for the Nether, 2 for the End, custom ones from 1000.
attributeLayerName
attributeLayerName:
string
Attribute Layer Name, at most 128 characters.
attributes
attributes:
EnvironmentAttributeData[]
Attributes that changed or were added, one EnvironmentAttributeData each.
type
Type Literal
{ attributeLayerDimension: number; attributeLayerName: string; attributes: string[]; type: RemoveEnvironmentAttributes; }
attributeLayerDimension
attributeLayerDimension:
number
Attribute Layer Dimension: 0 for the Overworld, 1 for the Nether, 2 for the End, custom ones from 1000.
attributeLayerName
attributeLayerName:
string
Attribute Layer Name, at most 128 characters.
attributes
attributes:
string[]
Attributes removed from the layer, each an attribute name of at most 128 characters.
type
AttributeValue
AttributeValue = {
operation:BoolAttributeOperation;type:Bool;value:boolean; } | {constraintMax?:number;constraintMin?:number;operation:FloatAttributeOperation;type:Float;value:number; } | {operation:ColorAttributeOperation;type:Color;value:number; }
Defined in: protocol/src/structure/EnvironmentAttributeData.ts:58
One attribute value, the shape of Attribute, FromAttribute and ToAttribute. type picks the alternative and the fields that follow it.
Union Members
Type Literal
{ operation: BoolAttributeOperation; type: Bool; value: boolean; }
operation
operation:
BoolAttributeOperation
operation.
type
type:
Bool
value
value:
boolean
value.
Type Literal
{ constraintMax?: number; constraintMin?: number; operation: FloatAttributeOperation; type: Float; value: number; }
constraintMax?
optionalconstraintMax?:number
constraintMax, the highest result the operation may produce.
constraintMin?
optionalconstraintMin?:number
constraintMin, the lowest result the operation may produce.
operation
operation:
FloatAttributeOperation
operation.
type
type:
Float
value
value:
number
value, a little-endian float.
Type Literal
{ operation: ColorAttributeOperation; type: Color; value: number; }
operation
operation:
ColorAttributeOperation
operation.
type
type:
Color
value
value:
number
value, a Color255RGBA packed into four bytes and read as a little-endian uint32.
AutomationClientConnectPayload
AutomationClientConnectPayload =
PayloadOf<typeofautomationClientConnectPacket>
Defined in: protocol/src/wire/definitions/automationClientConnect.ts:18
Tells the client to open a websocket connection to the given address.
BlockActorDataPayload
BlockActorDataPayload =
PayloadOf<typeofblockActorDataPacket>
Defined in: protocol/src/wire/definitions/blocks.ts:67
Replaces a block actor's network NBT data at the specified block position.
BlockStateValue
BlockStateValue =
string|number|boolean
Defined in: protocol/src/BlockRuntimeId.ts:44
What a block state property can hold. A flag is a boolean, not 0 or 1 - see stateTag.
BookEditOperation
BookEditOperation = {
action:ReplacePage|AddPage;pageIndex:number;pageText:string;photoName:string; } | {action:DeletePage;pageIndex:number; } | {action:SwapPages;pageIndex:number;swapWithIndex:number; } | {action:Finalize;author:string;title:string;xuid:string; }
Defined in: protocol/src/packet/BookEditPacket.ts:16
Fields carried by one action in a book edit.
BossEventPayload
BossEventPayload =
PayloadOf<typeofbossEventPacket>
Defined in: protocol/src/wire/definitions/bossEvent.ts:37
Updates a boss bar's target actor, title, health, color, and overlay.
CameraPayload
CameraPayload =
PayloadOf<typeofcameraPacket>
Defined in: protocol/src/wire/definitions/camera.ts:19
Points an Education Edition tripod camera at a player.
CameraShakePayload
CameraShakePayload =
PayloadOf<typeofcameraShakePacket>
Defined in: protocol/src/wire/definitions/cameraShake.ts:23
A shake to add to the player's camera, or an order to stop the shaking.
CameraSplinePayload
CameraSplinePayload =
PayloadOf<typeofcameraSplinePacket>
Defined in: protocol/src/wire/definitions/cameraSpline.ts:99
Hands the client the custom camera splines of the world's behavior packs.
ChangeDimensionPayload
ChangeDimensionPayload =
PayloadOf<typeofchangeDimensionPacket>
Defined in: protocol/src/packet/ChangeDimensionPacket.ts:10
The target dimension and position, respawn flag, and optional loading screen id.
ChangeMobPropertyPayload
ChangeMobPropertyPayload =
PayloadOf<typeofchangeMobPropertyPacket>
Defined in: protocol/src/wire/definitions/changeMobProperty.ts:28
Sets one data-driven property on a mob.
ChunkRadiusUpdatedPayload
ChunkRadiusUpdatedPayload =
PayloadOf<typeofchunkRadiusUpdatedPacket>
Defined in: protocol/src/wire/definitions/chunkRadiusUpdated.ts:18
Tells the client the view distance the server granted, measured in chunks.
ClientCacheStatusPayload
ClientCacheStatusPayload =
PayloadOf<typeofclientCacheStatusPacket>
Defined in: protocol/src/wire/definitions/clientCache.ts:18
Tells the server whether the client supports caching chunk and block entity data.
ClientCameraAimAssistPayload
ClientCameraAimAssistPayload =
PayloadOf<typeofclientCameraAimAssistPacket>
Defined in: protocol/src/wire/definitions/clientCameraAimAssist.ts:22
Sent by the client to turn aim assist on from a camera preset's aim_assist settings, or off.
ClientToServerHandshake
ClientToServerHandshake =
ClientToServerHandshakePayload
Defined in: protocol/src/packet/ClientToServerHandshakePacket.ts:11
Nothing. The packet arriving at all is the whole message.
ClientToServerHandshakePayload
ClientToServerHandshakePayload =
PayloadOf<typeofclientToServerHandshakePacket>
Defined in: protocol/src/wire/definitions/clientToServerHandshake.ts:21
Completes the client handshake; encryption state is signaled by the first encrypted bytes.
ClientboundCloseForm
ClientboundCloseForm =
Record<string,never>
Defined in: protocol/src/packet/ClientboundCloseFormPacket.ts:5
Nothing. The packet arriving at all is the whole message.
ClientboundDataDrivenUIReload
ClientboundDataDrivenUIReload =
Record<string,never>
Defined in: protocol/src/packet/ClientboundDataDrivenUIReloadPacket.ts:5
Nothing. The packet arriving at all is the whole message.
ClientboundMatchmakingStatePayload
ClientboundMatchmakingStatePayload =
PayloadOf<typeofclientboundMatchmakingStatePacket>
Defined in: protocol/src/wire/definitions/added2225.ts:227
Reports matchmaking state, destination, and optional information about who triggered it.
ClientboundPlayAudioContentPayload
ClientboundPlayAudioContentPayload =
PayloadOf<typeofclientboundPlayAudioContentPacket>
Defined in: protocol/src/wire/definitions/added2225.ts:237
Plays signed audio content with its playback type and sound parameters.
ClientboundStonecutterSetRecipePayload
ClientboundStonecutterSetRecipePayload =
PayloadOf<typeofclientboundStonecutterSetRecipePacket>
Defined in: protocol/src/wire/definitions/added2225.ts:231
Updates a player's selected stonecutter recipe for the specified container.
CodeBuilderPayload
CodeBuilderPayload =
PayloadOf<typeofcodeBuilderPacket>
Defined in: protocol/src/wire/definitions/codeBuilder.ts:20
Where the Code Builder websocket server lives, and whether to open the app now.
CodeBuilderSourcePayload
CodeBuilderSourcePayload =
PayloadOf<typeofcodeBuilderSourcePacket>
Defined in: protocol/src/wire/definitions/codeBuilderSource.ts:21
An Education Edition request from the client's Code Builder webview to the server.
CommandBlockTarget
CommandBlockTarget = {
isBlock:false;targetRuntimeId:bigint; } | {blockPosition:BlockPos;commandBlockMode:CommandBlockMode;isBlock:true;isConditional:boolean;redstoneMode:boolean; }
Defined in: protocol/src/packet/CommandBlockUpdatePacket.ts:15
The entity or block targeted by a command block update.
CommandOutputPayload
CommandOutputPayload =
PayloadOf<typeofcommandOutputPacket>
Defined in: protocol/src/wire/definitions/commands.ts:126
Returns command output messages, success count, origin, and optional structured data.
CommandParameterType
CommandParameterType = typeof
CommandParameterType[keyof typeofCommandParameterType]
Defined in: protocol/src/wire/structures/CommandParameter.ts:92
A command parameter's type word, one of the values of CommandParameterType.
CommandRequestPayload
CommandRequestPayload =
PayloadOf<typeofcommandRequestPacket>
Defined in: protocol/src/wire/definitions/commands.ts:31
Sends a command string with its origin, internal flag, and command protocol version.
CompletedUsingItemPayload
CompletedUsingItemPayload =
PayloadOf<typeofcompletedUsingItemPacket>
Defined in: protocol/src/wire/definitions/completedUsingItem.ts:20
The end of a use that takes time, such as finishing a drink or a meal.
ContainerClosePayload
ContainerClosePayload =
PayloadOf<typeofcontainerClosePacket>
Defined in: protocol/src/wire/definitions/containers.ts:89
Closes a container window and records whether the server initiated the close.
ContainerOpenPayload
ContainerOpenPayload =
PayloadOf<typeofcontainerOpenPacket>
Defined in: protocol/src/wire/definitions/containers.ts:58
Opens a client container window with its type, position, and owning actor or block.
ContainerSetDataPayload
ContainerSetDataPayload =
PayloadOf<typeofcontainerSetDataPacket>
Defined in: protocol/src/wire/definitions/containers.ts:76
Updates one property on the currently open container.
CreatePhotoPayload
CreatePhotoPayload =
PayloadOf<typeofcreatePhotoPacket>
Defined in: protocol/src/wire/definitions/createPhoto.ts:21
A request to turn a portfolio photo into a photo item in the player's inventory.
CurrentStructureFeaturePayload
CurrentStructureFeaturePayload =
PayloadOf<typeofcurrentStructureFeaturePacket>
Defined in: protocol/src/wire/definitions/currentStructureFeature.ts:18
Names the structure feature the player currently occupies.
DataStoreEntry
DataStoreEntry = {
type:UPDATE;update:DataStoreUpdate; } | {change:DataStoreChange;type:CHANGE; } | {removal:DataStoreRemoval;type:REMOVAL; }
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:86
One Updates entry. type is the one-of selector and decides which alternative follows it on the wire.
DataStorePropertyValue
DataStorePropertyValue = {
type:NONE; } | {type:BOOL;value:boolean; } | {type:INT64;value:bigint; } | {type:DOUBLE;value:number; } | {type:STRING;value:string; } | {type:LIST;value:DataStorePropertyValue[]; } | {type:MAP;value:DataStoreMapEntry[]; }
Defined in: protocol/src/packet/ClientboundDataStorePacket.ts:55
The New Property Value of a Data Store Change: a little-endian int32 type tag with the values of DataStorePropertyType, then the value the tag announces. Lists and maps nest further values.
DataStoreValue
DataStoreValue = {
type:DOUBLE;value:number; } | {type:BOOLEAN;value:boolean; } | {type:STRING;value:string; }
Defined in: protocol/src/structure/DataStoreUpdate.ts:21
The Data of a Data Store Update. type is the one-of selector and decides how value goes on the wire, so the two travel together.
DebugInfoPayload
DebugInfoPayload =
PayloadOf<typeofdebugInfoPacket>
Defined in: protocol/src/wire/definitions/debugInfo.ts:19
A blob of server debug text tied to an actor.
DimensionDefinitionFields
DimensionDefinitionFields =
PayloadOf<typeofdimensionDefinition>
Defined in: protocol/src/wire/structures/DimensionDefinition.ts:52
The fields of one DimensionDefinition, the same shape at every protocol version.
DisconnectPayload
DisconnectPayload =
PayloadOf<typeofdisconnectPacket>
Defined in: protocol/src/wire/definitions/disconnect.ts:63
Closes the connection with a reason and optional plain and filtered display messages.
EasingFunction
EasingFunction =
Lowercase<keyof typeofEasingType>
Defined in: protocol/src/structure/CameraInstruction.ts:47
An easing_function name as the wire carries it, for example "in_out_quad": a lowercase EasingType member.
EditorNetworkPayload
EditorNetworkPayload =
PayloadOf<typeofeditorNetworkPacket>
Defined in: protocol/src/wire/definitions/editorNetwork.ts:22
Carries an opaque Bedrock Editor payload between an editor client and an editor server.
EmotePayload
EmotePayload =
PayloadOf<typeofemotePacket>
Defined in: protocol/src/wire/definitions/player.ts:88
Plays a player's emote with its identity, duration, platform, and display flags.
EntityOverrideUpdate
EntityOverrideUpdate = {
type:ClearOverrides; } | {type:RemoveOverride; } | {type:SetIntOverride;value:number; } | {type:SetFloatOverride;value:number; }
Defined in: protocol/src/packet/PlayerUpdateEntityOverridesPacket.ts:31
The Update variant of a PlayerUpdateEntityOverridesPacket. type picks the alternative and its fields.
Union Members
Type Literal
{ type: ClearOverrides; }
Type Literal
{ type: RemoveOverride; }
Type Literal
{ type: SetIntOverride; value: number; }
type
type:
SetIntOverride
value
value:
number
Value, a little-endian int32.
Type Literal
{ type: SetFloatOverride; value: number; }
type
type:
SetFloatOverride
value
value:
number
Value, a little-endian float. The client expects a finite number.
FieldSpec
FieldSpec<
T> =WireType<T> |GatedField<T>
Defined in: protocol/src/wire/define.ts:29
One entry in a field list: always on the wire, or gated by version.
Type Parameters
T
T
GameTestResultsPayload
GameTestResultsPayload =
PayloadOf<typeofgameTestResultsPacket>
Defined in: protocol/src/wire/definitions/gameTestResults.ts:21
The outcome of a GameTest the client asked for with a GameTestRequestPacket.
GuiDataPickItemPayload
GuiDataPickItemPayload =
PayloadOf<typeofguiDataPickItemPacket>
Defined in: protocol/src/wire/definitions/guiDataPickItem.ts:22
Tells the client which hotbar slot to hover over and the two lines to show in the pick-block popup.
HeightMap
HeightMap =
number[][]
Defined in: protocol/src/structure/SubChunkHeightmapData.ts:31
A sub chunk heightmap: 16 rows indexed [z][x], each height a signed byte. -1 means the column's surface is below the sub chunk, 16 that it is above, and 0 to 15 the y inside it.
HurtArmorPayload
HurtArmorPayload =
PayloadOf<typeofhurtArmorPacket>
Defined in: protocol/src/wire/definitions/hurtArmor.ts:26
Tells a client how much damage its armor took, and leaves the client to apply it.
IngredientDescriptor
IngredientDescriptor = {
kind:"name";meta:number;name:string; } | {kind:"tag";tag:string; }
Defined in: protocol/src/structure/RecipeIngredient.ts:36
What one slot accepts: a named item with an aux value, or a Bedrock item tag.
InteractPayload
InteractPayload =
PayloadOf<typeofinteractPacket>
Defined in: protocol/src/wire/definitions/interaction.ts:28
Reports a client interaction action, its target actor, and any action-specific position.
InventoryContentPayload
InventoryContentPayload =
PayloadOf<typeofinventoryContentPacket>
Defined in: protocol/src/wire/definitions/containers.ts:156
Replaces a container's full ordered slot list and its container metadata.
InventorySlotPayload
InventorySlotPayload =
PayloadOf<typeofinventorySlotPacket>
Defined in: protocol/src/wire/definitions/containers.ts:135
Replaces one slot's contents, including its container and optional storage metadata.
InventoryTransactionPayload
InventoryTransactionPayload =
PayloadOf<typeofinventoryTransactionPacket>
Defined in: protocol/src/wire/definitions/inventoryTransaction.ts:200
Describes an inventory transaction, its changed slots, and transaction-specific action data.
LegacyTelemetryEventData
LegacyTelemetryEventData = {
achievementId:number;ordinal: typeofAchievement; } | {interactedEntityId:bigint;interactionActorColor:number;interactionActorType:number;interactionActorVariant:number;interactionType:number;ordinal: typeofInteraction; } | {dimensionId:number;ordinal: typeofPortalCreated; } | {ordinal: typeofPortalUsed;sourceDimensionId:number;targetDimensionId:number; } | {damageSource:number;instigatorActorId:bigint;instigatorChildActorType:number;ordinal: typeofMobKilled;targetActorId:bigint;traderName:string;tradeTier:number; } | {contentsColor:number;contentsType:number;fillLevel:number;ordinal: typeofCauldronUsed; } | {damageSource:number;diedInRaid:boolean;instigatorActorId:number;instigatorMobVariant:number;ordinal: typeofPlayerDied; } | {bossActorId:bigint;bossType:number;ordinal: typeofBossKilled;partySize:number; } | {commandName:string;errorCount:number;errorList:string;ordinal: typeofSlashCommand;successCount:number; } | {bornBabyColor:number;bornBabyEntityType:number;bornBabyEntityVariant:number;ordinal: typeofMobBorn; } | {blockInteractionType:number;itemId:number;ordinal: typeofPOICauldronUsed; } | {blockInteractionType:number;itemId:number;ordinal: typeofComposterUsed; } | {itemId:number;ordinal: typeofBellUsed; } | {eventName:string;ordinal: typeofActorDefinition; } | {currentWave:number;ordinal: typeofRaidUpdate;success:boolean;totalWaves:number; } | {ordinal: typeofTargetBlockHit;redstoneLevel:number; } | {itemId:number;ordinal: typeofPiglinBarter;wasTargetingBarteringPlayer:boolean; } | {ordinal: typeofPlayerWaxedOrUnwaxedCopper;playerWaxedOrUnwaxedCopperBlockId:number; } | {codeBuilderRuntimeAction:string;ordinal: typeofCodeBuilderRuntimeAction; } | {objectiveName:string;ordinal: typeofCodeBuilderScoreboard;score:number; } | {count:number;itemAux:number;itemId:number;ordinal: typeofItemUsed;useMethod:number; } | {ordinal: typeofEmpty; }
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:84
The payload of one telemetry event, tagged with the alternative it travels as.
Fields the docs type as an enum - the achievement, the interaction type, the actor type, the block interaction type and the damage source - stay plain numbers. The docs print those enums' members by list position, and the changelog for ActorType shows the real wire values are nothing like their positions, so naming them here would invent values.
Union Members
Type Literal
{ achievementId: number; ordinal: typeof Achievement; }
Type Literal
{ interactedEntityId: bigint; interactionActorColor: number; interactionActorType: number; interactionActorVariant: number; interactionType: number; ordinal: typeof Interaction; }
Type Literal
{ dimensionId: number; ordinal: typeof PortalCreated; }
Type Literal
{ ordinal: typeof PortalUsed; sourceDimensionId: number; targetDimensionId: number; }
Type Literal
{ damageSource: number; instigatorActorId: bigint; instigatorChildActorType: number; ordinal: typeof MobKilled; targetActorId: bigint; traderName: string; tradeTier: number; }
damageSource
damageSource:
number
instigatorActorId
instigatorActorId:
bigint
instigatorChildActorType
instigatorChildActorType:
number
ordinal
ordinal: typeof
MobKilled
targetActorId
targetActorId:
bigint
traderName
traderName:
string
Empty when the victim does not trade.
tradeTier
tradeTier:
number
-1 when the victim does not trade.
Type Literal
{ contentsColor: number; contentsType: number; fillLevel: number; ordinal: typeof CauldronUsed; }
Type Literal
{ damageSource: number; diedInRaid: boolean; instigatorActorId: number; instigatorMobVariant: number; ordinal: typeof PlayerDied; }
Type Literal
{ bossActorId: bigint; bossType: number; ordinal: typeof BossKilled; partySize: number; }
Type Literal
{ commandName: string; errorCount: number; errorList: string; ordinal: typeof SlashCommand; successCount: number; }
commandName
commandName:
string
errorCount
errorCount:
number
errorList
errorList:
string
The error messages, joined with semicolons.
ordinal
ordinal: typeof
SlashCommand
successCount
successCount:
number
Type Literal
{ bornBabyColor: number; bornBabyEntityType: number; bornBabyEntityVariant: number; ordinal: typeof MobBorn; }
Type Literal
{ blockInteractionType: number; itemId: number; ordinal: typeof POICauldronUsed; }
Type Literal
{ blockInteractionType: number; itemId: number; ordinal: typeof ComposterUsed; }
Type Literal
{ itemId: number; ordinal: typeof BellUsed; }
Type Literal
{ eventName: string; ordinal: typeof ActorDefinition; }
Type Literal
{ currentWave: number; ordinal: typeof RaidUpdate; success: boolean; totalWaves: number; }
Type Literal
{ ordinal: typeof TargetBlockHit; redstoneLevel: number; }
Type Literal
{ itemId: number; ordinal: typeof PiglinBarter; wasTargetingBarteringPlayer: boolean; }
Type Literal
{ ordinal: typeof PlayerWaxedOrUnwaxedCopper; playerWaxedOrUnwaxedCopperBlockId: number; }
Type Literal
{ codeBuilderRuntimeAction: string; ordinal: typeof CodeBuilderRuntimeAction; }
Type Literal
{ objectiveName: string; ordinal: typeof CodeBuilderScoreboard; score: number; }
Type Literal
{ count: number; itemAux: number; itemId: number; ordinal: typeof ItemUsed; useMethod: number; }
Type Literal
{ ordinal: typeof Empty; }
LessonProgressPayload
LessonProgressPayload =
PayloadOf<typeoflessonProgressPacket>
Defined in: protocol/src/wire/definitions/lessonProgress.ts:21
Reports an Education Edition lesson starting, completing or restarting, with the score the player reached.
LevelChunkPayload
LevelChunkPayload =
PayloadOf<typeoflevelChunkPacket>
Defined in: protocol/src/wire/definitions/levelChunk.ts:76
Sends a chunk column, its cache metadata, and serialized block data to the client.
MapCreateLockedCopyPayload
MapCreateLockedCopyPayload =
PayloadOf<typeofmapCreateLockedCopyPacket>
Defined in: protocol/src/wire/definitions/mapCreateLockedCopy.ts:19
A map being locked at a cartography table.
MobEffectPayload
MobEffectPayload =
PayloadOf<typeofmobEffectPacket>
Defined in: protocol/src/wire/definitions/actors.ts:94
Adds, updates, or removes a status effect on an actor.
MobEquipmentPayload
MobEquipmentPayload =
PayloadOf<typeofmobEquipmentPacket>
Defined in: protocol/src/wire/definitions/containers.ts:111
Assigns an actor's equipped stack and selected inventory and hotbar slots.
ModalFormRequestPayload
ModalFormRequestPayload =
PayloadOf<typeofmodalFormRequestPacket>
Defined in: protocol/src/wire/definitions/forms.ts:20
Sends a custom form id and the JSON document that defines the client's form UI.
ModalFormResponsePayload
ModalFormResponsePayload =
PayloadOf<typeofmodalFormResponsePacket>
Defined in: protocol/src/wire/definitions/forms.ts:40
Returns a form submission or a cancellation reason for the requested form id.
MoveActorAbsolutePayload
MoveActorAbsolutePayload =
PayloadOf<typeofmoveActorAbsolutePacket>
Defined in: protocol/src/wire/definitions/movement.ts:87
Sets an actor's absolute position, rotation, and movement flags.
MovePlayerPayload
MovePlayerPayload =
PayloadOf<typeofmovePlayerPacket>
Defined in: protocol/src/wire/definitions/movement.ts:68
Updates a player's position, rotation, ground state, riding actor, and movement tick.
MultiplayerSettingsPayload
MultiplayerSettingsPayload =
PayloadOf<typeofmultiplayerSettingsPacket>
Defined in: protocol/src/wire/definitions/multiplayerSettings.ts:18
A change to the multiplayer settings of an Education Edition session.
NetworkChunkPublisherUpdatePayload
NetworkChunkPublisherUpdatePayload =
Omit<WirePayload,"savedChunks"> &object
Defined in: protocol/src/packet/NetworkChunkPublisherUpdatePacket.ts:20
The client's chunk-loading center, view radius, and server-built chunk coordinates.
Type Declaration
savedChunks
savedChunks:
ChunkCoord[]
NetworkStackLatencyPayload
NetworkStackLatencyPayload =
PayloadOf<typeofnetworkStackLatencyPacket>
Defined in: protocol/src/wire/definitions/networkStackLatency.ts:19
A ping the client uses for its debug latency graph.
NpcDialoguePayload
NpcDialoguePayload =
PayloadOf<typeofnpcDialoguePacket>
Defined in: protocol/src/wire/definitions/npcDialogue.ts:30
Opens or closes an NPC dialogue window on the client without the player clicking an NPC.
NpcRequestPayload
NpcRequestPayload =
PayloadOf<typeofnpcRequestPacket>
Defined in: protocol/src/wire/definitions/npcRequest.ts:25
What a player did with an NPC, sent when they interact with one or edit it.
OnScreenTextureAnimationPayload
OnScreenTextureAnimationPayload =
PayloadOf<typeofonScreenTextureAnimationPacket>
Defined in: protocol/src/wire/definitions/effects.ts:26
Selects the full-screen texture animation the client should play.
PackSettingValue
PackSettingValue =
number|boolean|string|string[]
Defined in: protocol/src/packet/ServerboundPackSettingChangePacket.ts:8
A pack setting value in one of the alternatives the packet carries.
PacketViolationWarningPayload
PacketViolationWarningPayload =
PayloadOf<typeofpacketViolationWarningPacket>
Defined in: protocol/src/wire/definitions/packetViolationWarning.ts:23
The client reporting that a packet the server sent did not parse.
PartyDestinationCookieResponsePayload
PartyDestinationCookieResponsePayload =
PayloadOf<typeofpartyDestinationCookieResponsePacket>
Defined in: protocol/src/wire/definitions/partyDestinationCookieResponse.ts:19
The client's answer to a SendPartyDestinationCookiePacket.
PayloadOf
PayloadOf<
D> =DextendsPacketDefinition<infer F> ?{ -readonly [K in keyof F]: ValueOf<F[K]> }:never
Defined in: protocol/src/wire/define.ts:42
The payload shape a definition's field list implies.
Type Parameters
D
D
PlaySoundPacketPayload
PlaySoundPacketPayload =
PayloadOf<typeofplaySoundPacket>
Defined in: protocol/src/wire/definitions/levelSoundEvent.ts:57
Plays a named sound at a position with volume, pitch, and optional playback controls.
PlayStatusPayload
PlayStatusPayload =
PayloadOf<typeofplayStatusPacket>
Defined in: protocol/src/wire/definitions/playStatus.ts:20
Reports whether login or player spawning succeeded, failed, or requires another protocol.
PlayerActionPayload
PlayerActionPayload =
PayloadOf<typeofplayerActionPacket>
Defined in: protocol/src/wire/definitions/player.ts:32
Reports a player action with its action code, affected blocks, and face.
PlayerFogPayload
PlayerFogPayload =
PayloadOf<typeofplayerFogPacket>
Defined in: protocol/src/packet/PlayerFogPacket.ts:10
The complete ordered list of fog identifiers the client should render.
PlayerHotbarPayload
PlayerHotbarPayload =
PayloadOf<typeofplayerHotbarPacket>
Defined in: protocol/src/packet/PlayerHotbarPacket.ts:10
The selected slot, its container id, and whether the client should change selection.
PlayerListPayload
PlayerListPayload =
PayloadOf<typeofplayerListPacket>
Defined in: protocol/src/wire/definitions/playerList.ts:114
Adds players and their skin details to the roster or removes roster entries by UUID.
PlayerLocation
PlayerLocation = {
packetType:PLAYER_LOCATION_COORDINATES;position:Vec3;targetActorId:bigint; } | {packetType:PLAYER_LOCATION_HIDE;position:null;targetActorId:bigint; }
Defined in: protocol/src/packet/PlayerLocationPacket.ts:16
A player's location or hide instruction, addressed by actor id.
Union Members
Type Literal
{ packetType: PLAYER_LOCATION_COORDINATES; position: Vec3; targetActorId: bigint; }
packetType
packetType:
PLAYER_LOCATION_COORDINATES
Coordinate update discriminator.
position
position:
Vec3
Position of the player.
targetActorId
targetActorId:
bigint
Actor whose location is being sent.
Type Literal
{ packetType: PLAYER_LOCATION_HIDE; position: null; targetActorId: bigint; }
packetType
packetType:
PLAYER_LOCATION_HIDE
Hide discriminator.
position
position:
null
Hide carries no coordinates.
targetActorId
targetActorId:
bigint
Actor whose location is being sent.
PlayerSkinPayload
PlayerSkinPayload =
PayloadOf<typeofplayerSkinPacket>
Defined in: protocol/src/wire/definitions/playerSkin.ts:36
Replaces a player's skin and carries the localized names of the old and new skins.
PlayerStartItemCooldownPayload
PlayerStartItemCooldownPayload =
PayloadOf<typeofplayerStartItemCooldownPacket>
Defined in: protocol/src/wire/definitions/playerStartItemCooldown.ts:21
Starts a cooldown on an item category for the receiving player.
PlayerToggleCrafterSlotRequestPayload
PlayerToggleCrafterSlotRequestPayload =
PayloadOf<typeofplayerToggleCrafterSlotRequestPacket>
Defined in: protocol/src/wire/definitions/playerToggleCrafterSlotRequest.ts:26
The client enabling or disabling one slot of a crafter block.
PlayerVideoCapture
PlayerVideoCapture = {
action:START;filePrefix:string;frameRate:number; } | {action:STOP; }
Defined in: protocol/src/packet/PlayerVideoCapturePacket.ts:15
The fields of a PlayerVideoCapturePacket. action picks the alternative and its fields.
Union Members
Type Literal
{ action: START; filePrefix: string; frameRate: number; }
action
action:
START
filePrefix
filePrefix:
string
FilePrefix for the frame files the client writes.
frameRate
frameRate:
number
FrameRate of the capture, a little-endian uint32.
Type Literal
{ action: STOP; }
PositionTrackingDBClientRequestPayload
PositionTrackingDBClientRequestPayload =
PayloadOf<typeofpositionTrackingDBClientRequestPacket>
Defined in: protocol/src/wire/definitions/positionTrackingDBClientRequest.ts:19
A lookup in the server's position tracking database.
PrimitiveShapeExtraData
PrimitiveShapeExtraData = {
type:None; } | {endLocation?:Vec3;headLength?:number;headRadius?:number;segments?:number;type:Arrow; } | {backgroundColor?:number;depthTest:boolean;lineGapHeight:number;showBackface:boolean;showTextBackface:boolean;text:string;type:Text;useRotation:boolean; } | {bound:Vec3;type:Box; } | {endLocation:Vec3;type:Line; } | {segments:number;type:Sphere; } | {height:number;radiusX:Vec2;radiusZ:Vec2;segments:number;type:Cylinder; } | {depth?:number;height:number;type:Pyramid;width:number; } | {radii:Vec3;segmentsPerAxis:number;type:Ellipsoid; } | {height:number;radii:Vec2;segments:number;type:Cone; }
Defined in: protocol/src/structure/PrimitiveShapeData.ts:48
The Extra Shape Data variant of a debug shape. type picks the alternative and its fields. Colors are ARGB packed as 0xAARRGGBB in an unsigned 32-bit integer.
Union Members
Type Literal
{ type: None; }
Type Literal
{ endLocation?: Vec3; headLength?: number; headRadius?: number; segments?: number; type: Arrow; }
endLocation?
optionalendLocation?:Vec3
Arrow End Location.
headLength?
optionalheadLength?:number
Arrow Head Length.
headRadius?
optionalheadRadius?:number
Arrow Head Radius.
segments?
optionalsegments?:number
Num Segments of the arrow head, one byte.
type
type:
Arrow
Type Literal
{ backgroundColor?: number; depthTest: boolean; lineGapHeight: number; showBackface: boolean; showTextBackface: boolean; text: string; type: Text; useRotation: boolean; }
backgroundColor?
optionalbackgroundColor?:number
BackgroundColor behind the text. The client picks a translucent black when absent.
depthTest
depthTest:
boolean
DepthTest: let blocks hide the text, as signs do, instead of showing through them like a nametag.
lineGapHeight
lineGapHeight:
number
LineGapHeight between lines of multiline text.
showBackface
showBackface:
boolean
ShowBackface of the background.
showTextBackface
showTextBackface:
boolean
ShowTextBackface of the text.
text
text:
string
Text to draw.
type
type:
Text
useRotation
useRotation:
boolean
UseRotation: face the shape's Rotation instead of the camera.
Type Literal
bound
bound:
Vec3
Box Bound, the box's extent.
type
type:
Box
Type Literal
{ endLocation: Vec3; type: Line; }
endLocation
endLocation:
Vec3
Line End Location.
type
type:
Line
Type Literal
{ segments: number; type: Sphere; }
segments
segments:
number
Num Segments of the circle or sphere, one byte.
type
type:
Sphere
Type Literal
{ height: number; radiusX: Vec2; radiusZ: Vec2; segments: number; type: Cylinder; }
height
height:
number
Height.
radiusX
radiusX:
Vec2
Radius X.
radiusZ
radiusZ:
Vec2
Radius Z.
segments
segments:
number
Num Segments, one byte.
type
type:
Cylinder
Type Literal
{ depth?: number; height: number; type: Pyramid; width: number; }
depth?
optionaldepth?:number
Depth of the base along Z. The client uses Width when absent.
height
height:
number
Height.
type
type:
Pyramid
width
width:
number
Width of the base along X.
Type Literal
{ radii: Vec3; segmentsPerAxis: number; type: Ellipsoid; }
radii
radii:
Vec3
Radii along X, Y and Z.
segmentsPerAxis
segmentsPerAxis:
number
Segments Per Axis, one byte.
type
type:
Ellipsoid
Type Literal
{ height: number; radii: Vec2; segments: number; type: Cone; }
height
height:
number
Height.
radii
radii:
Vec2
Radii of the base along X and Z.
segments
segments:
number
Num Segments, one byte.
type
type:
Cone
ProtocolPacketClass
ProtocolPacketClass = new (...
args) =>NetworkPacket<unknown>
Defined in: protocol/src/ProtocolCodec.ts:8
A constructible packet class exported by the protocol package.
Parameters
args
...never[]
Returns
NetworkPacket<unknown>
RefreshEntitlements
RefreshEntitlements =
Record<string,never>
Defined in: protocol/src/packet/RefreshEntitlementsPacket.ts:5
Nothing. The packet arriving at all is the whole message.
RemoveActorPayload
RemoveActorPayload =
PayloadOf<typeofremoveActorPacket>
Defined in: protocol/src/wire/definitions/actors.ts:40
Removes an actor by its unique id.
RemoveObjectivePayload
RemoveObjectivePayload =
PayloadOf<typeofremoveObjectivePacket>
Defined in: protocol/src/wire/definitions/scoreboard.ts:181
Removes an objective and all scores associated with it.
RemoveVolumeEntityPayload
RemoveVolumeEntityPayload =
PayloadOf<typeofremoveVolumeEntityPacket>
Defined in: protocol/src/wire/definitions/removeVolumeEntity.ts:19
Tells the client to drop a volume entity it learned about from an AddVolumeEntityPacket.
RequestAbilityPayload
RequestAbilityPayload =
PayloadOf<typeofrequestAbilityPacket>
Defined in: protocol/src/wire/definitions/requestAbility.ts:24
The client asking to change one of its own abilities, such as toggling flight.
RequestChunkRadiusPayload
RequestChunkRadiusPayload =
PayloadOf<typeofrequestChunkRadiusPacket>
Defined in: protocol/src/wire/definitions/chunkRadiusUpdated.ts:34
Requests a view distance and reports the largest radius the client can handle.
RequestNetworkSettingsPayload
RequestNetworkSettingsPayload =
PayloadOf<typeofrequestNetworkSettingsPacket>
Defined in: protocol/src/wire/definitions/networkSettings.ts:24
Announces the client's Bedrock protocol version before network settings are negotiated.
RequestPermissionsPayload
RequestPermissionsPayload =
PayloadOf<typeofrequestPermissionsPacket>
Defined in: protocol/src/wire/definitions/requestPermissions.ts:22
An operator asking the server to change another player's permission level.
ResourcePacksReadyForValidation
ResourcePacksReadyForValidation =
Record<string,never>
Defined in: protocol/src/packet/ResourcePacksReadyForValidationPacket.ts:5
Nothing. The packet arriving at all is the whole message.
RespawnPayload
RespawnPayload =
PayloadOf<typeofrespawnPacket>
Defined in: protocol/src/packet/RespawnPacket.ts:10
The respawn position, transition state, and runtime id for the respawning player.
ScorePacketEntry
ScorePacketEntry = {
action:Remove;objectiveName?:string;scoreboardId:bigint; } | {action:ChangePlayer;objectiveName:string;playerUniqueId:bigint;scoreboardId:bigint;scoreValue:number; } | {action:ChangeEntity;actorId:bigint;objectiveName:string;scoreboardId:bigint;scoreValue:number; } | {action:ChangeFakePlayer;fakePlayerName:string;objectiveName:string;scoreboardId:bigint;scoreValue:number; }
Defined in: protocol/src/wire/definitions/scoreboard.ts:37
One line of a scoreboard, or the instruction to drop one.
Union Members
Type Literal
{ action: Remove; objectiveName?: string; scoreboardId: bigint; }
action
action:
Remove
objectiveName?
optionalobjectiveName?:string
When set, only this objective's score is reset. When absent, every objective's is.
scoreboardId
scoreboardId:
bigint
Type Literal
{ action: ChangePlayer; objectiveName: string; playerUniqueId: bigint; scoreboardId: bigint; scoreValue: number; }
Type Literal
{ action: ChangeEntity; actorId: bigint; objectiveName: string; scoreboardId: bigint; scoreValue: number; }
Type Literal
{ action: ChangeFakePlayer; fakePlayerName: string; objectiveName: string; scoreboardId: bigint; scoreValue: number; }
ScriptMessagePayload
ScriptMessagePayload =
PayloadOf<typeofscriptMessagePacket>
Defined in: protocol/src/wire/definitions/scriptMessage.ts:18
A custom message between the client's and the server's scripts.
ServerSettingsRequestPayload
ServerSettingsRequestPayload =
PayloadOf<typeofserverSettingsRequestPacket>
Defined in: protocol/src/wire/definitions/serverSettings.ts:21
Requests the server's settings form; the packet's arrival carries the entire request.
ServerSettingsResponsePayload
ServerSettingsResponsePayload =
PayloadOf<typeofserverSettingsResponsePacket>
Defined in: protocol/src/wire/definitions/serverSettingsResponse.ts:20
The server's settings form, sent in reply to ServerSettingsRequestPacket.
ServerStatsPayload
ServerStatsPayload =
PayloadOf<typeofserverStatsPacket>
Defined in: protocol/src/wire/definitions/serverStats.ts:18
Performance figures the server reports to the client.
ServerboundCursorItemDragPayload
ServerboundCursorItemDragPayload =
PayloadOf<typeofserverboundCursorItemDragPacket>
Defined in: protocol/src/wire/definitions/added2225.ts:235
Marks the start or stop of a cursor item split-drag.
ServerboundLoadingScreenPayload
ServerboundLoadingScreenPayload =
PayloadOf<typeofserverboundLoadingScreenPacket>
Defined in: protocol/src/wire/definitions/serverboundLoadingScreen.ts:18
Reports a loading screen starting or ending on the client.
ServerboundRegisterAudioContentPayload
ServerboundRegisterAudioContentPayload =
PayloadOf<typeofserverboundRegisterAudioContentPacket>
Defined in: protocol/src/wire/definitions/added2225.ts:239
Registers audio content ids and their signed metadata and playback payloads.
ServerboundStonecutterSetRecipePayload
ServerboundStonecutterSetRecipePayload =
PayloadOf<typeofserverboundStonecutterSetRecipePacket>
Defined in: protocol/src/wire/definitions/added2225.ts:229
Selects a recipe index in the serverbound stonecutter container.
SetActorLinkPayload
SetActorLinkPayload =
PayloadOf<typeofsetActorLinkPacket>
Defined in: protocol/src/wire/definitions/actors.ts:66
Creates or clears a relationship between two actors, such as riding.
SetActorMotionPayload
SetActorMotionPayload =
PayloadOf<typeofsetActorMotionPacket>
Defined in: protocol/src/wire/definitions/movement.ts:100
Sets an actor's velocity and the input tick associated with the change.
SetCommandsEnabledPayload
SetCommandsEnabledPayload =
PayloadOf<typeofsetCommandsEnabledPacket>
Defined in: protocol/src/packet/SetCommandsEnabledPacket.ts:10
The Commands Enabled flag sent by SetCommandsEnabledPacket.
SetDefaultGameTypePayload
SetDefaultGameTypePayload =
PayloadOf<typeofsetDefaultGameTypePacket>
Defined in: protocol/src/wire/definitions/setDefaultGameType.ts:20
Packet 105 on protocol 2193.
SetDifficultyPayload
SetDifficultyPayload =
PayloadOf<typeofsetDifficultyPacket>
Defined in: protocol/src/packet/SetDifficultyPacket.ts:10
The Difficulty value sent by SetDifficultyPacket.
SetDisplayObjectivePayload
SetDisplayObjectivePayload =
PayloadOf<typeofsetDisplayObjectivePacket>
Defined in: protocol/src/wire/definitions/scoreboard.ts:167
Registers a scoreboard objective and selects where its title and scores appear.
SetHealthPayload
SetHealthPayload =
PayloadOf<typeofsetHealthPacket>
Defined in: protocol/src/packet/SetHealthPacket.ts:10
The Health field sent by SetHealthPacket.
SetLastHurtByPayload
SetLastHurtByPayload =
PayloadOf<typeofsetLastHurtByPacket>
Defined in: protocol/src/wire/definitions/setLastHurtBy.ts:17
Tells the client which kind of actor hit the player last.
SetLocalPlayerAsInitializedPayload
SetLocalPlayerAsInitializedPayload =
PayloadOf<typeofsetLocalPlayerAsInitializedPacket>
Defined in: protocol/src/wire/definitions/player.ts:102
Marks the local player initialized so the server can begin tracking and streaming it.
SetPassengerOfBlockPayload
SetPassengerOfBlockPayload =
PayloadOf<typeofsetPassengerOfBlockPacket>
Defined in: protocol/src/wire/definitions/added2225.ts:233
Sets or clears the block a passenger actor is riding.
SetPlayerGameTypePayload
SetPlayerGameTypePayload =
PayloadOf<typeofsetPlayerGameTypePacket>
Defined in: protocol/src/wire/definitions/player.ts:46
Sets the game type for the player sending or receiving the packet.
SetPlayerInventoryOptionsPayload
SetPlayerInventoryOptionsPayload =
PayloadOf<typeofsetPlayerInventoryOptionsPacket>
Defined in: protocol/src/wire/definitions/setPlayerInventoryOptions.ts:25
How the player has arranged their inventory screen.
SetScorePayload
SetScorePayload =
PayloadOf<typeofsetScorePacket>
Defined in: protocol/src/wire/definitions/scoreboard.ts:145
Adds, changes, or removes scoreboard entries and their objective scores.
SetScoreboardIdentityPayload
SetScoreboardIdentityPayload =
PayloadOf<typeofsetScoreboardIdentityPacket>
Defined in: protocol/src/wire/definitions/scoreboard.ts:235
Assigns scoreboard ids to players or clears those identity mappings.
SetSpawnPositionPayload
SetSpawnPositionPayload =
PayloadOf<typeofsetSpawnPositionPacket>
Defined in: protocol/src/packet/SetSpawnPositionPacket.ts:18
A world or player spawn type, its dimension, and the related block positions.
SetTimePayload
SetTimePayload =
PayloadOf<typeofsetTimePacket>
Defined in: protocol/src/packet/SetTimePacket.ts:10
The Time field sent by SetTimePacket, measured in world ticks.
SetTitlePayload
SetTitlePayload =
PayloadOf<typeofsetTitlePacket>
Defined in: protocol/src/wire/definitions/chat.ts:163
Controls the title overlay text, timing, subtitle, and action bar shown to the player.
SettingsCommandPayload
SettingsCommandPayload =
PayloadOf<typeofsettingsCommandPacket>
Defined in: protocol/src/wire/definitions/settingsCommand.ts:21
Requests a setting change through commands.
ShowCreditsPayload
ShowCreditsPayload =
PayloadOf<typeofshowCreditsPacket>
Defined in: protocol/src/wire/definitions/showCredits.ts:26
Starts a player's credits or reports that the player has finished watching them.
ShowProfilePayload
ShowProfilePayload =
PayloadOf<typeofshowProfilePacket>
Defined in: protocol/src/wire/definitions/showProfile.ts:17
Opens the Xbox profile card of one player on the client.
SimpleEventPayload
SimpleEventPayload =
PayloadOf<typeofsimpleEventPacket>
Defined in: protocol/src/wire/definitions/simpleEvent.ts:18
Asks the server to turn commands on or off, or to unlock the world template settings.
SimulationTypePayload
SimulationTypePayload =
PayloadOf<typeofsimulationTypePacket>
Defined in: protocol/src/wire/definitions/simulationType.ts:17
Switches the client's simulation type for toolbox mode.
SoundDataUpdate
SoundDataUpdate =
SoundDataSignal|SoundDataSetVolume|SoundDataSetPitch|SoundDataFade|SoundDataSeekTo
Defined in: protocol/src/packet/ClientboundUpdateSoundDataPacket.ts:57
A stop, volume, pitch, fade, seek, pause, or resume operation for a playing sound.
SpawnParticleEffectPayload
SpawnParticleEffectPayload =
PayloadOf<typeofspawnParticleEffectPacket>
Defined in: protocol/src/wire/definitions/effects.ts:54
Spawns a named particle effect at a position or relative to an actor.
StartGamePayload
StartGamePayload =
PayloadOf<typeofstartGamePacket>
Defined in: protocol/src/wire/definitions/startGame.ts:406
Initializes the client with the player, world, game rules, registries, and server settings.
StopSoundPayload
StopSoundPayload =
PayloadOf<typeofstopSoundPacket>
Defined in: protocol/src/wire/definitions/levelSoundEvent.ts:107
Stops a named sound, all sounds, or legacy music playback on the client.
SyncWorldClocksData
SyncWorldClocksData = {
clocks:WorldClockState[];type:SyncState; } | {clocks:WorldClock[];type:InitializeRegistry; } | {clockId:bigint;timeMarkers:TimeMarker[];type:AddTimeMarker; } | {clockId:bigint;timeMarkerIds:bigint[];type:RemoveTimeMarker; }
Defined in: protocol/src/packet/SyncWorldClocksPacket.ts:58
The Data variant of a SyncWorldClocksPacket. type picks the alternative and its fields.
Union Members
Type Literal
{ clocks: WorldClockState[]; type: SyncState; }
clocks
clocks:
WorldClockState[]
ClockData, one SyncWorldClockStateData per clock.
type
type:
SyncState
Type Literal
{ clocks: WorldClock[]; type: InitializeRegistry; }
clocks
clocks:
WorldClock[]
ClockData, one WorldClockData per clock.
type
type:
InitializeRegistry
Type Literal
{ clockId: bigint; timeMarkers: TimeMarker[]; type: AddTimeMarker; }
clockId
clockId:
bigint
ClockId the markers belong to, a varuint64.
timeMarkers
timeMarkers:
TimeMarker[]
TimeMarkers added to the clock.
type
type:
AddTimeMarker
Type Literal
{ clockId: bigint; timeMarkerIds: bigint[]; type: RemoveTimeMarker; }
clockId
clockId:
bigint
ClockId the markers belonged to, a varuint64.
timeMarkerIds
timeMarkerIds:
bigint[]
TimeMarkerIds removed from the clock, each a varuint64.
type
type:
RemoveTimeMarker
SyncWorldClocksPayload
SyncWorldClocksPayload =
PayloadOf<typeofsyncWorldClocksPacket>
Defined in: protocol/src/wire/definitions/syncWorldClocks.ts:99
Initializes and keeps in sync the world clocks of a server.
TakeItemActorPayload
TakeItemActorPayload =
PayloadOf<typeoftakeItemActorPacket>
Defined in: protocol/src/wire/definitions/actors.ts:51
Identifies the item actor being picked up and the actor taking it.
TextPayload
TextPayload =
PayloadOf<typeoftextPacket>
Defined in: protocol/src/wire/definitions/chat.ts:135
Sends chat, system text, or translated UI text with the fields required by its message type.
TickingAreasLoadStatusPayload
TickingAreasLoadStatusPayload =
PayloadOf<typeoftickingAreasLoadStatusPacket>
Defined in: protocol/src/wire/definitions/tickingAreasLoadStatus.ts:18
Whether the client is sitting on a loading screen waiting for ticking areas to preload.
ToastRequestPayload
ToastRequestPayload =
PayloadOf<typeoftoastRequestPacket>
Defined in: protocol/src/wire/definitions/toastRequest.ts:19
Asks the client to show a toast notification, the small overlay the game uses for achievements and friend activity.
UnlockedRecipesPayload
UnlockedRecipesPayload =
PayloadOf<typeofunlockedRecipesPacket>
Defined in: protocol/src/wire/definitions/unlockedRecipes.ts:18
Changes the set of recipes a player has unlocked.
UpdateAdventureSettingsPayload
UpdateAdventureSettingsPayload =
PayloadOf<typeofupdateAdventureSettingsPacket>
Defined in: protocol/src/packet/UpdateAdventureSettingsPacket.ts:10
The player's PvM, MvP, world immutability, name tag, and auto-jump settings.
UpdateBlockPayload
UpdateBlockPayload =
PayloadOf<typeofupdateBlockPacket>
Defined in: protocol/src/wire/definitions/blocks.ts:56
Updates a block's runtime state, update flags, and layer at one position.
UpdateClientInputLocksPayload
UpdateClientInputLocksPayload =
PayloadOf<typeofupdateClientInputLocksPacket>
Defined in: protocol/src/wire/definitions/updateClientInputLocks.ts:17
Replaces the set of player inputs the client must ignore, such as camera rotation, jumping or walking in one direction.
UpdatePlayerGameTypePayload
UpdatePlayerGameTypePayload =
PayloadOf<typeofupdatePlayerGameTypePacket>
Defined in: protocol/src/wire/definitions/player.ts:64
Announces a player's new game type and the tick associated with the change.
Variables
ANY_META
constANY_META:32767=32767
Defined in: protocol/src/structure/RecipeIngredient.ts:33
The auxiliary value written for a descriptor that names no single item.
32767 is the wildcard meta, "any", which is what an invalid descriptor and a tag descriptor both stand for. An invalid descriptor writes it in place of a name; a tag descriptor writes it after the tag's name.
ActorLinkType
constActorLinkType:object
Defined in: protocol/src/wire/definitions/addActor.ts:22
The ActorLinkType values an ActorLink is sent with.
Type Declaration
None
readonlyNone:0=0
Passenger
readonlyPassenger:2=2
Riding
readonlyRiding:1=1
BATCH_PACKET_ID
constBATCH_PACKET_ID:254=0xfe
Defined in: protocol/src/BatchCodec.ts:6
The id every batch carries, and the only packet id RakNet ever sees from Minecraft.
CommandParameterType
constCommandParameterType:object
Defined in: protocol/src/wire/structures/CommandParameter.ts:92
The type word of a basic command parameter, ready to be written to the wire.
Each entry is a CommandArgumentType id ORed with CommandParameterTypeFlag.Valid, so the two tables cannot disagree. Enum is the bare enum flag; a parameter with an enum attached gets its word built by the packet from the enum's index, not from this value.
Type Declaration
BlockPosition
readonlyBlockPosition:number
BlockStateArray
readonlyBlockStateArray:number
ClockTimeMarker
readonlyClockTimeMarker:number
CodeBuilderArgs
readonlyCodeBuilderArgs:number
CompareOperator
readonlyCompareOperator:number
Enum
readonlyEnum:Enum=CommandParameterTypeFlag.Enum
EquipmentSlot
readonlyEquipmentSlot:number
Float
readonlyFloat:number
FullIntegerRange
readonlyFullIntegerRange:number
Int
readonlyInt:number
Json
readonlyJson:number
Message
readonlyMessage:number
MessageRoot
readonlyMessageRoot:number
Operator
readonlyOperator:number
PathCommand
readonlyPathCommand:number
PoiTag
readonlyPoiTag:number
PoiType
readonlyPoiType:number
Position
readonlyPosition:number
RawText
readonlyRawText:number
String
readonlyString:number
Target
readonlyTarget:number
Value
readonlyValue:number
WildcardInt
readonlyWildcardInt:number
WildcardSelection
readonlyWildcardSelection:number
DEFAULT_COMPRESSION_LEVEL
constDEFAULT_COMPRESSION_LEVEL:7=7
Defined in: protocol/src/CompressionCodec.ts:27
What the server compressed at before the level was configurable.
Higher means less bandwidth and more CPU. Measured on a 10 KiB chunk payload: level 7 costs 0.367 ms, level 1 costs 0.111 ms.
DEFAULT_MAX_DECOMPRESSED_LENGTH
constDEFAULT_MAX_DECOMPRESSED_LENGTH:number
Defined in: protocol/src/CompressionCodec.ts:38
Ceiling on what one batch may inflate to.
A compressed payload arrives inside a single RakNet message, so it is bounded by reassembly at roughly 2.8 MiB - but what it expands to is bounded by nothing at all, and both a server and a client here read compressed bytes from a peer they have not authenticated yet. zlib enforces the limit itself rather than us discovering it after allocating.
EMPTY_ITEM_STACK_ID
constEMPTY_ITEM_STACK_ID:0=0
Defined in: protocol/src/wire/structures/ItemStackDescriptor.ts:16
The id of the empty stack. Every field after it is still written.
HANDSHAKE_PACKET_NAMES
constHANDSHAKE_PACKET_NAMES: readonly ["RequestNetworkSettingsPacket","NetworkSettingsPacket","PlayStatusPacket","DisconnectPacket"]
Defined in: protocol/src/HandshakeCodec.ts:5
Packet class names allowed before a client announces its protocol version.
INPUT_FLAG_COUNT
constINPUT_FLAG_COUNT:number
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:99
One past the largest flag number in the documented enum.
LegacyTelemetryEventDataOrdinal
constLegacyTelemetryEventDataOrdinal:object
Defined in: protocol/src/packet/LegacyTelemetryEventPacket.ts:51
The alternatives of the Event Data oneOf, as its varuint32 selector numbers them.
The selector is not the Event Type: several event types carry no data of their own and share the LegacyTelemetryEventDataOrdinal.Empty alternative.
Type Declaration
Achievement
readonlyAchievement:0=0
ActorDefinition
readonlyActorDefinition:13=13
BellUsed
readonlyBellUsed:12=12
BossKilled
readonlyBossKilled:7=7
CauldronUsed
readonlyCauldronUsed:5=5
CodeBuilderRuntimeAction
readonlyCodeBuilderRuntimeAction:18=18
CodeBuilderScoreboard
readonlyCodeBuilderScoreboard:19=19
ComposterUsed
readonlyComposterUsed:11=11
Empty
readonlyEmpty:21=21
Interaction
readonlyInteraction:1=1
ItemUsed
readonlyItemUsed:20=20
MobBorn
readonlyMobBorn:9=9
MobKilled
readonlyMobKilled:4=4
PiglinBarter
readonlyPiglinBarter:16=16
PlayerDied
readonlyPlayerDied:6=6
PlayerWaxedOrUnwaxedCopper
readonlyPlayerWaxedOrUnwaxedCopper:17=17
POICauldronUsed
readonlyPOICauldronUsed:10=10
PortalCreated
readonlyPortalCreated:2=2
PortalUsed
readonlyPortalUsed:3=3
RaidUpdate
readonlyRaidUpdate:14=14
SlashCommand
readonlySlashCommand:8=8
TargetBlockHit
readonlyTargetBlockHit:15=15
MAX_BLOCK_ACTIONS
constMAX_BLOCK_ACTIONS:100=100
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:103
Maximum number of PlayerBlockActionData entries allowed in one packet.
MAX_CLIENT_PIXELS
constMAX_CLIENT_PIXELS:16384=16384
Defined in: protocol/src/packet/MapInfoRequestPacket.ts:7
The most Client Pixels List entries the docs allow in one packet (maxItems), one per pixel of a 128 by 128 map.
MAX_INVENTORY_ACTIONS
constMAX_INVENTORY_ACTIONS:100=100
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:102
The docs' runtime constraint on the Actions list: "Verify that the number of InventoryActions does not exceed 100". The reader refuses a longer list before allocating it.
ProtocolVersions
constProtocolVersions:object
Defined in: protocol/src/ProtocolVersion.ts:23
Wire definitions supported by this package, oldest protocol version first.
Type Declaration
v2193
readonlyv2193:object
v2193.ids
readonlyids:object=packetIds2193
v2193.ids.ActorEventPacket
ActorEventPacket:
number=0x1b
v2193.ids.ActorPickRequestPacket
ActorPickRequestPacket:
number=0x23
v2193.ids.AddActorPacket
AddActorPacket:
number=0x0d
v2193.ids.AddBehaviorTreePacket
AddBehaviorTreePacket:
number=0x59
v2193.ids.AddItemActorPacket
AddItemActorPacket:
number=0x0f
v2193.ids.AddPaintingPacket
AddPaintingPacket:
number=0x16
v2193.ids.AddPlayerPacket
AddPlayerPacket:
number=0x0c
v2193.ids.AddVolumeEntityPacket
AddVolumeEntityPacket:
number=0xa6
v2193.ids.AgentActionEventPacket
AgentActionEventPacket:
number=0xb5
v2193.ids.AgentAnimationPacket
AgentAnimationPacket:
number=0x130
v2193.ids.AnimateEntityPacket
AnimateEntityPacket:
number=0x9e
v2193.ids.AnimatePacket
AnimatePacket:
number=0x2c
v2193.ids.AnvilDamagePacket
AnvilDamagePacket:
number=0x8d
v2193.ids.AutomationClientConnectPacket
AutomationClientConnectPacket:
number=0x5f
v2193.ids.AvailableActorIdentifiersPacket
AvailableActorIdentifiersPacket:
number=0x77
v2193.ids.AvailableCommandsPacket
AvailableCommandsPacket:
number=0x4c
v2193.ids.AwardAchievementPacket
AwardAchievementPacket:
number=0x135
v2193.ids.BiomeDefinitionListPacket
BiomeDefinitionListPacket:
number=0x7a
v2193.ids.BlockActorDataPacket
BlockActorDataPacket:
number=0x38
v2193.ids.BlockEventPacket
BlockEventPacket:
number=0x1a
v2193.ids.BlockPickRequestPacket
BlockPickRequestPacket:
number=0x22
v2193.ids.BookEditPacket
BookEditPacket:
number=0x61
v2193.ids.BossEventPacket
BossEventPacket:
number=0x4a
v2193.ids.CameraAimAssistActorPriorityPacket
CameraAimAssistActorPriorityPacket:
number=0x153
v2193.ids.CameraAimAssistPacket
CameraAimAssistPacket:
number=0x13c
v2193.ids.CameraAimAssistPresetsPacket
CameraAimAssistPresetsPacket:
number=0x140
v2193.ids.CameraInstructionPacket
CameraInstructionPacket:
number=0x12c
v2193.ids.CameraPacket
CameraPacket:
number=0x49
v2193.ids.CameraPresetsPacket
CameraPresetsPacket:
number=0xc6
v2193.ids.CameraShakePacket
CameraShakePacket:
number=0x9f
v2193.ids.CameraSplinePacket
CameraSplinePacket:
number=0x152
v2193.ids.ChangeDimensionPacket
ChangeDimensionPacket:
number=0x3d
v2193.ids.ChangeMobPropertyPacket
ChangeMobPropertyPacket:
number=0xb6
v2193.ids.ChunkRadiusUpdatedPacket
ChunkRadiusUpdatedPacket:
number=0x46
v2193.ids.ClientboundAttributeLayerSyncPacket
ClientboundAttributeLayerSyncPacket:
number=0x159
v2193.ids.ClientboundCloseFormPacket
ClientboundCloseFormPacket:
number=0x136
v2193.ids.ClientboundControlSchemeSetPacket
ClientboundControlSchemeSetPacket:
number=0x147
v2193.ids.ClientboundDataDrivenUICloseScreenPacket
ClientboundDataDrivenUICloseScreenPacket:
number=0x14e
v2193.ids.ClientboundDataDrivenUIReloadPacket
ClientboundDataDrivenUIReloadPacket:
number=0x14f
v2193.ids.ClientboundDataDrivenUIShowScreenPacket
ClientboundDataDrivenUIShowScreenPacket:
number=0x14d
v2193.ids.ClientboundDataStorePacket
ClientboundDataStorePacket:
number=0x14a
v2193.ids.ClientboundDebugRendererPacket
ClientboundDebugRendererPacket:
number=0xa4
v2193.ids.ClientboundMapItemDataPacket
ClientboundMapItemDataPacket:
number=0x43
v2193.ids.ClientboundTextureShiftPacket
ClientboundTextureShiftPacket:
number=0x150
v2193.ids.ClientboundUpdateSoundDataPacket
ClientboundUpdateSoundDataPacket:
number=0x15c
v2193.ids.ClientCacheBlobStatusPacket
ClientCacheBlobStatusPacket:
number=0x87
v2193.ids.ClientCacheMissResponsePacket
ClientCacheMissResponsePacket:
number=0x88
v2193.ids.ClientCacheStatusPacket
ClientCacheStatusPacket:
number=0x81
v2193.ids.ClientCameraAimAssistPacket
ClientCameraAimAssistPacket:
number=0x141
v2193.ids.ClientMovementPredictionSyncPacket
ClientMovementPredictionSyncPacket:
number=0x142
v2193.ids.ClientToServerHandshakePacket
ClientToServerHandshakePacket:
number=0x04
v2193.ids.CodeBuilderPacket
CodeBuilderPacket:
number=0x96
v2193.ids.CodeBuilderSourcePacket
CodeBuilderSourcePacket:
number=0xb2
v2193.ids.CommandBlockUpdatePacket
CommandBlockUpdatePacket:
number=0x4e
v2193.ids.CommandOutputPacket
CommandOutputPacket:
number=0x4f
v2193.ids.CommandRequestPacket
CommandRequestPacket:
number=0x4d
v2193.ids.CompletedUsingItemPacket
CompletedUsingItemPacket:
number=0x8e
v2193.ids.ContainerClosePacket
ContainerClosePacket:
number=0x2f
v2193.ids.ContainerOpenPacket
ContainerOpenPacket:
number=0x2e
v2193.ids.ContainerRegistryCleanupPacket
ContainerRegistryCleanupPacket:
number=0x13d
v2193.ids.ContainerSetDataPacket
ContainerSetDataPacket:
number=0x33
v2193.ids.CorrectPlayerMovePredictionPacket
CorrectPlayerMovePredictionPacket:
number=0xa1
v2193.ids.CraftingDataPacket
CraftingDataPacket:
number=0x34
v2193.ids.CreatePhotoPacket
CreatePhotoPacket:
number=0xab
v2193.ids.CreativeContentPacket
CreativeContentPacket:
number=0x91
v2193.ids.CurrentStructureFeaturePacket
CurrentStructureFeaturePacket:
number=0x13a
v2193.ids.DeathInfoPacket
DeathInfoPacket:
number=0xbd
v2193.ids.DebugInfoPacket
DebugInfoPacket:
number=0x9b
v2193.ids.DimensionDataPacket
DimensionDataPacket:
number=0xb4
v2193.ids.DisconnectPacket
DisconnectPacket:
number=0x05
v2193.ids.EditorNetworkPacket
EditorNetworkPacket:
number=0xbe
v2193.ids.EducationSettingsPacket
EducationSettingsPacket:
number=0x89
v2193.ids.EduUriResourcePacket
EduUriResourcePacket:
number=0xaa
v2193.ids.EmoteListPacket
EmoteListPacket:
number=0x98
v2193.ids.EmotePacket
EmotePacket:
number=0x8a
v2193.ids.FeatureRegistryPacket
FeatureRegistryPacket:
number=0xbf
v2193.ids.GameRulesChangedPacket
GameRulesChangedPacket:
number=0x48
v2193.ids.GameTestRequestPacket
GameTestRequestPacket:
number=0xc2
v2193.ids.GameTestResultsPacket
GameTestResultsPacket:
number=0xc3
v2193.ids.GraphicsOverrideParameterPacket
GraphicsOverrideParameterPacket:
number=0x14b
v2193.ids.GuiDataPickItemPacket
GuiDataPickItemPacket:
number=0x36
v2193.ids.HurtArmorPacket
HurtArmorPacket:
number=0x26
v2193.ids.InteractPacket
InteractPacket:
number=0x21
v2193.ids.InventoryContentPacket
InventoryContentPacket:
number=0x31
v2193.ids.InventorySlotPacket
InventorySlotPacket:
number=0x32
v2193.ids.InventoryTransactionPacket
InventoryTransactionPacket:
number=0x1e
v2193.ids.ItemRegistryPacket
ItemRegistryPacket:
number=0xa2
v2193.ids.ItemStackRequestPacket
ItemStackRequestPacket:
number=0x93
v2193.ids.ItemStackResponsePacket
ItemStackResponsePacket:
number=0x94
v2193.ids.JigsawStructureDataPacket
JigsawStructureDataPacket:
number=0x139
v2193.ids.LabTablePacket
LabTablePacket:
number=0x6d
v2193.ids.LecternUpdatePacket
LecternUpdatePacket:
number=0x7d
v2193.ids.LegacyTelemetryEventPacket
LegacyTelemetryEventPacket:
number=0x41
v2193.ids.LessonProgressPacket
LessonProgressPacket:
number=0xb7
v2193.ids.LevelChunkPacket
LevelChunkPacket:
number=0x3a
v2193.ids.LevelEventGenericPacket
LevelEventGenericPacket:
number=0x7c
v2193.ids.LevelEventPacket
LevelEventPacket:
number=0x19
v2193.ids.LevelSoundEventPacket
LevelSoundEventPacket:
number=0x7b
v2193.ids.LocatorBarPacket
LocatorBarPacket:
number=0x155
v2193.ids.LoginPacket
LoginPacket:
number=0x01
v2193.ids.MapCreateLockedCopyPacket
MapCreateLockedCopyPacket:
number=0x83
v2193.ids.MapInfoRequestPacket
MapInfoRequestPacket:
number=0x44
v2193.ids.MobArmorEquipmentPacket
MobArmorEquipmentPacket:
number=0x20
v2193.ids.MobEffectPacket
MobEffectPacket:
number=0x1c
v2193.ids.MobEquipmentPacket
MobEquipmentPacket:
number=0x1f
v2193.ids.ModalFormRequestPacket
ModalFormRequestPacket:
number=0x64
v2193.ids.ModalFormResponsePacket
ModalFormResponsePacket:
number=0x65
v2193.ids.MotionPredictionHintsPacket
MotionPredictionHintsPacket:
number=0x9d
v2193.ids.MoveActorAbsolutePacket
MoveActorAbsolutePacket:
number=0x12
v2193.ids.MoveActorDeltaPacket
MoveActorDeltaPacket:
number=0x6f
v2193.ids.MovementEffectPacket
MovementEffectPacket:
number=0x13e
v2193.ids.MovePlayerPacket
MovePlayerPacket:
number=0x13
v2193.ids.MultiplayerSettingsPacket
MultiplayerSettingsPacket:
number=0x8b
v2193.ids.NetworkChunkPublisherUpdatePacket
NetworkChunkPublisherUpdatePacket:
number=0x79
v2193.ids.NetworkSettingsPacket
NetworkSettingsPacket:
number=0x8f
v2193.ids.NetworkStackLatencyPacket
NetworkStackLatencyPacket:
number=0x73
v2193.ids.NpcDialoguePacket
NpcDialoguePacket:
number=0xa9
v2193.ids.NpcRequestPacket
NpcRequestPacket:
number=0x62
v2193.ids.OnScreenTextureAnimationPacket
OnScreenTextureAnimationPacket:
number=0x82
v2193.ids.OpenSignPacket
OpenSignPacket:
number=0x12f
v2193.ids.PacketViolationWarningPacket
PacketViolationWarningPacket:
number=0x9c
v2193.ids.PartyChangedPacket
PartyChangedPacket:
number=0x156
v2193.ids.PartyDestinationCookieResponsePacket
PartyDestinationCookieResponsePacket:
number=0x15e
v2193.ids.PhotoTransferPacket
PhotoTransferPacket:
number=0x63
v2193.ids.PlayerActionPacket
PlayerActionPacket:
number=0x24
v2193.ids.PlayerArmorDamagePacket
PlayerArmorDamagePacket:
number=0x95
v2193.ids.PlayerAuthInputPacket
PlayerAuthInputPacket:
number=0x90
v2193.ids.PlayerEnchantOptionsPacket
PlayerEnchantOptionsPacket:
number=0x92
v2193.ids.PlayerFogPacket
PlayerFogPacket:
number=0xa0
v2193.ids.PlayerHotbarPacket
PlayerHotbarPacket:
number=0x30
v2193.ids.PlayerListPacket
PlayerListPacket:
number=0x3f
v2193.ids.PlayerLocationPacket
PlayerLocationPacket:
number=0x146
v2193.ids.PlayerSkinPacket
PlayerSkinPacket:
number=0x5d
v2193.ids.PlayerStartItemCooldownPacket
PlayerStartItemCooldownPacket:
number=0xb0
v2193.ids.PlayerToggleCrafterSlotRequestPacket
PlayerToggleCrafterSlotRequestPacket:
number=0x132
v2193.ids.PlayerUpdateEntityOverridesPacket
PlayerUpdateEntityOverridesPacket:
number=0x145
v2193.ids.PlayerVideoCapturePacket
PlayerVideoCapturePacket:
number=0x144
v2193.ids.PlaySoundPacket
PlaySoundPacket:
number=0x56
v2193.ids.PlayStatusPacket
PlayStatusPacket:
number=0x02
v2193.ids.PositionTrackingDBClientRequestPacket
PositionTrackingDBClientRequestPacket:
number=0x9a
v2193.ids.PositionTrackingDBServerBroadcastPacket
PositionTrackingDBServerBroadcastPacket:
number=0x99
v2193.ids.PrimitiveShapesPacket
PrimitiveShapesPacket:
number=0x148
v2193.ids.PurchaseReceiptPacket
PurchaseReceiptPacket:
number=0x5c
v2193.ids.RecordStartedPacket
RecordStartedPacket:
number=0x160
v2193.ids.RefreshEntitlementsPacket
RefreshEntitlementsPacket:
number=0x131
v2193.ids.RemoveActorPacket
RemoveActorPacket:
number=0x0e
v2193.ids.RemoveObjectivePacket
RemoveObjectivePacket:
number=0x6a
v2193.ids.RemoveVolumeEntityPacket
RemoveVolumeEntityPacket:
number=0xa7
v2193.ids.RequestAbilityPacket
RequestAbilityPacket:
number=0xb8
v2193.ids.RequestChunkRadiusPacket
RequestChunkRadiusPacket:
number=0x45
v2193.ids.RequestNetworkSettingsPacket
RequestNetworkSettingsPacket:
number=0xc1
v2193.ids.RequestPermissionsPacket
RequestPermissionsPacket:
number=0xb9
v2193.ids.ResourcePackChunkDataPacket
ResourcePackChunkDataPacket:
number=0x53
v2193.ids.ResourcePackChunkRequestPacket
ResourcePackChunkRequestPacket:
number=0x54
v2193.ids.ResourcePackClientResponsePacket
ResourcePackClientResponsePacket:
number=0x08
v2193.ids.ResourcePackDataInfoPacket
ResourcePackDataInfoPacket:
number=0x52
v2193.ids.ResourcePacksInfoPacket
ResourcePacksInfoPacket:
number=0x06
v2193.ids.ResourcePacksReadyForValidationPacket
ResourcePacksReadyForValidationPacket:
number=0x154
v2193.ids.ResourcePackStackPacket
ResourcePackStackPacket:
number=0x07
v2193.ids.RespawnPacket
RespawnPacket:
number=0x2d
v2193.ids.ScriptMessagePacket
ScriptMessagePacket:
number=0xb1
v2193.ids.SendPartyDestinationCookiePacket
SendPartyDestinationCookiePacket:
number=0x15d
v2193.ids.ServerboundDataDrivenScreenClosedPacket
ServerboundDataDrivenScreenClosedPacket:
number=0x157
v2193.ids.ServerboundDataStorePacket
ServerboundDataStorePacket:
number=0x14c
v2193.ids.ServerboundDiagnosticsPacket
ServerboundDiagnosticsPacket:
number=0x13b
v2193.ids.ServerboundLoadingScreenPacket
ServerboundLoadingScreenPacket:
number=0x138
v2193.ids.ServerboundPackSettingChangePacket
ServerboundPackSettingChangePacket:
number=0x149
v2193.ids.ServerPlayerPostMovePositionPacket
ServerPlayerPostMovePositionPacket:
number=0x10
v2193.ids.ServerPresenceInfoPacket
ServerPresenceInfoPacket:
number=0x15b
v2193.ids.ServerSettingsRequestPacket
ServerSettingsRequestPacket:
number=0x66
v2193.ids.ServerSettingsResponsePacket
ServerSettingsResponsePacket:
number=0x67
v2193.ids.ServerStatsPacket
ServerStatsPacket:
number=0xc0
v2193.ids.ServerStoreInfoPacket
ServerStoreInfoPacket:
number=0x15a
v2193.ids.ServerToClientHandshakePacket
ServerToClientHandshakePacket:
number=0x03
v2193.ids.SetActorDataPacket
SetActorDataPacket:
number=0x27
v2193.ids.SetActorLinkPacket
SetActorLinkPacket:
number=0x29
v2193.ids.SetActorMotionPacket
SetActorMotionPacket:
number=0x28
v2193.ids.SetCommandsEnabledPacket
SetCommandsEnabledPacket:
number=0x3b
v2193.ids.SetDefaultGameTypePacket
SetDefaultGameTypePacket:
number=0x69
v2193.ids.SetDifficultyPacket
SetDifficultyPacket:
number=0x3c
v2193.ids.SetDisplayObjectivePacket
SetDisplayObjectivePacket:
number=0x6b
v2193.ids.SetHealthPacket
SetHealthPacket:
number=0x2a
v2193.ids.SetHudPacket
SetHudPacket:
number=0x134
v2193.ids.SetLastHurtByPacket
SetLastHurtByPacket:
number=0x60
v2193.ids.SetLocalPlayerAsInitializedPacket
SetLocalPlayerAsInitializedPacket:
number=0x71
v2193.ids.SetPlayerFurnaceOptionsPacket
SetPlayerFurnaceOptionsPacket:
number=0x15f
v2193.ids.SetPlayerGameTypePacket
SetPlayerGameTypePacket:
number=0x3e
v2193.ids.SetPlayerInventoryOptionsPacket
SetPlayerInventoryOptionsPacket:
number=0x133
v2193.ids.SetScoreboardIdentityPacket
SetScoreboardIdentityPacket:
number=0x70
v2193.ids.SetScorePacket
SetScorePacket:
number=0x6c
v2193.ids.SetSpawnPositionPacket
SetSpawnPositionPacket:
number=0x2b
v2193.ids.SetTimePacket
SetTimePacket:
number=0x0a
v2193.ids.SettingsCommandPacket
SettingsCommandPacket:
number=0x8c
v2193.ids.SetTitlePacket
SetTitlePacket:
number=0x58
v2193.ids.ShowCreditsPacket
ShowCreditsPacket:
number=0x4b
v2193.ids.ShowProfilePacket
ShowProfilePacket:
number=0x68
v2193.ids.ShowStoreOfferPacket
ShowStoreOfferPacket:
number=0x5b
v2193.ids.SimpleEventPacket
SimpleEventPacket:
number=0x40
v2193.ids.SimulationTypePacket
SimulationTypePacket:
number=0xa8
v2193.ids.SpawnExperienceOrbPacket
SpawnExperienceOrbPacket:
number=0x42
v2193.ids.SpawnParticleEffectPacket
SpawnParticleEffectPacket:
number=0x76
v2193.ids.StartGamePacket
StartGamePacket:
number=0x0b
v2193.ids.StopSoundPacket
StopSoundPacket:
number=0x57
v2193.ids.StructureBlockUpdatePacket
StructureBlockUpdatePacket:
number=0x5a
v2193.ids.StructureTemplateDataRequestPacket
StructureTemplateDataRequestPacket:
number=0x84
v2193.ids.StructureTemplateDataResponsePacket
StructureTemplateDataResponsePacket:
number=0x85
v2193.ids.SubChunkPacket
SubChunkPacket:
number=0xae
v2193.ids.SubChunkRequestPacket
SubChunkRequestPacket:
number=0xaf
v2193.ids.SubClientLoginPacket
SubClientLoginPacket:
number=0x5e
v2193.ids.SyncActorPropertyPacket
SyncActorPropertyPacket:
number=0xa5
v2193.ids.SyncWorldClocksPacket
SyncWorldClocksPacket:
number=0x158
v2193.ids.TakeItemActorPacket
TakeItemActorPacket:
number=0x11
v2193.ids.TextPacket
TextPacket:
number=0x09
v2193.ids.TickingAreasLoadStatusPacket
TickingAreasLoadStatusPacket:
number=0xb3
v2193.ids.ToastRequestPacket
ToastRequestPacket:
number=0xba
v2193.ids.TransferPacket
TransferPacket:
number=0x55
v2193.ids.TrimDataPacket
TrimDataPacket:
number=0x12e
v2193.ids.UnlockedRecipesPacket
UnlockedRecipesPacket:
number=0xc7
v2193.ids.UpdateAbilitiesPacket
UpdateAbilitiesPacket:
number=0xbb
v2193.ids.UpdateAdventureSettingsPacket
UpdateAdventureSettingsPacket:
number=0xbc
v2193.ids.UpdateAttributesPacket
UpdateAttributesPacket:
number=0x1d
v2193.ids.UpdateBlockPacket
UpdateBlockPacket:
number=0x15
v2193.ids.UpdateBlockSyncedPacket
UpdateBlockSyncedPacket:
number=0x6e
v2193.ids.UpdateClientInputLocksPacket
UpdateClientInputLocksPacket:
number=0xc4
v2193.ids.UpdateClientOptionsPacket
UpdateClientOptionsPacket:
number=0x143
v2193.ids.UpdateEquipPacket
UpdateEquipPacket:
number=0x51
v2193.ids.UpdatePlayerGameTypePacket
UpdatePlayerGameTypePacket:
number=0x97
v2193.ids.UpdateSoftEnumPacket
UpdateSoftEnumPacket:
number=0x72
v2193.ids.UpdateSubChunkBlocksPacket
UpdateSubChunkBlocksPacket:
number=0xac
v2193.ids.UpdateTradePacket
UpdateTradePacket:
number=0x50
v2193.ids.VoxelShapesPacket
VoxelShapesPacket:
number=0x151
v2193.minecraftVersions
readonlyminecraftVersions: readonlystring[] =minecraftVersions2193
v2193.protocolVersion
readonlyprotocolVersion:2193=protocolVersion2193
v2225
readonlyv2225:object
v2225.ids
readonlyids:Readonly<Record<string,number>> =packetIds2225
v2225.minecraftVersions
readonlyminecraftVersions: readonlystring[] =minecraftVersions2225
v2225.protocolVersion
readonlyprotocolVersion:2225=protocolVersion2225
SINCE_2207_SUB_CHUNK_RESULTS
constSINCE_2207_SUB_CHUNK_RESULTS:WireGate
Defined in: protocol/src/wire/wireGates.ts:45
Sub-chunk request result values moved up by one at protocol 2207.
SINCE_2225
constSINCE_2225:WireGate
Defined in: protocol/src/wire/wireGates.ts:42
Protocol 2225 (Minecraft 1.26.60) appended or inserted fields in eight packets; see docs/research/protocol-2225-delta.md for the per-packet evidence.
UNCOMPRESSED_BATCH
constUNCOMPRESSED_BATCH:255=0xff
Defined in: protocol/src/CompressionCodec.ts:19
"Not compressed", as a batch's prefix byte says it.
The same idea travels at two widths and they do not agree. NetworkSettings negotiates the algorithm in a two byte field, where none is 0xffff; every batch then repeats it in a single byte, where none is 0xff. Reading the byte straight into PacketCompressionAlgorithm therefore matches nothing and throws - which showed up as "Failed to inflate batched content" the moment a client sent its first uncompressed packet, a few packets into a login it had otherwise completed.
UNKNOWN_BLOCK_NAME
constUNKNOWN_BLOCK_NAME:"minecraft:unknown"='minecraft:unknown'
Defined in: protocol/src/BlockRuntimeId.ts:23
The name whose every state is UNKNOWN_RUNTIME_ID.
UNKNOWN_RUNTIME_ID
constUNKNOWN_RUNTIME_ID:-2=-2
Defined in: protocol/src/BlockRuntimeId.ts:20
The id vanilla reserves for a state it cannot resolve.
UNTIL_2225
constUNTIL_2225:WireGate
Defined in: protocol/src/wire/wireGates.ts:55
The other half of a layout change at 2225: the field as it travelled up to 2193, which 2225 replaced rather than merely extended. A moved or reshaped field is a gated pair, one field under this gate and its successor under SINCE_2225.
actorEventPacket
constactorEventPacket:PacketDefinition<{data:WireType<number>;event:WireType<number>;fireAtPosition:WireType<Vector3|null>;runtimeEntityId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/actors.ts:19
The ActorEventPacket field list.
Fire At Position is an optional, and its presence byte travels whether or not a position follows: a client that reads past the end of a packet drops the connection.
actorLinks
constactorLinks:WireType<ActorLink[]>
Defined in: protocol/src/wire/definitions/addActor.ts:85
ActorLink[]: a varuint count, then that many links.
actorPickRequestPacket
constactorPickRequestPacket:PacketDefinition<{actorId:WireType<bigint>;maxSlots:WireType<number>;withData:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/actorPickRequest.ts:11
The ActorPickRequestPacket field list.
addActorPacket
constaddActorPacket:PacketDefinition<{attributes:WireType<Attribute[]>;bodyYaw:WireType<number>;headYaw:WireType<number>;links:WireType<ActorLink[]>;metadata:WireType<Metadata>;motion:WireType<Vector3>;passengerOfBlock:GatedField<PassengerOfBlock|null>;pitch:WireType<number>;position:WireType<Vector3>;runtimeEntityId:WireType<bigint>;syncedProperties:WireType<SyncedProperties>;targetActorId:WireType<bigint>;type:WireType<string>;yaw:WireType<number>; }>
Defined in: protocol/src/wire/definitions/addActor.ts:105
The AddActorPacket field list; the module doc carries the wire provenance.
addBehaviorTreePacket
constaddBehaviorTreePacket:PacketDefinition<{behaviorTreeStructure:WireType<string>; }>
Defined in: protocol/src/wire/definitions/addBehaviorTree.ts:12
The AddBehaviorTreePacket field list.
addItemActorPacket
constaddItemActorPacket:PacketDefinition<{isFromFishing:WireType<boolean>;item:WireType<ItemStackDescriptorData>;metadata:WireType<Metadata>;motion:WireType<Vector3>;position:WireType<Vector3>;runtimeEntityId:WireType<bigint>;targetActorId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/addItemActor.ts:17
The fields sent when one dropped item actor enters a client's world.
addPlayerPacket
constaddPlayerPacket:PacketDefinition<{abilities:WireType<SerializedAbilitiesData>;buildPlatform:WireType<number>;carriedItem:WireType<ItemStackDescriptorData>;deviceId:WireType<string>;gamemode:WireType<number>;headYaw:WireType<number>;links:WireType<ActorLink[]>;metadata:WireType<Metadata>;motion:WireType<Vector3>;name:WireType<string>;passengerOfBlock:GatedField<PassengerOfBlock|null>;pitch:WireType<number>;platformChatId:WireType<string>;position:WireType<Vector3>;runtimeEntityId:WireType<bigint>;syncedProperties:WireType<SyncedProperties>;uuid:WireType<UUID>;yaw:WireType<number>; }>
Defined in: protocol/src/wire/definitions/addPlayer.ts:86
The AddPlayerPacket field list; the module doc carries the wire provenance.
agentActionEventPacket
constagentActionEventPacket:PacketDefinition<{action:WireType<number>;requestId:WireType<string>;response:WireType<string>; }>
Defined in: protocol/src/wire/definitions/agentActionEvent.ts:8
The AgentActionEventPacket field list.
agentAnimationPacket
constagentAnimationPacket:PacketDefinition<{animation:WireType<number>;runtimeId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/agentAnimation.ts:11
The AgentAnimationPacket field list.
animateEntityPacket
constanimateEntityPacket:PacketDefinition<{animation:WireType<string>;blendOutTime:WireType<number>;controller:WireType<string>;nextState:WireType<string>;runtimeIds:WireType<bigint[]>;stopExpression:WireType<string>;stopExpressionVersion:WireType<number>; }>
Defined in: protocol/src/wire/definitions/animateEntity.ts:10
The AnimateEntityPacket field list.
animatePacket
constanimatePacket:PacketDefinition<{action:WireType<number>;data:WireType<number>;hand:GatedField<number>;runtimeEntityId:WireType<bigint>;swingSource:WireType<string|null>; }>
Defined in: protocol/src/wire/definitions/animate.ts:40
The AnimatePacket field list; the module doc carries the wire provenance.
automationClientConnectPacket
constautomationClientConnectPacket:PacketDefinition<{websocketServerUri:WireType<string>; }>
Defined in: protocol/src/wire/definitions/automationClientConnect.ts:12
The AutomationClientConnectPacket field list.
availableActorIdentifiersPacket
constavailableActorIdentifiersPacket:PacketDefinition<{identifiers:WireType<Buffer<ArrayBufferLike>>; }>
Defined in: protocol/src/wire/definitions/availableActorIdentifiers.ts:23
The AvailableActorIdentifiersPacket field list: every actor type the client may be asked to render, sent once at world start.
biomeDefinitionListPacket
constbiomeDefinitionListPacket:PacketDefinition<{definitions:WireType<Buffer<ArrayBufferLike>>; }>
Defined in: protocol/src/wire/definitions/biomeDefinitionList.ts:25
The BiomeDefinitionListPacket field list: every biome the client can render. A client that reaches the world-generation screen with an empty list disconnects.
blockActorDataPacket
constblockActorDataPacket:PacketDefinition<{actorDataTags:WireType<NBTTagCompound>;position:WireType<Vec3Like>; }>
Defined in: protocol/src/wire/definitions/blocks.ts:59
The BlockActorDataPacket field list.
bossEventPacket
constbossEventPacket:PacketDefinition<{color:WireType<number>;eventType:WireType<number>;filteredName:WireType<string>;healthPercent:WireType<number>;name:WireType<string>;overlay:WireType<number>;targetActorId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/bossEvent.ts:19
The BossEventPacket field list.
Every field travels whatever the Event Type is. Up to protocol 2192 the packet also carried a Player ID between the target and the event type, and only wrote the fields the event type used. A reader that still expects that layout takes the event type for the first byte of a ZigZag Player ID and misreads the rest of the packet.
byteRotation
constbyteRotation:WireType<number>
Defined in: protocol/src/wire/definitions/movement.ts:37
An angle as the single byte the movement packets carry it in.
The wire unit is a 256th of a turn, so the conversion is lossy in both directions, and the rounding and the mask are load-bearing: angles accumulate freely either side of [0, 360) and the raw division would hand writeByte a fraction or a number out of range.
cameraAimAssistPresetsPacket
constcameraAimAssistPresetsPacket:PacketDefinition<{categories:WireType<CameraAimAssistCategoryDefinition[]>;operation:WireType<number>;presets:WireType<CameraAimAssistPresetDefinition[]>; }>
Defined in: protocol/src/wire/definitions/cameraAimAssistPresets.ts:37
The CameraAimAssistPresetsPacket field list: the categories and presets that fill or extend the client's aim assist registry. The packet class's doc carries the note on the docs' swapped field labels.
cameraPacket
constcameraPacket:PacketDefinition<{cameraId:WireType<bigint>;targetPlayerId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/camera.ts:11
The CameraPacket field list.
cameraPresetsPacket
constcameraPresetsPacket:PacketDefinition<{cameraPresets:WireType<CameraPresetData[]>; }>
Defined in: protocol/src/wire/definitions/cameraPresets.ts:27
The CameraPresetsPacket field list: the camera presets a client may switch to. A set instruction's preset is an index into the list, so the order matters.
cameraShakePacket
constcameraShakePacket:PacketDefinition<{intensity:WireType<number>;seconds:WireType<number>;shakeAction:WireType<number>;shakeType:WireType<number>; }>
Defined in: protocol/src/wire/definitions/cameraShake.ts:11
The CameraShakePacket field list.
cameraSplinePacket
constcameraSplinePacket:PacketDefinition<{splines:WireType<SplineDefinition[]>; }>
Defined in: protocol/src/wire/definitions/cameraSpline.ts:93
The CameraSplinePacket field list.
changeDimensionPacket
constchangeDimensionPacket:PacketDefinition<{dimension:WireType<number>;loadingScreenId:WireType<number|null>;position:WireType<Vector3>;respawn:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:63
The ChangeDimensionPacket field list.
The 1.26.51 schema lists Loading Screen Id as required and draws it as a plain uint32, but its own description says to leave it empty when no screen is expected, and gophertunnel at protocol 2193 writes the presence byte this optional writes.
changeMobPropertyPacket
constchangeMobPropertyPacket:PacketDefinition<{actorUniqueId:WireType<bigint>;boolValue:WireType<boolean>;floatValue:WireType<number>;intValue:WireType<number>;propertyName:WireType<string>;stringValue:WireType<string>; }>
Defined in: protocol/src/wire/definitions/changeMobProperty.ts:12
The ChangeMobPropertyPacket field list.
chunkRadiusUpdatedPacket
constchunkRadiusUpdatedPacket:PacketDefinition<{radius:WireType<number>; }>
Defined in: protocol/src/wire/definitions/chunkRadiusUpdated.ts:12
The ChunkRadiusUpdatedPacket field list.
clientCacheStatusPacket
constclientCacheStatusPacket:PacketDefinition<{enabled:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/clientCache.ts:12
The ClientCacheStatusPacket field list.
clientCameraAimAssistPacket
constclientCameraAimAssistPacket:PacketDefinition<{action:WireType<number>;allowAimAssist:WireType<boolean>;cameraPresetId:WireType<string>; }>
Defined in: protocol/src/wire/definitions/clientCameraAimAssist.ts:12
The ClientCameraAimAssistPacket field list.
clientToServerHandshakePacket
constclientToServerHandshakePacket:PacketDefinition<{ }>
Defined in: protocol/src/wire/definitions/clientToServerHandshake.ts:18
The ClientToServerHandshakePacket field list: empty.
The client's answer to ServerToClientHandshake says only that the client derived the key and turned encryption on, so it carries its meaning by arriving readable rather than by its contents. The empty list is still a definition so the registry accounts for the packet and the round-trip suite holds it to writing no bytes: a field appearing here would leave the first encrypted batch a byte long.
clientboundMatchmakingStatePacket
constclientboundMatchmakingStatePacket:PacketDefinition<{destinationName:WireType<string>;options:WireType<MatchmakingStateOptions|null>;state:WireType<number>; }>
Defined in: protocol/src/wire/definitions/added2225.ts:164
The ClientboundMatchmakingStatePacket field list.
clientboundPlayAudioContentPacket
constclientboundPlayAudioContentPacket:PacketDefinition<{playbackContent:WireType<SignedAudioContent>;playbackType:WireType<number>;playSound:WireType<PlaySoundPayload>;sharedMetadata:WireType<SignedAudioContent>; }>
Defined in: protocol/src/wire/definitions/added2225.ts:209
The ClientboundPlayAudioContentPacket field list.
clientboundStonecutterSetRecipePacket
constclientboundStonecutterSetRecipePacket:PacketDefinition<{containerId:WireType<number>;playerId:WireType<bigint>;recipeIndex:WireType<number>; }>
Defined in: protocol/src/wire/definitions/added2225.ts:185
The ClientboundStonecutterSetRecipePacket field list.
codeBuilderPacket
constcodeBuilderPacket:PacketDefinition<{shouldOpenCodeBuilder:WireType<boolean>;url:WireType<string>; }>
Defined in: protocol/src/wire/definitions/codeBuilder.ts:12
The CodeBuilderPacket field list.
codeBuilderSourcePacket
constcodeBuilderSourcePacket:PacketDefinition<{category:WireType<number>;codeStatus:WireType<number>;operation:WireType<number>; }>
Defined in: protocol/src/wire/definitions/codeBuilderSource.ts:11
The CodeBuilderSourcePacket field list.
commandOutputMessage
constcommandOutputMessage:WireType<CommandOutputMessage>
Defined in: protocol/src/wire/definitions/commands.ts:91
CommandOutputMessage: the message id, whether it succeeded, and its placeholder values.
commandOutputPacket
constcommandOutputPacket:PacketDefinition<{dataSet:WireType<string|null>;originData:WireType<CommandOriginData>;outputMessages:WireType<CommandOutputMessage[]>;outputType:WireType<CommandOutputType>;successCount:WireType<number>; }>
Defined in: protocol/src/wire/definitions/commands.ts:112
The CommandOutputPacket field list.
A command may come from a websocket server or a command block rather than from the player, so the reply repeats the CommandOriginData of the request instead of assuming the chat window.
commandOutputType
constcommandOutputType:WireType<CommandOutputType>
Defined in: protocol/src/wire/definitions/commands.ts:67
Output Type: the enum's member name as a string, not its number.
A name this server does not know reads as None, which is what the hand-written decoder did: an unknown output type is not worth dropping a connection over.
commandRequestPacket
constcommandRequestPacket:PacketDefinition<{commandName:WireType<string>;commandOriginData:WireType<CommandOriginData>;internal:WireType<boolean>;version:WireType<string>; }>
Defined in: protocol/src/wire/definitions/commands.ts:19
The CommandRequestPacket field list.
Version refers to the CurrentCmdVersion enum, which the schema gives no Enum-as-Value option, so the member name travels rather than its number.
completedUsingItemPacket
constcompletedUsingItemPacket:PacketDefinition<{itemId:WireType<number>;itemUseMethod:WireType<number>; }>
Defined in: protocol/src/wire/definitions/completedUsingItem.ts:12
The CompletedUsingItemPacket field list.
containerClosePacket
constcontainerClosePacket:PacketDefinition<{containerId:WireType<number>;containerType:WireType<number>;serverInitiatedClose:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/containers.ts:79
The ContainerClosePacket field list.
containerOpenPacket
constcontainerOpenPacket:PacketDefinition<{containerEntityId:WireType<bigint>;containerType:WireType<number>;position:WireType<Vec3Like>;windowId:WireType<number>; }>
Defined in: protocol/src/wire/definitions/containers.ts:46
The ContainerOpenPacket field list.
containerSetDataPacket
constcontainerSetDataPacket:PacketDefinition<{containerId:WireType<number>;id:WireType<number>;value:WireType<number>; }>
Defined in: protocol/src/wire/definitions/containers.ts:66
The ContainerSetDataPacket field list.
The same ID means a different property in each kind of container, so the client reads it against whatever Container ID currently has open.
createPhotoPacket
constcreatePhotoPacket:PacketDefinition<{photoItemName:WireType<string>;photoName:WireType<string>;rawId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/createPhoto.ts:11
The CreatePhotoPacket field list.
currentStructureFeaturePacket
constcurrentStructureFeaturePacket:PacketDefinition<{currentStructureFeature:WireType<string>; }>
Defined in: protocol/src/wire/definitions/currentStructureFeature.ts:12
The CurrentStructureFeaturePacket field list.
debugInfoPacket
constdebugInfoPacket:PacketDefinition<{actorId:WireType<bigint>;data:WireType<string>; }>
Defined in: protocol/src/wire/definitions/debugInfo.ts:11
The DebugInfoPacket field list.
dimensionDefinition
constdimensionDefinition:PacketDefinition<{cloudHeight:GatedField<number>;defaultBiome:WireType<string>;dimensionType:WireType<number>;generatorType:WireType<number>;heightRange:WireType<number>;minimumY:WireType<number>;packId:WireType<UUID>;renderClouds:GatedField<boolean>; }>
Defined in: protocol/src/wire/structures/DimensionDefinition.ts:32
The DimensionDefinition field list; the module doc carries the wire provenance.
disconnectPacket
constdisconnectPacket:PacketDefinition<{messages:WireType<DisconnectMessages>;reason:WireType<number>; }>
Defined in: protocol/src/wire/definitions/disconnect.ts:51
The DisconnectPacket field list.
editorNetworkPacket
consteditorNetworkPacket:PacketDefinition<{rawVariantData:WireType<string>;rawVariantName:WireType<string>;routeToManager:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/editorNetwork.ts:12
The EditorNetworkPacket field list.
emotePacket
constemotePacket:PacketDefinition<{actorRuntimeId:WireType<bigint>;emoteId:WireType<string>;emoteLengthTicks:WireType<number>;flags:WireType<number>;platformId:WireType<string>;xuid:WireType<string>; }>
Defined in: protocol/src/wire/definitions/player.ts:72
The EmotePacket field list.
Sent by a client to play an emote and by the server to show one on another player. The Flags byte carries the server-side and mute-chat bits.
fullContainerName
constfullContainerName:WireType<FullContainerNameData>
Defined in: protocol/src/wire/definitions/containers.ts:36
FullContainerName: the container name byte, then an optional dynamic id.
Whether the dynamic id travels is decided by the container, not by the protocol version, so the branch lives in this wire type's reader and writer rather than in a gate. The two inventory packets differ in how they carry this - one behind its own presence byte, one not - which is why it is a named type rather than two inline fields.
gameRulesChangedPacket
constgameRulesChangedPacket:PacketDefinition<{rulesList:WireType<GameRule[]>; }>
Defined in: protocol/src/wire/definitions/gameRulesChanged.ts:25
The GameRulesChangedPacket field list; the class doc carries the wire provenance.
gameTestResultsPacket
constgameTestResultsPacket:PacketDefinition<{error:WireType<string>;succeeded:WireType<boolean>;testName:WireType<string>; }>
Defined in: protocol/src/wire/definitions/gameTestResults.ts:11
The GameTestResultsPacket field list.
guiDataPickItemPacket
constguiDataPickItemPacket:PacketDefinition<{itemEffectName:WireType<string>;itemName:WireType<string>;slot:WireType<number>; }>
Defined in: protocol/src/wire/definitions/guiDataPickItem.ts:12
The GuiDataPickItemPacket field list.
hurtArmorPacket
consthurtArmorPacket:PacketDefinition<{armorSlots:WireType<bigint>;cause:WireType<number>;damage:WireType<number>; }>
Defined in: protocol/src/wire/definitions/hurtArmor.ts:12
The HurtArmorPacket field list.
interactPacket
constinteractPacket:PacketDefinition<{action:WireType<number>;position:WireType<Vector3|null>;target:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/interaction.ts:18
The InteractPacket field list.
Position is an optional: a presence byte, then three little-endian floats when set. Only the mouse-over and the leave-vehicle actions carry one.
inventoryContentPacket
constinventoryContentPacket:PacketDefinition<{fullContainerName:WireType<FullContainerNameData>;slots:WireType<ItemStackDescriptorData[]>;storageItem:WireType<ItemStackDescriptorData>;windowId:WireType<number>; }>
Defined in: protocol/src/wire/definitions/containers.ts:144
The InventoryContentPacket field list.
There is no slot index on a slot: position in the list is the slot, so every slot travels, empty or not. Neither Full Container Name nor Storage Item is an optional here, unlike in InventorySlotPacket.
inventorySlotPacket
constinventorySlotPacket:PacketDefinition<{fullContainerName:WireType<FullContainerNameData|null>;inventorySlot:WireType<number>;item:WireType<ItemStackDescriptorData>;storageItem:WireType<ItemStackDescriptorData|null>;windowId:WireType<number>; }>
Defined in: protocol/src/wire/definitions/containers.ts:121
The InventorySlotPacket field list.
Container Id and Slot are varuint32s, not the uint8 the docs page types the first as: gophertunnel's inventory_slot.go and PocketMine both read a varuint here. Full Container Name and Storage Item are each an optional; Item is not, and an emptied slot travels as a whole empty stack rather than a bare zero.
inventoryTransactionPacket
constinventoryTransactionPacket:PacketDefinition<{legacyRequest:WireType<LegacyTransactionRequest>;transaction:GatedField<TransactionPayload<ItemStackDescriptorData> |null>;transactionWithHand:GatedField<TransactionPayload<ItemStackDescriptorData> |null>; }>
Defined in: protocol/src/wire/definitions/inventoryTransaction.ts:190
The InventoryTransactionPacket field list; the module doc carries the wire provenance.
jigsawStructureDataPacket
constjigsawStructureDataPacket:PacketDefinition<{structureData:WireType<Buffer<ArrayBufferLike>>; }>
Defined in: protocol/src/wire/definitions/jigsawStructureData.ts:24
The JigsawStructureDataPacket field list: the jigsaw structure rules, which the client wants before StartGamePacket or it disconnects with MissingStructureData.
lessonProgressPacket
constlessonProgressPacket:PacketDefinition<{action:WireType<number>;activityId:WireType<string>;score:WireType<number>; }>
Defined in: protocol/src/wire/definitions/lessonProgress.ts:11
The LessonProgressPacket field list.
levelChunkPacket
constlevelChunkPacket:PacketDefinition<{cacheBlobIds:WireType<bigint[]>;cacheEnabled:WireType<boolean>;chunkX:WireType<number>;chunkZ:WireType<number>;data:WireType<Buffer<ArrayBufferLike>>;dimension:WireType<number>;isClientBiomeUpdate:GatedField<boolean>;subChunkRequest:WireType<SubChunkRequestMode>; }>
Defined in: protocol/src/wire/definitions/levelChunk.ts:56
The LevelChunkPacket field list; the module doc carries the wire provenance.
levelEventGenericPacket
constlevelEventGenericPacket:PacketDefinition<{eventId:WireType<number>;serializedEventData:WireType<Buffer<ArrayBufferLike>>; }>
Defined in: protocol/src/wire/definitions/levelEventGeneric.ts:28
The LevelEventGenericPacket field list: a level event whose payload is too large for LevelEventPacket's single position and data word. Every event's data carries originX, originY and originZ, which stand in for the position field this packet does not have.
levelSoundEventPacket
constlevelSoundEventPacket:PacketDefinition<{disableRelativeVolume:WireType<boolean>;entityType:WireType<string>;entityUniqueId:WireType<bigint>;extraData:WireType<number>;fireAtPosition:WireType<Vec3Like|null>;isBabyMob:WireType<boolean>;position:WireType<Vec3Like>;soundName:WireType<string>; }>
Defined in: protocol/src/wire/definitions/levelSoundEvent.ts:72
The LevelSoundEventPacket field list.
Sound Event is the tagged SoundEventIdentifier variant Mojang's 1.26.51 notes describe, either a LevelSoundEvent member or a free sound name. The metadata types it as one string and nothing precedes it: the enum member travels as its name (step, break), so a reader cannot tell the two alternatives apart and does not need to.
The docs page types Fire At Position as a plain Vec3 at 2193 and records the optional from 2207 on. Clients have read a presence byte there since 1.21.70, gophertunnel and PocketMine both write one, and the 2207 entry is the metadata catching up. A bare Vec3 here would hand the client eleven bytes it does not expect.
mapCreateLockedCopyPacket
constmapCreateLockedCopyPacket:PacketDefinition<{newMapId:WireType<bigint>;originalMapId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/mapCreateLockedCopy.ts:11
The MapCreateLockedCopyPacket field list.
mobEffectPacket
constmobEffectPacket:PacketDefinition<{ambient:WireType<boolean>;effectAmplifier:WireType<number>;effectDurationTicks:WireType<number>;effectId:WireType<number>;eventId:WireType<number>;showParticles:WireType<boolean>;targetRuntimeId:WireType<bigint>;tick:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/actors.ts:74
The MobEffectPacket field list.
Every field travels whatever the Event ID is: a Remove carries the amplifier and the duration it is dropping, not a shortened body.
mobEquipmentPacket
constmobEquipmentPacket:PacketDefinition<{hotbarSlot:WireType<number>;inventorySlot:WireType<number>;item:WireType<ItemStackDescriptorData>;runtimeEntityId:WireType<bigint>;windowId:WireType<number>; }>
Defined in: protocol/src/wire/definitions/containers.ts:97
The MobEquipmentPacket field list.
An empty hand is an air stack, not an omission: the descriptor carries its fixed set of fields whatever the id is.
modalFormRequestPacket
constmodalFormRequestPacket:PacketDefinition<{formId:WireType<number>;formUiJson:WireType<string>; }>
Defined in: protocol/src/wire/definitions/forms.ts:12
The ModalFormRequestPacket field list.
modalFormResponsePacket
constmodalFormResponsePacket:PacketDefinition<{formCancelReason:WireType<number|null>;formId:WireType<number>;jsonResponse:WireType<string|null>; }>
Defined in: protocol/src/wire/definitions/forms.ts:30
The ModalFormResponsePacket field list.
A submitted form carries the JSON and no reason; a dismissed one carries the reason and no JSON. The 1.26.51 metadata lists both as plain required fields, but the client has written each behind a presence byte since 1.19.30, and the 1.26.60 preview changelog marks them optional. The presence bytes are what a real client sends.
moveActorAbsolutePacket
constmoveActorAbsolutePacket:PacketDefinition<{flags:WireType<number>;headYaw:WireType<number>;pitch:WireType<number>;position:WireType<Vector3>;runtimeEntityId:WireType<bigint>;yaw:WireType<number>; }>
Defined in: protocol/src/wire/definitions/movement.ts:71
The MoveActorAbsolutePacket field list, one MoveActorAbsoluteData.
movePlayerPacket
constmovePlayerPacket:PacketDefinition<{headYaw:WireType<number>;mode:WireType<number>;onGround:WireType<boolean>;pitch:WireType<number>;position:WireType<Vector3>;ridingEntityRuntimeId:WireType<bigint>;runtimeEntityId:WireType<bigint>;teleportData:WireType<TeleportData|null>;tick:WireType<bigint>;yaw:WireType<number>; }>
Defined in: protocol/src/wire/definitions/movement.ts:44
The MovePlayerPacket field list.
multiplayerSettingsPacket
constmultiplayerSettingsPacket:PacketDefinition<{packetType:WireType<number>; }>
Defined in: protocol/src/wire/definitions/multiplayerSettings.ts:12
The MultiplayerSettingsPacket field list.
networkChunkPublisherUpdatePacket
constnetworkChunkPublisherUpdatePacket:PacketDefinition<{position:WireType<Vec3Like>;radius:WireType<number>;savedChunks:WireType<Record<string,number>[]>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:85
The NetworkChunkPublisherUpdatePacket field list.
networkNbtCompound
constnetworkNbtCompound:WireType<NBTTagCompound>
Defined in: protocol/src/wire/definitions/blocks.ts:29
One network NBT compound: little endian with varint lengths, under an empty root name.
The root name is written empty whatever the compound calls itself, because a vanilla compound has no name of its own and one loaded from a world file may carry one.
networkSettingsPacket
constnetworkSettingsPacket:PacketDefinition<{clientThrottleScalar:WireType<number>;clientThrottleThreshold:WireType<number>;clientThrottlingEnabled:WireType<boolean>;compressionAlgorithm:WireType<number>;compressionThreshold:WireType<number>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:95
The NetworkSettingsPacket field list.
networkStackLatencyPacket
constnetworkStackLatencyPacket:PacketDefinition<{creationTime:WireType<bigint>;isFromServer:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/networkStackLatency.ts:11
The NetworkStackLatencyPacket field list.
npcDialoguePacket
constnpcDialoguePacket:PacketDefinition<{actionJson:WireType<string>;actionType:WireType<number>;dialogue:WireType<string>;npcId:WireType<bigint>;npcName:WireType<string>;sceneName:WireType<string>; }>
Defined in: protocol/src/wire/definitions/npcDialogue.ts:11
The NpcDialoguePacket field list.
npcRequestPacket
constnpcRequestPacket:PacketDefinition<{actionIndex:WireType<number>;actions:WireType<string>;npcRuntimeId:WireType<bigint>;requestType:WireType<number>;sceneName:WireType<string>; }>
Defined in: protocol/src/wire/definitions/npcRequest.ts:11
The NpcRequestPacket field list.
onScreenTextureAnimationPacket
constonScreenTextureAnimationPacket:PacketDefinition<{animationType:WireType<number>; }>
Defined in: protocol/src/wire/definitions/effects.ts:20
The OnScreenTextureAnimationPacket field list: a full-screen texture animation, such as the flash when a totem of undying fires.
Effect Id is a little-endian uint32 rather than a varint, and it is the whole payload.
packetViolationWarningPacket
constpacketViolationWarningPacket:PacketDefinition<{message:WireType<string>;packetId:WireType<number>;severity:WireType<number>;type:WireType<number>; }>
Defined in: protocol/src/wire/definitions/packetViolationWarning.ts:11
The PacketViolationWarningPacket field list.
partyDestinationCookieResponsePacket
constpartyDestinationCookieResponsePacket:PacketDefinition<{accepted:WireType<boolean>;cookie:WireType<string>; }>
Defined in: protocol/src/wire/definitions/partyDestinationCookieResponse.ts:11
The PartyDestinationCookieResponsePacket field list.
playSoundPacket
constplaySoundPacket:PacketDefinition<{bypassListenerRangeCheck:WireType<boolean>;loopCount:WireType<number>;name:WireType<string>;pitch:WireType<number>;playbackPositionSeconds:WireType<number|null>;position:WireType<Vec3Like>;soundHandle:WireType<bigint|null>;volume:WireType<number>; }>
Defined in: protocol/src/wire/definitions/levelSoundEvent.ts:37
The PlaySoundPacket field list.
The position is a block coordinate triple multiplied by eight before writing. This lets the packet place sound at eighth-block precision, but decoding floors the values back to blocks.
playStatusPacket
constplayStatusPacket:PacketDefinition<{status:WireType<number>; }>
Defined in: protocol/src/wire/definitions/playStatus.ts:14
The PlayStatusPacket field list.
playerActionPacket
constplayerActionPacket:PacketDefinition<{action:WireType<number>;blockFace:WireType<number>;blockPosition:WireType<Vec3Like>;resultPosition:WireType<Vec3Like>;runtimeEntityId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/player.ts:18
The PlayerActionPacket field list.
Both positions are BlockPos, three ZigZag varints with a signed y. The y used to be unsigned on the way up from the client, and has not been since 1.26.10: read unsigned, a ZigZag y comes out doubled and anything below sea level as a number in the billions.
playerFogPacket
constplayerFogPacket:PacketDefinition<{fogStack:WireType<string[]>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:123
The PlayerFogPacket field list.
playerHotbarPacket
constplayerHotbarPacket:PacketDefinition<{containerId:WireType<number>;selectedSlot:WireType<number>;shouldSelectSlot:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:75
The PlayerHotbarPacket field list.
playerListPacket
constplayerListPacket:PacketDefinition<{bodyWithPlayFabIdInSkin:GatedField<PlayerListBody|null>;bodyWithPlayFabIdOnEntry:GatedField<PlayerListBody|null>; }>
Defined in: protocol/src/wire/definitions/playerList.ts:106
The PlayerListPacket field list; the module doc carries the wire provenance.
playerSkinPacket
constplayerSkinPacket:PacketDefinition<{newSkinName:WireType<string>;oldSkinName:WireType<string>;skinCarryingPlayFabId:GatedField<Skin|null>;skinWithoutPlayFabId:GatedField<Skin|null>;uuid:WireType<UUID>; }>
Defined in: protocol/src/wire/definitions/playerSkin.ts:22
The PlayerSkinPacket field list; the module doc carries the wire provenance.
playerStartItemCooldownPacket
constplayerStartItemCooldownPacket:PacketDefinition<{durationTicks:WireType<number>;itemCategory:WireType<string>; }>
Defined in: protocol/src/wire/definitions/playerStartItemCooldown.ts:10
The PlayerStartItemCooldownPacket field list.
playerToggleCrafterSlotRequestPacket
constplayerToggleCrafterSlotRequestPacket:PacketDefinition<{isDisabled:WireType<boolean>;posX:WireType<number>;posY:WireType<number>;posZ:WireType<number>;slotIndex:WireType<number>; }>
Defined in: protocol/src/wire/definitions/playerToggleCrafterSlotRequest.ts:12
The PlayerToggleCrafterSlotRequestPacket field list.
positionTrackingDBClientRequestPacket
constpositionTrackingDBClientRequestPacket:PacketDefinition<{action:WireType<number>;id:WireType<number>; }>
Defined in: protocol/src/wire/definitions/positionTrackingDBClientRequest.ts:11
The PositionTrackingDBClientRequestPacket field list.
removeActorPacket
constremoveActorPacket:PacketDefinition<{uniqueEntityId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/actors.ts:34
The RemoveActorPacket field list.
removeObjectivePacket
constremoveObjectivePacket:PacketDefinition<{objectiveName:WireType<string>; }>
Defined in: protocol/src/wire/definitions/scoreboard.ts:175
The RemoveObjectivePacket field list.
The client drops the objective and every score filed under it, so this undoes a SetDisplayObjectivePacket and the SetScorePacket entries that followed it.
removeVolumeEntityPacket
constremoveVolumeEntityPacket:PacketDefinition<{dimension:WireType<number>;entityNetworkId:WireType<number>; }>
Defined in: protocol/src/wire/definitions/removeVolumeEntity.ts:11
The RemoveVolumeEntityPacket field list.
requestAbilityPacket
constrequestAbilityPacket:PacketDefinition<{ability:WireType<number>;boolValue:WireType<boolean>;floatValue:WireType<number>;valueType:WireType<number>; }>
Defined in: protocol/src/wire/definitions/requestAbility.ts:12
The RequestAbilityPacket field list.
requestChunkRadiusPacket
constrequestChunkRadiusPacket:PacketDefinition<{maxRadius:WireType<number>;radius:WireType<number>; }>
Defined in: protocol/src/wire/definitions/chunkRadiusUpdated.ts:26
The RequestChunkRadiusPacket field list.
A retail client discards every LevelChunk that arrives before the server's answer, so the answer has to come before the chunks.
requestNetworkSettingsPacket
constrequestNetworkSettingsPacket:PacketDefinition<{protocolVersion:WireType<number>; }>
Defined in: protocol/src/wire/definitions/networkSettings.ts:18
The RequestNetworkSettingsPacket field list.
ClientNetworkVersion is a big endian int32, not a varint, on purpose: a server speaking another protocol still has to read it so it can refuse the connection with the right PlayStatus. Mojang's page says nothing else may be added here.
requestPermissionsPacket
constrequestPermissionsPacket:PacketDefinition<{customPermissionFlags:WireType<number>;playerPermissionLevel:WireType<number>;targetPlayerUniqueId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/requestPermissions.ts:12
The RequestPermissionsPacket field list.
resourcePackChunkDataPacket
constresourcePackChunkDataPacket:PacketDefinition<{byteOffset:WireType<bigint>;chunkData:WireType<Buffer<ArrayBufferLike>>;chunkId:WireType<number>;resourceName:WireType<string>; }>
Defined in: protocol/src/wire/definitions/resourcePacks.ts:136
The ResourcePackChunkDataPacket field list.
The chunk may be no larger than the Chunk Size announced in ResourcePackDataInfoPacket.
resourcePackChunkRequestPacket
constresourcePackChunkRequestPacket:PacketDefinition<{chunk:WireType<number>;resourceName:WireType<string>; }>
Defined in: protocol/src/wire/definitions/resourcePacks.ts:124
The ResourcePackChunkRequestPacket field list.
Chunk is a signed int32, not a varint: a chunk index travels as four fixed bytes.
resourcePackClientResponsePacket
constresourcePackClientResponsePacket:PacketDefinition<{response:WireType<ResourcePackResponseData>; }>
Defined in: protocol/src/wire/definitions/resourcePacks.ts:252
The ResourcePackClientResponsePacket field list: one field, Response.
The schema types Response Type as an int8 and caps Downloading Packs at 65535 entries, which reads like a one byte status and a uint16 count. That is the layout before protocol 2193. Since the Cereal conversion the bytes are the ones above: a 1.26.51 client's DownloadingFinished is 02 13 followed by the 19 bytes of downloadingfinished, and gophertunnel at protocol 2193 writes the same. Until protocol 748 the list was written after every alternative; a real server reads the two stray bytes as the next packet.
resourcePackDataInfoPacket
constresourcePackDataInfoPacket:PacketDefinition<{chunkSize:WireType<number>;fileHash:WireType<Buffer<ArrayBufferLike>>;fileSize:WireType<bigint>;isPremiumPack:WireType<boolean>;numberOfChunks:WireType<number>;packType:WireType<number>;resourceName:WireType<string>; }>
Defined in: protocol/src/wire/definitions/resourcePacks.ts:153
The ResourcePackDataInfoPacket field list.
The client answers with one ResourcePackChunkRequestPacket per chunk, and the server replies to each with a ResourcePackChunkDataPacket.
resourcePackResponse
constresourcePackResponse:WireType<ResourcePackResponseData>
Defined in: protocol/src/wire/definitions/resourcePacks.ts:204
Response: a oneOf of four alternatives, as the alternative index then its name.
Which fields travel is decided by the answer itself, not by the protocol version, so the branch lives in this wire type's reader and writer rather than in a gate.
resourcePackStackPacket
constresourcePackStackPacket:PacketDefinition<{experiments:WireType<Experiment[]>;experimentsAlreadyEnabled:WireType<boolean>;gameVersion:WireType<string>;includeEditorPacks:WireType<boolean>;texturePackRequired:WireType<boolean>;texturePacks:WireType<ResourcePackStackEntry[]>; }>
Defined in: protocol/src/wire/definitions/resourcePacks.ts:101
The ResourcePackStackPacket field list.
One pack list, not two. 748 sent the behavior packs ahead of the texture packs, and a reader that still expects them takes the texture pack count for the behavior pack count and every field after it is read from the wrong place.
resourcePacksInfoPacket
constresourcePacksInfoPacket:PacketDefinition<{forceDisableVibrantVisuals:WireType<boolean>;hasAddonPacks:WireType<boolean>;hasScripts:WireType<boolean>;resourcePackEntries:WireType<ResourcePackEntry[]>;resourcePackRequired:WireType<boolean>;worldTemplate:WireType<PackIdVersion>; }>
Defined in: protocol/src/wire/definitions/resourcePacks.ts:58
The ResourcePacksInfoPacket field list.
respawnPacket
constrespawnPacket:PacketDefinition<{position:WireType<Vec3Like>;runtimeEntityId:WireType<bigint>;state:WireType<number>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:47
The RespawnPacket field list.
scorePacketEntry
constscorePacketEntry:WireType<ScorePacketEntry>
Defined in: protocol/src/wire/definitions/scoreboard.ts:72
Score Info: one entry, under whichever of the four alternatives its selector names.
Which fields travel is decided by the entry's own action, not by the protocol version, so the branch lives in this wire type's reader and writer rather than in a gate.
scoreboardIdentityInfo
constscoreboardIdentityInfo:WireType<ScoreboardIdentityPacketInfo>
Defined in: protocol/src/wire/definitions/scoreboard.ts:201
Scoreboard Identity Info: one entry, with its player id behind a presence byte.
Whether the player id travels is decided per entry by that byte, not by the packet type and not by the protocol version, so the branch lives in this wire type rather than in a gate. Mojang's Cereal conversion note for the packet says the same. Before protocol 2193 the id was written only when the packet type was Update, so a reader keyed on the type is one byte off on every entry.
scriptMessagePacket
constscriptMessagePacket:PacketDefinition<{messageId:WireType<string>;messageValue:WireType<string>; }>
Defined in: protocol/src/wire/definitions/scriptMessage.ts:10
The ScriptMessagePacket field list.
serverSettingsRequestPacket
constserverSettingsRequestPacket:PacketDefinition<{ }>
Defined in: protocol/src/wire/definitions/serverSettings.ts:18
The ServerSettingsRequestPacket field list: empty.
The client asks for the server's settings form while it sets up its settings screen, and the packet arriving at all is the whole message. A server with a form to offer answers with a ServerSettingsResponsePacket; one without answers nothing. The empty list is still a definition so the registry accounts for the packet and the round-trip suite holds it to writing no bytes, which is what a field appearing here by accident would break.
serverSettingsResponsePacket
constserverSettingsResponsePacket:PacketDefinition<{formId:WireType<number>;formUiJson:WireType<string>; }>
Defined in: protocol/src/wire/definitions/serverSettingsResponse.ts:12
The ServerSettingsResponsePacket field list.
serverStatsPacket
constserverStatsPacket:PacketDefinition<{networkTime:WireType<number>;serverTime:WireType<number>; }>
Defined in: protocol/src/wire/definitions/serverStats.ts:10
The ServerStatsPacket field list.
serverToClientHandshakePacket
constserverToClientHandshakePacket:PacketDefinition<{jwt:WireType<string>; }>
Defined in: protocol/src/wire/definitions/serverToClientHandshake.ts:13
The ServerToClientHandshakePacket field list: the server's half of the encryption handshake, and the last packet it sends in the clear.
serverboundCursorItemDragPacket
constserverboundCursorItemDragPacket:PacketDefinition<{state:WireType<number>; }>
Defined in: protocol/src/wire/definitions/added2225.ts:203
The ServerboundCursorItemDragPacket field list.
serverboundLoadingScreenPacket
constserverboundLoadingScreenPacket:PacketDefinition<{loadingScreenId:WireType<number|null>;loadingScreenType:WireType<number>; }>
Defined in: protocol/src/wire/definitions/serverboundLoadingScreen.ts:10
The ServerboundLoadingScreenPacket field list.
serverboundMatchmakingCancelPacket
constserverboundMatchmakingCancelPacket:PacketDefinition<{ }>
Defined in: protocol/src/wire/definitions/added2225.ts:174
The ServerboundMatchmakingCancelPacket field list: the schema declares no properties.
serverboundRegisterAudioContentPacket
constserverboundRegisterAudioContentPacket:PacketDefinition<{registrations:WireType<AudioContentRegistrationEntry[]>; }>
Defined in: protocol/src/wire/definitions/added2225.ts:221
The ServerboundRegisterAudioContentPacket field list.
serverboundStonecutterSetRecipePacket
constserverboundStonecutterSetRecipePacket:PacketDefinition<{containerId:WireType<number>;recipeIndex:WireType<number>; }>
Defined in: protocol/src/wire/definitions/added2225.ts:177
The ServerboundStonecutterSetRecipePacket field list.
setActorDataPacket
constsetActorDataPacket:PacketDefinition<{metadata:WireType<Metadata>;runtimeEntityId:WireType<bigint>;syncedProperties:WireType<SyncedProperties>;tick:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/setActorData.ts:11
The SetActorDataPacket field list; the class doc carries the wire provenance.
setActorLinkPacket
constsetActorLinkPacket:PacketDefinition<{link:WireType<ActorLink>; }>
Defined in: protocol/src/wire/definitions/actors.ts:60
The SetActorLinkPacket field list.
Both sides send it: a client sends two at a time when a player mounts something. A link sent this way reaches only the clients that receive it; a player who sees the pair later needs the link in the AddActorPacket or AddPlayerPacket that spawns them.
setActorMotionPacket
constsetActorMotionPacket:PacketDefinition<{motion:WireType<Vector3>;runtimeEntityId:WireType<bigint>;tick:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/movement.ts:90
The SetActorMotionPacket field list.
setCommandsEnabledPacket
constsetCommandsEnabledPacket:PacketDefinition<{commandsEnabled:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:23
The SetCommandsEnabledPacket field list.
setDefaultGameTypePacket
constsetDefaultGameTypePacket:PacketDefinition<{gamemode:WireType<number>; }>
Defined in: protocol/src/wire/definitions/setDefaultGameType.ts:11
The SetDefaultGameTypePacket field list.
setDifficultyPacket
constsetDifficultyPacket:PacketDefinition<{difficulty:WireType<number>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:29
The SetDifficultyPacket field list.
setDisplayObjectivePacket
constsetDisplayObjectivePacket:PacketDefinition<{criteriaName:WireType<string>;displaySlotName:WireType<string>;objectiveDisplayName:WireType<string>;objectiveName:WireType<string>;sortOrder:WireType<number>; }>
Defined in: protocol/src/wire/definitions/scoreboard.ts:153
The SetDisplayObjectivePacket field list.
The slot names vanilla uses are list, sidebar and belowname, and the criteria name is always dummy: the client tracks no criteria itself.
setHealthPacket
constsetHealthPacket:PacketDefinition<{health:WireType<number>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:17
The SetHealthPacket field list.
setLastHurtByPacket
constsetLastHurtByPacket:PacketDefinition<{lastHurtBy:WireType<number>; }>
Defined in: protocol/src/wire/definitions/setLastHurtBy.ts:11
The SetLastHurtByPacket field list.
setLocalPlayerAsInitializedPacket
constsetLocalPlayerAsInitializedPacket:PacketDefinition<{runtimeEntityId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/player.ts:96
The SetLocalPlayerAsInitializedPacket field list.
The last step of a join: until this arrives the server has a player nobody can see, and chunk streaming and entity tracking are both keyed off it.
setPassengerOfBlockPacket
constsetPassengerOfBlockPacket:PacketDefinition<{passenger:WireType<bigint>;passengerOfBlockData:WireType<PassengerOfBlock|null>; }>
Defined in: protocol/src/wire/definitions/added2225.ts:195
The SetPassengerOfBlockPacket field list.
setPlayerGameTypePacket
constsetPlayerGameTypePacket:PacketDefinition<{gametype:WireType<number>; }>
Defined in: protocol/src/wire/definitions/player.ts:40
The SetPlayerGameTypePacket field list.
Sent both ways: the client when the player picks a game type, the server back so the client shows the one the server holds.
setPlayerInventoryOptionsPacket
constsetPlayerInventoryOptionsPacket:PacketDefinition<{craftingLayout:WireType<number>;filtering:WireType<boolean>;inventoryLayout:WireType<number>;leftTab:WireType<number>;rightTab:WireType<number>; }>
Defined in: protocol/src/wire/definitions/setPlayerInventoryOptions.ts:11
The SetPlayerInventoryOptionsPacket field list.
setScorePacket
constsetScorePacket:PacketDefinition<{entries:WireType<ScorePacketEntry[]>; }>
Defined in: protocol/src/wire/definitions/scoreboard.ts:139
The SetScorePacket field list.
The docs mark Score Info itself optional at 2193 and record it losing that marking at 2207. No presence byte travels here: gophertunnel at 2193 writes the bare count, and a presence byte would push every entry one byte out.
setScoreboardIdentityPacket
constsetScoreboardIdentityPacket:PacketDefinition<{entries:WireType<ScoreboardIdentityPacketInfo[]>;type:WireType<number>; }>
Defined in: protocol/src/wire/definitions/scoreboard.ts:227
The SetScoreboardIdentityPacket field list.
An entry with an identity takes its display name from the player it points at, so the name follows a rename. A player leaving is handled by clearing the identity, which leaves the line showing whatever text it was last given.
setSpawnPositionPacket
constsetSpawnPositionPacket:PacketDefinition<{blockPosition:WireType<Vec3Like>;dimension:WireType<number>;position:WireType<Vec3Like>;type:WireType<number>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:35
The SetSpawnPositionPacket field list.
setTimePacket
constsetTimePacket:PacketDefinition<{time:WireType<number>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:11
The SetTimePacket field list: the world tick as one ZigZag varint.
setTitlePacket
constsetTitlePacket:PacketDefinition<{fadeInTime:WireType<number>;fadeOutTime:WireType<number>;filteredTitleMessage:WireType<string>;platformOnlineId:WireType<string>;stayTime:WireType<number>;titleText:WireType<string>;titleType:WireType<number>;xuid:WireType<string>; }>
Defined in: protocol/src/wire/definitions/chat.ts:143
The SetTitlePacket field list.
The three trailing strings are the fields the packet gained after 1.16. Omitting them leaves the client reading the next packet's bytes as Xuid.
settingsCommandPacket
constsettingsCommandPacket:PacketDefinition<{command:WireType<string>;suppressOutput:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/settingsCommand.ts:13
The SettingsCommandPacket field list.
showCreditsPacket
constshowCreditsPacket:PacketDefinition<{creditsState:WireType<number>;playerRuntimeId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/showCredits.ts:18
The ShowCreditsPacket field list.
The server sends it with Credits State set to Start, usually when a player leaves the End through the exit portal. The client answers with the same packet and Finished once the credits are over, which is the server's cue to put the player back in the world.
showProfilePacket
constshowProfilePacket:PacketDefinition<{xuid:WireType<string>; }>
Defined in: protocol/src/wire/definitions/showProfile.ts:11
The ShowProfilePacket field list.
simpleEventPacket
constsimpleEventPacket:PacketDefinition<{type:WireType<number>; }>
Defined in: protocol/src/wire/definitions/simpleEvent.ts:12
The SimpleEventPacket field list.
simulationTypePacket
constsimulationTypePacket:PacketDefinition<{simType:WireType<number>; }>
Defined in: protocol/src/wire/definitions/simulationType.ts:11
The SimulationTypePacket field list.
spawnParticleEffectPacket
constspawnParticleEffectPacket:PacketDefinition<{actorId:WireType<bigint>;dimensionId:WireType<number>;effectName:WireType<string>;molangVariables:WireType<string|null>;position:WireType<Vector3>; }>
Defined in: protocol/src/wire/definitions/effects.ts:36
The SpawnParticleEffectPacket field list: a named particle effect, including ones only a behavior pack knows about.
The /particle command and the script spawn-particle events are what still use it; the hardcoded effects go through LevelEventPacket instead. An unknown Effect Name is a no-op on the client rather than an error.
splineDefinition
constsplineDefinition:WireType<SplineDefinition>
Defined in: protocol/src/wire/definitions/cameraSpline.ts:72
CameraSplineDefinition: the six fields in wire order.
startGamePacket
conststartGamePacket:PacketDefinition<{achievementsDisabled:WireType<boolean>;allowAnonymousBlockDropsInEditorWorlds:WireType<boolean>;baseGameVersion:WireType<string>;blockNetworkIdsAreHashes:WireType<boolean>;blockProperties:WireType<BlockProperty[]>;blockRegistryChecksum:WireType<bigint>;bonusChestEnabled:WireType<boolean>;chatRestrictionLevel:WireType<number>;clientSideGeneration:WireType<boolean>;commandsEnabled:WireType<boolean>;confirmedPlatformLockedContent:WireType<boolean>;createdInEditor:WireType<boolean>;currentTick:WireType<bigint>;customSkinsDisabled:WireType<boolean>;dayCycleStopTime:WireType<number>;difficulty:WireType<number>;dimension:WireType<number>;disablePlayerInteractions:WireType<boolean>;editorLevelMigrationVersion:GatedField<number>;editorWorldType:WireType<number>;educationEditionOffer:WireType<number>;educationFeaturesEnabled:WireType<boolean>;educationProductId:WireType<string>;eduSharedUriResource:WireType<{buttonName:string;linkUri:string; }>;emoteChatMuted:WireType<boolean>;enableItemStackNetManager:WireType<boolean>;enchantmentSeed:WireType<number>;entityId:WireType<bigint>;experiments:WireType<ExperimentToggle[]>;experimentsEverToggled:WireType<boolean>;exportedFromEditor:WireType<boolean>;forceExperimentalGameplay:WireType<boolean|null>;gamemode:WireType<number>;gameRules:WireType<GameRule[]>;generator:WireType<number>;hardcore:WireType<boolean>;hasLockedBehaviorPack:WireType<boolean>;hasLockedResourcePack:WireType<boolean>;isFromLockedTemplate:WireType<boolean>;isFromWorldTemplate:WireType<boolean>;isTrial:WireType<boolean>;isWorldTemplateOptionLocked:WireType<boolean>;lanBroadcast:WireType<boolean>;levelId:WireType<string>;levelName:WireType<string>;lightningLevel:WireType<number>;limitedWorldDepth:WireType<number>;limitedWorldWidth:WireType<number>;multiplayerCorrelationId:WireType<string>;multiplayerGame:WireType<boolean>;newNether:WireType<boolean>;onlySpawnV1Villagers:WireType<boolean>;ownerId:WireType<string>;personaDisabled:WireType<boolean>;pitch:WireType<number>;platformBroadcastSetting:WireType<number>;playerPermissions:WireType<number>;playerPropertyData:WireType<Buffer<ArrayBufferLike>>;position:WireType<Vec3Like>;rainLevel:WireType<number>;rewindHistorySize:WireType<number>;runtimeEntityId:WireType<bigint>;scenarioId:WireType<string>;seed:WireType<bigint>;serverAuthoritativeBlockBreaking:WireType<boolean>;serverAuthoritativeSound:WireType<boolean>;serverChunkTickRange:WireType<number>;serverEditorConnectionPolicy:WireType<number>;serverId:WireType<string>;serverJoinInformation:WireType<ServerJoinInformation|null>;serverVersion:WireType<string>;spawnBiomeType:WireType<number>;spawnPosition:WireType<Vec3Like>;startWithMapEnabled:WireType<boolean>;templateContentIdentity:WireType<string>;texturePacksRequired:WireType<boolean>;useMsaGamertagsOnly:WireType<boolean>;userDefinedBiomeName:WireType<string>;worldGamemode:WireType<number>;worldId:WireType<string>;worldTemplateId:WireType<WireUUID>;xboxLiveBroadcastSetting:WireType<number>;yaw:WireType<number>; }>
Defined in: protocol/src/wire/definitions/startGame.ts:233
The StartGamePacket field list; the module doc carries the wire provenance.
stopSoundPacket
conststopSoundPacket:PacketDefinition<{soundName:WireType<string>;stopAllSounds:WireType<boolean>;stopMusicLegacy:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/levelSoundEvent.ts:97
The StopSoundPacket field list: stops a sound that is still playing, such as a music disc.
A client that is not playing the named sound ignores the packet. With Stop All Sounds? set the name may be empty.
syncActorPropertyPacket
constsyncActorPropertyPacket:PacketDefinition<{propertyData:WireType<NBTTagCompound>; }>
Defined in: protocol/src/wire/definitions/syncActorProperty.ts:26
The SyncActorPropertyPacket field list: the actor properties of one actor type that are flagged for client sync. The compound holds type, the actor identifier, and properties, the property definitions.
syncWorldClocksPacket
constsyncWorldClocksPacket:PacketDefinition<{data:WireType<SyncWorldClocksData>; }>
Defined in: protocol/src/wire/definitions/syncWorldClocks.ts:93
The SyncWorldClocksPacket field list.
takeItemActorPacket
consttakeItemActorPacket:PacketDefinition<{itemRuntimeEntityId:WireType<bigint>;takerRuntimeEntityId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/actors.ts:43
The TakeItemActorPacket field list.
textPacket
consttextPacket:PacketDefinition<{body:WireType<TextBody>;filtered:WireType<string|null>;needsTranslation:WireType<boolean>;platformChatId:WireType<string>;xuid:WireType<string>; }>
Defined in: protocol/src/wire/definitions/chat.ts:121
The TextPacket field list.
Older protocols wrote the message type first, with no variant index, and the filtered string unconditionally.
tickingAreasLoadStatusPacket
consttickingAreasLoadStatusPacket:PacketDefinition<{preload:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/tickingAreasLoadStatus.ts:12
The TickingAreasLoadStatusPacket field list.
toastRequestPacket
consttoastRequestPacket:PacketDefinition<{content:WireType<string>;title:WireType<string>; }>
Defined in: protocol/src/wire/definitions/toastRequest.ts:11
The ToastRequestPacket field list.
trimDataPacket
consttrimDataPacket:PacketDefinition<{materials:WireType<TrimMaterial[]>;patterns:WireType<TrimPattern[]>; }>
Defined in: protocol/src/wire/definitions/trimData.ts:36
The TrimDataPacket field list: every armor trim pattern and material the client may show, sent once during the join.
unlockedRecipesPacket
constunlockedRecipesPacket:PacketDefinition<{recipes:WireType<string[]>;type:WireType<number>; }>
Defined in: protocol/src/wire/definitions/unlockedRecipes.ts:10
The UnlockedRecipesPacket field list.
updateAbilitiesPacket
constupdateAbilitiesPacket:PacketDefinition<{abilityLayers:WireType<SerializedAbilityLayer[]>;commandPermission:WireType<number>;playerPermission:WireType<number>;targetActorUniqueId:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/updateAbilities.ts:26
The UpdateAbilitiesPacket field list. The docs type "Player Permissions" as PlayerPermissionLevel and "Command Permissions" as CommandPermissionLevel, the generated enums in @jsprismarine/minecraft.
updateAdventureSettingsPacket
constupdateAdventureSettingsPacket:PacketDefinition<{autoJump:WireType<boolean>;noAttackingMobs:WireType<boolean>;noAttackingPlayers:WireType<boolean>;showNameTags:WireType<boolean>;worldImmutable:WireType<boolean>; }>
Defined in: protocol/src/wire/definitions/worldStatus.ts:109
The UpdateAdventureSettingsPacket field list.
updateAttributesPacket
constupdateAttributesPacket:PacketDefinition<{attributes:WireType<Attribute[]>;runtimeEntityId:WireType<bigint>;tick:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/updateAttributes.ts:21
The UpdateAttributesPacket field list; the class doc carries the wire provenance.
updateBlockPacket
constupdateBlockPacket:PacketDefinition<{blockRuntimeId:WireType<number>;flags:WireType<number>;layer:WireType<number>;position:WireType<Vec3Like>; }>
Defined in: protocol/src/wire/definitions/blocks.ts:44
The UpdateBlockPacket field list.
updateClientInputLocksPacket
constupdateClientInputLocksPacket:PacketDefinition<{locks:WireType<number>; }>
Defined in: protocol/src/wire/definitions/updateClientInputLocks.ts:11
The UpdateClientInputLocksPacket field list.
updatePlayerGameTypePacket
constupdatePlayerGameTypePacket:PacketDefinition<{playerGameType:WireType<number>;targetPlayer:WireType<bigint>;tick:WireType<bigint>; }>
Defined in: protocol/src/wire/definitions/player.ts:54
The UpdatePlayerGameTypePacket field list.
Every client keeps the game type of every player it knows about, so this goes to all of them and not only to the player who changed.
updateSubChunkBlocksPacket
constupdateSubChunkBlocksPacket:PacketDefinition<{extras:WireType<UpdateSubChunkNetworkBlockInfo[]>;standards:WireType<UpdateSubChunkNetworkBlockInfo[]>;subChunkBlockPosition:WireType<Vec3Like>; }>
Defined in: protocol/src/wire/definitions/updateSubChunkBlocks.ts:27
The UpdateSubChunkBlocksPacket field list: every block that changed in one sub chunk during a tick. The Blocks Changed lists carry the first block layer's changes, then the second layer's, which holds waterlogging.
voxelShapesPacket
constvoxelShapesPacket:PacketDefinition<{customShapeCount:WireType<number>;nameMap:WireType<VoxelShapeNameEntry[]>;shapes:WireType<SerializableVoxelShape[]>; }>
Defined in: protocol/src/wire/definitions/voxelShapes.ts:37
The VoxelShapesPacket field list: the server's voxel shape registry, the block collision shapes both sides resolve by handle. Sent before StartGamePacket during every join.
wireDefinitions
constwireDefinitions:ReadonlyMap<string,PacketDefinition>
Defined in: protocol/src/wire/definitions/index.ts:165
The declaratively defined packets, keyed by packet name.
worldClocksData
constworldClocksData:WireType<SyncWorldClocksData>
Defined in: protocol/src/wire/definitions/syncWorldClocks.ts:54
Data: a Cereal tagged variant, a varuint32 selector then the chosen alternative's fields.
Functions
blockRuntimeId()
blockRuntimeId(
name,states?):number
Defined in: protocol/src/BlockRuntimeId.ts:100
The runtime id of a block state given by name and properties.
Parameters
name
string
states?
Readonly<Record<string, BlockStateValue>> = {}
Returns
number
UNKNOWN_RUNTIME_ID for UNKNOWN_BLOCK_NAME, which is not hashed.
blockRuntimeIdOf()
blockRuntimeIdOf(
compound):number
Defined in: protocol/src/BlockRuntimeId.ts:94
The runtime id of an already-built {name, states} compound, for a caller that builds the compound its own way - from a schema that knows each property's vanilla tag type, say.
Parameters
compound
Returns
number
blockStateCompound()
blockStateCompound(
name,states?):NBTTagCompound
Defined in: protocol/src/BlockRuntimeId.ts:64
The {name, states} compound a runtime id is the hash of.
The properties are sorted by name because the two sides hash the bytes and not the meaning: a different key order is a different id.
Parameters
name
string
The block's namespaced identifier.
states?
Readonly<Record<string, BlockStateValue>> = {}
Its properties; an empty compound is written when there are none.
Returns
buildCodecRegistry()
buildCodecRegistry(
list):object
Defined in: protocol/src/ProtocolCodecRegistry.ts:4
Builds a registry over codecs whose protocol versions must be unique.
Parameters
list
readonly ProtocolCodec[]
Returns
object
codecs
codecs:
ReadonlyMap<number,ProtocolCodec>
latest
latest:
ProtocolCodec
createHandshakeCodec()
createHandshakeCodec(
latestCodec):ProtocolCodec
Defined in: protocol/src/HandshakeCodec.ts:17
Creates the codec used before protocol negotiation completes.
Parameters
latestCodec
A configured codec; the four handshake packets use its stable ids.
Returns
A codec that rejects every id outside the handshake exchange.
createProtocolCodec()
createProtocolCodec(
options):ProtocolCodec
Defined in: protocol/src/ProtocolCodec.ts:64
Creates a version codec from Protocol's packet classes and a server-provided data context. Protocol owns packet construction, ids, and version stamping; the server supplies captured registries through context so this package does not depend on a particular game's content.
Parameters
options
The packet-id definition and data for the selected protocol version.
Returns
A codec that reads and writes packets using that version's ids and tables.
createProtocolCodecRegistry()
createProtocolCodecRegistry(
list):ProtocolCodecRegistry
Defined in: protocol/src/ProtocolCodecRegistry.ts:34
Builds protocol lookups and version summaries from codecs configured by a server.
Parameters
list
readonly ProtocolCodec[]
Codecs with distinct protocol versions.
Returns
The registry, newest codec, and supported Minecraft release list.
creativeCategoryOf()
creativeCategoryOf(
name):CreativeItemCategory
Defined in: protocol/src/packet/CreativeContentPacket.ts:43
The tab a group sits in, from the name the game data gives it.
construction, nature, equipment and items are the four vanilla uses. A name this does not know falls back to the catch-all tab, because a menu drawn under the wrong heading is still a menu and a group index pointing at nothing is not.
Parameters
name
string
The tab name as the creative data writes it.
Returns
The matching tab, or ITEMS.
defaultStructureSettings()
defaultStructureSettings():
StructureSettings
Defined in: protocol/src/structure/StructureSettings.ts:71
A new structure starts at the origin with every block and actor included.
Returns
definePacket()
definePacket<
F>(name,fields):PacketDefinition<F>
Defined in: protocol/src/wire/define.ts:58
Declares a packet's wire layout.
Type Parameters
F
F extends Record<string, FieldSpec<unknown>>
Parameters
name
string
The packet's name as the codec id tables key it.
fields
F
The fields in wire order.
Returns
emptyItemStackDescriptor()
emptyItemStackDescriptor():
ItemStackDescriptorData
Defined in: protocol/src/wire/structures/ItemStackDescriptor.ts:35
Returns a new descriptor for an empty slot.
Returns
fnv1a32()
fnv1a32(
data):number
Defined in: protocol/src/BlockRuntimeId.ts:32
FNV-1a, 32 bit, as a signed integer.
Kept apart from the NBT work so it can be checked against the published test vectors for the algorithm rather than only against block ids.
Parameters
data
Buffer
Returns
number
See
http://www.isthe.com/chongo/tech/comp/fnv/
gated()
gated<
T>(gate,of,fallback):GatedField<T>
Defined in: protocol/src/wire/define.ts:32
Marks a field as travelling only at the versions its gate admits.
Type Parameters
T
T
Parameters
gate
of
WireType<T>
fallback
T
Returns
GatedField<T>
hasLegacyRequest()
hasLegacyRequest(
legacyRequestId):boolean
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:110
The docs' validity rule for a Legacy Request ID: negative and even. Zero means no request, and the Legacy Set Item Slots list is only on the wire when the id is valid.
Parameters
legacyRequestId
number
The Legacy Request ID as read or as about to be written.
Returns
boolean
Whether the slot list travels with it.
isEasingFunction()
isEasingFunction(
name): name is "linear" | "spring" | "in_quad" | "out_quad" | "in_out_quad" | "in_cubic" | "out_cubic" | "in_out_cubic" | "in_quart" | "out_quart" | "in_out_quart" | "in_quint" | "out_quint" | "in_out_quint" | "in_sine" | "out_sine" | "in_out_sine" | "in_expo" | "out_expo" | "in_out_expo" | "in_circ" | "out_circ" | "in_out_circ" | "in_bounce" | "out_bounce" | "in_out_bounce" | "in_back" | "out_back" | "in_out_back" | "in_elastic" | "out_elastic" | "in_out_elastic"
Defined in: protocol/src/structure/CameraInstruction.ts:50
Whether a string read from the wire names one of the docs' easing_function values.
Parameters
name
string
Returns
name is "linear" | "spring" | "in_quad" | "out_quad" | "in_out_quad" | "in_cubic" | "out_cubic" | "in_out_cubic" | "in_quart" | "out_quart" | "in_out_quart" | "in_quint" | "out_quint" | "in_out_quint" | "in_sine" | "out_sine" | "in_out_sine" | "in_expo" | "out_expo" | "in_out_expo" | "in_circ" | "out_circ" | "in_out_circ" | "in_bounce" | "out_bounce" | "in_out_bounce" | "in_back" | "out_back" | "in_out_back" | "in_elastic" | "out_elastic" | "in_out_elastic"
isGated()
isGated<
T>(spec):spec is GatedField<T>
Defined in: protocol/src/wire/define.ts:36
Whether a field spec is gated.
Type Parameters
T
T
Parameters
spec
FieldSpec<T>
Returns
spec is GatedField<T>
layoutAt()
layoutAt<
D>(definition,protocolVersion,useCompiler?):WireLayout<D>
Defined in: protocol/src/wire/WireLayout.ts:176
The layout of a definition at a protocol version, resolved once and frozen.
Type Parameters
D
D extends PacketDefinition<Record<string, FieldSpec<unknown>>>
Parameters
definition
D
The packet's field list.
protocolVersion
number
The protocol the session negotiated.
useCompiler?
boolean = true
Set false to force the compatible walker for differential tests.
Returns
WireLayout<D>
readCraftingData()
readCraftingData(
stream):CraftingData
Defined in: protocol/src/packet/CraftingDataPacket.ts:303
Reads the eleven arrays and the flag, the mirror of writeCraftingData.
Parameters
stream
Returns
Throws
When one of the five lists with no payload type is not empty, since nothing after it could be read without knowing its entries' layout.
readCreativeContent()
readCreativeContent(
stream):CreativeContent
Defined in: protocol/src/packet/CreativeContentPacket.ts:92
Reads the two lists, the mirror of writeCreativeContent.
Parameters
stream
Returns
readDimensionDefinition()
readDimensionDefinition(
stream,protocolVersion?):object
Defined in: protocol/src/wire/structures/DimensionDefinition.ts:75
Reads a DimensionDefinition in the layout of the given protocol version, the mirror of writeDimensionDefinition. Fields the version leaves off the wire take their fallbacks, so a 2193 read still yields cloudHeight and renderClouds.
Parameters
stream
The stream to read from.
protocolVersion?
number = protocolVersion2193
The negotiated protocol version; defaults to 2193.
Returns
cloudHeight
cloudHeight:
number
Cloud Height: the block y clouds render at; 2225 on.
defaultBiome
defaultBiome:
string=t.string
Default Biome: the biome identifier the dimension generates with.
dimensionType
dimensionType:
number=t.varint32
Dimension Type: the dimension's runtime id. Vanilla uses 0 to 2; custom dimensions count from 1000.
generatorType
generatorType:
number=t.varint32
Generator Type: a Generator value (0 Legacy, 1 Overworld, 2 Flat, 3 Nether, 4 TheEnd, 5 Void, 6 Undefined).
heightRange
heightRange:
number=t.varint32
Height Range: how many blocks sit above Minimum Y.
minimumY
minimumY:
number=t.varint32
Minimum Y: the lowest block y of the dimension.
packId
packId:
UUID
Pack Id: the behavior pack that registered the dimension.
renderClouds
renderClouds:
boolean
Render Clouds: whether the dimension draws clouds at all; 2225 on.
readInventoryAction()
readInventoryAction(
stream):InventoryActionData
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:187
Reads one action.
The Container ID and the Bit Flags are each an optional with its own presence byte. Up to protocol 748 the reader inferred their presence from the Source Type. The client still sets each byte by that rule (a container has a Container ID, the world has Bit Flags), but the byte is what is on the wire, and a reader that infers instead of reading is one field off as soon as the two disagree.
Parameters
stream
The stream positioned at the Source Type.
Returns
The action's six fields.
readItemStackDescriptor()
readItemStackDescriptor(
stream):ItemStackDescriptorData
Defined in: protocol/src/wire/structures/ItemStackDescriptor.ts:76
Reads a stack descriptor, the mirror of writeItemStackDescriptor.
Every field is read whatever the id is. Up to protocol 748 a zero id was the whole descriptor; at 2168 an empty slot is eight bytes, and a reader that still stops at the id is misaligned from the next field onwards.
Parameters
stream
The stream positioned at the descriptor's id.
Returns
The six fields as they were on the wire.
readItemStackRequest()
readItemStackRequest(
stream,protocolVersion?):ItemStackRequest
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:333
Reads one ItemStackRequest: Client Request Id, Actions, Strings To Filter, StringsToFilterOrigin.
Each action opens with two numbers that mean the same thing: a varuint variant index, which is the action's position in the oneOf list, and then the Action type as a byte. The variant index is what is dispatched on. Protocol 2225 inserts CraftReservedAction at type 18, shifting the two deprecated craft actions; the selected layout follows the supplied protocol version. The echoed Action type byte is read and dropped.
Parameters
stream
The stream positioned at Client Request Id.
protocolVersion?
number = protocolVersion2193
The negotiated protocol version; defaults to 2193.
Returns
Throws
when the action count is above MAX_REQUEST_ACTIONS, or an action or descriptor type is unknown.
readPacketId()
readPacketId(
buffer):number
Defined in: protocol/src/NetworkPacket.ts:17
Reads the packet id from a Bedrock packet header without consuming its body.
The header is an unsigned varint. Its low ten bits are the packet id; sender and target subclient ids occupy the bits above them. For a truncated varint, the bytes that are present still contribute to the returned id; callers can pass it through their ordinary packet lookup.
Parameters
buffer
Uint8Array
Encoded packet bytes positioned at the header.
Returns
number
The packet id in the low ten bits of the header.
readPlayerAuthInput()
readPlayerAuthInput(
stream,protocolVersion?):PlayerAuthInput
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:246
Reads PlayerAuthInputPacket fields in the order the client sends them.
Parameters
stream
The stream positioned at the packet payload.
protocolVersion?
number = protocolVersion2193
The negotiated protocol version for nested item stack requests.
Returns
readStructureSettings()
readStructureSettings(
stream):StructureSettings
Defined in: protocol/src/structure/StructureSettings.ts:89
Reads the docs' StructureSettings fields in wire order.
Parameters
stream
Returns
readUseItemData()
readUseItemData(
stream):UseItemData
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:290
Reads the body of a use-item transaction: everything after the Actions.
Shared with PlayerAuthInputPacket, which carries the same transaction inside itself when the client used an item in the same tick it moved. The two packets differ only in what surrounds this. Property order is read order, so these lines are the wire layout.
Parameters
stream
The stream positioned at the Action Type.
Returns
The body's twelve fields.
recipeUuidFor()
recipeUuidFor(
id):Buffer
Defined in: protocol/src/packet/CraftingDataPacket.ts:98
The UUID a recipe travels under, derived from its id.
The data carries none, and it cannot be random: the client keys its recipe book on these, so a fresh set each start is a book that resets itself. Hashing the id gives the same answer every time, from the one thing a recipe is guaranteed to have.
Parameters
id
string
The recipe's identifier.
Returns
Buffer
The sixteen digest bytes, in the big endian order a UUID is written in.
since()
since(
protocolVersion,reason):WireGate
Defined in: protocol/src/wire/wireGates.ts:25
A gate admitting a field from protocolVersion on.
Parameters
protocolVersion
number
reason
string
Returns
until()
until(
protocolVersion,reason):WireGate
Defined in: protocol/src/wire/wireGates.ts:32
A gate admitting a field up to but not including protocolVersion.
Parameters
protocolVersion
number
reason
string
Returns
writeBlockStateNbt()
writeBlockStateNbt(
compound):Buffer
Defined in: protocol/src/BlockRuntimeId.ts:81
The bytes a block state hashes to: little endian NBT with fixed-width lengths, not the varint network flavor, which would produce different bytes and therefore a different id.
Parameters
compound
Returns
Buffer
writeCraftingData()
writeCraftingData(
stream,data):void
Defined in: protocol/src/packet/CraftingDataPacket.ts:194
Writes the eleven arrays and the flag without a packet header, for a caller that writes its own. The server's own packet class is that caller: it holds recipes as its own objects and needs the bytes of the payload alone, so the format lives here once.
Parameters
stream
data
Returns
void
writeCreativeContent()
writeCreativeContent(
stream,data):void
Defined in: protocol/src/packet/CreativeContentPacket.ts:75
Writes the two lists without a packet header, for a caller that writes its own.
The server's own packet class is that caller: it holds the menu as item instances and needs the bytes of the payload alone, so the format lives here once and nothing reimplements it.
Parameters
stream
data
Returns
void
writeDimensionDefinition()
writeDimensionDefinition(
stream,value,protocolVersion?):void
Defined in: protocol/src/wire/structures/DimensionDefinition.ts:60
Writes a DimensionDefinition in the layout of the given protocol version.
Parameters
stream
The stream to write to.
value
The definition's fields.
cloudHeight
number = ...
Cloud Height: the block y clouds render at; 2225 on.
defaultBiome
string = t.string
Default Biome: the biome identifier the dimension generates with.
dimensionType
number = t.varint32
Dimension Type: the dimension's runtime id. Vanilla uses 0 to 2; custom dimensions count from 1000.
generatorType
number = t.varint32
Generator Type: a Generator value (0 Legacy, 1 Overworld, 2 Flat, 3 Nether, 4 TheEnd, 5 Void, 6 Undefined).
heightRange
number = t.varint32
Height Range: how many blocks sit above Minimum Y.
minimumY
number = t.varint32
Minimum Y: the lowest block y of the dimension.
packId
Pack Id: the behavior pack that registered the dimension.
renderClouds
boolean = ...
Render Clouds: whether the dimension draws clouds at all; 2225 on.
protocolVersion?
number = protocolVersion2193
The negotiated protocol version; defaults to 2193.
Returns
void
writeInventoryAction()
writeInventoryAction(
stream,action):void
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:201
The mirror of readInventoryAction.
Parameters
stream
The stream to append to.
action
The action to write.
Returns
void
writeItemStackDescriptor()
writeItemStackDescriptor(
stream,value):void
Defined in: protocol/src/wire/structures/ItemStackDescriptor.ts:52
Writes a stack descriptor, field for field.
Nothing is normalized here. An empty stack that arrived with zeroes in every field after the id goes back out with those zeroes, which is what makes a decode-encode pass identity.
Parameters
stream
The stream to append to.
value
The descriptor to write.
Returns
void
writeItemStackRequest()
writeItemStackRequest(
stream,request,protocolVersion?):void
Defined in: protocol/src/wire/structures/ItemStackRequest.ts:483
Writes one ItemStackRequest, the mirror of readItemStackRequest: Client Request Id, Actions - each as its variant index, the same type as a byte, then its payload - Strings To Filter, and StringsToFilterOrigin. Protocol 2225 writes the inserted CraftReservedAction and shifted deprecated craft actions using that version's action ids.
Parameters
stream
The stream to write into.
request
The request fields to encode.
protocolVersion?
number = protocolVersion2193
The negotiated protocol version; defaults to 2193.
Returns
void
writePlayerAuthInput()
writePlayerAuthInput(
stream,input,protocolVersion?):void
Defined in: protocol/src/wire/structures/PlayerAuthInput.ts:317
Writes every PlayerAuthInputPacket field in the order the client sends it.
Parameters
stream
The stream to write into.
input
The input fields to encode.
protocolVersion?
number = protocolVersion2193
The negotiated protocol version for nested item stack requests.
Returns
void
writeStructureSettings()
writeStructureSettings(
stream,settings):void
Defined in: protocol/src/structure/StructureSettings.ts:127
Writes the docs' StructureSettings fields in wire order.
Parameters
stream
settings
Returns
void
writeUseItemData()
writeUseItemData(
stream,data):void
Defined in: protocol/src/wire/structures/InventoryTransaction.ts:311
The mirror of readUseItemData.
Parameters
stream
The stream to append to.
data
The body to write.
Returns
void