show unknown vehicle flags, fix other misc mistakes (#67)

LeftofZen · web-flow · commit c9a5af507489 · 2024-08-20T00:59:49.000+10:00
diff --git a/Dat/Objects/DockObject.cs b/Dat/Objects/DockObject.cs
@@ -9,7 +9,7 @@ namespace OpenLoco.Dat.Objects
 	public enum DockObjectFlags : uint16_t
 	{
 		None = 0,
-		unk01 = 1 << 0,
+		HasShadows = 1 << 0,
 	};
 
 	[TypeConverter(typeof(ExpandableObjectConverter))]
diff --git a/Dat/Objects/Industry/IndustryObjectFlags.cs b/Dat/Objects/Industry/IndustryObjectFlags.cs
@@ -1,4 +1,4 @@
-﻿namespace OpenLoco.Dat.Objects
+namespace OpenLoco.Dat.Objects
 {
 	[Flags]
 	public enum IndustryObjectFlags : uint32_t
@@ -19,19 +19,19 @@ public enum IndustryObjectFlags : uint32_t
 		BuiltRequiresOpenSpace = 1 << 12,
 		Oilfield = 1 << 13,
 		Mines = 1 << 14,
-		unk15 = 1 << 15,
+		NotRotatable = 1 << 15,
 		CanBeFoundedByPlayer = 1 << 16,
 		RequiresAllCargo = 1 << 17,
-		unk18 = 1 << 18,
-		unk19 = 1 << 19,
-		unk20 = 1 << 20,
+		unk_18 = 1 << 18,
+		unk_19 = 1 << 19,
+		RequiresElectricityPylons = 1 << 20,
 		HasShadows = 1 << 21,
-		unk22 = 1 << 22,
-		unk23 = 1 << 23,
+		unk_22 = 1 << 22,
+		unk_23 = 1 << 23,
 		BuiltInDesert = 1 << 24,
 		BuiltNearDesert = 1 << 25,
-		unk26 = 1 << 26,
-		unk27 = 1 << 27,
-		unk28 = 1 << 28,
+		unk_26 = 1 << 26,
+		unk_27 = 1 << 27,
+		unk_28 = 1 << 28,
 	}
 }
diff --git a/Dat/Objects/LandObject.cs b/Dat/Objects/LandObject.cs
@@ -9,10 +9,12 @@ namespace OpenLoco.Dat.Objects
 	public enum LandObjectFlags : uint8_t
 	{
 		None = 0,
-		unk0 = 1 << 0,
-		unk1 = 1 << 1,
+		unk_00 = 1 << 0,
+		unk_01 = 1 << 1,
 		IsDesert = 1 << 2,
 		NoTrees = 1 << 3,
+		unk_04 = 1 << 4,
+		unk_05 = 1 << 5,
 	};
 
 	[TypeConverter(typeof(ExpandableObjectConverter))]
@@ -48,7 +50,7 @@ public ReadOnlySpan<byte> Load(ReadOnlySpan<byte> remainingData)
 			remainingData = remainingData[S5Header.StructLength..];
 
 			// unused obj
-			if (Flags.HasFlag(LandObjectFlags.unk1))
+			if (Flags.HasFlag(LandObjectFlags.unk_01))
 			{
 				UnkObjHeader = S5Header.Read(remainingData[..S5Header.StructLength]);
 				remainingData = remainingData[S5Header.StructLength..];
@@ -59,12 +61,12 @@ public ReadOnlySpan<byte> Load(ReadOnlySpan<byte> remainingData)
 
 		public ReadOnlySpan<byte> Save()
 		{
-			var variableDataSize = S5Header.StructLength + (Flags.HasFlag(LandObjectFlags.unk1) ? S5Header.StructLength : 0);
+			var variableDataSize = S5Header.StructLength + (Flags.HasFlag(LandObjectFlags.unk_01) ? S5Header.StructLength : 0);
 
 			var data = new byte[variableDataSize];
 			data = [.. CliffEdgeHeader.Write()];
 
-			if (Flags.HasFlag(LandObjectFlags.unk1))
+			if (Flags.HasFlag(LandObjectFlags.unk_01))
 			{
 				UnkObjHeader.Write().CopyTo(data.AsSpan()[S5Header.StructLength..]);
 			}
diff --git a/Dat/Objects/RoadObject.cs b/Dat/Objects/RoadObject.cs
@@ -8,7 +8,7 @@ namespace OpenLoco.Dat.Objects
 	[Flags]
 	public enum RoadObjectFlags : uint16_t
 	{
-		none = 0,
+		None = 0,
 		unk_00 = 1 << 0,
 		unk_01 = 1 << 1,
 		unk_02 = 1 << 2,
diff --git a/Dat/Objects/SteamObject.cs b/Dat/Objects/SteamObject.cs
@@ -11,8 +11,8 @@ public enum SteamObjectFlags : uint16_t
 		None = 0,
 		ApplyWind = 1 << 0,
 		DisperseOnCollision = 1 << 1,
-		unk2 = 1 << 2,
-		unk3 = 1 << 3,
+		unk_02 = 1 << 2,
+		unk_03 = 1 << 3,
 	};
 
 	[TypeConverter(typeof(ExpandableObjectConverter))]
diff --git a/Dat/Objects/TrainSignalObject.cs b/Dat/Objects/TrainSignalObject.cs
@@ -11,7 +11,7 @@ public enum TrainSignalObjectFlags : uint16_t
 		None = 0 << 0,
 		IsLeft = 1 << 0,
 		HasLights = 1 << 1,
-		unk1 = 1 << 2,
+		unk_02 = 1 << 2,
 	}
 
 	[TypeConverter(typeof(ExpandableObjectConverter))]
diff --git a/Dat/Objects/TreeObject.cs b/Dat/Objects/TreeObject.cs
@@ -10,11 +10,11 @@ public enum TreeObjectFlags : uint16_t
 	{
 		None = 0,
 		HasSnowVariation = 1 << 0,
-		unk1 = 1 << 1,
+		unk_01 = 1 << 1,
 		VeryHighAltitude = 1 << 2,
 		HighAltitude = 1 << 3,
 		RequiresWater = 1 << 4,
-		unk5 = 1 << 5,
+		unk_05 = 1 << 5,
 		DroughtResistant = 1 << 6,
 		HasShadow = 1 << 7,
 	};
diff --git a/Dat/Objects/Vehicle/BogieSpriteFlags.cs b/Dat/Objects/Vehicle/BogieSpriteFlags.cs
@@ -1,13 +1,15 @@
-﻿namespace OpenLoco.Dat.Objects
+namespace OpenLoco.Dat.Objects
 {
 	[Flags]
 	public enum BogieSpriteFlags : uint8_t
 	{
 		None = 0,
 		HasSprites = 1 << 0,         // If not set then no bogie will be loaded
 		RotationalSymmetry = 1 << 1, // requires 16 rather than 32 sprites
-		HasGentleSprites = 1 << 2,   // for gentle slopes
-		HasSteepSprites = 1 << 3,    // for steep slopes
-		unk_4 = 1 << 4,              // Increases bounding box size
+		unk_02 = 1 << 2,
+		HasGentleSprites = 1 << 3,   // for gentle slopes
+		HasSteepSprites = 1 << 4,    // for steep slopes
+		HasBrakingLights = 1 << 5,
+		HasSpeedAnimation = 1 << 6, // Speed based animation (such as hydrofoil)
 	};
 }
diff --git a/Dat/Objects/Vehicle/VehicleObject.cs b/Dat/Objects/Vehicle/VehicleObject.cs
@@ -142,7 +142,7 @@ public Engine2Sound? SoundPropertyEngine2
 		public ReadOnlySpan<byte> Load(ReadOnlySpan<byte> remainingData)
 		{
 			// track type
-			if (!Flags.HasFlag(VehicleObjectFlags.unk09) && (Mode == TransportMode.Rail || Mode == TransportMode.Road))
+			if (!Flags.HasFlag(VehicleObjectFlags.unk_09) && (Mode == TransportMode.Rail || Mode == TransportMode.Road))
 			{
 				TrackType = S5Header.Read(remainingData[..S5Header.StructLength]);
 				remainingData = remainingData[S5Header.StructLength..];
@@ -259,7 +259,7 @@ public ReadOnlySpan<byte> Save()
 			var ms = new MemoryStream();
 
 			// track type
-			if (!Flags.HasFlag(VehicleObjectFlags.unk09) && (Mode == TransportMode.Rail || Mode == TransportMode.Road))
+			if (!Flags.HasFlag(VehicleObjectFlags.unk_09) && (Mode == TransportMode.Rail || Mode == TransportMode.Road))
 			{
 				ms.Write(TrackType!.Write());
 			}
@@ -500,7 +500,7 @@ public bool Validate()
 				return false;
 			}
 
-			if (Flags.HasFlag(VehicleObjectFlags.unk09))
+			if (Flags.HasFlag(VehicleObjectFlags.unk_09))
 			{
 				if (NumTrackExtras != 0)
 				{
diff --git a/Dat/Objects/Vehicle/VehicleObjectFlags.cs b/Dat/Objects/Vehicle/VehicleObjectFlags.cs
@@ -4,16 +4,21 @@ namespace OpenLoco.Dat.Objects
 	public enum VehicleObjectFlags : uint16_t
 	{
 		None = 0,
-		flag_02 = 1 << 2, // rollable? APT Passenger carriage
-		flag_03 = 1 << 3, // rollable? APT Driving carriage
+		unk_00 = 1 << 0,
+		unk_01 = 1 << 1,
+		unk_02 = 1 << 2, // rollable? APT Passenger carriage
+		unk_03 = 1 << 3, // rollable? APT Driving carriage
+		unk_04 = 1 << 4,
+		unk_05 = 1 << 5,
 		RackRail = 1 << 6,
-		unk08 = 1 << 8,
-		unk09 = 1 << 9, // any-track??
+		unk_07 = 1 << 7,
+		unk_08 = 1 << 8,
+		unk_09 = 1 << 9, // any-track??
 		SpeedControl = 1 << 10,
 		CanCouple = 1 << 11,
-		unk12 = 1 << 12, // dual-head??
+		unk_12 = 1 << 12, // dual-head??
 		IsHelicopter = 1 << 13,
 		Refittable = 1 << 14,
-		unk15 = 1 << 15, // no-announce??
+		unk_15 = 1 << 15, // no-announce??
 	};
 }
diff --git a/Dat/Objects/WallObject.cs b/Dat/Objects/WallObject.cs
@@ -13,10 +13,10 @@ public enum WallObjectFlags : uint8_t
 		HasGlass = 1 << 1,  // unused? only for rct2?
 		OnlyOnLevelLand = 1 << 2,
 		DoubleSided = 1 << 3, // unused? only for rct2?
-		Door = 1 << 4, // unused? only for rct2?
-		LongDoorAnimation = 1 << 5, // unused? only for rct2?
+		Door_UNUSED = 1 << 4, // unused, setting it in loco does nothing
+		LongDoor_UNUSED = 1 << 5, // unused, setting it in loco does nothing
 		HasSecondaryColour = 1 << 6,
-		HasTertiaryColour = 1 << 7, // unused? only for rct2?
+		HasTertiaryColour_UNUSED = 1 << 7, // unused, setting it in loco does nothing
 	};
 
 	// this is copied from OpenRCT2: https://github.com/OpenRCT2/OpenRCT2/blob/develop/src/openrct2/object/WallSceneryEntry.h
diff --git a/Dat/Types/G1Element32.cs b/Dat/Types/G1Element32.cs
@@ -8,7 +8,7 @@ public enum G1ElementFlags : uint16_t
 	{
 		None = 0,
 		HasTransparency = 1 << 0,   // Image data contains transparent sections (when not set data is plain bmp)
-		unk1 = 1 << 1,              // Unknown function not used on any entry
+		unk_01 = 1 << 1,              // Unknown function not used on any entry
 		IsRLECompressed = 1 << 2,   // Image data is encoded using CS's form of run length encoding
 		IsR8G8B8Palette = 1 << 3,   // Image data is a sequence of palette entries R8G8B8
 		HasZoomSprites = 1 << 4,    // Use a different sprite for higher zoom levels
diff --git a/Dat/Types/SCV5/CompanyFlags.cs b/Dat/Types/SCV5/CompanyFlags.cs
@@ -4,9 +4,9 @@ namespace OpenLoco.Dat.Types.SCV5
 	public enum CompanyFlags : uint32_t
 	{
 		None = 0U,
-		Unk0 = 1U << 0,                      // 0x01
-		Unk1 = 1U << 1,                      // 0x02
-		Unk2 = 1U << 2,                      // 0x04
+		unk_00 = 1U << 0,                    // 0x01
+		unk_01 = 1U << 1,                    // 0x02
+		unk_02 = 1U << 2,                    // 0x04
 		Sorted = 1U << 3,                    // 0x08
 		IncreasedPerformance = 1U << 4,      // 0x10
 		DecreasedPerformance = 1U << 5,      // 0x20
diff --git a/Dat/Types/SCV5/ObjectiveFlags.cs b/Dat/Types/SCV5/ObjectiveFlags.cs
@@ -7,7 +7,7 @@ public enum ObjectiveFlags : uint8_t
 		BeTopCompany = (byte)(1U << 0),
 		BeWithinTopThreeCompanies = (byte)(1U << 1),
 		WithinTimeLimit = (byte)(1U << 2),
-		Flag_3 = (byte)(1U << 3),
-		Flag_4 = (byte)(1U << 4),
+		unk_03 = (byte)(1U << 3),
+		unk_04 = (byte)(1U << 4),
 	}
 }
diff --git a/Dat/Types/SCV5/S5FixFlags.cs b/Dat/Types/SCV5/S5FixFlags.cs
@@ -3,8 +3,8 @@ namespace OpenLoco.Dat.Types.SCV5
 	[Flags]
 	public enum S5FixFlags : uint16_t
 	{
-		none = (uint16_t)0U,
-		fixFlag0 = (uint16_t)1U << 0,
-		fixFlag1 = (uint16_t)1U << 1,
+		None = (uint16_t)0U,
+		FixFlag0 = (uint16_t)1U << 0,
+		FixFlag1 = (uint16_t)1U << 1,
 	};
 }
diff --git a/Tests/LoadSaveTests.cs b/Tests/LoadSaveTests.cs
@@ -371,7 +371,7 @@ void assertFunc(ILocoObject obj, IndustryObject struc) => Assert.Multiple(() =>
 				Assert.That(struc.CostFactor, Is.EqualTo(400), nameof(struc.CostFactor));
 				Assert.That(struc.CostIndex, Is.EqualTo(1), nameof(struc.CostIndex));
 				Assert.That(struc.DesignedYear, Is.EqualTo(0), nameof(struc.DesignedYear));
-				Assert.That(struc.Flags, Is.EqualTo(IndustryObjectFlags.BuiltOnLowGround | IndustryObjectFlags.BuiltAwayFromTown | IndustryObjectFlags.unk18 | IndustryObjectFlags.unk19), nameof(struc.Flags));
+				Assert.That(struc.Flags, Is.EqualTo(IndustryObjectFlags.BuiltOnLowGround | IndustryObjectFlags.BuiltAwayFromTown | IndustryObjectFlags.unk_18 | IndustryObjectFlags.unk_19), nameof(struc.Flags));
 				Assert.That(struc.InitialProductionRate[0].Min, Is.EqualTo(8));
 				Assert.That(struc.InitialProductionRate[0].Max, Is.EqualTo(12));
 				Assert.That(struc.InitialProductionRate[1].Min, Is.EqualTo(0));
@@ -532,7 +532,7 @@ void assertFunc(ILocoObject obj, LandObject struc) => Assert.Multiple(() =>
 				Assert.That(struc.CostIndex, Is.EqualTo(2), nameof(struc.CostIndex));
 				Assert.That(struc.var_03, Is.EqualTo(5), nameof(struc.var_03));
 				Assert.That(struc.var_04, Is.EqualTo(1), nameof(struc.var_04));
-				Assert.That(struc.Flags, Is.EqualTo(LandObjectFlags.unk0), nameof(struc.Flags));
+				Assert.That(struc.Flags, Is.EqualTo(LandObjectFlags.unk_00), nameof(struc.Flags));
 				Assert.That(struc.CliffEdgeHeader1, Is.EqualTo(0), nameof(struc.CliffEdgeHeader1));
 				Assert.That(struc.CliffEdgeHeader2, Is.EqualTo(0), nameof(struc.CliffEdgeHeader2));
 				Assert.That(struc.CostFactor, Is.EqualTo(20), nameof(struc.CostFactor));
@@ -714,7 +714,7 @@ void assertFunc(ILocoObject obj, SteamObject struc) => Assert.Multiple(() =>
 			{
 				Assert.That(struc.Name, Is.EqualTo(0), nameof(struc.Name));
 
-				Assert.That(struc.Flags, Is.EqualTo(SteamObjectFlags.ApplyWind | SteamObjectFlags.DisperseOnCollision | SteamObjectFlags.unk2), nameof(struc.Flags));
+				Assert.That(struc.Flags, Is.EqualTo(SteamObjectFlags.ApplyWind | SteamObjectFlags.DisperseOnCollision | SteamObjectFlags.unk_02), nameof(struc.Flags));
 				// FrameInfoType0 contents
 				// FrameInfoType1 contents
 				Assert.That(struc.FrameInfoType0, Has.Count.EqualTo(47), nameof(struc.FrameInfoType0));
diff --git a/WinGui/Properties/Resources.Designer.cs b/WinGui/Properties/Resources.Designer.cs

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ namespace OpenLoco.Dat.Objects`
`9`	`9`	`public enum DockObjectFlags : uint16_t`
`10`	`10`	`{`
`11`	`11`	`None = 0,`
`12`		`- unk01 = 1 << 0,`
	`12`	`+ HasShadows = 1 << 0,`
`13`	`13`	`};`
`14`	`14`
`15`	`15`	`[TypeConverter(typeof(ExpandableObjectConverter))]`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace OpenLoco.Dat.Objects`
`8`	`8`	`[Flags]`
`9`	`9`	`public enum RoadObjectFlags : uint16_t`
`10`	`10`	`{`
`11`		`- none = 0,`
	`11`	`+ None = 0,`
`12`	`12`	`unk_00 = 1 << 0,`
`13`	`13`	`unk_01 = 1 << 1,`
`14`	`14`	`unk_02 = 1 << 2,`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public enum TrainSignalObjectFlags : uint16_t`
`11`	`11`	`None = 0 << 0,`
`12`	`12`	`IsLeft = 1 << 0,`
`13`	`13`	`HasLights = 1 << 1,`
`14`		`- unk1 = 1 << 2,`
	`14`	`+ unk_02 = 1 << 2,`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`[TypeConverter(typeof(ExpandableObjectConverter))]`
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ public Engine2Sound? SoundPropertyEngine2`
`142`	`142`	`public ReadOnlySpan<byte> Load(ReadOnlySpan<byte> remainingData)`
`143`	`143`	`{`
`144`	`144`	`// track type`
`145`		`- if (!Flags.HasFlag(VehicleObjectFlags.unk09) && (Mode == TransportMode.Rail \|\| Mode == TransportMode.Road))`
	`145`	`+ if (!Flags.HasFlag(VehicleObjectFlags.unk_09) && (Mode == TransportMode.Rail \|\| Mode == TransportMode.Road))`
`146`	`146`	`{`
`147`	`147`	`TrackType = S5Header.Read(remainingData[..S5Header.StructLength]);`
`148`	`148`	`remainingData = remainingData[S5Header.StructLength..];`
`@@ -259,7 +259,7 @@ public ReadOnlySpan<byte> Save()`
`259`	`259`	`var ms = new MemoryStream();`
`260`	`260`
`261`	`261`	`// track type`
`262`		`- if (!Flags.HasFlag(VehicleObjectFlags.unk09) && (Mode == TransportMode.Rail \|\| Mode == TransportMode.Road))`
	`262`	`+ if (!Flags.HasFlag(VehicleObjectFlags.unk_09) && (Mode == TransportMode.Rail \|\| Mode == TransportMode.Road))`
`263`	`263`	`{`
`264`	`264`	`ms.Write(TrackType!.Write());`
`265`	`265`	`}`
`@@ -500,7 +500,7 @@ public bool Validate()`
`500`	`500`	`return false;`
`501`	`501`	`}`
`502`	`502`
`503`		`- if (Flags.HasFlag(VehicleObjectFlags.unk09))`
	`503`	`+ if (Flags.HasFlag(VehicleObjectFlags.unk_09))`
`504`	`504`	`{`
`505`	`505`	`if (NumTrackExtras != 0)`
`506`	`506`	`{`