Refactor and document LampEventUnit.

Author: freezy

Editor/Descriptors/LampEventUnitDescriptor.cs

@@ -0,0 +1,52 @@
+// 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;
+
+namespace VisualPinball.Unity.VisualScripting.Editor
+{
+	[Descriptor(typeof(LampEventUnit))]
+	public class LampEventUnitDescriptor : UnitDescriptor<LampEventUnit>
+	{
+		public LampEventUnitDescriptor(LampEventUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node triggers an event when a lamp with a given ID changes its intensity.";
+		}
+
+		protected override EditorTexture DefinedIcon() => EditorTexture.Single(Unity.Editor.Icons.LampEvent);
+
+		protected override void DefinedPort(IUnitPort port, UnitPortDescription desc)
+		{
+			base.DefinedPort(port, desc);
+
+			switch (port.key) {
+				case nameof(LampEventUnit.Id):
+					desc.summary = "The ID of the lamp that changed its intensity.";
+					break;
+				case nameof(LampEventUnit.Value):
+					desc.summary = "The new intensity of the lamp (0-255).";
+					break;
+				case nameof(LampEventUnit.IsEnabled):
+					desc.summary = "Whether the intensity is larger than 0.";
+					break;
+			}
+		}
+	}
+}

Editor/Descriptors/LampEventUnitDescriptor.cs.meta

@@ -16,51 +16,43 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using Unity.VisualScripting;
 
 namespace VisualPinball.Unity.VisualScripting.Editor
 {
 	[Widget(typeof(LampEventUnit))]
-	public sealed class LampEventUnitWidget : UnitWidget<LampEventUnit>
+	public sealed class LampEventUnitWidget : GleUnitWidget<LampEventUnit>
 	{
 		public LampEventUnitWidget(FlowCanvas canvas, LampEventUnit 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/LampEventUnitWidget.cs

@@ -18,21 +18,21 @@
 
 namespace VisualPinball.Unity.VisualScripting
 {
-	[UnitTitle("On Lamp Event")]
+	[UnitTitle("On Lamp Changed")]
 	[UnitCategory("Events\\Visual Pinball")]
-	public sealed class LampEventUnit : EventUnit<LampEventArgs>
+	public sealed class LampEventUnit : GleEventUnit<LampEventArgs>
 	{
 		[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("Intensity")]
+		public ValueOutput Value { get; private set; }
 
 		[DoNotSerialize]
-		[PortLabelHidden]
-		public ValueOutput enabled { get; private set; }
+		[PortLabel("Is Enabled")]
+		public ValueOutput IsEnabled { get; private set; }
 
 		protected override bool register => true;
 
@@ -45,21 +45,21 @@ protected override void Definition()
 		{
 			base.Definition();
 
-			id = ValueInput(nameof(id), string.Empty);
+			Id = ValueInput(nameof(Id), string.Empty);
 
-			value = ValueOutput<int>(nameof(value));
-			enabled = ValueOutput<bool>(nameof(enabled));
+			Value = ValueOutput<int>(nameof(Value));
+			IsEnabled = ValueOutput<bool>(nameof(IsEnabled));
 		}
 
 		protected override void AssignArguments(Flow flow, LampEventArgs args)
 		{
-			flow.SetValue(value, args.Value);
-			flow.SetValue(enabled, args.Value > 0);
+			flow.SetValue(Value, args.Value);
+			flow.SetValue(IsEnabled, args.Value > 0);
 		}
 
 		protected override bool ShouldTrigger(Flow flow, LampEventArgs args)
 		{
-			return args.Id == flow.GetValue<string>(id);
+			return args.Id == flow.GetValue<string>(Id);
 		}
 	}
 }