fix vehicle cargo categories not saving correctly

LeftofZen · LeftofZen · commit 4b7da73117f7 · 2025-02-05T14:56:29.000+11:00
diff --git a/Dat/Objects/Vehicle/VehicleObject.cs b/Dat/Objects/Vehicle/VehicleObject.cs
@@ -33,7 +33,7 @@ public record VehicleObject(
 		[property: LocoStructOffset(0xDC)] Speed16 RackSpeed,
 		[property: LocoStructOffset(0xDE)] uint16_t Weight,
 		[property: LocoStructOffset(0xE0)] VehicleObjectFlags Flags,
-		[property: LocoStructOffset(0xE2), LocoArrayLength(2), LocoStructVariableLoad] List<uint8_t> MaxCargo,
+		[property: LocoStructOffset(0xE2), LocoArrayLength(VehicleObject.CompatibleCargoTypesLength), LocoStructVariableLoad] List<uint8_t> MaxCargo,
 		[property: LocoStructOffset(0xE4), LocoArrayLength(VehicleObject.CompatibleCargoTypesLength), LocoStructVariableLoad, Browsable(false)] List<List<CargoCategory>> CompatibleCargoCategories,
 		[property: LocoStructOffset(0xEC), LocoArrayLength(VehicleObject.CargoTypeSpriteOffsetsLength), LocoStructVariableLoad] Dictionary<CargoCategory, uint8_t> CargoTypeSpriteOffsets,
 		[property: LocoStructOffset(0x10C), LocoStructVariableLoad, Browsable(false)] uint8_t _NumSimultaneousCargoTypes,
@@ -163,8 +163,7 @@ public ReadOnlySpan<byte> Load(ReadOnlySpan<byte> remainingData)
 					continue;
 				}
 
-				var ptr = BitConverter.ToUInt16(remainingData[0..2]);
-				while (ptr != (uint16_t)CargoCategory.NULL)
+				while ((CargoCategory)BitConverter.ToUInt16(remainingData[0..2]) != CargoCategory.NULL)
 				{
 					var cargoCategory = (CargoCategory)BitConverter.ToUInt16(remainingData[0..2]);
 					remainingData = remainingData[2..]; // uint16_t
@@ -178,9 +177,6 @@ public ReadOnlySpan<byte> Load(ReadOnlySpan<byte> remainingData)
 					{
 						// invalid object - shouldn't have 2 cargo types that are the same
 					}
-
-					// advance ptr
-					ptr = BitConverter.ToUInt16(remainingData[0..2]);
 				}
 
 				remainingData = remainingData[2..]; // uint16_t, skips the 0xFFFF bytes
@@ -261,7 +257,7 @@ public ReadOnlySpan<byte> Save()
 			// cargo types
 			for (var i = 0; i < CompatibleCargoTypesLength; ++i) // CompatibleCargoTypesLength should == CompatibleCargoCategories.Length
 			{
-				if (MaxCargo.Count < i)
+				if (MaxCargo.Count < i || MaxCargo[i] == 0)
 				{
 					ms.WriteByte(0); // write a 0 for MaxCargo - this indicates no more cargo and we skip the rest
 					continue;
@@ -277,8 +273,7 @@ public ReadOnlySpan<byte> Save()
 					ms.WriteByte(CargoTypeSpriteOffsets[cc]);
 				}
 
-				ms.WriteByte(0xFF);
-				ms.WriteByte(0xFF);
+				ms.Write(BitConverter.GetBytes((uint16_t)CargoCategory.NULL));
 			}
 
 			// animation
diff --git a/Dat/Objects/Vehicle/VehicleObjectFlags.cs b/Dat/Objects/Vehicle/VehicleObjectFlags.cs
@@ -15,7 +15,6 @@ public enum VehicleObjectFlags : uint16_t
 		// Alternates between sprite 0 and sprite 1 for each vehicle of this type in a train
 		// NOTE: This is for vehicles and not vehicle components (which can also do similar)
 		AlternatingCarSprite = 1 << 7,
-		unk_08 = 1 << 8,
 		AircraftIsTailDragger = 1 << 8,
 		AnyRoadType = 1 << 9, // set on all road vehicles except trams
 		SpeedControl = 1 << 10,
diff --git a/Gui/ViewModels/DatTypes/DatObjectEditorViewModel.cs b/Gui/ViewModels/DatTypes/DatObjectEditorViewModel.cs
@@ -41,6 +41,8 @@ public class DatObjectEditorViewModel : BaseLocoFileViewModel
 		[Reactive]
 		public UiDatLocoFile? CurrentObject { get; private set; }
 
+		public ReactiveCommand<Unit, Unit> ExportUncompressedCommand { get; }
+
 		public ReactiveCommand<Unit, Unit> ViewHexCommand { get; }
 		public Interaction<HexWindowViewModel, HexWindowViewModel?> HexViewerShowDialog { get; }
 
@@ -52,6 +54,8 @@ public DatObjectEditorViewModel(FileSystemItemObject currentFile, ObjectEditorMo
 		{
 			Load();
 
+			ExportUncompressedCommand = ReactiveCommand.Create(SaveAsUncompressedDat);
+
 			HexViewerShowDialog = new();
 			_ = HexViewerShowDialog.RegisterHandler(DoShowDialogAsync<HexWindowViewModel, HexViewerWindow>);
 
@@ -188,15 +192,21 @@ public override void Save()
 		}
 
 		public override void SaveAs()
+			=> SaveAsCore();
+
+		void SaveAsUncompressedDat()
+			=> SaveAsCore(SawyerEncoding.Uncompressed);
+
+		void SaveAsCore(SawyerEncoding? encodingToUse = null)
 		{
 			var saveFile = Task.Run(async () => await PlatformSpecific.SaveFilePicker(PlatformSpecific.DatFileTypes)).Result;
 			if (saveFile != null)
 			{
-				SaveCore(saveFile.Path.LocalPath);
+				SaveCore(saveFile.Path.LocalPath, encodingToUse);
 			}
 		}
 
-		void SaveCore(string filename)
+		void SaveCore(string filename, SawyerEncoding? encodingToUse = null)
 		{
 			if (CurrentObject?.LocoObject == null)
 			{
@@ -243,7 +253,7 @@ void SaveCore(string filename)
 			SawyerStreamWriter.Save(filename,
 				S5HeaderViewModel?.Name ?? CurrentObject.DatFileInfo.S5Header.Name,
 				S5HeaderViewModel?.SourceGame ?? CurrentObject.DatFileInfo.S5Header.SourceGame,
-				ObjectHeaderViewModel?.Encoding ?? SawyerEncoding.Uncompressed,
+				encodingToUse ?? ObjectHeaderViewModel?.Encoding ?? SawyerEncoding.Uncompressed,
 				CurrentObject.LocoObject,
 				logger,
 				Model.Settings.AllowSavingAsVanillaObject);
diff --git a/Gui/Views/DatObjectEditorView.axaml b/Gui/Views/DatObjectEditorView.axaml
@@ -8,8 +8,12 @@
 	x:Class="OpenLoco.Gui.Views.DatObjectEditorView"
 	x:DataType="vm:DatObjectEditorViewModel">
 	<DockPanel>
-		<Grid ColumnDefinitions="*, Auto, 384">
-			<TabControl Grid.Column="0">
+		<Grid ColumnDefinitions="*, Auto, 384" RowDefinitions="Auto, *">
+			<StackPanel Grid.Row="0" Grid.ColumnSpan="3" Orientation="Horizontal">
+				<Button Margin="4" Command="{Binding ExportUncompressedCommand}" ToolTip.Tip="Equivalent to saving the object with 'Uncompressed' encoding">Export as uncompressed DAT file</Button>
+				<Button Margin="4" Command="{Binding ViewHexCommand}">Hex Viewer</Button>
+			</StackPanel>
+			<TabControl Grid.Column="0" Grid.Row="1">
 				<TabControl.Styles>
 					<Style Selector="TabItem">
 						<Setter Property="Padding" Value="8"/>
@@ -157,8 +161,8 @@
 					</Border>
 				</TabItem>
 			</TabControl>
-			<GridSplitter Grid.Column="1" />
-			<TabControl Grid.Column="2">
+			<GridSplitter Grid.Column="1" Grid.Row="1" />
+			<TabControl Grid.Column="2" Grid.Row="1">
 				<TabControl.Styles>
 					<Style Selector="TabItem">
 						<Setter Property="Padding" Value="8"/>
@@ -173,12 +177,6 @@
 						</StackPanel>
 					</Border>
 				</TabItem>
-				<TabItem Header="Hex Dump" >
-					<StackPanel Orientation="Vertical">
-						<Button Command="{Binding ViewHexCommand}">Hex Viewer</Button>
-						<!--<Button Command="{Binding SelectObjectCommand}">Object Selector</Button>-->
-					</StackPanel>
-				</TabItem>
 			</TabControl>
 		</Grid>
 	</DockPanel>

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public record VehicleObject(`
`33`	`33`	`[property: LocoStructOffset(0xDC)] Speed16 RackSpeed,`
`34`	`34`	`[property: LocoStructOffset(0xDE)] uint16_t Weight,`
`35`	`35`	`[property: LocoStructOffset(0xE0)] VehicleObjectFlags Flags,`
`36`		`- [property: LocoStructOffset(0xE2), LocoArrayLength(2), LocoStructVariableLoad] List<uint8_t> MaxCargo,`
	`36`	`+ [property: LocoStructOffset(0xE2), LocoArrayLength(VehicleObject.CompatibleCargoTypesLength), LocoStructVariableLoad] List<uint8_t> MaxCargo,`
`37`	`37`	`[property: LocoStructOffset(0xE4), LocoArrayLength(VehicleObject.CompatibleCargoTypesLength), LocoStructVariableLoad, Browsable(false)] List<List<CargoCategory>> CompatibleCargoCategories,`
`38`	`38`	`[property: LocoStructOffset(0xEC), LocoArrayLength(VehicleObject.CargoTypeSpriteOffsetsLength), LocoStructVariableLoad] Dictionary<CargoCategory, uint8_t> CargoTypeSpriteOffsets,`
`39`	`39`	`[property: LocoStructOffset(0x10C), LocoStructVariableLoad, Browsable(false)] uint8_t _NumSimultaneousCargoTypes,`
`@@ -163,8 +163,7 @@ public ReadOnlySpan<byte> Load(ReadOnlySpan<byte> remainingData)`
`163`	`163`	`continue;`
`164`	`164`	`}`
`165`	`165`
`166`		`- var ptr = BitConverter.ToUInt16(remainingData[0..2]);`
`167`		`- while (ptr != (uint16_t)CargoCategory.NULL)`
	`166`	`+ while ((CargoCategory)BitConverter.ToUInt16(remainingData[0..2]) != CargoCategory.NULL)`
`168`	`167`	`{`
`169`	`168`	`var cargoCategory = (CargoCategory)BitConverter.ToUInt16(remainingData[0..2]);`
`170`	`169`	`remainingData = remainingData[2..]; // uint16_t`
`@@ -178,9 +177,6 @@ public ReadOnlySpan<byte> Load(ReadOnlySpan<byte> remainingData)`
`178`	`177`	`{`
`179`	`178`	`// invalid object - shouldn't have 2 cargo types that are the same`
`180`	`179`	`}`
`181`		`-`
`182`		`- // advance ptr`
`183`		`- ptr = BitConverter.ToUInt16(remainingData[0..2]);`
`184`	`180`	`}`
`185`	`181`
`186`	`182`	`remainingData = remainingData[2..]; // uint16_t, skips the 0xFFFF bytes`
`@@ -261,7 +257,7 @@ public ReadOnlySpan<byte> Save()`
`261`	`257`	`// cargo types`
`262`	`258`	`for (var i = 0; i < CompatibleCargoTypesLength; ++i) // CompatibleCargoTypesLength should == CompatibleCargoCategories.Length`
`263`	`259`	`{`
`264`		`- if (MaxCargo.Count < i)`
	`260`	`+ if (MaxCargo.Count < i \|\| MaxCargo[i] == 0)`
`265`	`261`	`{`
`266`	`262`	`ms.WriteByte(0); // write a 0 for MaxCargo - this indicates no more cargo and we skip the rest`
`267`	`263`	`continue;`
`@@ -277,8 +273,7 @@ public ReadOnlySpan<byte> Save()`
`277`	`273`	`ms.WriteByte(CargoTypeSpriteOffsets[cc]);`
`278`	`274`	`}`
`279`	`275`
`280`		`- ms.WriteByte(0xFF);`
`281`		`- ms.WriteByte(0xFF);`
	`276`	`+ ms.Write(BitConverter.GetBytes((uint16_t)CargoCategory.NULL));`
`282`	`277`	`}`
`283`	`278`
`284`	`279`	`// animation`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,8 @@ public class DatObjectEditorViewModel : BaseLocoFileViewModel`
`41`	`41`	`[Reactive]`
`42`	`42`	`public UiDatLocoFile? CurrentObject { get; private set; }`
`43`	`43`
	`44`	`+ public ReactiveCommand<Unit, Unit> ExportUncompressedCommand { get; }`
	`45`	`+`
`44`	`46`	`public ReactiveCommand<Unit, Unit> ViewHexCommand { get; }`
`45`	`47`	`public Interaction<HexWindowViewModel, HexWindowViewModel?> HexViewerShowDialog { get; }`
`46`	`48`
`@@ -52,6 +54,8 @@ public DatObjectEditorViewModel(FileSystemItemObject currentFile, ObjectEditorMo`
`52`	`54`	`{`
`53`	`55`	`Load();`
`54`	`56`
	`57`	`+ ExportUncompressedCommand = ReactiveCommand.Create(SaveAsUncompressedDat);`
	`58`	`+`
`55`	`59`	`HexViewerShowDialog = new();`
`56`	`60`	`_ = HexViewerShowDialog.RegisterHandler(DoShowDialogAsync<HexWindowViewModel, HexViewerWindow>);`
`57`	`61`
`@@ -188,15 +192,21 @@ public override void Save()`
`188`	`192`	`}`
`189`	`193`
`190`	`194`	`public override void SaveAs()`
	`195`	`+ => SaveAsCore();`
	`196`	`+`
	`197`	`+ void SaveAsUncompressedDat()`
	`198`	`+ => SaveAsCore(SawyerEncoding.Uncompressed);`
	`199`	`+`
	`200`	`+ void SaveAsCore(SawyerEncoding? encodingToUse = null)`
`191`	`201`	`{`
`192`	`202`	`var saveFile = Task.Run(async () => await PlatformSpecific.SaveFilePicker(PlatformSpecific.DatFileTypes)).Result;`
`193`	`203`	`if (saveFile != null)`
`194`	`204`	`{`
`195`		`- SaveCore(saveFile.Path.LocalPath);`
	`205`	`+ SaveCore(saveFile.Path.LocalPath, encodingToUse);`
`196`	`206`	`}`
`197`	`207`	`}`
`198`	`208`
`199`		`- void SaveCore(string filename)`
	`209`	`+ void SaveCore(string filename, SawyerEncoding? encodingToUse = null)`
`200`	`210`	`{`
`201`	`211`	`if (CurrentObject?.LocoObject == null)`
`202`	`212`	`{`
`@@ -243,7 +253,7 @@ void SaveCore(string filename)`
`243`	`253`	`SawyerStreamWriter.Save(filename,`
`244`	`254`	`S5HeaderViewModel?.Name ?? CurrentObject.DatFileInfo.S5Header.Name,`
`245`	`255`	`S5HeaderViewModel?.SourceGame ?? CurrentObject.DatFileInfo.S5Header.SourceGame,`
`246`		`- ObjectHeaderViewModel?.Encoding ?? SawyerEncoding.Uncompressed,`
	`256`	`+ encodingToUse ?? ObjectHeaderViewModel?.Encoding ?? SawyerEncoding.Uncompressed,`
`247`	`257`	`CurrentObject.LocoObject,`
`248`	`258`	`logger,`
`249`	`259`	`Model.Settings.AllowSavingAsVanillaObject);`