fix: Switch dispatch issues.

Author: freezy

VisualPinball.Unity/VisualPinball.Unity/Game/CoilPlayer.cs

@@ -120,8 +120,8 @@ private void AssignCoilMapping(CoilMapping coilMapping, bool isLampCoil)
 			}
 		}
 
-		private void AssignCoilMapping(string id, CoilMapping coilMapping, bool isLampCoil)
-		{
+		private void AssignCoilMapping(string id, CoilMapping coilMapping, bool isLampCoil)
+		{
 			if (!_coilAssignments.ContainsKey(id)) {
 				_coilAssignments[id] = new List<CoilDestConfig>();
 			}
@@ -130,20 +130,19 @@ private void AssignCoilMapping(string id, CoilMapping coilMapping, bool isLampCo
 				w.DestinationDeviceItem == coilMapping.DeviceItem &&
 				w.IsDynamic) != null;
 
-			_coilAssignments[id].Add(new CoilDestConfig(coilMapping.Device, coilMapping.DeviceItem, isLampCoil, hasDynamicWire));
-			CoilStatuses[id] = false;
-		}
-
-		private void HandleCoilEvent(object sender, CoilEventArgs coilEvent)
-		{
-			// always save state
-			CoilStatuses[coilEvent.Id] = coilEvent.IsEnabled;
+			_coilAssignments[id].Add(new CoilDestConfig(coilMapping.Device, coilMapping.DeviceItem, isLampCoil, hasDynamicWire));
+			CoilStatuses[id] = false;
+		}
+
+		private void HandleCoilEvent(object sender, CoilEventArgs coilEvent)
+		{
+			// always save state
+			CoilStatuses[coilEvent.Id] = coilEvent.IsEnabled;
 
 			// trigger coil if mapped
-			if (_coilAssignments.ContainsKey(coilEvent.Id)) {
-				foreach (var destConfig in _coilAssignments[coilEvent.Id]) {
-
-					if (destConfig.HasDynamicWire) {
+			if (_coilAssignments.ContainsKey(coilEvent.Id)) {
+				foreach (var destConfig in _coilAssignments[coilEvent.Id]) {
+					if (destConfig.HasDynamicWire) {
 						// goes back through the wire mapping, which will decide whether it has already sent the event or not
 						_wirePlayer!.HandleCoilEvent(coilEvent.Id, coilEvent.IsEnabled);
 						continue;

VisualPinball.Unity/VisualPinball.Unity/Game/Engine/IGamelogicEngine.cs

@@ -140,8 +140,8 @@ CancellationToken ct
 	/// Sometimes we want to extend an existing GLE with other components. This
 	/// API allows other components to be able to drive the GLE.
 	/// </summary>
-	public interface IGamelogicBridge
-	{
+	public interface IGamelogicBridge
+	{
 		void SetCoil(string id, bool isEnabled);
 
 		void SetLamp(string id, float value, bool isCoil = false, LampSource source = LampSource.Lamp);
@@ -152,8 +152,23 @@ public interface IGamelogicBridge
 
 		public event EventHandler<SwitchEventArgs2> OnSwitchChanged;
 
-		// todo displays
-	}
+		// todo displays
+	}
+
+	public enum GamelogicInputDispatchMode
+	{
+		MainThread = 0,
+		SimulationThread = 1,
+	}
+
+	/// <summary>
+	/// Optional capability interface for game logic engines that can safely
+	/// receive switch updates from the simulation thread.
+	/// </summary>
+	public interface IGamelogicInputThreading
+	{
+		GamelogicInputDispatchMode SwitchDispatchMode { get; }
+	}
 
 	public class RequestedDisplays
 	{

VisualPinball.Unity/VisualPinball.Unity/Game/Player.cs

@@ -22,10 +22,11 @@
 using Unity.Mathematics;
 using UnityEngine;
 using UnityEngine.InputSystem;
-using UnityEngine.Serialization;
-using VisualPinball.Engine.Common;
-using VisualPinball.Engine.Game;
-using VisualPinball.Engine.Game.Engines;
+using UnityEngine.Serialization;
+using VisualPinball.Engine.Common;
+using VisualPinball.Engine.Game;
+using VisualPinball.Engine.Game.Engines;
+using VisualPinball.Unity.Simulation;
 using Color = VisualPinball.Engine.Math.Color;
 using Logger = NLog.Logger;
 
@@ -107,11 +108,12 @@ public void UnpackReferences(byte[] data, Transform root, PackagedRefs refs, Pac
 		private const float SlowMotionMax = 0.1f;
 		private const float TimeLapseMax = 2.5f;
 
-		private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
+		private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 		private TableComponent _tableComponent;
 		private PlayfieldComponent _playfieldComponent;
-		private PhysicsEngine _physicsEngine;
-		private CancellationTokenSource _gamelogicEngineInitCts;
+		private PhysicsEngine _physicsEngine;
+		private SimulationThreadComponent _simulationThreadComponent;
+		private CancellationTokenSource _gamelogicEngineInitCts;
 
 		private PlayfieldComponent PlayfieldComponent {
 			get {
@@ -122,22 +124,39 @@ private PlayfieldComponent PlayfieldComponent {
 			}
 		}
 
-		private PhysicsEngine PhysicsEngine {
+		private PhysicsEngine PhysicsEngine {
 			get {
 				if (_physicsEngine == null) {
 					_physicsEngine = GetComponentInChildren<PhysicsEngine>();
 				}
 				return _physicsEngine;
 			}
-		}
+		}
+
+		private SimulationThreadComponent SimulationThreadComponent {
+			get {
+				if (_simulationThreadComponent == null) {
+					_simulationThreadComponent = GetComponent<SimulationThreadComponent>();
+				}
+				return _simulationThreadComponent;
+			}
+		}
 
 		#region Access
 
 		internal IApiSwitch Switch(ISwitchDeviceComponent component, string switchItem) => component != null ? _switchPlayer.Switch(component, switchItem) : null;
 		public IApiCoil Coil(ICoilDeviceComponent component, string coilItem) => component != null ? _coilPlayer.Coil(component, coilItem) : null;
 		public IApiLamp Lamp(ILampDeviceComponent component) => component != null ? _lampPlayer.Lamp(component) : null;
 		public IApiWireDeviceDest WireDevice(IWireableComponent c) => _wirePlayer.WireDevice(c);
-		internal void HandleWireSwitchChange(WireDestConfig wireConfig, bool isEnabled) => _wirePlayer.HandleSwitchChange(wireConfig, isEnabled);
+		internal void HandleWireSwitchChange(WireDestConfig wireConfig, bool isEnabled) => _wirePlayer.HandleSwitchChange(wireConfig, isEnabled);
+
+		internal void DispatchSwitch(string switchId, bool isClosed)
+		{
+			if (SimulationThreadComponent != null && SimulationThreadComponent.EnqueueSwitchFromMainThread(switchId, isClosed)) {
+				return;
+			}
+			GamelogicEngine?.Switch(switchId, isClosed);
+		}
 
 		public Dictionary<string, IApiSwitchStatus> SwitchStatuses => _switchPlayer.SwitchStatuses;
 		public Dictionary<string, bool> CoilStatuses => _coilPlayer.CoilStatuses;
@@ -170,7 +189,7 @@ private void Awake()
 				GamelogicEngine = engineComponent;
 				_lampPlayer.Awake(this, _tableComponent, GamelogicEngine);
 				_coilPlayer.Awake(this, _tableComponent, GamelogicEngine, _lampPlayer, _wirePlayer);
-				_switchPlayer.Awake(_tableComponent, GamelogicEngine, _inputManager);
+				_switchPlayer.Awake(this, _tableComponent, GamelogicEngine, _inputManager);
 				_wirePlayer.Awake(_tableComponent, _inputManager, _switchPlayer, this, PhysicsEngine);
 				_displayPlayer.Awake(GamelogicEngine);
 			}
@@ -297,15 +316,15 @@ public void Register<TApi>(TApi api, MonoBehaviour component) where TApi : IApi
 			}
 		}
 
-		private void RegisterCollider(int itemId, IApiColliderGenerator apiColl)
-		{
-			if (!apiColl.IsColliderAvailable) {
-				return;
-			}
-			_colliderGenerators.Add(apiColl);
-			if (apiColl is IApiHittable apiHittable) {
-				_hittables[itemId] = apiHittable;
-			}
+		private void RegisterCollider(int itemId, IApiColliderGenerator apiColl)
+		{
+			if (!apiColl.IsColliderAvailable) {
+				return;
+			}
+			_colliderGenerators.Add(apiColl);
+			if (apiColl is IApiHittable apiHittable) {
+				_hittables[itemId] = apiHittable;
+			}
 
 			if (apiColl is IApiCollidable apiCollidable) {
 				_collidables[itemId] = apiCollidable;
@@ -319,20 +338,19 @@ private void RegisterCollider(int itemId, IApiColliderGenerator apiColl)
 		public void ScheduleAction(int timeMs, Action action) => PhysicsEngine.ScheduleAction(timeMs, action);
 		public void ScheduleAction(uint timeMs, Action action) => PhysicsEngine.ScheduleAction(timeMs, action);
 
-		public void OnEvent(in EventData eventData)
-		{
-			Debug.Log(eventData);
-			switch (eventData.EventId) {
-				case EventId.HitEventsHit:
-					if (!_hittables.ContainsKey(eventData.ItemId)) {
-						Debug.LogError($"Cannot find {eventData.ItemId} in hittables.");
-					}
-					_hittables[eventData.ItemId].OnHit(eventData.BallId);
-					break;
-
-				case EventId.HitEventsUnhit:
-					_hittables[eventData.ItemId].OnHit(eventData.BallId, true);
-					break;
+		public void OnEvent(in EventData eventData)
+		{
+				switch (eventData.EventId) {
+				case EventId.HitEventsHit:
+					if (!_hittables.ContainsKey(eventData.ItemId)) {
+						Debug.LogError($"Cannot find {eventData.ItemId} in hittables.");
+					}
+					_hittables[eventData.ItemId].OnHit(eventData.BallId);
+					break;
+
+				case EventId.HitEventsUnhit:
+					_hittables[eventData.ItemId].OnHit(eventData.BallId, true);
+					break;
 
 				case EventId.LimitEventsBos:
 					_rotatables[eventData.ItemId].OnRotate(eventData.FloatParam, false);

VisualPinball.Unity/VisualPinball.Unity/Game/SwitchHandler.cs

@@ -128,21 +128,22 @@ public bool HasWireDest(IWireableComponent device, string deviceItem)
 		internal void OnSwitch(bool enabled)
 		{
 			// handle switch -> gamelogic engine
-			if (Engine != null && _switches != null) {
-				foreach (var switchConfig in _switches) {
-
-					// set new status now
-					_switchStatuses[switchConfig.SwitchId].IsSwitchEnabled = enabled;
-					Engine.Switch(switchConfig.SwitchId, switchConfig.IsNormallyClosed ? !enabled : enabled);
+			if (Engine != null && _switches != null) {
+				foreach (var switchConfig in _switches) {
+					var isClosed = switchConfig.IsNormallyClosed ? !enabled : enabled;
+
+					// set new status now
+					_switchStatuses[switchConfig.SwitchId].IsSwitchEnabled = enabled;
+					_player.DispatchSwitch(switchConfig.SwitchId, isClosed);
 
 					// if it's pulse, schedule to re-open
-					if (enabled && switchConfig.IsPulseSwitch) {
-						_physicsEngine.ScheduleAction(
-							switchConfig.PulseDelay,
-							() => {
-								_switchStatuses[switchConfig.SwitchId].IsSwitchEnabled = false;
-								Engine.Switch(switchConfig.SwitchId, switchConfig.IsNormallyClosed);
-								IsEnabled = false;
+					if (enabled && switchConfig.IsPulseSwitch) {
+						_physicsEngine.ScheduleAction(
+							switchConfig.PulseDelay,
+							() => {
+								_switchStatuses[switchConfig.SwitchId].IsSwitchEnabled = false;
+								_player.DispatchSwitch(switchConfig.SwitchId, switchConfig.IsNormallyClosed);
+								IsEnabled = false;
 #if UNITY_EDITOR
 								RefreshUI();
 #endif
@@ -170,11 +171,12 @@ internal void OnSwitch(bool enabled)
 		internal void ScheduleSwitch(bool enabled, int delay, Action<bool> onSwitched)
 		{
 			// handle switch -> gamelogic engine
-			if (Engine != null && _switches != null) {
-				foreach (var switchConfig in _switches) {
-					_physicsEngine.ScheduleAction(delay,
-						() => Engine.Switch(switchConfig.SwitchId, switchConfig.IsNormallyClosed ? !enabled : enabled));
-				}
+			if (Engine != null && _switches != null) {
+				foreach (var switchConfig in _switches) {
+					var isClosed = switchConfig.IsNormallyClosed ? !enabled : enabled;
+					_physicsEngine.ScheduleAction(delay,
+						() => _player.DispatchSwitch(switchConfig.SwitchId, isClosed));
+				}
 			} else {
 				Logger.Warn("Cannot schedule device switch.");
 			}

VisualPinball.Unity/VisualPinball.Unity/Game/SwitchPlayer.cs

@@ -38,9 +38,10 @@ public class SwitchPlayer
 		/// </summary>
 		private readonly Dictionary<string, List<KeyboardSwitch>> _keySwitchAssignments = new();
 
-		private TableComponent _tableComponent;
-		private IGamelogicEngine _gamelogicEngine;
-		private InputManager _inputManager;
+		private TableComponent _tableComponent;
+		private Player _player;
+		private IGamelogicEngine _gamelogicEngine;
+		private InputManager _inputManager;
 
 		private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
@@ -51,11 +52,12 @@ internal void RegisterSwitchDevice(ISwitchDeviceComponent component, IApiSwitchD
 		public bool SwitchDeviceExists(ISwitchDeviceComponent component)
 			=> _switchDevices.ContainsKey(component);
 
-		public void Awake(TableComponent tableComponent, IGamelogicEngine gamelogicEngine, InputManager inputManager)
-		{
-			_tableComponent = tableComponent;
-			_gamelogicEngine = gamelogicEngine;
-			_inputManager = inputManager;
+		public void Awake(Player player, TableComponent tableComponent, IGamelogicEngine gamelogicEngine, InputManager inputManager)
+		{
+			_player = player;
+			_tableComponent = tableComponent;
+			_gamelogicEngine = gamelogicEngine;
+			_inputManager = inputManager;
 		}
 
 		public void OnStart()
@@ -76,19 +78,23 @@ public void OnStart()
 								break;
 							}
 
-							// check if device exists
-							if (!_switchDevices.TryGetValue(switchMapping.Device, out var device)) {
-								Logger.Error($"Unknown switch device \"{switchMapping.Device}\".");
-								break;
-							}
+							// check if device exists
+							if (!_switchDevices.TryGetValue(switchMapping.Device, out var device)) {
+								if (switchMapping.Device is IMechHandler) {
+									Logger.Info($"Switch \"{switchMapping.Id}\" on mech device \"{switchMapping.Device}\" is handled by mech config and does not require runtime switch registration.");
+									break;
+								}
+								Logger.Error($"Unknown switch device \"{switchMapping.Device}\".");
+								break;
+							}
 
 							var deviceSwitch = device.Switch(switchMapping.DeviceItem);
 							if (deviceSwitch != null) {
-								var existingSwitchStatus = SwitchStatuses.ContainsKey(switchMapping.Id) ? SwitchStatuses[switchMapping.Id] : null;
-								var switchStatus = deviceSwitch.AddSwitchDest(new SwitchConfig(switchMapping), existingSwitchStatus);
-								SwitchStatuses[switchMapping.Id] = switchStatus;
-
-							} else {
+							var existingSwitchStatus = SwitchStatuses.ContainsKey(switchMapping.Id) ? SwitchStatuses[switchMapping.Id] : null;
+							var switchStatus = deviceSwitch.AddSwitchDest(new SwitchConfig(switchMapping), existingSwitchStatus);
+							SwitchStatuses[switchMapping.Id] = switchStatus;
+
+						} else {
 								Logger.Error($"Unknown switch \"{switchMapping.DeviceItem}\" in switch device \"{switchMapping.Device}\".");
 							}
 
@@ -126,13 +132,13 @@ private void HandleKeyInput(object obj, InputActionChange change)
 				case InputActionChange.ActionStarted:
 				case InputActionChange.ActionCanceled:
 					var action = (InputAction)obj;
-					if (_keySwitchAssignments.TryGetValue(action.name, out var assignment)) {
-						if (_gamelogicEngine != null) {
-							foreach (var sw in assignment) {
-								sw.IsSwitchEnabled = change == InputActionChange.ActionStarted;
-								_gamelogicEngine.Switch(sw.SwitchId, sw.IsSwitchClosed);
-							}
-						}
+					if (_keySwitchAssignments.TryGetValue(action.name, out var assignment)) {
+						if (_player != null) {
+							foreach (var sw in assignment) {
+								sw.IsSwitchEnabled = change == InputActionChange.ActionStarted;
+								_player.DispatchSwitch(sw.SwitchId, sw.IsSwitchClosed);
+							}
+						}
 					} else {
 						Logger.Info($"Unmapped input command \"{action.name}\".");
 					}