Add coil pulse node.

Author: freezy

Editor/Descriptors/PulseCoilUnitDescriptor.cs

@@ -0,0 +1,56 @@
+// 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(PulseCoilUnit))]
+	public class PulseCoilUnitDescriptor : UnitDescriptor<PulseCoilUnit>
+	{
+		public PulseCoilUnitDescriptor(PulseCoilUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node enables a coil defined by its ID and disables it after a given delay.";
+		}
+
+		protected override EditorTexture DefinedIcon()
+		{
+			var texture = VisualPinball.Unity.Editor.Icons.Coil(VisualPinball.Unity.Editor.IconSize.Large, IconColor.Orange);
+			return EditorTexture.Single(texture);
+		}
+
+		protected override void DefinedPort(IUnitPort port, UnitPortDescription desc)
+		{
+			base.DefinedPort(port, desc);
+
+			switch (port.key) {
+				case nameof(PulseCoilUnit.Id):
+					desc.summary = "The ID of the coil to be pulsed.";
+					break;
+				case nameof(PulseCoilUnit.PulseDuration):
+					desc.summary = "The time in milliseconds until the coil is disabled again.";
+					break;
+			}
+		}
+	}
+}

Editor/Descriptors/PulseCoilUnitDescriptor.cs.meta

@@ -0,0 +1,56 @@
+// 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(PulseCoilUnit))]
+	public sealed class PulseCoilUnitWidget : GleUnitWidget<PulseCoilUnit>
+	{
+		private VariableNameInspector _coilIdInspector;
+		private readonly Func<Metadata, VariableNameInspector> _setCoilInspectorConstructor;
+
+		public PulseCoilUnitWidget(FlowCanvas canvas, PulseCoilUnit unit) : base(canvas, unit)
+		{
+			_setCoilInspectorConstructor = meta => new VariableNameInspector(meta, GetNameSuggestions);
+		}
+
+		public override Inspector GetPortInspector(IUnitPort port, Metadata meta)
+		{
+			if (port == unit.Id) {
+				InspectorProvider.instance.Renew(ref _coilIdInspector, meta, _setCoilInspectorConstructor);
+				return _coilIdInspector;
+			}
+
+			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.AvailableCoils.Select(coil => coil.Id).ToList();
+		}
+	}
+}

Editor/Widgets/PulseCoilUnitWidget.cs

@@ -0,0 +1,76 @@
+// 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;
+using UnityEngine;
+
+namespace VisualPinball.Unity.VisualScripting
+{
+	[UnitTitle("Pulse Coil")]
+	[UnitSurtitle("Gamelogic Engine")]
+	[UnitCategory("Visual Pinball")]
+	public class PulseCoilUnit : GleUnit
+	{
+		[DoNotSerialize]
+		[PortLabelHidden]
+		public ControlInput InputTrigger;
+
+		[DoNotSerialize]
+		[PortLabelHidden]
+		public ControlOutput OutputTrigger;
+
+		[DoNotSerialize]
+		[PortLabel("Coil ID")]
+		public ValueInput Id { get; private set; }
+
+		[DoNotSerialize]
+		[PortLabel("Duration (ms)")]
+		public ValueInput PulseDuration { get; private set; }
+
+		protected override void Definition()
+		{
+			InputTrigger = ControlInput(nameof(InputTrigger), Process);
+			OutputTrigger = ControlOutput(nameof(OutputTrigger));
+
+			Id = ValueInput<string>(nameof(Id), string.Empty);
+			PulseDuration = ValueInput<int>(nameof(PulseDuration), 80);
+
+			Requirement(Id, InputTrigger);
+			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 GLE.");
+				return OutputTrigger;
+			}
+
+			var id = flow.GetValue<string>(Id);
+			var pulseDuration = flow.GetValue<int>(PulseDuration);
+
+			Gle.SetCoil(id, true);
+			Player.ScheduleAction(pulseDuration, () => Gle.SetCoil(id, false));
+
+			return OutputTrigger;
+		}
+	}
+}