Adding popup messages for errors with status codes alongside the exception message

Nitrox.Test/Model/StatusCodeTests.cs

@@ -0,0 +1,27 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System;
+using static NitroxModel.DisplayStatusCodes;
+namespace NitroxModel;
+
+[TestClass]
+public class StatusCodeTests
+{
+    [TestMethod]
+    public void ThrowStatusCodesNonFatal()
+    {
+        // Display one of every status code once non-fatally, should display all of them once
+        for (int i = 0; i < Enum.GetNames(typeof(StatusCode)).Length; i++)
+        {
+            DisplayStatusCode((StatusCode)i, false, "Testing exception");
+        }
+    }
+    [TestMethod]
+    public void ThrowStatusCodesFatal()
+    {
+        // Display one of every status code once fatally, should only display the first one
+        for (int i = 0; i < Enum.GetNames(typeof(StatusCode)).Length; i++)
+        {
+            DisplayStatusCode((StatusCode)i, true, "Testing exception");
+        }
+    }
+}

NitroxClient/Communication/Exceptions/ClientConnectionFailedException.cs

@@ -1,15 +1,17 @@
-using System;
-
+using System;
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.Exceptions
 {
     public class ClientConnectionFailedException : Exception
     {
         public ClientConnectionFailedException(string message) : base(message)
         {
+            DisplayStatusCode(StatusCode.connectionFailClient, false, "Client failed to connect to the server and has been disconnected" + message);
         }
 
         public ClientConnectionFailedException(string message, Exception innerException) : base(message, innerException)
         {
+            DisplayStatusCode(StatusCode.connectionFailClient, false, "Client failed to connect to the server and has been disconnected" + message);
         }
     }
 }

NitroxClient/Communication/MultiplayerSession/ConnectionState/AwaitingReservationCredentials.cs

@@ -1,10 +1,10 @@
-using System;
+using System;
 using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
 using NitroxModel.Helper;
 using NitroxModel.MultiplayerSession;
 using NitroxModel.Packets;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public class AwaitingReservationCredentials : ConnectionNegotiatingState
@@ -56,7 +56,7 @@ private static void ClientIsConnected(IMultiplayerSessionConnectionContext sessi
         {
             if (!sessionConnectionContext.Client.IsConnected)
             {
-                throw new InvalidOperationException("The client is not connected.");
+                DisplayStatusCode(StatusCode.invalidPacket, false, "The client is not connected.");
             }
         }
 
@@ -68,7 +68,7 @@ private static void PlayerSettingsIsNotNull(IMultiplayerSessionConnectionContext
             }
             catch (ArgumentNullException ex)
             {
-                throw new InvalidOperationException("The context does not contain player settings.", ex);
+                DisplayStatusCode(StatusCode.invalidPacket, false, "The context does not contain player settings." + ex);
             }
         }
 
@@ -80,7 +80,7 @@ private static void AuthenticationContextIsNotNull(IMultiplayerSessionConnection
             }
             catch (ArgumentNullException ex)
             {
-                throw new InvalidOperationException("The context does not contain an authentication context.", ex);
+                DisplayStatusCode(StatusCode.invalidPacket, false, "The context does not contain an authentication context." + ex);
             }
         }
     }

NitroxClient/Communication/MultiplayerSession/ConnectionState/AwaitingSessionReservation.cs

@@ -1,10 +1,10 @@
-using System;
+using System;
 using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
 using NitroxModel.Helper;
 using NitroxModel.MultiplayerSession;
 using NitroxModel.Packets.Exceptions;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public class AwaitingSessionReservation : ConnectionNegotiatingState
@@ -59,14 +59,15 @@ private static void ReservationIsNotNull(IMultiplayerSessionConnectionContext se
             }
             catch (ArgumentNullException ex)
             {
-                throw new InvalidOperationException("The context does not have a reservation.", ex);
+                DisplayStatusCode(StatusCode.invalidPacket, false, "The context does not have a reservation." + ex.ToString());
             }
         }
 
         private void ReservationPacketIsCorrelated(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
             if (!reservationCorrelationId.Equals(sessionConnectionContext.Reservation.CorrelationId))
             {
+                DisplayStatusCode(StatusCode.invalidPacket, false, sessionConnectionContext.Reservation.ToString() + reservationCorrelationId.ToString());
                 throw new UncorrelatedPacketException(sessionConnectionContext.Reservation, reservationCorrelationId);
             }
         }

NitroxClient/Communication/MultiplayerSession/ConnectionState/CommunicatingState.cs

@@ -1,6 +1,7 @@
-using System.Threading.Tasks;
+using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
-
+using NitroxModel;
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public abstract class CommunicatingState : IMultiplayerSessionConnectionState
@@ -14,7 +15,7 @@ public virtual void Disconnect(IMultiplayerSessionConnectionContext sessionConne
         {
             sessionConnectionContext.ClearSessionState();
             sessionConnectionContext.Client.Stop();
-
+            DisplayStatusCode(StatusCode.connectionFailClient, false, "Client was disconnected.");
             Disconnected newConnectionState = new Disconnected();
             sessionConnectionContext.UpdateConnectionState(newConnectionState);
         }

NitroxClient/Communication/MultiplayerSession/ConnectionState/ConnectionNegotiatedState.cs

@@ -1,14 +1,15 @@
-using System;
+using System;
 using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public abstract class ConnectionNegotiatedState : CommunicatingState
     {
         public override Task NegotiateReservationAsync(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
-            throw new InvalidOperationException("Unable to negotiate a session connection in the current state.");
+            DisplayStatusCode(StatusCode.connectionFailClient, false, "Unable to negotiate a session connection in the current state.");
+            throw new Exception();
         }
     }
 }

NitroxClient/Communication/MultiplayerSession/ConnectionState/ConnectionNegotiatingState.cs

@@ -1,13 +1,13 @@
-using System;
+using System;
 using NitroxClient.Communication.Abstract;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public abstract class ConnectionNegotiatingState : CommunicatingState
     {
         public override void JoinSession(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
-            throw new InvalidOperationException("Cannot join a session until a reservation has been negotiated with the server.");
+            DisplayStatusCode(StatusCode.connectionFailClient, false, "Cannot join a session until a reservation has been negotiated with the server.");
         }
     }
 }

NitroxClient/Communication/MultiplayerSession/ConnectionState/Disconnected.cs

@@ -1,10 +1,10 @@
-using System;
+using System;
 using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
 using NitroxClient.Communication.Exceptions;
 using NitroxModel.Helper;
 using NitroxModel.Packets;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public class Disconnected : IMultiplayerSessionConnectionState
@@ -32,7 +32,7 @@ private void ValidateState(IMultiplayerSessionConnectionContext sessionConnectio
             }
             catch (ArgumentNullException ex)
             {
-                throw new InvalidOperationException("The context is missing an IP address.", ex);
+                DisplayStatusCode(StatusCode.connectionFailClient, false, "The context is missing an IP address." + ex.ToString());
             }
         }
 
@@ -44,7 +44,7 @@ private static void ValidateClient(IMultiplayerSessionConnectionContext sessionC
             }
             catch (ArgumentNullException ex)
             {
-                throw new InvalidOperationException("The client must be set on the connection context before trying to negotiate a session reservation.", ex);
+                DisplayStatusCode(StatusCode.connectionFailClient, false, "The client must be set on the connection context before trying to negotiate a session reservation." + ex.ToString());
             }
         }
 
@@ -56,7 +56,7 @@ private static async Task StartClientAsync(string ipAddress, IClient client, int
 
                 if (!client.IsConnected)
                 {
-                    throw new ClientConnectionFailedException("The client failed to connect without providing a reason why.");
+                    DisplayStatusCode(StatusCode.connectionFailClient, false, "The client failed to connect without providing a reason why.");
                 }
             }
         }
@@ -74,12 +74,12 @@ private static void EstablishSessionPolicy(IMultiplayerSessionConnectionContext
 
         public void JoinSession(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
-            throw new InvalidOperationException("Cannot join a session until a reservation has been negotiated with the server.");
+            DisplayStatusCode(StatusCode.connectionFailClient, false, "Cannot join a session until a reservation has been negotiated with the server.");
         }
 
         public void Disconnect(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
-            throw new InvalidOperationException("Not connected to a multiplayer server.");
+            DisplayStatusCode(StatusCode.connectionFailClient, false, "Not connected to a multiplayer server.");
         }
     }
 }

NitroxClient/Communication/MultiplayerSession/ConnectionState/EstablishingSessionPolicy.cs

@@ -1,9 +1,9 @@
-using System;
+using System;
 using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
 using NitroxModel.Helper;
 using NitroxModel.Packets.Exceptions;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public class EstablishingSessionPolicy : ConnectionNegotiatingState
@@ -47,15 +47,15 @@ private static void SessionPolicyIsNotNull(IMultiplayerSessionConnectionContext
             }
             catch (ArgumentNullException ex)
             {
-                throw new InvalidOperationException("The context is missing a session policy.", ex);
+                DisplayStatusCode(StatusCode.invalidPacket, false, "The context is missing a session policy." + ex.ToString());
             }
         }
 
         private void SessionPolicyPacketCorrelation(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
             if (!policyRequestCorrelationId.Equals(sessionConnectionContext.SessionPolicy.CorrelationId))
             {
-                throw new UncorrelatedPacketException(sessionConnectionContext.SessionPolicy, policyRequestCorrelationId);
+                DisplayStatusCode(StatusCode.invalidPacket, false, "The packet was uncorrelated to the function of this processor: ");
             }
         }
 

NitroxClient/Communication/MultiplayerSession/ConnectionState/SessionJoined.cs

@@ -1,6 +1,6 @@
-using System;
+using System;
 using NitroxClient.Communication.Abstract;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public class SessionJoined : ConnectionNegotiatedState
@@ -9,7 +9,7 @@ public class SessionJoined : ConnectionNegotiatedState
 
         public override void JoinSession(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
-            throw new InvalidOperationException("The session is already in progress.");
+            DisplayStatusCode(StatusCode.outboundConnectionAlreadyOpen, false, "The session is already in progress.");
         }
     }
 }

NitroxClient/Communication/MultiplayerSession/ConnectionState/SessionReservationRejected.cs

@@ -1,6 +1,6 @@
-using System;
+using System;
 using NitroxClient.Communication.Abstract;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public class SessionReservationRejected : ConnectionNegotiatedState
@@ -9,7 +9,7 @@ public class SessionReservationRejected : ConnectionNegotiatedState
 
         public override void JoinSession(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
-            throw new InvalidOperationException("The session has rejected the reserveration request.");
+            DisplayStatusCode(StatusCode.connectionFailClient, false, "The session has rejected the reserveration request.");
         }
     }
 }

NitroxClient/Communication/MultiplayerSession/ConnectionState/SessionReserved.cs

@@ -1,7 +1,8 @@
-using System;
+using System;
 using NitroxClient.Communication.Abstract;
+using NitroxModel;
 using NitroxModel.Packets;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public class SessionReserved : ConnectionNegotiatedState
@@ -27,7 +28,7 @@ private static void ValidateState(IMultiplayerSessionConnectionContext sessionCo
         {
             if (!sessionConnectionContext.Client.IsConnected)
             {
-                throw new InvalidOperationException("The client is not connected.");
+                DisplayStatusCode(StatusCode.connectionFailClient, false, "The client is not connected.");
             }
         }
 

NitroxClient/Communication/MultiplayerSession/MultiplayerSessionManager.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
@@ -9,7 +9,7 @@
 using NitroxModel.MultiplayerSession;
 using NitroxModel.Packets;
 using NitroxModel.Serialization;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession
 {
     public class MultiplayerSessionManager : IMultiplayerSession, IMultiplayerSessionConnectionContext
@@ -68,13 +68,15 @@ public void ProcessSessionPolicy(MultiplayerSessionPolicy policy)
                                            .Replace("{serverVersion}", SessionPolicy.NitroxVersionAllowed.ToString())
                                            .Replace("{localVersion}", localVersion.ToString()));
                     CurrentState.Disconnect(this);
+                    DisplayStatusCode(StatusCode.versionMismatch, false, $"Client is out of date. Server: {SessionPolicy.NitroxVersionAllowed}, Client: {localVersion}");
                     return;
                 case 1:
                     Log.Error($"Server is out of date. Server: {SessionPolicy.NitroxVersionAllowed}, Client: {localVersion}");
                     Log.InGame(Language.main.Get("Nitrox_OutOfDateServer")
                                            .Replace("{serverVersion}", SessionPolicy.NitroxVersionAllowed.ToString())
                                            .Replace("{localVersion}", localVersion.ToString()));
                     CurrentState.Disconnect(this);
+                    DisplayStatusCode(StatusCode.versionMismatch, false, $"Server is out of date. Server: {SessionPolicy.NitroxVersionAllowed}, Client: {localVersion}");
                     return;
             }
 
@@ -119,6 +121,7 @@ public void Disconnect()
             if (CurrentState.CurrentStage != MultiplayerSessionConnectionStage.DISCONNECTED)
             {
                 CurrentState.Disconnect(this);
+                DisplayStatusCode(StatusCode.connectionFailClient, false, "Client has been disconnected");
             }
         }
 

NitroxClient/Communication/NetworkingLayer/LiteNetLib/LiteNetLibClient.cs

@@ -7,9 +7,10 @@
 using NitroxClient.Debuggers;
 using NitroxClient.MonoBehaviours;
 using NitroxClient.MonoBehaviours.Gui.Modals;
+using NitroxModel;
 using NitroxModel.Networking;
 using NitroxModel.Packets;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.NetworkingLayer.LiteNetLib;
 
 public class LiteNetLibClient : IClient
@@ -111,6 +112,7 @@ private void Disconnected(NetPeer peer, DisconnectInfo disconnectInfo)
         if (Multiplayer.Active)
         {
             Modal.Get<LostConnectionModal>()?.Show();
+            DisplayStatusCode(StatusCode.connectionFailClient, false, "The client was disconnected from the server");
         }
 
         IsConnected = false;

NitroxClient/Communication/Packets/Processors/Abstract/ClientPacketProcessor.cs

@@ -1,4 +1,4 @@
-using NitroxModel.Packets;
+using NitroxModel.Packets;
 using NitroxModel.Packets.Processors.Abstract;
 
 namespace NitroxClient.Communication.Packets.Processors.Abstract
@@ -7,6 +7,7 @@ public abstract class ClientPacketProcessor<T> : PacketProcessor where T : Packe
     {
         public override void ProcessPacket(Packet packet, IProcessorContext context)
         {
+            // Send the packet to the according processor script
             Process((T)packet);
         }
 

NitroxClient/Communication/Packets/Processors/BedEnterProcessor.cs

@@ -1,4 +1,4 @@
-using NitroxClient.Communication.Packets.Processors.Abstract;
+using NitroxClient.Communication.Packets.Processors.Abstract;
 using NitroxModel.Packets;
 
 namespace NitroxClient.Communication.Packets.Processors