Add get player ID node.

Author: freezy

Editor/Descriptors/GetPlayerIdUnitDescriptor.cs

@@ -0,0 +1,50 @@
+// 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(GetPlayerIdUnit))]
+	public class GetPlayerIdUnitDescriptor : UnitDescriptor<GetPlayerIdUnit>
+	{
+		public GetPlayerIdUnitDescriptor(GetPlayerIdUnit target) : base(target)
+		{
+		}
+
+		protected override string DefinedSummary()
+		{
+			return "This node returns either the first, the last, or the current player ID.";
+		}
+
+		protected override EditorTexture DefinedIcon() => EditorTexture.Single(Unity.Editor.Icons.PlayerVariable);
+
+		protected override void DefinedPort(IUnitPort port, UnitPortDescription desc)
+		{
+			base.DefinedPort(port, desc);
+
+			switch (port.key) {
+				case nameof(GetPlayerIdUnit.PlayerId):
+					desc.summary = "The player ID as configured in the node header.";
+					break;
+			}
+		}
+	}
+}

Editor/Descriptors/GetPlayerIdUnitDescriptor.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(GetPlayerIdUnit))]
+	public sealed class GetPlayerIdWidget : GleUnitWidget<GetPlayerIdUnit>
+	{
+		public GetPlayerIdWidget(FlowCanvas canvas, GetPlayerIdUnit unit) : base(canvas, unit)
+		{
+		}
+	}
+}

Editor/Widgets/GetPlayerIdWidget.cs

@@ -0,0 +1,58 @@
+// 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.Linq;
+using Unity.VisualScripting;
+
+namespace VisualPinball.Unity.VisualScripting
+{
+	[UnitTitle("Get Player ID")]
+	[UnitSurtitle("Player State")]
+	[UnitCategory("Visual Pinball/Variables")]
+	public class GetPlayerIdUnit : GleUnit
+	{
+		[Serialize, Inspectable, UnitHeaderInspectable]
+		public WhichPlayer Which { get; set; }
+
+		[DoNotSerialize, PortLabel("Player ID"), Inspectable]
+		public ValueOutput PlayerId { get; private set; }
+
+		protected override void Definition()
+		{
+			PlayerId = ValueOutput(nameof(PlayerId), GetPlayerId);
+		}
+
+		private int GetPlayerId(Flow flow)
+		{
+			if (!AssertVsGle(flow)) {
+				throw new InvalidOperationException("Cannot retrieve GLE from unit.");
+			}
+
+			return Which switch {
+				WhichPlayer.First => VsGle.PlayerStates.Keys.Min(),
+				WhichPlayer.Last => VsGle.PlayerStates.Keys.Max(),
+				WhichPlayer.Current => VsGle.CurrentPlayerState.Id,
+				_ => throw new ArgumentOutOfRangeException()
+			};
+		}
+	}
+
+	public enum WhichPlayer
+	{
+		Current, First, Last
+	}
+}