units: add get switch unit

Author: jsm174

Editor/Descriptors/GetSwitchUnitDescriptor.cs

@@ -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(GetSwitchUnit))]
+	public class GetSwitchUnitDescriptor : UnitDescriptor<GetSwitchUnit>
+	{
+		public GetSwitchUnitDescriptor(GetSwitchUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node retrieves the current status of the switch.";
+		}
+
+		protected override EditorTexture DefinedIcon() => EditorTexture.Single(Unity.Editor.Icons.Switch(false, IconSize.Large, IconColor.Orange));
+
+		protected override void DefinedPort(IUnitPort port, UnitPortDescription desc)
+		{
+			base.DefinedPort(port, desc);
+
+			switch (port.key) {
+				case nameof(GetSwitchUnit.Id):
+					desc.summary = "The ID of the switch for which to get current status.";
+					break;
+				case nameof(GetSwitchUnit.IsEnabled):
+					desc.summary = "Whether the switch is enabled.";
+					break;
+			}
+		}
+	}
+}

Editor/Descriptors/GetSwitchUnitDescriptor.cs.meta

@@ -0,0 +1,59 @@
+// 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(GetSwitchUnit))]
+	public sealed class GetSwitchUnitWidget : GleUnitWidget<GetSwitchUnit>
+	{
+		public GetSwitchUnitWidget(FlowCanvas canvas, GetSwitchUnit unit) : base(canvas, unit)
+		{
+			_switchIdInspectorConstructor = meta => new VariableNameInspector(meta, GetNameSuggestions);
+		}
+
+		protected override NodeColorMix baseColor => NodeColorMix.TealReadable;
+
+		private VariableNameInspector _switchIdInspector;
+		private readonly Func<Metadata, VariableNameInspector> _switchIdInspectorConstructor;
+
+		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/GetSwitchUnitWidget.cs

@@ -51,7 +51,7 @@ private IEnumerable<string> GetNameSuggestions()
 				return new List<string>();
 			}
 			var gle = Gle;
-			return gle == null ? new List<string>() : gle.AvailableSwitches.Select(lamp => lamp.Id).ToList();
+			return gle == null ? new List<string>() : gle.AvailableSwitches.Select(sw => sw.Id).ToList();
 		}
 	}
 }

Editor/Widgets/GetSwitchUnitWidget.cs.meta

@@ -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/>.
+
+using Unity.VisualScripting;
+using UnityEngine;
+
+namespace VisualPinball.Unity.VisualScripting
+{
+	[UnitTitle("Get Switch Value")]
+	[UnitSurtitle("Gamelogic Engine")]
+	[UnitCategory("Visual Pinball")]
+	public class GetSwitchUnit : GleUnit
+	{
+		[DoNotSerialize]
+		[PortLabel("Switch ID")]
+		public ValueInput Id { get; private set; }
+
+		[DoNotSerialize]
+		[PortLabel("Is Enabled")]
+		public ValueOutput IsEnabled { get; private set; }
+
+		protected override void Definition()
+		{
+			Id = ValueInput(nameof(Id), string.Empty);
+
+			IsEnabled = ValueOutput(nameof(IsEnabled), GetEnabled);
+		}
+
+		private bool GetEnabled(Flow flow)
+		{
+			if (!AssertGle(flow)) {
+				Debug.LogError("Cannot find GLE.");
+				return false;
+			}
+
+			return Gle.GetSwitch(flow.GetValue<string>(Id));
+		}
+	}
+}