fix: StructuredComponents batch 1 audit — TrimComponent, ProfileComponent, WrittenBookContent, and NBT serialization

Audited all 8 high-complexity structured components against official 1.20.6
decompiled STREAM_CODEC definitions. Found and fixed bugs in 3 components
plus a systemic NBT serialization issue:

TrimComponent (ID 35):
- Serialize had TrimPatternType and ShowInTooltip incorrectly nested inside
  the TrimMaterialType==0 branch; moved them outside to match Parse logic
- Description fields (TrimMaterial.description, TrimPattern.description) were
  read/written as String but official codec uses ComponentSerialization
  (NBT Tag format); changed to ReadNextNbt/GetNbt

ProfileComponent (ID 46):
- Serialize was missing the HasUniqueId Bool prefix before UUID
- Serialize only wrote properties when count > 0 but omitted the VarInt count
  prefix entirely when empty; now always writes VarInt count

WrittenBookContentComponent (ID 34):
- Page content uses Filterable<Component> where Component is NBT-encoded via
  ComponentSerialization.STREAM_CODEC, not plain String; changed Parse to use
  ReadNextNbt and Serialize to use GetNbt
- Added RawContentNbt/FilteredContentNbt fields to BookPage record for
  round-trip NBT preservation
- Removed unnecessary ChatParser.ParseText on title (it's a plain string)

DataTypes.GetNbt:
- Added TAG_String root support for 1.20.4+ (chat components like "Page 1"
  are encoded as TAG_String, not TAG_Compound)
- Fixed root name handling: versions >= 1.20.2 omit the root compound name,
  but GetNbt was unconditionally writing it

Components confirmed correct (no changes needed):
- FoodComponentComponent (ID 20), ToolComponent (ID 22),
  InstrumentComponent (ID 40), PotionContentsComponent (ID 31),
  AttributeModifiersComponent (ID 12)

Made-with: Cursor
This commit is contained in:
BruceChen 2026-03-20 00:09:05 +08:00
parent 79a0dff8cd
commit a36ba23ba6
5 changed files with 77 additions and 60 deletions

View file

@ -15,10 +15,12 @@ public class TrimComponent(DataTypes dataTypes, ItemPalette itemPalette, SubComp
public float ItemModelIndex { get; set; }
public int NumberOfOverrides { get; set; }
public List<TrimAssetOverride>? Overrides { get; set; }
public Dictionary<string, object>? DescriptionNbt { get; set; }
public string Description { get; set; } = null!;
public int TrimPatternType { get; set; }
public string TrimPatternTypeAssetName { get; set; } = null!;
public int TemplateItem { get; set; }
public Dictionary<string, object>? TrimPatternTypeDescriptionNbt { get; set; }
public string TrimPatternTypeDescription { get; set; } = null!;
public bool Decal { get; set; }
public bool ShowInTooltip { get; set; }
@ -43,7 +45,8 @@ public class TrimComponent(DataTypes dataTypes, ItemPalette itemPalette, SubComp
dataTypes.ReadNextString(data)));
}
Description = ChatParser.ParseText(dataTypes.ReadNextString(data));
DescriptionNbt = dataTypes.ReadNextNbt(data);
Description = ChatParser.ParseText(DescriptionNbt);
}
TrimPatternType = dataTypes.ReadNextVarInt(data);
@ -52,7 +55,8 @@ public class TrimComponent(DataTypes dataTypes, ItemPalette itemPalette, SubComp
{
TrimPatternTypeAssetName = dataTypes.ReadNextString(data);
TemplateItem = dataTypes.ReadNextVarInt(data);
TrimPatternTypeDescription = dataTypes.ReadNextString(data);
TrimPatternTypeDescriptionNbt = dataTypes.ReadNextNbt(data);
TrimPatternTypeDescription = ChatParser.ParseText(TrimPatternTypeDescriptionNbt);
Decal = dataTypes.ReadNextBool(data);
}
@ -67,8 +71,8 @@ public class TrimComponent(DataTypes dataTypes, ItemPalette itemPalette, SubComp
if (TrimMaterialType == 0)
{
if (string.IsNullOrEmpty(AssetName) || string.IsNullOrEmpty(Description))
throw new NullReferenceException("Can't serialize the TrimComponent because the Asset Name or Description are null!");
if (string.IsNullOrEmpty(AssetName))
throw new NullReferenceException("Can't serialize the TrimComponent because the Asset Name is null!");
data.AddRange(DataTypes.GetString(AssetName));
data.AddRange(DataTypes.GetVarInt(Ingredient));
@ -85,22 +89,22 @@ public class TrimComponent(DataTypes dataTypes, ItemPalette itemPalette, SubComp
data.AddRange(DataTypes.GetString(assetName));
}
}
data.AddRange(DataTypes.GetString(Description));
data.AddRange(DataTypes.GetVarInt(TrimPatternType));
if (TrimPatternType == 0)
{
if (string.IsNullOrEmpty(TrimPatternTypeAssetName) || string.IsNullOrEmpty(TrimPatternTypeDescription))
throw new NullReferenceException("Can't serialize the TrimComponent because the TrimPatternTypeAssetName or TrimPatternTypeDescription are null!");
data.AddRange(DataTypes.GetString(TrimPatternTypeAssetName));
data.AddRange(DataTypes.GetVarInt(TemplateItem));
data.AddRange(DataTypes.GetString(TrimPatternTypeDescription));
data.AddRange(DataTypes.GetBool(Decal));
}
data.AddRange(DataTypes.GetBool(ShowInTooltip));
data.AddRange(DataTypes.GetNbt(DescriptionNbt));
}
data.AddRange(DataTypes.GetVarInt(TrimPatternType));
if (TrimPatternType == 0)
{
if (string.IsNullOrEmpty(TrimPatternTypeAssetName))
throw new NullReferenceException("Can't serialize the TrimComponent because the TrimPatternTypeAssetName is null!");
data.AddRange(DataTypes.GetString(TrimPatternTypeAssetName));
data.AddRange(DataTypes.GetVarInt(TemplateItem));
data.AddRange(DataTypes.GetNbt(TrimPatternTypeDescriptionNbt));
data.AddRange(DataTypes.GetBool(Decal));
}
data.AddRange(DataTypes.GetBool(ShowInTooltip));
return new Queue<byte>(data);
}