mech: Use switch IDs from mappings.

Author: freezy

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

@@ -118,6 +118,7 @@ public GamelogicEngineLamp[] AvailableLamps {
 		public bool _solenoidsEnabled;
 		public long _solenoidDelayStart;
 		private Dictionary<int, PinMameMechComponent> _registeredMechs = new();
+		private HashSet<int> _mechSwitches = new();
 
 		private void Awake()
 		{
@@ -182,10 +183,7 @@ private void OnGameStarted()
 			_isRunning = true;
 
 			SendInitialSwitches();
-
-			foreach (var (id, mech) in _registeredMechs) {
-				_pinMame.SetMech(id, mech.Config);
-			}
+			SendMechs();
 
 			_solenoidDelayStart = DateTimeOffset.Now.ToUnixTimeMilliseconds();
 		}
@@ -478,13 +476,24 @@ public void SendInitialSwitches()
 				if (!isClosed) {
 					continue;
 				}
-				if (_switches.ContainsKey(id)) {
+				if (_switches.ContainsKey(id) && !_mechSwitches.Contains(_switches[id].InternalId)) {
 					Logger.Info($"[PinMAME] => sw {id} ({_switches[id].InternalId}): {true} | {_switches[id].Description}");
 					_pinMame.SetSwitch(_switches[id].InternalId, true);
 				}
 			}
 		}
 
+		private void SendMechs()
+		{
+			foreach (var (id, mech) in _registeredMechs) {
+				var mechConfig = mech.Config(_player.SwitchMapping);
+				_pinMame.SetMech(id, mechConfig);
+				foreach (var c in mechConfig.SwitchList) {
+					_mechSwitches.Add(c.SwNo);
+				}
+			}
+		}
+
 		private void UpdateCaches()
 		{
 			if (_game == null) {
@@ -536,6 +545,10 @@ public void StopGame()
 		public void Switch(string id, bool isClosed)
 		{
 			if (_switches.ContainsKey(id)) {
+				if (_mechSwitches.Contains(_switches[id].InternalId)) {
+					// mech switches are triggered internally by pinmame.
+					return;
+				}
 				Logger.Info($"[PinMAME] => sw {id} ({_switches[id].InternalId}): {isClosed} | {_switches[id].Description}");
 				_pinMame.SetSwitch(_switches[id].InternalId, isClosed);
 			} else {

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

@@ -17,16 +17,19 @@
 // ReSharper disable InconsistentNaming
 
 using System;
+using System.Collections.Generic;
+using System.Linq;
 using NLog;
 using PinMame;
 using UnityEngine;
+using VisualPinball.Engine.Game.Engines;
 using VisualPinball.Unity;
 using Logger = NLog.Logger;
 
 namespace VisualPinball.Engine.PinMAME
 {
 	[AddComponentMenu("Visual Pinball/PinMAME/PinMAME Mech Handler")]
-	public class PinMameMechComponent : MonoBehaviour, IMechHandler
+	public class PinMameMechComponent : MonoBehaviour, IMechHandler, ISwitchDeviceComponent, ISerializationCallbackReceiver
 	{
 		#region Data
 
@@ -61,7 +64,7 @@ public class PinMameMechComponent : MonoBehaviour, IMechHandler
 		public int Steps;
 
 		[Tooltip("Define your switch marks here.")]
-		public PinMameMechSwitchMark[] Marks;
+		public MechMark[] Marks;
 
 		[Unit("ms")]
 		[Min(0)]
@@ -78,66 +81,67 @@ public class PinMameMechComponent : MonoBehaviour, IMechHandler
 
 		public event EventHandler<MechEventArgs> OnMechUpdate;
 
-		public PinMameMechConfig Config
+		public PinMameMechConfig Config(List<SwitchMapping> switchMappings)
 		{
-			get {
-				var type = 0u;
-				type |= Type switch {
-					PinMameMechType.OneSolenoid => (uint)PinMameMechFlag.OneSol,
-					PinMameMechType.OneDirectionalSolenoid => (uint)PinMameMechFlag.OneDirSol,
-					PinMameMechType.TwoDirectionalSolenoids => (uint)PinMameMechFlag.TwoDirSol,
-					PinMameMechType.TwoStepperSolenoids => (uint)PinMameMechFlag.TwoStepSol,
-					PinMameMechType.FourStepperSolenoids => (uint)PinMameMechFlag.FourStepSol,
-					_ => throw new ArgumentOutOfRangeException()
-				};
-
-				type |= Repeat switch {
-					PinMameRepeat.Circle => (uint)PinMameMechFlag.Circle,
-					PinMameRepeat.Reverse => (uint)PinMameMechFlag.Reverse,
-					PinMameRepeat.StopAtEnd => (uint)PinMameMechFlag.StopEnd,
-					_ => throw new ArgumentOutOfRangeException()
-				};
-
-				type |= LinearMovement ? (uint)PinMameMechFlag.Linear : (uint)PinMameMechFlag.NonLinear;
-				type |= FastUpdates ? (uint)PinMameMechFlag.Fast : (uint)PinMameMechFlag.Slow;
-				type |= ResultByLength ? (uint)PinMameMechFlag.LengthSw : (uint)PinMameMechFlag.StepSw;
-
-				var mechConfig = new PinMameMechConfig(
-					type,
-					Solenoid1,
-					Solenoid2,
-					Length,
-					Steps,
-					0,
-					Acceleration,
-					Retardation
-				);
-
-				foreach(var mark in Marks) {
-					switch (mark.Type) {
-						case PinMameMechSwitchMarkType.Switch:
-							mechConfig.AddSwitch(new PinMameMechSwitchConfig(mark.SwitchId, mark.StepBeginning, mark.StepEnd));
-							break;
-						case PinMameMechSwitchMarkType.PulseSwitch:
-							mechConfig.AddSwitch(new PinMameMechSwitchConfig(mark.SwitchId, mark.StepBeginning, mark.StepPulseDuration, 1));
-							break;
-						case PinMameMechSwitchMarkType.PulseSwitchNew:
-							mechConfig.AddSwitch(new PinMameMechSwitchConfig(mark.SwitchId, mark.StepBeginning, mark.StepEnd, mark.StepPulseDuration));
-							break;
-						default:
-							throw new ArgumentOutOfRangeException();
-					}
+			var type = 0u;
+			type |= Type switch {
+				PinMameMechType.OneSolenoid => (uint)PinMameMechFlag.OneSol,
+				PinMameMechType.OneDirectionalSolenoid => (uint)PinMameMechFlag.OneDirSol,
+				PinMameMechType.TwoDirectionalSolenoids => (uint)PinMameMechFlag.TwoDirSol,
+				PinMameMechType.TwoStepperSolenoids => (uint)PinMameMechFlag.TwoStepSol,
+				PinMameMechType.FourStepperSolenoids => (uint)PinMameMechFlag.FourStepSol,
+				_ => throw new ArgumentOutOfRangeException()
+			};
+
+			type |= Repeat switch {
+				PinMameRepeat.Circle => (uint)PinMameMechFlag.Circle,
+				PinMameRepeat.Reverse => (uint)PinMameMechFlag.Reverse,
+				PinMameRepeat.StopAtEnd => (uint)PinMameMechFlag.StopEnd,
+				_ => throw new ArgumentOutOfRangeException()
+			};
+
+			type |= LinearMovement ? (uint)PinMameMechFlag.Linear : (uint)PinMameMechFlag.NonLinear;
+			type |= FastUpdates ? (uint)PinMameMechFlag.Fast : (uint)PinMameMechFlag.Slow;
+			type |= ResultByLength ? (uint)PinMameMechFlag.LengthSw : (uint)PinMameMechFlag.StepSw;
+
+			var mechConfig = new PinMameMechConfig(
+				type,
+				Solenoid1,
+				Solenoid2,
+				Length,
+				Steps,
+				0,
+				Acceleration,
+				Retardation
+			);
+
+			foreach (var mark in Marks) {
+				var switchMapping = switchMappings.FirstOrDefault(sm => 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.");
+					continue;
 				}
-
-				return mechConfig;
+				mechConfig.AddSwitch(new PinMameMechSwitchConfig(switchMapping.InternalId, mark.StepBeginning, mark.StepEnd, mark.Pulse));
 			}
 
+			return mechConfig;
+
 		}
 
 		private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
 		#endregion
 
+		#region Wiring
+
+		public IEnumerable<GamelogicEngineSwitch> AvailableSwitches => Marks.Select(m => m.Switch);
+
+		public SwitchDefault SwitchDefault => SwitchDefault.NormallyOpen;
+
+		IEnumerable<GamelogicEngineSwitch> IDeviceComponent<GamelogicEngineSwitch>.AvailableDeviceItems => AvailableSwitches;
+
+		#endregion
+
 		#region Runtime
 
 		private PinMameGamelogicEngine _gle;
@@ -157,6 +161,27 @@ public void UpdateMech(PinMameMechInfo data)
 
 		#endregion
 
+		#region ISerializationCallbackReceiver
+
+		public void OnBeforeSerialize()
+		{
+			#if UNITY_EDITOR
+
+			var switchIds = new HashSet<string>();
+			foreach (var mark in Marks) {
+				if (!mark.HasId || switchIds.Contains(mark.SwitchId)) {
+					mark.GenerateId();
+				}
+				switchIds.Add(mark.SwitchId);
+			}
+			#endif
+		}
+
+		public void OnAfterDeserialize()
+		{
+		}
+
+		#endregion
 	}
 
 	[Serializable]