Refactor and document GetLampValueUnit.

Author: freezy

Editor/Descriptors/GetLampValueUnitDescriptor.cs

@@ -0,0 +1,54 @@
+// Visual Pinball Engine
+// Copyright (C) 2021 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 VisualPinball.Unity.Editor;
+using IconSize = VisualPinball.Unity.Editor.IconSize;
+
+namespace VisualPinball.Unity.VisualScripting.Editor
+{
+	[Descriptor(typeof(GetLampValueUnit))]
+	public class GetLampValueUnitDescriptor : UnitDescriptor<GetLampValueUnit>
+	{
+		public GetLampValueUnitDescriptor(GetLampValueUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node retrieves the current intensity of the lamp, as well as if the lamp is enabled or not.";
+		}
+
+		protected override EditorTexture DefinedIcon() => EditorTexture.Single(Unity.Editor.Icons.Light(IconSize.Large, IconColor.Orange));
+
+		protected override void DefinedPort(IUnitPort port, UnitPortDescription desc)
+		{
+			base.DefinedPort(port, desc);
+
+			switch (port.key) {
+				case nameof(GetLampValueUnit.Id):
+					desc.summary = "The ID of the lamp for which the intensity is returned.";
+					break;
+				case nameof(GetLampValueUnit.Value):
+					desc.summary = "The intensity of the lamp.";
+					break;
+				case nameof(GetLampValueUnit.IsEnabled):
+					desc.summary = "Whether the intensity is larger than 0.";
+					break;
+			}
+		}
+	}
+}

Editor/Descriptors/GetLampValueUnitDescriptor.cs.meta

@@ -14,54 +14,47 @@
 // 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;
 using VisualPinball.Unity;
 
 namespace VisualPinball.Unity.VisualScripting.Editor
 {
 	[Widget(typeof(GetLampValueUnit))]
-	public sealed class GetLampValueUnitWidget : UnitWidget<GetLampValueUnit>
+	public sealed class GetLampValueUnitWidget : GleUnitWidget<GetLampValueUnit>
 	{
 		public GetLampValueUnitWidget(FlowCanvas canvas, GetLampValueUnit unit) : base(canvas, unit)
 		{
-			lampIdInspectorConstructor = (metadata) => new VariableNameInspector(metadata, GetNameSuggestions);
+			_lampIdInspectorConstructor = meta => new VariableNameInspector(meta, GetNameSuggestions);
 		}
 
 		protected override NodeColorMix baseColor => NodeColorMix.TealReadable;
 
-		private VariableNameInspector lampIdInspector;
-		private Func<Metadata, VariableNameInspector> lampIdInspectorConstructor;
+		private VariableNameInspector _lampIdInspector;
+		private readonly Func<Metadata, VariableNameInspector> _lampIdInspectorConstructor;
 
-		public override Inspector GetPortInspector(IUnitPort port, Metadata metadata)
+		public override Inspector GetPortInspector(IUnitPort port, Metadata meta)
 		{
-			if (port == unit.id) {
-				InspectorProvider.instance.Renew(ref lampIdInspector, metadata, lampIdInspectorConstructor);
+			if (port == unit.Id) {
+				InspectorProvider.instance.Renew(ref _lampIdInspector, meta, _lampIdInspectorConstructor);
 
-				return lampIdInspector;
+				return _lampIdInspector;
 			}
 
-			return base.GetPortInspector(port, metadata);
+			return base.GetPortInspector(port, meta);
 		}
 
 		private IEnumerable<string> GetNameSuggestions()
 		{
-			var list = new List<string>();
-
-			var tableComponent = TableSelector.Instance.SelectedTable;
-
-			if (tableComponent != null) {
-				var gle = tableComponent.gameObject.GetComponent<IGamelogicEngine>();
-
-				if (gle != null) {
-					foreach (var lamp in gle.AvailableLamps) {
-						list.Add(lamp.Id);
-					}
-				}
+			if (!GameObjectAvailable) {
+				return new List<string>();
 			}
-
-			return list;
+			var gle = Gle;
+			return gle == null ? new List<string>() : gle.AvailableLamps.Select(lamp => lamp.Id).ToList();
 		}
 	}
 }

Editor/Widgets/GetLampValueUnitWidget.cs

@@ -22,8 +22,8 @@ public abstract class GleUnitWidget<TUnit> : UnitWidget<TUnit> where TUnit : Uni
 	{
 		protected override NodeColorMix baseColor => GleAvailable ? NodeColorMix.TealReadable : new NodeColorMix { red = 1f, green = 0f, blue = 0f };
 		protected bool GameObjectAvailable => reference != null && reference.gameObject != null;
-		protected bool GleAvailable => GameObjectAvailable && Gle != null;
 		protected IGamelogicEngine Gle => reference.gameObject.GetComponentInParent<IGamelogicEngine>();
+		private bool GleAvailable => GameObjectAvailable && Gle != null;
 
 		protected GleUnitWidget(FlowCanvas canvas, TUnit unit) : base(canvas, unit)
 		{

Editor/Widgets/GleUnitWidget.cs

@@ -14,6 +14,8 @@
 // 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;

Editor/Widgets/LampEventUnitWidget.cs

@@ -14,6 +14,8 @@
 // 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;

Editor/Widgets/SetCoilUnitWidget.cs

@@ -14,6 +14,8 @@
 // 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;

Editor/Widgets/SetLampUnitWidget.cs

@@ -14,6 +14,8 @@
 // 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;

Editor/Widgets/SwitchEventUnitWidget.cs

@@ -67,7 +67,5 @@ private ControlOutput Process(Flow flow)
 
 			return OutputTrigger;
 		}
-
-
 	}
 }

Runtime/Nodes/Coils/SetCoilUnit.cs

@@ -20,28 +20,28 @@ namespace VisualPinball.Unity.VisualScripting
 {
 	[UnitTitle("Get Lamp Value")]
 	[UnitCategory("Visual Pinball")]
-	public class GetLampValueUnit : Unit
+	public class GetLampValueUnit : GleUnit
 	{
 		[DoNotSerialize]
-		[PortLabelHidden]
-		public ValueInput id { get; private set; }
+		[PortLabel("Lamp ID")]
+		public ValueInput Id { get; private set; }
 
 		[DoNotSerialize]
-		[PortLabelHidden]
-		public ValueOutput value { get; private set; }
+		[PortLabel("Value")]
+		public ValueOutput Value { get; private set; }
 
 		[DoNotSerialize]
-		[PortLabelHidden]
-		public ValueOutput enabled { get; private set; }
+		[PortLabel("Is Enabled")]
+		public ValueOutput IsEnabled { get; private set; }
 
 		private Player _player;
 
 		protected override void Definition()
 		{
-			id = ValueInput(nameof(id), string.Empty);
+			Id = ValueInput(nameof(Id), string.Empty);
 
-			value = ValueOutput(nameof(value), GetValue);
-			enabled = ValueOutput(nameof(enabled), GetEnabled);
+			Value = ValueOutput(nameof(Value), GetValue);
+			IsEnabled = ValueOutput(nameof(IsEnabled), GetEnabled);
 		}
 
 		private float GetValue(Flow flow)
@@ -50,7 +50,7 @@ private float GetValue(Flow flow)
 				_player = UnityEngine.Object.FindObjectOfType<Player>();
 			}
 
-			var key = flow.GetValue<string>(id);
+			var key = flow.GetValue<string>(Id);
 			return _player.LampStatuses.ContainsKey(key) ? _player.LampStatuses[key] : 0;
 		}
 
@@ -60,7 +60,7 @@ private bool GetEnabled(Flow flow)
 				_player = flow.stack.self.GetComponentInParent<Player>();
 			}
 
-			var key = flow.GetValue<string>(id);
+			var key = flow.GetValue<string>(Id);
 			return _player.LampStatuses.ContainsKey(key) && (_player.LampStatuses[key] > 0);
 		}
 	}