misc: added ClearDisplayUnit

Author: jsm174

Editor/Descriptors/ClearDisplayUnitDescriptor.cs

@@ -0,0 +1,39 @@
+// 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(ClearDisplayUnit))]
+	public class ClearDisplayUnitDescriptor : UnitDescriptor<ClearDisplayUnit>
+	{
+		public ClearDisplayUnitDescriptor(ClearDisplayUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node clears a display connected through the given ID.";
+		}
+
+		protected override EditorTexture DefinedIcon() => EditorTexture.Single(Unity.Editor.Icons.UpdateDisplay);
+	}
+}

Editor/Descriptors/ClearDisplayUnitDescriptor.cs.meta

@@ -0,0 +1,30 @@
+// 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
+{
+	[Widget(typeof(ClearDisplayUnit))]
+	public sealed class ClearDisplayUnitWidget : GleUnitWidget<ClearDisplayUnit>
+	{
+		public ClearDisplayUnitWidget(FlowCanvas canvas, ClearDisplayUnit unit) : base(canvas, unit)
+		{
+		}
+	}
+}

Editor/Widgets/ClearDisplayUnitWidget.cs

@@ -64,6 +64,7 @@ public class VisualScriptingGamelogicEngine : MonoBehaviour, IGamelogicEngine, I
 		public GamelogicEngineWire[] AvailableWires => Wires;
 
 		public event EventHandler<RequestedDisplays> OnDisplaysRequested;
+		public event EventHandler<DisplayClearData> OnDisplayClear;
 		public event EventHandler<DisplayFrameData> OnDisplayUpdateFrame;
 		public event EventHandler<DisplayAddPointsData> OnDisplayAddPoints;
 
@@ -156,6 +157,11 @@ public void OnInit(Player player, TableApi tableApi, BallManager ballManager)
 			EventBus.Trigger(VisualScriptingEventNames.GleStartedEvent, EventArgs.Empty);
 		}
 
+		public void DisplayClear(DisplayClearData data)
+		{
+			OnDisplayClear?.Invoke(this, data);
+		}
+
 		public void DisplayUpdateFrame(DisplayFrameData data)
 		{
 			OnDisplayUpdateFrame?.Invoke(this, data);
@@ -166,9 +172,9 @@ public void DisplayAddPoints(DisplayAddPointsData data)
 			OnDisplayAddPoints?.Invoke(this, data);
 		}
 
-		public void DisplayScoreEvent(string id, float score)
+		public void DisplayScoreEvent(string id, float points, float score)
 		{
-			EventBus.Trigger(VisualScriptingEventNames.DisplayScoreEvent, new DisplayScoreEventArgs(id, score));
+			EventBus.Trigger(VisualScriptingEventNames.DisplayScoreEvent, new DisplayScoreEventArgs(id, points, score));
 		}
 
 		public void Switch(string id, bool isClosed)

Editor/Widgets/ClearDisplayUnitWidget.cs.meta

@@ -0,0 +1,60 @@
+// 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 System;
+using System.Text;
+using Unity.VisualScripting;
+
+namespace VisualPinball.Unity.VisualScripting
+{
+	[UnitTitle("Clear Display")]
+	[UnitSurtitle("Gamelogic Engine")]
+	[UnitCategory("Visual Pinball")]
+	public class ClearDisplayUnit : GleUnit
+	{
+		[Serialize, Inspectable, UnitHeaderInspectable("ID")]
+		public DisplayDefinition Display { get; private set; }
+
+		[DoNotSerialize]
+		[PortLabelHidden]
+		public ControlInput InputTrigger;
+
+		[DoNotSerialize]
+		[PortLabelHidden]
+		public ControlOutput OutputTrigger;
+
+		protected override void Definition()
+		{
+			InputTrigger = ControlInput(nameof(InputTrigger), Process);
+			OutputTrigger = ControlOutput(nameof(OutputTrigger));
+
+			Succession(InputTrigger, OutputTrigger);
+		}
+
+		private ControlOutput Process(Flow flow)
+		{
+			if (!AssertVsGle(flow)) {
+				throw new InvalidOperationException("Cannot retrieve GLE from unit.");
+			}
+
+			if (Display != null) {
+				VsGle.DisplayClear(new DisplayClearData(Display.Id));
+			}
+
+			return OutputTrigger;
+		}
+	}
+}

Runtime/Gamelogic/VisualScriptingGamelogicEngine.cs

@@ -32,6 +32,10 @@ public class DisplayScoreEventUnit : GleEventUnit<DisplayScoreEventArgs>
 		[DisplayTypeFilterAttribute(DisplayType.ScoreReel)]
 		public DisplayDefinition Display { get; private set; }
 
+		[DoNotSerialize]
+		[PortLabel("Points")]
+		public ValueOutput Points { get; private set; }
+
 		[DoNotSerialize]
 		[PortLabel("Score")]
 		public ValueOutput Score { get; private set; }
@@ -45,6 +49,7 @@ protected override void Definition()
 		{
 			base.Definition();
 
+			Points = ValueOutput<float>(nameof(Points));
 			Score = ValueOutput<float>(nameof(Score));
 		}
 
@@ -55,6 +60,7 @@ protected override bool ShouldTrigger(Flow flow, DisplayScoreEventArgs args)
 
 		protected override void AssignArguments(Flow flow, DisplayScoreEventArgs args)
 		{
+			flow.SetValue(Points, args.Points);
 			flow.SetValue(Score, args.Score);
 		}
 	}