units: Add new SetSwitch and PulseSwitch units

Author: jsm174

Editor/Descriptors/PulseSwitchUnitDescriptor.cs

@@ -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 Unity.VisualScripting;
+using VisualPinball.Unity.Editor;
+
+namespace VisualPinball.Unity.VisualScripting.Editor
+{
+	[Descriptor(typeof(PulseSwitchUnit))]
+	public class PulseSwitchUnitDescriptor : UnitDescriptor<PulseSwitchUnit>
+	{
+		public PulseSwitchUnitDescriptor(PulseSwitchUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node enables switches defined by their IDs and disables it after a given delay.";
+		}
+
+		protected override EditorTexture DefinedIcon()
+		{
+			var texture = VisualPinball.Unity.Editor.Icons.Switch(false, VisualPinball.Unity.Editor.IconSize.Large, IconColor.Orange);
+			return EditorTexture.Single(texture);
+		}
+
+		protected override void DefinedPort(IUnitPort port, UnitPortDescription desc)
+		{
+			base.DefinedPort(port, desc);
+
+			if (port.key == nameof(PulseSwitchUnit.PulseDelay)) {
+				desc.summary = "The time in milliseconds until the switches are disabled again.";
+			}
+			else if (int.TryParse(port.key, out int id)) {
+				id += 1;
+
+				desc.label = $"Switch ID {id}";
+				desc.summary = $"Switch ID {id} of the switch to be pulsed.";
+			}
+		}
+	}
+}

Editor/Descriptors/PulseSwitchUnitDescriptor.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 Unity.VisualScripting;
+using VisualPinball.Unity.Editor;
+
+namespace VisualPinball.Unity.VisualScripting.Editor
+{
+	[Descriptor(typeof(SetSwitchUnit))]
+	public class SetSwitchUnitDescriptor : UnitDescriptor<SetSwitchUnit>
+	{
+		public SetSwitchUnitDescriptor(SetSwitchUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node assigns a given value to switches defined by their IDs.";
+		}
+
+		protected override EditorTexture DefinedIcon()
+		{
+			var texture = VisualPinball.Unity.Editor.Icons.Switch(false, VisualPinball.Unity.Editor.IconSize.Large, IconColor.Orange);
+			return EditorTexture.Single(texture);
+		}
+
+		protected override void DefinedPort(IUnitPort port, UnitPortDescription desc)
+		{
+			base.DefinedPort(port, desc);
+
+			if (port.key == nameof(SetSwitchUnit.IsEnabled)) {
+				desc.summary = "The value to assign to the switches.";
+			}
+			else if (int.TryParse(port.key, out int id)) {
+				id += 1;
+
+				desc.label = $"Switch ID {id}";
+				desc.summary = $"Switch ID {id} of the switch to be set.";
+			}
+		}
+	}
+}

Editor/Descriptors/SetSwitchUnitDescriptor.cs

@@ -0,0 +1,63 @@
+// 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(PulseSwitchUnit))]
+	public sealed class PulseSwitchUnitWidget : GleUnitWidget<PulseSwitchUnit>
+	{
+		private readonly List<Func<Metadata, VariableNameInspector>> _switchIdInspectorConstructorList;
+
+		public PulseSwitchUnitWidget(FlowCanvas canvas, PulseSwitchUnit unit) : base(canvas, unit)
+		{
+			_switchIdInspectorConstructorList = new List<Func<Metadata, VariableNameInspector>>();
+		}
+
+		public override Inspector GetPortInspector(IUnitPort port, Metadata meta)
+		{
+			if (_switchIdInspectorConstructorList.Count() < unit.inputCount) {
+				for (var index = 0; index < unit.inputCount - _switchIdInspectorConstructorList.Count(); index++) {
+					_switchIdInspectorConstructorList.Add(meta => new VariableNameInspector(meta, GetNameSuggestions));
+				}
+			}
+
+			for (var index = 0; index < unit.inputCount; index++) {
+				if (unit.multiInputs[index] == port) {
+					VariableNameInspector switchIdInspector = new VariableNameInspector(meta, GetNameSuggestions);
+					InspectorProvider.instance.Renew(ref switchIdInspector, meta, _switchIdInspectorConstructorList[index]);
+
+					return switchIdInspector;
+				}
+			}
+
+			return base.GetPortInspector(port, meta);
+		}
+
+		private IEnumerable<string> GetNameSuggestions()
+		{
+			return !GleAvailable
+				? new List<string>()
+				: Gle.RequestedSwitches.Select(sw => sw.Id).ToList();
+		}
+	}
+}

Editor/Descriptors/SetSwitchUnitDescriptor.cs.meta

@@ -0,0 +1,63 @@
+// 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(SetSwitchUnit))]
+	public sealed class SetSwitchUnitWidget : GleUnitWidget<SetSwitchUnit>
+	{
+		private readonly List<Func<Metadata, VariableNameInspector>> _switchIdInspectorConstructorList;
+
+		public SetSwitchUnitWidget(FlowCanvas canvas, SetSwitchUnit unit) : base(canvas, unit)
+		{
+			_switchIdInspectorConstructorList = new List<Func<Metadata, VariableNameInspector>>();
+		}
+
+		public override Inspector GetPortInspector(IUnitPort port, Metadata meta)
+		{
+			if (_switchIdInspectorConstructorList.Count() < unit.inputCount) {
+				for (var index = 0; index < unit.inputCount - _switchIdInspectorConstructorList.Count(); index++) {
+					_switchIdInspectorConstructorList.Add(meta => new VariableNameInspector(meta, GetNameSuggestions));
+				}
+			}
+
+			for (var index = 0; index < unit.inputCount; index++) {
+				if (unit.multiInputs[index] == port) {
+					VariableNameInspector switchIdInspector = new VariableNameInspector(meta, GetNameSuggestions);
+					InspectorProvider.instance.Renew(ref switchIdInspector, meta, _switchIdInspectorConstructorList[index]);
+
+					return switchIdInspector;
+				}
+			}
+
+			return base.GetPortInspector(port, meta);
+		}
+
+		private IEnumerable<string> GetNameSuggestions()
+		{
+			return !GleAvailable
+				? new List<string>()
+				: Gle.RequestedSwitches.Select(sw => sw.Id).ToList();
+		}
+	}
+}

Editor/Widgets/PulseSwitchUnitWidget.cs

@@ -0,0 +1,99 @@
+// 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 System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Unity.VisualScripting;
+using UnityEngine;
+
+namespace VisualPinball.Unity.VisualScripting
+{
+	[UnitTitle("Pulse Switch")]
+	[UnitSurtitle("Gamelogic Engine")]
+	[UnitCategory("Visual Pinball")]
+	public class PulseSwitchUnit : GleUnit, IMultiInputUnit
+	{
+		[DoNotSerialize]
+		[PortLabelHidden]
+		public ControlInput InputTrigger;
+
+		[DoNotSerialize]
+		[PortLabelHidden]
+		public ControlOutput OutputTrigger;
+
+		[SerializeAs(nameof(inputCount))]
+		private int _inputCount = 1;
+
+		[DoNotSerialize]
+		[Inspectable, UnitHeaderInspectable("Switch IDs")]
+		public int inputCount
+		{
+			get => _inputCount;
+			set => _inputCount = Mathf.Clamp(value, 1, 10);
+		}
+
+		[DoNotSerialize]
+		public ReadOnlyCollection<ValueInput> multiInputs { get; private set; }
+
+		[DoNotSerialize]
+		[PortLabel("Delay (ms)")]
+		public ValueInput PulseDelay { get; private set; }
+
+		protected override void Definition()
+		{
+			InputTrigger = ControlInput(nameof(InputTrigger), Process);
+			OutputTrigger = ControlOutput(nameof(OutputTrigger));
+
+			var _multiInputs = new List<ValueInput>();
+
+			multiInputs = _multiInputs.AsReadOnly();
+
+			for (var i = 0; i < inputCount; i++) {
+				var input = ValueInput(i.ToString(), string.Empty);
+				_multiInputs.Add(input);
+
+				Requirement(input, InputTrigger);
+			}
+
+			PulseDelay = ValueInput(nameof(PulseDelay), 250);
+
+			Succession(InputTrigger, OutputTrigger);
+		}
+
+		private ControlOutput Process(Flow flow)
+		{
+			if (!AssertGle(flow)) {
+				Debug.LogError("Cannot find GLE.");
+				return OutputTrigger;
+			}
+
+			if (!AssertPlayer(flow)) {
+				Debug.LogError("Cannot find Player.");
+				return OutputTrigger;
+			}
+
+			var pulseDuration = flow.GetValue<int>(PulseDelay);
+
+			foreach (var input in multiInputs) {
+				var switchId = flow.GetValue<string>(input);
+				Gle.Switch(switchId, true);
+				Player.ScheduleAction(pulseDuration, () => Gle.Switch(switchId, false));
+			}
+
+			return OutputTrigger;
+		}
+	}
+}