Add Trough Component

README.md

@@ -15,6 +15,8 @@ other "current gen" engines, while keeping backwards-compatibility.
 VPE also aims to significantly improve the editor experience by extending the 
 editor of the game engine.
 
+For a more detailed overview, header over to the [website](https://docs.visualpinball.org/creators-guide/introduction/overview.html)!
+
 ## How?
 
 The "core" of VPE (i.e. the `VisualPinball.Engine` project) is a pure C# port
@@ -32,7 +34,7 @@ VPE is still work in progress. You can check the current features list [here](ht
 and the open issues [here](https://github.com/freezy/VisualPinball.Engine/issues).
 
 There are a few videos in the [VPF thread](https://www.vpforums.org/index.php?showtopic=43651), 
-where you can discuss.
+where you can discuss. Screenshots are [here](https://github.com/freezy/VisualPinball.Engine/wiki/Unity-Screenshots! :)
 
 ## Credits
 

VisualPinball.Engine.Test/Test/Fixtures.cs

@@ -51,6 +51,7 @@ public static class VpxPath
 		public static readonly string Texture = PathHelper.GetFixturePath("TextureTest.vpx");
 		public static readonly string Timer = PathHelper.GetFixturePath("TimerTest.vpx");
 		public static readonly string Trigger = PathHelper.GetFixturePath("TriggerTest.vpx");
+		public static readonly string Trough = PathHelper.GetFixturePath("TroughTest.vpx");
 	}
 
 	public static class ObjPath

VisualPinball.Engine.Test/VPT/Mappings/MappingsDataTests.cs

@@ -44,7 +44,7 @@ public void ShouldWriteMappingsData()
 
 		private static void ValidateTableData(MappingsData data)
 		{
-			data.Switches.Length.Should().Be(4);
+			data.Switches.Length.Should().Be(13);
 
 			data.Switches[0].Id.Should().Be("s_create_ball");
 			data.Switches[0].Description.Should().Be("Create Ball");
@@ -72,7 +72,20 @@ private static void ValidateTableData(MappingsData data)
 			data.Switches[3].Source.Should().Be(SwitchSource.Constant);
 			data.Switches[3].Constant.Should().Be(SwitchConstant.NormallyClosed);
 
-			data.Coils.Length.Should().Be(2);
+			data.Switches[3].Id.Should().Be("s_right_flipper");
+			data.Switches[3].Description.Should().Be("Right Flipper");
+			data.Switches[3].Source.Should().Be(SwitchSource.Constant);
+			data.Switches[3].Constant.Should().Be(SwitchConstant.NormallyClosed);
+
+			data.Switches[7].Id.Should().Be("s_trough1");
+			data.Switches[7].Description.Should().Be("Trough 1 (eject)");
+			data.Switches[7].Source.Should().Be(SwitchSource.Device);
+			data.Switches[7].Device.Should().Be("Trough");
+			data.Switches[7].DeviceItem.Should().Be("1");
+			data.Switches[7].Type.Should().Be(SwitchType.OnOff);
+			data.Switches[7].PulseDelay.Should().Be(250);
+
+			data.Coils.Length.Should().Be(6);
 
 			data.Coils[0].Id.Should().Be("c_auto_plunger");
 			data.Coils[0].Description.Should().Be("Auto Plunger");
@@ -86,6 +99,14 @@ private static void ValidateTableData(MappingsData data)
 			data.Coils[1].PlayfieldItem.Should().Be("Flipper1");
 			data.Coils[1].Type.Should().Be(CoilType.DualWound);
 			data.Coils[1].HoldCoilId.Should().Be("c_left_flipper_hold");
+
+			data.Coils[5].Id.Should().Be("c_trough_eject");
+			data.Coils[5].Description.Should().Be("Trough Eject");
+			data.Coils[5].Destination.Should().Be(CoilDestination.Device);
+			data.Coils[5].Device.Should().Be("Trough");
+			data.Coils[5].DeviceItem.Should().Be("eject");
+			data.Coils[5].Type.Should().Be(CoilType.SingleWound);
+			data.Coils[5].HoldCoilId.Should().Be("");
 		}
 	}
 }

VisualPinball.Engine.Test/VPT/Trough/TroughDataTests.cs

@@ -0,0 +1,53 @@
+// Visual Pinball Engine
+// Copyright (C) 2020 freezy and VPE Team
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+using FluentAssertions;
+using NUnit.Framework;
+using VisualPinball.Engine.Test.Test;
+using VisualPinball.Engine.VPT.Trough;
+
+namespace VisualPinball.Engine.Test.VPT.Trough
+{
+	public class TroughDataTests
+	{
+		[Test]
+		public void ShouldReadTroughData()
+		{
+			var table = Engine.VPT.Table.Table.Load(VpxPath.Trough);
+			ValidateTroughData(table.Trough("Trough1").Data);
+		}
+
+		[Test]
+		public void ShouldWriteTroughData()
+		{
+			const string tmpFileName = "ShouldWriteTroughData.vpx";
+			var table = Engine.VPT.Table.Table.Load(VpxPath.Trough);
+			table.Save(tmpFileName);
+			var writtenTable = Engine.VPT.Table.Table.Load(tmpFileName);
+			ValidateTroughData(writtenTable.Trough("Trough1").Data);
+		}
+
+		private static void ValidateTroughData(TroughData data)
+		{
+			data.BallCount.Should().Be(3);
+			data.SwitchCount.Should().Be(4);
+			data.SettleTime.Should().Be(112);
+			data.EntryKicker.Should().Be("BallDrain");
+			data.ExitKicker.Should().Be("BallRelease");
+			data.JamSwitch.Should().Be("TroughJam");
+		}
+	}
+}

VisualPinball.Engine/Game/Engines/GamelogicEngineCoil.cs

@@ -22,5 +22,7 @@ public struct GamelogicEngineCoil
 		public string Description;
 		public string PlayfieldItemHint;
 		public string MainCoilIdOfHoldCoil;
+		public string DeviceHint;
+		public string DeviceItemHint;
 	}
 }

VisualPinball.Engine/Game/Engines/GamelogicEngineSwitch.cs

@@ -23,5 +23,7 @@ public struct GamelogicEngineSwitch
 		public string InputActionHint;
 		public string InputMapHint;
 		public string PlayfieldItemHint;
+		public string DeviceHint;
+		public string DeviceItemHint;
 	}
 }

VisualPinball.Engine/Game/ICoilable.cs

@@ -19,6 +19,5 @@ namespace VisualPinball.Engine.Game
 	public interface ICoilable
 	{
 		string Name { get; }
-		bool IsDualWound { get; set; }
 	}
 }

VisualPinball.Engine/Game/ICoilableDevice.cs

@@ -0,0 +1,28 @@
+// Visual Pinball Engine
+// Copyright (C) 2020 freezy and VPE Team
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+using System.Collections.Generic;
+using VisualPinball.Engine.Game.Engines;
+
+namespace VisualPinball.Engine.Game
+{
+	public interface ICoilableDevice
+	{
+		string Name { get; }
+
+		IEnumerable<GamelogicEngineCoil> AvailableCoils { get; }
+	}
+}

VisualPinball.Engine/Game/ISwitchableDevice.cs

@@ -0,0 +1,28 @@
+// Visual Pinball Engine
+// Copyright (C) 2020 freezy and VPE Team
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+using System.Collections.Generic;
+using VisualPinball.Engine.Game.Engines;
+
+namespace VisualPinball.Engine.Game
+{
+	public interface ISwitchableDevice
+	{
+		string Name { get; }
+
+		IEnumerable<GamelogicEngineSwitch> AvailableSwitches { get; }
+	}
+}

VisualPinball.Engine/VPT/Item.cs

@@ -15,7 +15,6 @@
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
 using System;
-using VisualPinball.Engine.Math;
 
 namespace VisualPinball.Engine.VPT
 {

VisualPinball.Engine/VPT/ItemType.cs

@@ -54,5 +54,6 @@ public enum ItemType
 
 		// VPE internal
 		Ball = 100,
+		Trough = 101,
 	}
 }