units: added coil units to mirror what we have for switches

Author: jsm174

Editor/Descriptors/AllCoilsEnabledEventUnitDescriptor.cs

@@ -0,0 +1,32 @@
+// 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(AllCoilsEnabledEventUnit))]
+	public class AllCoilsEnabledEventUnitDescriptor : MultiUnitDescriptor<AllCoilsEnabledEventUnit>
+	{
+		public AllCoilsEnabledEventUnitDescriptor(AllCoilsEnabledEventUnit target) : base(target) { }
+		protected override string ItemLabel(int id) => $"Coil ID {id}";
+		protected override string ItemDescription(int id) => $"Coil ID {id} to look for enabled status.";
+		protected override string DefinedSummary() => "This node triggers an event when the last coil in the list gets enabled.";
+		protected override EditorTexture DefinedIcon() => EditorTexture.Single(Unity.Editor.Icons.CoilEvent);
+	}
+}

Editor/Descriptors/AllCoilsEnabledEventUnitDescriptor.cs.meta

@@ -0,0 +1,49 @@
+// 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(CoilEnabledEventUnit))]
+	public class CoilEnabledEventUnitDescriptor : UnitDescriptor<CoilEnabledEventUnit>
+	{
+		public CoilEnabledEventUnitDescriptor(CoilEnabledEventUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node triggers an event when a coil in the list of given ID is enabled.";
+		}
+
+		protected override EditorTexture DefinedIcon() => EditorTexture.Single(Unity.Editor.Icons.CoilEvent);
+
+		protected override void DefinedPort(IUnitPort port, UnitPortDescription desc)
+		{
+			base.DefinedPort(port, desc);
+
+			if (int.TryParse(port.key, out int id)) {
+				id += 1;
+
+				desc.label = $"Coil ID {id}";
+				desc.summary = $"Coil ID {id} to look for enabled status.";
+			}
+		}
+	}
+}

Editor/Descriptors/CoilEnabledEventUnitDescriptor.cs

@@ -0,0 +1,52 @@
+// 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(CoilEventUnit))]
+	public class CoilEventUnitDescriptor : UnitDescriptor<CoilEventUnit>
+	{
+		public CoilEventUnitDescriptor(CoilEventUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node triggers an event when a coil with a given ID changes.";
+		}
+
+		protected override EditorTexture DefinedIcon() => EditorTexture.Single(Unity.Editor.Icons.CoilEvent);
+
+		protected override void DefinedPort(IUnitPort port, UnitPortDescription desc)
+		{
+			base.DefinedPort(port, desc);
+
+			if (port.key == nameof(CoilEventUnit.IsEnabled)) {
+				desc.summary = "The new value of the coil, true if enabled, false otherwise.";
+			}
+			else if (int.TryParse(port.key, out int id)) {
+				id += 1;
+
+				desc.label = $"Coil ID {id}";
+				desc.summary = $"Coil ID {id} to look for a change status.";
+			}
+		}
+	}
+}

Editor/Descriptors/CoilEnabledEventUnitDescriptor.cs.meta

@@ -0,0 +1,53 @@
+// 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;
+using IconSize = VisualPinball.Unity.Editor.IconSize;
+
+namespace VisualPinball.Unity.VisualScripting.Editor
+{
+	[Descriptor(typeof(GetCoilUnit))]
+	public class GetCoilUnitDescriptor : UnitDescriptor<GetCoilUnit>
+	{
+		public GetCoilUnitDescriptor(GetCoilUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node retrieves the current status of the coil.";
+		}
+
+		protected override EditorTexture DefinedIcon() => EditorTexture.Single(Unity.Editor.Icons.Coil(IconSize.Large, IconColor.Orange));
+
+		protected override void DefinedPort(IUnitPort port, UnitPortDescription desc)
+		{
+			base.DefinedPort(port, desc);
+
+			switch (port.key) {
+				case nameof(GetCoilUnit.Id):
+					desc.summary = "Coil ID to check if enabled.";
+					break;
+				case nameof(GetCoilUnit.IsEnabled):
+					desc.summary = "Whether the coil is enabled.";
+					break;
+			}
+		}
+	}
+}

Editor/Descriptors/CoilEventUnitDescriptor.cs

@@ -0,0 +1,16 @@
+using System.Collections.Generic;
+using System.Linq;
+using Unity.VisualScripting;
+
+namespace VisualPinball.Unity.VisualScripting.Editor
+{
+	[Widget(typeof(AllCoilsEnabledEventUnit))]
+	public sealed class AllCoilsEnabledEventUnitWidget : GleMultiUnitWidget<AllCoilsEnabledEventUnit>
+	{
+		public AllCoilsEnabledEventUnitWidget(FlowCanvas canvas, AllCoilsEnabledEventUnit unit) : base(canvas, unit)
+		{
+		}
+
+		protected override IEnumerable<string> IdSuggestions(IGamelogicEngine gle) => gle.RequestedCoils.Select(coil => coil.Id);
+	}
+}

Editor/Descriptors/CoilEventUnitDescriptor.cs.meta

@@ -10,6 +10,7 @@ public sealed class AllSwitchesEnabledEventUnitWidget : GleMultiUnitWidget<AllSw
 		public AllSwitchesEnabledEventUnitWidget(FlowCanvas canvas, AllSwitchesEnabledEventUnit unit) : base(canvas, unit)
 		{
 		}
+
 		protected override IEnumerable<string> IdSuggestions(IGamelogicEngine gle) => gle.RequestedSwitches.Select(sw => sw.Id);
 	}
 }

Editor/Descriptors/GetCoilUnitDescriptor.cs

@@ -0,0 +1,34 @@
+// 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.Collections.Generic;
+using System.Linq;
+using Unity.VisualScripting;
+
+namespace VisualPinball.Unity.VisualScripting.Editor
+{
+	[Widget(typeof(CoilEnabledEventUnit))]
+	public sealed class CoilEnabledEventUnitWidget : GleMultiUnitWidget<CoilEnabledEventUnit>
+	{
+		public CoilEnabledEventUnitWidget(FlowCanvas canvas, CoilEnabledEventUnit unit) : base(canvas, unit)
+		{
+		}
+
+		protected override IEnumerable<string> IdSuggestions(IGamelogicEngine gle) => gle.RequestedCoils.Select(coil => coil.Id);
+	}
+}

Editor/Descriptors/GetCoilUnitDescriptor.cs.meta

@@ -0,0 +1,34 @@
+// 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.Collections.Generic;
+using System.Linq;
+using Unity.VisualScripting;
+
+namespace VisualPinball.Unity.VisualScripting.Editor
+{
+	[Widget(typeof(CoilEventUnit))]
+	public sealed class CoilEventUnitWidget : GleMultiUnitWidget<CoilEventUnit>
+	{
+		public CoilEventUnitWidget(FlowCanvas canvas, CoilEventUnit unit) : base(canvas, unit)
+		{
+		}
+
+		protected override IEnumerable<string> IdSuggestions(IGamelogicEngine gle) => gle.RequestedCoils.Select(coil => coil.Id);
+	}
+}