mech: Handle solenoids by coil manager.

Author: freezy

VisualPinball.Engine.PinMAME.Unity/Editor/PinMameMechInspector.cs

@@ -27,8 +27,6 @@ namespace VisualPinball.Unity.Editor
 	public class PinMameMechInspector : ItemInspector
 	{
 		private SerializedProperty _typeProperty;
-		private SerializedProperty _solenoid1Property;
-		private SerializedProperty _solenoid2Property;
 		private SerializedProperty _repeatProperty;
 		private SerializedProperty _linearMovementProperty;
 		private SerializedProperty _fastUpdatesProperty;
@@ -46,8 +44,6 @@ protected override void OnEnable()
 			base.OnEnable();
 
 			_typeProperty = serializedObject.FindProperty(nameof(PinMameMechComponent.Type));
-			_solenoid1Property = serializedObject.FindProperty(nameof(PinMameMechComponent.Solenoid1));
-			_solenoid2Property = serializedObject.FindProperty(nameof(PinMameMechComponent.Solenoid2));
 			_repeatProperty = serializedObject.FindProperty(nameof(PinMameMechComponent.Repeat));
 			_linearMovementProperty = serializedObject.FindProperty(nameof(PinMameMechComponent.LinearMovement));
 			_fastUpdatesProperty = serializedObject.FindProperty(nameof(PinMameMechComponent.FastUpdates));
@@ -66,15 +62,6 @@ public override void OnInspectorGUI()
 			OnPreInspectorGUI();
 
 			PropertyField(_typeProperty);
-			if (_typeProperty.enumValueIndex == (int)PinMameMechType.OneDirectionalSolenoid) {
-				PropertyField(_solenoid1Property, "Solenoid");
-
-			} else {
-				PropertyField(_solenoid1Property);
-			}
-			if (_typeProperty.enumValueIndex > (int)PinMameMechType.OneDirectionalSolenoid && _typeProperty.enumValueIndex != (int)PinMameMechType.FourStepperSolenoids) {
-				PropertyField(_solenoid2Property);
-			}
 			PropertyField(_repeatProperty);
 			PropertyField(_lengthProperty);
 			PropertyField(_stepsProperty);

VisualPinball.Engine.PinMAME.Unity/Runtime/PinMameGamelogicEngine.cs

@@ -174,6 +174,10 @@ public void OnInit(Player player, TableApi tableApi, BallManager ballManager)
 		public void RegisterMech(PinMameMechComponent mechComponent)
 		{
 			var id = _numMechs++;
+			if (id > _pinMame.GetMaxMechs()) {
+				Logger.Error($"PinMAME only supports up to {_pinMame.GetMaxMechs()} custom mechs, ignoring {mechComponent.name}.");
+				return;
+			}
 			_registeredMechs[id] = mechComponent;
 		}
 
@@ -486,7 +490,7 @@ public void SendInitialSwitches()
 		private void SendMechs()
 		{
 			foreach (var (id, mech) in _registeredMechs) {
-				var mechConfig = mech.Config(_player.SwitchMapping);
+				var mechConfig = mech.Config(_player.SwitchMapping, _player.CoilMapping);
 				_pinMame.SetMech(id, mechConfig);
 				foreach (var c in mechConfig.SwitchList) {
 					_mechSwitches.Add(c.SwNo);

VisualPinball.Engine.PinMAME.Unity/Runtime/PinMameMechComponent.cs

@@ -29,19 +29,13 @@
 namespace VisualPinball.Engine.PinMAME
 {
 	[AddComponentMenu("Visual Pinball/PinMAME/PinMAME Mech Handler")]
-	public class PinMameMechComponent : MonoBehaviour, IMechHandler, ISwitchDeviceComponent, ISerializationCallbackReceiver
+	public class PinMameMechComponent : MonoBehaviour, IMechHandler, ISwitchDeviceComponent, ICoilDeviceComponent, ISerializationCallbackReceiver
 	{
 		#region Data
 
 		[Tooltip("This defines how the mech is controlled.")]
 		public PinMameMechType Type = PinMameMechType.OneDirectionalSolenoid;
 
-		[Tooltip("The first solenoid handled by the mech.")]
-		public int Solenoid1;
-
-		[Tooltip("The second solenoid handled by the mech.")]
-		public int Solenoid2;
-
 		[Tooltip("How the mech behaves when the end of the range of motion is reached.")]
 		public PinMameRepeat Repeat;
 
@@ -71,6 +65,7 @@ public class PinMameMechComponent : MonoBehaviour, IMechHandler, ISwitchDeviceCo
 		[Tooltip("The amount of time in milliseconds required to reach full speed.")]
 		public int Acceleration;
 
+		[Unit("times acceleration")]
 		[Min(0)]
 		[Tooltip("Retardation factor. One means same as acceleration, 0.5 half as fast, etc.")]
 		public int Retardation;
@@ -79,9 +74,12 @@ public class PinMameMechComponent : MonoBehaviour, IMechHandler, ISwitchDeviceCo
 
 		#region Access
 
+		[SerializeField] private string _solenoid1;
+		[SerializeField] private string _solenoid2;
+
 		public event EventHandler<MechEventArgs> OnMechUpdate;
 
-		public PinMameMechConfig Config(List<SwitchMapping> switchMappings)
+		public PinMameMechConfig Config(List<SwitchMapping> switchMappings, List<CoilMapping> coilMappings)
 		{
 			var type = 0u;
 			type |= Type switch {
@@ -104,10 +102,13 @@ public PinMameMechConfig Config(List<SwitchMapping> switchMappings)
 			type |= FastUpdates ? (uint)PinMameMechFlag.Fast : (uint)PinMameMechFlag.Slow;
 			type |= ResultByLength ? (uint)PinMameMechFlag.LengthSw : (uint)PinMameMechFlag.StepSw;
 
+			var coilMapping1 = coilMappings.FirstOrDefault(cm => ReferenceEquals(cm.Device, this) && cm.DeviceItem == _solenoid1);
+			var coilMapping2 = coilMappings.FirstOrDefault(cm => ReferenceEquals(cm.Device, this) && cm.DeviceItem == _solenoid2);
+
 			var mechConfig = new PinMameMechConfig(
 				type,
-				Solenoid1,
-				Solenoid2,
+				coilMapping1?.InternalId ?? 0,
+				coilMapping2?.InternalId ?? 0,
 				Length,
 				Steps,
 				0,
@@ -118,14 +119,27 @@ public PinMameMechConfig Config(List<SwitchMapping> switchMappings)
 			foreach (var mark in Marks) {
 				var switchMapping = switchMappings.FirstOrDefault(sm => ReferenceEquals(sm.Device, this) && sm.DeviceItem == mark.SwitchId);
 				if (switchMapping == null) {
-					Logger.Error($"Switch \"{mark.Description}\" for mech {name} is not mapped in the switch manager, ignoring.");
+					Logger.Error($"Switch \"{mark.Name}\" for mech {name} is not mapped in the switch manager, ignoring.");
 					continue;
 				}
-				mechConfig.AddSwitch(new PinMameMechSwitchConfig(switchMapping.InternalId, mark.StepBeginning, mark.StepEnd, mark.Pulse));
-			}
 
-			return mechConfig;
+				switch (mark.Type) {
+					case MechMarkSwitchType.EnableBetween:
+						mechConfig.AddSwitch(new PinMameMechSwitchConfig(switchMapping.InternalId, mark.StepBeginning, mark.StepEnd));
+						break;
+
+					case MechMarkSwitchType.AlwaysPulse:
+						mechConfig.AddSwitch(new PinMameMechSwitchConfig(switchMapping.InternalId, -mark.PulseFreq, mark.PulseDuration));
+						break;
 
+					case MechMarkSwitchType.PulseBetween:
+						mechConfig.AddSwitch(new PinMameMechSwitchConfig(switchMapping.InternalId, mark.StepBeginning, mark.StepEnd, mark.PulseFreq));
+						break;
+					default:
+						throw new ArgumentOutOfRangeException();
+				}
+			}
+			return mechConfig;
 		}
 
 		private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
@@ -140,6 +154,32 @@ public PinMameMechConfig Config(List<SwitchMapping> switchMappings)
 
 		IEnumerable<GamelogicEngineSwitch> IDeviceComponent<GamelogicEngineSwitch>.AvailableDeviceItems => AvailableSwitches;
 
+		IEnumerable<IGamelogicEngineDeviceItem> IDeviceComponent<IGamelogicEngineDeviceItem>.AvailableDeviceItems => AvailableCoils;
+
+		public IEnumerable<IGamelogicEngineDeviceItem> AvailableWireDestinations => AvailableCoils;
+
+		IEnumerable<GamelogicEngineCoil> IDeviceComponent<GamelogicEngineCoil>.AvailableDeviceItems => AvailableCoils;
+
+		public IEnumerable<GamelogicEngineCoil> AvailableCoils {
+			get {
+				switch (Type)
+				{
+					case PinMameMechType.OneSolenoid:
+					case PinMameMechType.OneDirectionalSolenoid:
+						return new[] { new GamelogicEngineCoil(_solenoid1) { Description = "Mech Solenoid" } };
+					case PinMameMechType.TwoDirectionalSolenoids:
+					case PinMameMechType.TwoStepperSolenoids:
+					case PinMameMechType.FourStepperSolenoids:
+						return new[] {
+							new GamelogicEngineCoil(_solenoid1) { Description = "Mech Solenoid 1" },
+							new GamelogicEngineCoil(_solenoid2) { Description = "Mech Solenoid 2" },
+						};
+					default:
+						throw new ArgumentOutOfRangeException();
+				}
+			}
+		}
+
 		#endregion
 
 		#region Runtime
@@ -167,6 +207,14 @@ public void OnBeforeSerialize()
 		{
 			#if UNITY_EDITOR
 
+			if (string.IsNullOrEmpty(_solenoid1)) {
+				_solenoid1 = GenerateCoilId();
+			}
+			if (string.IsNullOrEmpty(_solenoid2) || _solenoid1 == _solenoid2) {
+				_solenoid2 = GenerateCoilId();
+			}
+
+
 			var switchIds = new HashSet<string>();
 			foreach (var mark in Marks) {
 				if (!mark.HasId || switchIds.Contains(mark.SwitchId)) {
@@ -181,6 +229,8 @@ public void OnAfterDeserialize()
 		{
 		}
 
+		private string GenerateCoilId() => $"coil_{Guid.NewGuid().ToString()[..8]}";
+
 		#endregion
 	}
 }