events: Added SwitchEnabled event

Author: jsm174

Editor/Descriptors/SwitchEnabledEventUnitDescriptor.cs

@@ -0,0 +1,48 @@
+// Visual Pinball Engine
+// Copyright (C) 2022 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/>.
+
+// ReSharper disable UnusedType.Global
+
+using Unity.VisualScripting;
+
+namespace VisualPinball.Unity.VisualScripting.Editor
+{
+	[Descriptor(typeof(SwitchEnabledEventUnit))]
+	public class SwitchEnabledEventUnitDescriptor : UnitDescriptor<SwitchEnabledEventUnit>
+	{
+		public SwitchEnabledEventUnitDescriptor(SwitchEnabledEventUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node triggers an event when a switch with a given ID is enabled.";
+		}
+
+		protected override EditorTexture DefinedIcon() => EditorTexture.Single(Unity.Editor.Icons.SwitchEvent);
+
+		protected override void DefinedPort(IUnitPort port, UnitPortDescription desc)
+		{
+			base.DefinedPort(port, desc);
+
+			switch (port.key) {
+				case nameof(SwitchEnabledEventUnit.Id):
+					desc.summary = "The ID of the switch that was enabled.";
+					break;
+			}
+		}
+	}
+}

Editor/Descriptors/SwitchEnabledEventUnitDescriptor.cs.meta

@@ -0,0 +1,57 @@
+// Visual Pinball Engine
+// Copyright (C) 2022 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/>.
+
+// ReSharper disable UnusedType.Global
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Unity.VisualScripting;
+
+namespace VisualPinball.Unity.VisualScripting.Editor
+{
+	[Widget(typeof(SwitchEnabledEventUnit))]
+	public sealed class SwitchEnabledEventUnitWidget : GleUnitWidget<SwitchEnabledEventUnit>
+	{
+		private VariableNameInspector _switchIdInspector;
+		private readonly Func<Metadata, VariableNameInspector> _switchIdInspectorConstructor;
+
+		public SwitchEnabledEventUnitWidget(FlowCanvas canvas, SwitchEnabledEventUnit unit) : base(canvas, unit)
+		{
+			_switchIdInspectorConstructor = meta => new VariableNameInspector(meta, GetNameSuggestions);
+		}
+
+		public override Inspector GetPortInspector(IUnitPort port, Metadata meta)
+		{
+			if (port == unit.Id) {
+				InspectorProvider.instance.Renew(ref _switchIdInspector, meta, _switchIdInspectorConstructor);
+
+				return _switchIdInspector;
+			}
+
+			return base.GetPortInspector(port, meta);
+		}
+
+		private IEnumerable<string> GetNameSuggestions()
+		{
+			if (!GameObjectAvailable) {
+				return new List<string>();
+			}
+			var gle = Gle;
+			return gle == null ? new List<string>() : gle.AvailableSwitches.Select(sw => sw.Id).ToList();
+		}
+	}
+}

Editor/Widgets/SwitchEnabledEventUnitWidget.cs

@@ -21,6 +21,7 @@ public static class VisualScriptingEventNames
 		public const string GleStartedEvent = "GleStartedEvent";
 		public const string LampEvent = "LampEvent";
 		public const string SwitchEvent = "SwitchEvent";
+		public const string SwitchEnabledEvent = "SwitchEnabledEvent";
 		public const string CoilEvent = "CoilEvent";
 	}
 }

Editor/Widgets/SwitchEnabledEventUnitWidget.cs.meta

@@ -76,7 +76,13 @@ private void OnStarted(object sender, EventArgs e)
 
 		private static void OnSwitchChanged(object sender, SwitchEventArgs2 e)
 		{
-			EventBus.Trigger(VisualScriptingEventNames.SwitchEvent, new SwitchEventArgs2(e.Id, e.IsEnabled));
+			var args = new SwitchEventArgs2(e.Id, e.IsEnabled);
+
+			EventBus.Trigger(VisualScriptingEventNames.SwitchEvent, args);
+
+			if (e.IsEnabled) {
+				EventBus.Trigger(VisualScriptingEventNames.SwitchEnabledEvent, args);
+			}
 		}
 
 		private static void OnCoilChanged(object sender, CoilEventArgs e)

Runtime/Gamelogic/VisualScriptingEventNames.cs

@@ -66,8 +66,15 @@ public void OnInit(Player player, TableApi tableApi, BallManager ballManager)
 
 		public void Switch(string id, bool isClosed)
 		{
-			OnSwitchChanged?.Invoke(this, new SwitchEventArgs2(id, isClosed));
-			EventBus.Trigger(VisualScriptingEventNames.SwitchEvent, new SwitchEventArgs2(id, isClosed));
+			var args = new SwitchEventArgs2(id, isClosed);
+
+			OnSwitchChanged?.Invoke(this, args);
+
+			EventBus.Trigger(VisualScriptingEventNames.SwitchEvent, args);
+
+			if (isClosed) {
+				EventBus.Trigger(VisualScriptingEventNames.SwitchEnabledEvent, args);
+			}
 		}
 
 		public void SetCoil(string id, bool isEnabled)

Runtime/Gamelogic/VisualScriptingGamelogicBridge.cs

@@ -0,0 +1,51 @@
+// Visual Pinball Engine
+// Copyright (C) 2022 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 Unity.VisualScripting;
+
+namespace VisualPinball.Unity.VisualScripting
+{
+	[UnitTitle("On Switch Enabled")]
+	[UnitSurtitle("Gamelogic Engine")]
+	[UnitCategory("Events\\Visual Pinball")]
+	public class SwitchEnabledEventUnit : GleEventUnit<SwitchEventArgs2>
+	{
+		[DoNotSerialize]
+		[PortLabel("Switch ID")]
+		public ValueInput Id { get; private set; }
+
+		[DoNotSerialize]
+		protected override bool register => true;
+
+		// Adding an EventHook with the name of the event to the list of visual scripting events.
+		public override EventHook GetHook(GraphReference reference)
+		{
+			return new EventHook(VisualScriptingEventNames.SwitchEnabledEvent);
+		}
+
+		protected override void Definition()
+		{
+			base.Definition();
+
+			Id = ValueInput(nameof(Id), string.Empty);
+		}
+
+		protected override bool ShouldTrigger(Flow flow, SwitchEventArgs2 args)
+		{
+			return flow.GetValue<string>(Id) == args.Id;
+		}
+	}
+}