Hardened the menu

- Changing observers correctly recreates the menu
- Simplified some code here and there
- Switching to a third person or roaming camera falls back to the html menu
- Dispose entities on player disconnect
- Only transmit the menu entities to the desired player
- Refresh menus on various inputs

Author: AshleighAdams

README.md

@@ -4,4 +4,6 @@ A native CSSUniversalMenuAPI implementation, mirroring the behavior of SourceMod
 
 ![](./docs/GunsMenuCropped.png)
 
+https://www.youtube.com/watch?v=Be7qop6pVpI
+
 Many thanks to [@T3Marius's CS2ScreenMenuAPI](https://github.com/T3Marius/CS2ScreenMenuAPI) for acting as reference when it comes to using the point_worldtext entity.

src/SharpModMenu/MenuDriver.cs

@@ -13,7 +13,7 @@ internal sealed class MenuDriver : IMenuAPI
 {
 	private Dictionary<ulong, PlayerMenuState> MenuStates = new();
 	public List<(CBaseEntity ent, CCSPlayerController target)> MenuEntities { get; } = new();
-	public List<PlayerMenuState> ActiveHtmlMenuStates { get; } = new();
+	public List<PlayerMenuState> ActiveMenuStates { get; } = new();
 
 	internal PlayerMenuState GetMenuState(CCSPlayerController player, bool create = false)
 	{
@@ -29,7 +29,8 @@ internal void PlayerDisconnected(CCSPlayerController? player)
 	{
 		if (player is null)
 			return;
-		MenuStates.Remove(player.SteamID);
+		MenuStates.Remove(player.SteamID, out var value);
+		value?.Dispose();
 	}
 
 	public IMenu CreateMenu(CCSPlayerController player, CancellationToken ct = default)

src/SharpModMenu/PlayerExtensions.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Numerics;
 
 using CounterStrikeSharp.API;
@@ -18,34 +19,55 @@ public struct EyeAngles
 	public Vector3 Up { get; set; }
 }
 
+public enum ObserverMode
+{
+	FirstPerson,
+	ThirdPerson,
+	Roaming,
+}
+
+public record struct ObserverInfo(ObserverMode Mode, CCSPlayerPawnBase? Observing);
+
 internal static class PlayerExtensions
 {
-	public static CCSPlayerPawn? GetPlayerPawn(this CCSPlayerController player)
+	public static ObserverInfo GetObserverInfo(this CCSPlayerController player)
 	{
 		if (player.Pawn.Value is not CBasePlayerPawn pawn)
-			return null;
+			return new() { Mode = ObserverMode.Roaming, Observing = null };
+
+		if (pawn.ObserverServices is not CPlayer_ObserverServices observerServices)
+			return new() { Mode = ObserverMode.FirstPerson, Observing = pawn.As<CCSPlayerPawnBase>() };
 
-		if (pawn.LifeState == (byte)LifeState_t.LIFE_DEAD)
+		var observerMode = (ObserverMode_t)observerServices.ObserverMode;
+		var observing = observerServices.ObserverTarget?.Value?.As<CCSPlayerPawnBase>();
+
+		return new()
 		{
-			if (pawn.ObserverServices?.ObserverTarget.Value?.As<CBasePlayerPawn>() is not CBasePlayerPawn observer)
-				return null;
-			pawn = observer;
-		}
-		return pawn.As<CCSPlayerPawn>();
+			Mode = observerMode switch
+			{
+				ObserverMode_t.OBS_MODE_NONE => ObserverMode.Roaming,
+				ObserverMode_t.OBS_MODE_FIXED => ObserverMode.Roaming,
+				ObserverMode_t.OBS_MODE_IN_EYE => ObserverMode.FirstPerson,
+				ObserverMode_t.OBS_MODE_CHASE => ObserverMode.ThirdPerson,
+				ObserverMode_t.OBS_MODE_ROAMING => ObserverMode.Roaming,
+				ObserverMode_t.OBS_MODE_DIRECTED => ObserverMode.Roaming,
+				_ => ObserverMode.Roaming,
+			},
+			Observing = observing,
+		};
 	}
 
 	public static Vector _Forward = new(), _Right = new(), _Up = new();
-	public static EyeAngles? GetEyeAngles(this CCSPlayerController player)
+	public static EyeAngles? GetEyeAngles(this ObserverInfo observerInfo)
 	{
-		var playerPawn = GetPlayerPawn(player);
-		if (playerPawn is null)
+		if (observerInfo.Observing is not CCSPlayerPawnBase pawn)
 			return null;
 
-		var eyeAngles = playerPawn!.EyeAngles;
+		var eyeAngles = pawn.EyeAngles;
 		NativeAPI.AngleVectors(eyeAngles.Handle, _Forward.Handle, _Right.Handle, _Up.Handle);
 
-		var origin = new Vector3(playerPawn.AbsOrigin!.X, playerPawn.AbsOrigin!.Y, playerPawn.AbsOrigin!.Z);
-		var viewOffset = new Vector3(playerPawn.ViewOffset.X, playerPawn.ViewOffset.Y, playerPawn.ViewOffset.Z);
+		var origin = new Vector3(pawn.AbsOrigin!.X, pawn.AbsOrigin!.Y, pawn.AbsOrigin!.Z);
+		var viewOffset = new Vector3(pawn.ViewOffset.X, pawn.ViewOffset.Y, pawn.ViewOffset.Z);
 
 		return new()
 		{
@@ -57,10 +79,13 @@ internal static class PlayerExtensions
 		};
 	}
 
-	public static CCSGOViewModel? GetPredictedViewmodel(this CCSPlayerController player)
+	public static CCSGOViewModel? GetPredictedViewmodel(this ObserverInfo observerInfo)
 	{
-		var pawn = GetPlayerPawn(player);
-		if (pawn?.ViewModelServices is null)
+		if (observerInfo.Observing is not CCSPlayerPawnBase pawn)
+			return null;
+		if (pawn.ViewModelServices is null)
+			return null;
+		if (observerInfo.Mode != ObserverMode.FirstPerson)
 			return null;
 
 		var offset = Schema.GetSchemaOffset("CCSPlayer_ViewModelServices", "m_hViewModel");

src/SharpModMenu/PlayerMenuState.cs

@@ -83,19 +83,20 @@ public void HandleInput(PlayerKey key, bool fromBind)
 		}
 	}
 
-	private bool _PresentingHtml;
-	private bool PresentingHtml
+	public bool PresentingHtml { get; set; }
+	private bool _MenuActive;
+	private bool MenuActive
 	{
-		get => _PresentingHtml;
+		get => _MenuActive;
 		set
 		{
-			if (value == _PresentingHtml)
+			if (value == _MenuActive)
 				return;
-			_PresentingHtml = value;
+			_MenuActive = value;
 			if (value)
-				Driver.ActiveHtmlMenuStates.Add(this);
+				Driver.ActiveMenuStates.Add(this);
 			else
-				Driver.ActiveHtmlMenuStates.Remove(this);
+				Driver.ActiveMenuStates.Remove(this);
 		}
 	}
 
@@ -124,13 +125,11 @@ public void Refresh(bool sortPriorities = true)
 		}
 
 		CurrentMenu = FocusStack.Count > 0 ? FocusStack[0] : null;
+		MenuActive = CurrentMenu is not null;
 
 		if (CreateInitialInvisibleWorldTextEntity())
 		{
-			Server.NextFrame(() =>
-			{
-				Refresh(sortPriorities: false);
-			});
+			ForceRefresh = true;
 			return;
 		}
 
@@ -140,6 +139,8 @@ public void Refresh(bool sortPriorities = true)
 		}
 		else
 		{
+			if (!PresentingHtml)
+				DestroyEntities();
 			DrawActiveMenuHtml();
 			PresentingHtml = true;
 		}
@@ -167,7 +168,6 @@ private void DestroyEntities()
 			Background?.Remove();
 
 		ForegroundText = BackgroundText = Background = null;
-		Console.WriteLine("DEBUG: DestroyEntities()");
 	}
 
 	private static readonly Color ForegroundTextColor = Color.FromArgb(229, 150, 32); // 245, 177, 103 with a white bg, maybe 240, 160, 30 at 95% opacity?
@@ -180,40 +180,37 @@ private void CreateEntities()
 		Background = CreateWorldText(textColor: Color.FromArgb(200, 127, 127, 127), true, -0.002f);
 	}
 
-	private bool _Created = false;
+	// sometimes creating an ent for a pawn requires it to be done twice, so
+	// do it twice whenever our observed entity changes
+	private nint? _CreatedFor = null;
 	/// <summary>
 	/// The first world text isn't shown for some reason, this creates a barebones version then immediately destroys it
 	/// </summary>
 	private bool CreateInitialInvisibleWorldTextEntity()
 	{
-		if (_Created)
+		var observerInfo = Player.GetObserverInfo();
+
+		if (_CreatedFor.HasValue && _CreatedFor.Value == observerInfo.Observing?.Handle)
 			return false;
 
-		var viewmodel = Player.GetPredictedViewmodel();
+		var viewmodel = observerInfo.GetPredictedViewmodel();
 		if (viewmodel is null)
-		{
-			CurrentMenu?.Close();
 			return false;
-		}
 
 		var entity = CreateWorldText(Color.Orange, drawBackground: false, depthOffset: 0.0f);
 		if (entity is null)
-		{
-			CurrentMenu?.Close();
 			return false;
-		}
 
-		var maybeAngles = Player.GetEyeAngles();
+		var maybeAngles = observerInfo.GetEyeAngles();
 		if (!maybeAngles.HasValue)
-		{
-			CurrentMenu?.Close();
 			return false;
-		}
 
-		UpdateEntity(entity, viewmodel, "Hey", maybeAngles.Value.Position, maybeAngles.Value.Angle);
+		UpdateEntity(entity, viewmodel, "Hey", maybeAngles.Value.Position, maybeAngles.Value.Angle, updateText: true, updateParent: true);
 		entity.Remove();
 
-		_Created = true;
+		_CreatedFor = observerInfo.Observing?.Handle ?? nint.Zero;
+
+		Console.WriteLine("CreateInitialInvisibleWorldTextEntity(): DONE");
 		return true;
 	}
 
@@ -255,32 +252,40 @@ private CPointWorldText CreateWorldText(
 	private static QAngle _Ang = new();
 	private void UpdateEntity(
 		CPointWorldText ent,
-		CCSGOViewModel viewmodel,
-		string? newText,
+		CCSGOViewModel? viewmodel,
+		string newText,
 		Vector3 position,
-		Vector3 angles)
+		Vector3 angles,
+		bool updateText = true,
+		bool updateParent = true)
 	{
 		_Pos.X = position.X;
 		_Pos.Y = position.Y;
 		_Pos.Z = position.Z;
 		_Ang.X = angles.X;
 		_Ang.Y = angles.Y;
 		_Ang.Z = angles.Z;
-		if (newText is not null)
+
+		if (updateText)
 			ent.MessageText = newText;
 		ent.Teleport(_Pos, _Ang, null);
-		ent.AcceptInput("SetParent", viewmodel, null, "!activator");
-		if (newText is not null)
+
+		if (updateParent)
+			ent.AcceptInput("SetParent", viewmodel, null, "!activator");
+
+		if (updateText)
 			Utilities.SetStateChanged(ent, "CPointWorldText", "m_messageText");
 	}
 
-	private readonly Vector MenuPosition = new(-7.0f, 0.0f);
+	private readonly Vector MenuPosition = new(-6.9f, 0.0f);
 
-	private CCSGOViewModel? LastViewmodel { get; set; }
 	private Menu? LastPresented { get; set; }
 	private readonly StringBuilder ForegroundTextSb = new();
 	private readonly StringBuilder BackgroundTextSb = new();
 	private readonly StringBuilder BackgroundSb = new();
+	private nint MenuCurrentObserver { get; set; } = nint.Zero;
+	private ObserverMode MenuCurrentObserverMode { get; set; }
+	private CCSGOViewModel? MenuCurrentViewmodel { get; set; }
 	public bool DrawActiveMenu()
 	{
 		if (ReferenceEquals(CurrentMenu, LastPresented))
@@ -300,25 +305,18 @@ public bool DrawActiveMenu()
 
 		CurrentMenu.IsDirty = false;
 
-		bool allValid =
-			(ForegroundText?.IsValid ?? false) &&
-			(BackgroundText?.IsValid ?? false) &&
-			(Background?.IsValid ?? false);
-		if (!allValid)
-		{
-			DestroyEntities();
-			CreateEntities();
-		}
+		var observerInfo = Player.GetObserverInfo();
+		if (observerInfo.Mode != ObserverMode.FirstPerson)
+			return false;
 
-		var maybeEyeAngles = Player.GetEyeAngles();
+		var maybeEyeAngles = observerInfo.GetEyeAngles();
 		if (!maybeEyeAngles.HasValue)
 			return false;
 		var eyeAngles = maybeEyeAngles.Value;
 
-		var predictedViewmodel = Player.GetPredictedViewmodel();
+		var predictedViewmodel = observerInfo.GetPredictedViewmodel();
 		if (predictedViewmodel is null)
 			return false;
-		LastViewmodel = predictedViewmodel;
 
 		ForegroundTextSb.Clear();
 		BackgroundTextSb.Clear();
@@ -356,13 +354,25 @@ void writeLine(string text, bool background)
 			X = 0.0f
 		};
 
+		MenuCurrentObserver = observerInfo.Observing?.Handle ?? nint.Zero;
+		MenuCurrentObserverMode = observerInfo.Mode;
+		MenuCurrentViewmodel = predictedViewmodel;
+
+		bool allValid =
+			(ForegroundText?.IsValid ?? false) &&
+			(BackgroundText?.IsValid ?? false) &&
+			(Background?.IsValid ?? false);
+		if (!allValid)
+		{
+			DestroyEntities();
+			CreateEntities();
+		}
 		UpdateEntity(ForegroundText!, predictedViewmodel, ForegroundTextSb.ToString(), position, angle);
 		UpdateEntity(BackgroundText!, predictedViewmodel, BackgroundTextSb.ToString(), position, angle);
 		UpdateEntity(Background!, predictedViewmodel, BackgroundSb.ToString(), position, angle);
 		return true;
 	}
 
-
 	private readonly StringBuilder HtmlTextSb = new();
 	public string? HtmlContent { get; set; } = null;
 	public void DrawActiveMenuHtml()
@@ -373,7 +383,6 @@ public void DrawActiveMenuHtml()
 			return;
 		}
 
-
 		bool firstLine = true;
 		int linesWrote = 0;
 		void writeLine(string text, bool background)
@@ -442,4 +451,28 @@ private void BuildMenuStrings(Menu currentMenu, Action<string, bool> writeLine)
 				writeLine("0. Exit", true);
 		}
 	}
+
+	public bool ForceRefresh = true;
+	public void Tick()
+	{
+		if (CurrentMenu is null)
+			return;
+
+		if (PresentingHtml && HtmlContent is not null)
+			Player.PrintToCenterHtml(HtmlContent);
+
+		var observerInfo = Player.GetObserverInfo();
+
+		bool refresh =
+			ForceRefresh ||
+			observerInfo.Mode != MenuCurrentObserverMode ||
+			observerInfo.Observing?.Handle != MenuCurrentObserver;
+
+		if (refresh)
+		{
+			ForceRefresh = false;
+			CurrentMenu.IsDirty = true;
+			Refresh(sortPriorities: false);
+		}
+	}
 }