Difference between revisions of "Pre-release protocol"

From wiki.vg
Jump to navigation Jump to search
(Reset page)
(23w51a)
Line 1: Line 1:
There are currently no pre-release versions available to document on this page. For the latest stable Minecraft release, see the [[Protocol|Protocol]] page. For previous pre-release pages, see the [[Protocol version numbers|Protocol version numbers]] page.
+
This page documents the changes from the [[Protocol|last stable Minecraft release]] (currently [[Protocol version numbers|1.20.4, protocol 765]]) to the current pre-release (currently [[Protocol version numbers|23w51a, protocol {{Snapshot PVN|1073741993}}]]). Note that this page contains bleeding-edge information that may not be completely or correctly documented.
  
 
One who wishes to commandeer the merging of this into [[Protocol]] when an update is made must be sure to respect any changes that may have occurred to the respective packets there.
 
One who wishes to commandeer the merging of this into [[Protocol]] when an update is made must be sure to respect any changes that may have occurred to the respective packets there.
Line 13: Line 13:
 
=== Packets ===
 
=== Packets ===
  
No changes so far.
+
{| class="wikitable"
 +
! ID
 +
! Packet name
 +
!colspan="2"| Documentation
 +
|-
 +
!colspan="4"| Play clientbound
 +
{{PacketList|0x71|Update Attributes}}
 +
{{PacketList|0x72|Entity Effect}}
 +
|}
  
 
== New/modified data types ==
 
== New/modified data types ==
Line 21: Line 29:
 
== Entity Metadata ==
 
== Entity Metadata ==
  
No changes so far.
+
{| class="wikitable"
 +
! Type ([[Data Types#Definitions:varint|VarInt]] Enum)
 +
! Value (Varies)
 +
! Notes
 +
|-
 +
| 0
 +
| [[Data Types#Definitions:byte|Byte]]
 +
|
 +
|-
 +
| 1
 +
| [[Data Types#Definitions:varint|VarInt]]
 +
|
 +
|-
 +
| 2
 +
| [[Data Types#Definitions:varlong|VarLong]]
 +
|
 +
|-
 +
| 3
 +
| [[Data Types#Definitions:float|Float]]
 +
|
 +
|-
 +
| 4
 +
| [[Data Types#Definitions:string|String]]
 +
|
 +
|-
 +
| 5
 +
| [[Data Types#Definitions:chat|Chat]]
 +
|
 +
|-
 +
| 6
 +
| OptChat (Boolean + [[Data Types#Definitions:chat|Chat]])
 +
| [[Data Types#Definitions:chat|Chat]] is present if the Boolean is set to true
 +
|-
 +
| 7
 +
| [[Data Types#Definitions:slot|Slot]]
 +
|
 +
|-
 +
| 8
 +
| [[Data Types#Definitions:boolean|Boolean]]
 +
|
 +
|-
 +
| 9
 +
| [[Data Types#Definitions:rotation|Rotation]]
 +
| 3 [[Data Types#Definitions:float|Floats]]: rotation on x, rotation on y, rotation on z
 +
|-
 +
| 10
 +
| [[Data Types#Position|Position]]
 +
|
 +
|-
 +
| 11
 +
| OptPosition (Boolean + Position)
 +
| Position is present if the Boolean is set to true
 +
|-
 +
| 12
 +
| Direction ([[Data Types#Definitions:varint|VarInt]])
 +
| (Down = 0, Up = 1, North = 2, South = 3, West = 4, East = 5)
 +
|-
 +
| 13
 +
| OptUUID (Boolean + UUID)
 +
| UUID is present if the Boolean is set to true
 +
|-
 +
| 14
 +
| BlockID ([[Data Types#Definitions:varint|VarInt]])
 +
|-
 +
| 15
 +
| OptBlockID ([[Data Types#Definitions:varint|VarInt]])
 +
| 0 for absent (implies air); otherwise, a block state ID as per the block state registry
 +
|-
 +
| 16
 +
| [[Data_types#Definitions:nbt|NBT]]
 +
|
 +
|-
 +
| 17
 +
| [[Data Types#Particle|Particle]]
 +
|
 +
|-
 +
| 18
 +
| Villager Data
 +
| 3 [[Data Types#Definitions:varint|VarInts]]: villager type, villager profession, level
 +
|-
 +
| 19
 +
| OptVarInt
 +
| 0 for absent; 1 + actual value otherwise. Used for entity IDs.
 +
|-
 +
| 20
 +
| Pose
 +
| A [[Data Types#Definitions:varint|VarInt]] enum: 0: STANDING, 1: FALL_FLYING, 2: SLEEPING, 3: SWIMMING, 4: SPIN_ATTACK, 5: SNEAKING, 6: LONG_JUMPING, 7: DYING, 8: CROAKING, 9: USING_TONGUE, 10: SITTING, 11: ROARING, 12: SNIFFING, 13: EMERGING, 14: DIGGING
 +
|-
 +
| 21
 +
| Cat Variant
 +
| A [[Data Types#Definitions:varint|VarInt]] that points towards the CAT_VARIANT registry.
 +
|-
 +
| 22
 +
| Frog Variant
 +
| A [[Data Types#Definitions:varint|VarInt]] that points towards the FROG_VARIANT registry.
 +
|-
 +
| 23
 +
| OptGlobalPos (Boolean + GlobalPos)
 +
| GlobalPos consists of a dimension identifier and [[Data Types#Position|Position]].
 +
|-
 +
| 24
 +
| Painting Variant
 +
| A [[Data Types#Definitions:varint|VarInt]] that points towards the PAINTING_VARIANT registry.
 +
|-
 +
| 25
 +
| Sniffer State
 +
| A [[Data Types#Definitions:varint|VarInt]] enum: IDLING = 0, FEELING_HAPPY = 1, SCENTING = 2, SNIFFING = 3, SEARCHING = 4, DIGGING = 5, RISING = 6
 +
|- {{added}}
 +
| 26
 +
| Armadillo State
 +
| A [[Data Types#Definitions:varint|VarInt]] enum: IDLE = 0, ROLLING = 1, SCARED = 2
 +
|-
 +
| {{change|26|27}}
 +
| Vector3
 +
| 3 [[Data Types#Definitions:float|Floats]]: x, y, z
 +
|-
 +
| {{change|27|28}}
 +
| Quaternion
 +
| 4 [[Data Types#Definitions:float|Floats]]: x, y, z, w
 +
|-
 +
|}
  
=== Entity ===
+
=== Armadillo ===
  
No changes so far.
+
{{Metadata inherit|Armadillo|inherits=Animal|start_at=17}}
 +
{| class="wikitable" {{added}}
 +
! Index
 +
! Type
 +
!style="width: 250px;" colspan="2"| Meaning
 +
! Default
 +
|-
 +
| {{Metadata id|}}
 +
| Armadillo State
 +
|colspan="2"| Armadillo State
 +
| IDLE
 +
|}
  
 
== Block Actions ==
 
== Block Actions ==
Line 73: Line 212:
 
=== Clientbound ===
 
=== Clientbound ===
  
No changes so far.
+
==== Update Attributes ====
 +
 
 +
Sets {{Minecraft Wiki|Attribute|attributes}} on the given entity.
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! colspan="2"| Field Name
 +
! colspan="2"| Field Type
 +
! Notes
 +
|-
 +
| rowspan="6"| 0x71
 +
| rowspan="6"| Play
 +
| rowspan="6"| Client
 +
| colspan="2"| Entity ID
 +
| colspan="2"| VarInt
 +
|
 +
|-
 +
| colspan="2"| Number Of Properties
 +
| colspan="2"| VarInt
 +
| Number of elements in the following array.
 +
|-
 +
| rowspan="4"| Property
 +
| {{change|Key|Id}}
 +
| rowspan="4"| Array
 +
| {{change|Identifier|VarInt Enum}}
 +
| See below.
 +
|-
 +
| Value
 +
| Double
 +
| See below.
 +
|-
 +
| Number Of Modifiers
 +
| VarInt
 +
| Number of elements in the following array.
 +
|-
 +
| Modifiers
 +
| Array of Modifier Data
 +
| See {{Minecraft Wiki|Attribute#Modifiers}}. Modifier Data defined below.
 +
|}
 +
 
 +
Known Key values (see also {{Minecraft Wiki|Attribute#Modifiers}}):
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Id
 +
! Key
 +
! Default
 +
! Min
 +
! Max
 +
! Label
 +
|-
 +
| 0
 +
| generic.armor
 +
| 0.0
 +
| 0.0
 +
| 30.0
 +
| Armor.
 +
|-
 +
| 1
 +
| generic.armor_toughness
 +
| 0.0
 +
| 0.0
 +
| 20.0
 +
| Armor Toughness.
 +
|-
 +
| 2
 +
| generic.attack_damage
 +
| 2.0
 +
| 0.0
 +
| 2048.0
 +
| Attack Damage.
 +
|-
 +
| 3
 +
| generic.attack_knockback
 +
| 0.0
 +
| 0.0
 +
| 5.0
 +
| Attack Knockback.
 +
|-
 +
| 4
 +
| generic.attack_speed
 +
| 4.0
 +
| 0.0
 +
| 1024.0
 +
| Attack Speed.
 +
|- {{added}}
 +
| 5
 +
| generic.block_interaction_range
 +
| 4.5
 +
| 0.0
 +
| 64.0
 +
| Block Interaction Range.
 +
|- {{added}}
 +
| 6
 +
| generic.entity_interaction_range
 +
| 3.0
 +
| 0.0
 +
| 64.0
 +
| Entity Interaction Range.
 +
|-
 +
| 7
 +
| generic.flying_speed
 +
| 0.4
 +
| 0.0
 +
| 1024.0
 +
| Flying Speed.
 +
|-
 +
| 8
 +
| generic.follow_range
 +
| 32.0
 +
| 0.0
 +
| 2048.0
 +
| Follow Range.
 +
|-
 +
| 9
 +
| horse.jump_strength
 +
| 0.7
 +
| 0.0
 +
| 2.0
 +
| Jump Strength.
 +
|-
 +
| 10
 +
| generic.knockback_resistance
 +
| 0.0
 +
| 0.0
 +
| 1.0
 +
| Knockback Resistance.
 +
|-
 +
| 11
 +
| generic.luck
 +
| 0.0
 +
| -1024.0
 +
| 1024.0
 +
| Luck.
 +
|-
 +
| 12
 +
| generic.max_absorption
 +
| 0.0
 +
| 0.0
 +
| 2048.0
 +
| Max Absorption.
 +
|-
 +
| 13
 +
| generic.max_health
 +
| 20.0
 +
| 1.0
 +
| 1024.0
 +
| Max Health.
 +
|-
 +
| 14
 +
| generic.movement_speed
 +
| 0.7
 +
| 0.0
 +
| 1024.0
 +
| Movement Speed.
 +
|- {{added}}
 +
| 15
 +
| generic.scale
 +
| 1.0
 +
| 0.0625
 +
| 16.0
 +
| Scale.
 +
|-
 +
| 16
 +
| zombie.spawn_reinforcements
 +
| 0.0
 +
| 0.0
 +
| 1.0
 +
| Spawn Reinforcements Chance.
 +
|- {{added}}
 +
| 17
 +
| generic.step_height
 +
| 0.6
 +
| 0.0
 +
| 10.0
 +
| Step Height.
 +
|}
 +
 
 +
''Modifier Data'' structure:
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| UUID
 +
| UUID
 +
|
 +
|-
 +
| Amount
 +
| Double
 +
| May be positive or negative.
 +
|-
 +
| Operation
 +
| Byte
 +
| See below.
 +
|}
 +
 
 +
The operation controls how the base value of the modifier is changed.
 +
 
 +
* 0: Add/subtract amount
 +
* 1: Add/subtract amount percent of the current value
 +
* 2: Multiply by amount percent
 +
 
 +
All of the 0's are applied first, and then the 1's, and then the 2's.
 +
 
 +
==== Entity Effect ====
 +
 
 +
{| class="wikitable"
 +
! Packet ID
 +
! State
 +
! Bound To
 +
! Field Name
 +
! Field Type
 +
! Notes
 +
|-
 +
| rowspan="7"| 0x72
 +
| rowspan="7"| Play
 +
| rowspan="7"| Client
 +
| Entity ID
 +
| VarInt
 +
|
 +
|-
 +
| Effect ID
 +
| VarInt
 +
| See {{Minecraft Wiki|Status effect#Effect list|this table}}.
 +
|-
 +
| Amplifier
 +
| Byte
 +
| Notchian client displays effect level as Amplifier + 1.
 +
|-
 +
| Duration
 +
| VarInt
 +
| Duration in ticks. (-1 for infinite)
 +
|-
 +
| Flags
 +
| Byte
 +
| Bit field, see below.
 +
|- {{removed}}
 +
| Has Factor Data
 +
| Boolean
 +
| Used in DARKNESS effect
 +
|- {{removed}}
 +
| Factor Codec
 +
| NBT Tag
 +
| See below
 +
|}
 +
 
 +
{{Need Info|What exact effect does the blend bit flag have on the client?}}
 +
 
 +
Within flags:
 +
 
 +
* 0x01: Is ambient - was the effect spawned from a beacon?  All beacon-generated effects are ambient.  Ambient effects use a different icon in the HUD (blue border rather than gray).  If all effects on an entity are ambient, the [[Entity_metadata#Living Entity|"Is potion effect ambient" living metadata field]] should be set to true.  Usually should not be enabled.
 +
* 0x02: Show particles - should all particles from this effect be hidden?  Effects with particles hidden are not included in the calculation of the effect color, and are not rendered on the HUD (but are still rendered within the inventory).  Usually should be enabled.
 +
* 0x04: Show icon - should the icon be displayed on the client?  Usually should be enabled.
 +
* {{change||0x08: Blend - ???}}
 +
 
 +
{{change|Factor Data|}}
 +
{| class="wikitable" {{removed}}
 +
!Name
 +
!Type
 +
!style="width: 250px;" colspan="2"| Notes
 +
|-
 +
| padding_duration
 +
| TAG_INT
 +
|
 +
|-
 +
| factor_start
 +
| TAG_FLOAT
 +
|
 +
|-
 +
| factor_target
 +
| TAG_FLOAT
 +
|
 +
|-
 +
| factor_current
 +
| TAG_FLOAT
 +
|
 +
|-
 +
| effect_changed_timestamp
 +
| TAG_INT
 +
|-
 +
| factor_previous_frame
 +
| TAG_FLOAT
 +
|-
 +
| had_effect_last_tick
 +
| TAG_BOOLEAN
 +
|}
  
 
=== Serverbound ===
 
=== Serverbound ===

Revision as of 15:44, 19 December 2023

This page documents the changes from the last stable Minecraft release (currently 1.20.4, protocol 765) to the current pre-release (currently 23w51a, protocol Snapshot 169). Note that this page contains bleeding-edge information that may not be completely or correctly documented.

One who wishes to commandeer the merging of this into Protocol when an update is made must be sure to respect any changes that may have occurred to the respective packets there.

Contents

Data types

No changes so far.

Packets

ID Packet name Documentation
Play clientbound
0x71 Update Attributes Current Pre
0x72 Entity Effect Current Pre

New/modified data types

No changes so far.

Entity Metadata

Type (VarInt Enum) Value (Varies) Notes
0 Byte
1 VarInt
2 VarLong
3 Float
4 String
5 Chat
6 OptChat (Boolean + Chat) Chat is present if the Boolean is set to true
7 Slot
8 Boolean
9 Rotation 3 Floats: rotation on x, rotation on y, rotation on z
10 Position
11 OptPosition (Boolean + Position) Position is present if the Boolean is set to true
12 Direction (VarInt) (Down = 0, Up = 1, North = 2, South = 3, West = 4, East = 5)
13 OptUUID (Boolean + UUID) UUID is present if the Boolean is set to true
14 BlockID (VarInt)
15 OptBlockID (VarInt) 0 for absent (implies air); otherwise, a block state ID as per the block state registry
16 NBT
17 Particle
18 Villager Data 3 VarInts: villager type, villager profession, level
19 OptVarInt 0 for absent; 1 + actual value otherwise. Used for entity IDs.
20 Pose A VarInt enum: 0: STANDING, 1: FALL_FLYING, 2: SLEEPING, 3: SWIMMING, 4: SPIN_ATTACK, 5: SNEAKING, 6: LONG_JUMPING, 7: DYING, 8: CROAKING, 9: USING_TONGUE, 10: SITTING, 11: ROARING, 12: SNIFFING, 13: EMERGING, 14: DIGGING
21 Cat Variant A VarInt that points towards the CAT_VARIANT registry.
22 Frog Variant A VarInt that points towards the FROG_VARIANT registry.
23 OptGlobalPos (Boolean + GlobalPos) GlobalPos consists of a dimension identifier and Position.
24 Painting Variant A VarInt that points towards the PAINTING_VARIANT registry.
25 Sniffer State A VarInt enum: IDLING = 0, FEELING_HAPPY = 1, SCENTING = 2, SNIFFING = 3, SEARCHING = 4, DIGGING = 5, RISING = 6
26 Armadillo State A VarInt enum: IDLE = 0, ROLLING = 1, SCARED = 2
26 27 Vector3 3 Floats: x, y, z
27 28 Quaternion 4 Floats: x, y, z, w

Armadillo

Extends Animal.

Index Type Meaning Default
17 Armadillo State Armadillo State IDLE

Block Actions

No changes so far.

Inventories

No changes so far.

Plugin Channels

No changes so far.

Status

Clientbound

No changes so far.

Serverbound

No changes so far.

Login

Clientbound

No changes so far.

Serverbound

No changes so far.

Configuration

Clientbound

No changes so far.

Serverbound

No changes so far.

Play

Clientbound

Update Attributes

Sets attributes on the given entity.

Packet ID State Bound To Field Name Field Type Notes
0x71 Play Client Entity ID VarInt
Number Of Properties VarInt Number of elements in the following array.
Property Key Id Array Identifier VarInt Enum See below.
Value Double See below.
Number Of Modifiers VarInt Number of elements in the following array.
Modifiers Array of Modifier Data See Attribute#Modifiers. Modifier Data defined below.

Known Key values (see also Attribute#Modifiers):

Id Key Default Min Max Label
0 generic.armor 0.0 0.0 30.0 Armor.
1 generic.armor_toughness 0.0 0.0 20.0 Armor Toughness.
2 generic.attack_damage 2.0 0.0 2048.0 Attack Damage.
3 generic.attack_knockback 0.0 0.0 5.0 Attack Knockback.
4 generic.attack_speed 4.0 0.0 1024.0 Attack Speed.
5 generic.block_interaction_range 4.5 0.0 64.0 Block Interaction Range.
6 generic.entity_interaction_range 3.0 0.0 64.0 Entity Interaction Range.
7 generic.flying_speed 0.4 0.0 1024.0 Flying Speed.
8 generic.follow_range 32.0 0.0 2048.0 Follow Range.
9 horse.jump_strength 0.7 0.0 2.0 Jump Strength.
10 generic.knockback_resistance 0.0 0.0 1.0 Knockback Resistance.
11 generic.luck 0.0 -1024.0 1024.0 Luck.
12 generic.max_absorption 0.0 0.0 2048.0 Max Absorption.
13 generic.max_health 20.0 1.0 1024.0 Max Health.
14 generic.movement_speed 0.7 0.0 1024.0 Movement Speed.
15 generic.scale 1.0 0.0625 16.0 Scale.
16 zombie.spawn_reinforcements 0.0 0.0 1.0 Spawn Reinforcements Chance.
17 generic.step_height 0.6 0.0 10.0 Step Height.

Modifier Data structure:

Field Name Field Type Notes
UUID UUID
Amount Double May be positive or negative.
Operation Byte See below.

The operation controls how the base value of the modifier is changed.

  • 0: Add/subtract amount
  • 1: Add/subtract amount percent of the current value
  • 2: Multiply by amount percent

All of the 0's are applied first, and then the 1's, and then the 2's.

Entity Effect

Packet ID State Bound To Field Name Field Type Notes
0x72 Play Client Entity ID VarInt
Effect ID VarInt See this table.
Amplifier Byte Notchian client displays effect level as Amplifier + 1.
Duration VarInt Duration in ticks. (-1 for infinite)
Flags Byte Bit field, see below.
Has Factor Data Boolean Used in DARKNESS effect
Factor Codec NBT Tag See below
Huh.png The following information needs to be added to this page:
What exact effect does the blend bit flag have on the client?

Within flags:

  • 0x01: Is ambient - was the effect spawned from a beacon? All beacon-generated effects are ambient. Ambient effects use a different icon in the HUD (blue border rather than gray). If all effects on an entity are ambient, the "Is potion effect ambient" living metadata field should be set to true. Usually should not be enabled.
  • 0x02: Show particles - should all particles from this effect be hidden? Effects with particles hidden are not included in the calculation of the effect color, and are not rendered on the HUD (but are still rendered within the inventory). Usually should be enabled.
  • 0x04: Show icon - should the icon be displayed on the client? Usually should be enabled.
  • 0x08: Blend - ???

Factor Data

Name Type Notes
padding_duration TAG_INT
factor_start TAG_FLOAT
factor_target TAG_FLOAT
factor_current TAG_FLOAT
effect_changed_timestamp TAG_INT
factor_previous_frame TAG_FLOAT
had_effect_last_tick TAG_BOOLEAN

Serverbound

No changes so far.