Refactored Mirror events to use EventArgs classes instead of messy delegates

Author: marchellcx

LabExtended/API/ExMap.cs

@@ -35,6 +35,7 @@
 
 using Utils;
 using Utils.Networking;
+using LabExtended.Events.Mirror;
 
 #pragma warning disable CS8602 // Dereference of a possibly null reference.
 
@@ -550,16 +551,16 @@ private static void OnRoundWaiting()
     }
 
     // this is so stupid
-    private static void OnIdentityDestroyed(NetworkIdentity identity, NetworkServer.DestroyMode mode)
+    private static void OnDestroyingIdentity(MirrorDestroyingIdentityEventArgs args)
     {
         try
         {
-            if (identity == null || mode is not NetworkServer.DestroyMode.Destroy)
+            if (args.Identity == null || args.Mode is not NetworkServer.DestroyMode.Destroy)
                 return;
 
             Lockers.ForEach(l =>
             {
-                if (l.netId != identity.netId)
+                if (l.netId != args.Identity.netId)
                     return;
 
                 for (var i = 0; i < l.Chambers.Length; i++)
@@ -571,9 +572,9 @@ private static void OnIdentityDestroyed(NetworkIdentity identity, NetworkServer.
                 }
             });
 
-            Lockers.RemoveAll(x => x.netId == identity.netId);
+            Lockers.RemoveAll(x => x.netId == args.Identity.netId);
 
-            if (identity.TryGetComponent<IInteractable>(out var interactable))
+            if (args.Identity.TryGetComponent<IInteractable>(out var interactable))
                 InteractableCollider.AllInstances.Remove(interactable);
         }
         catch (Exception ex)
@@ -641,7 +642,7 @@ internal static void Internal_Init()
         ItemPickupBase.OnBeforePickupDestroyed += OnPickupDestroyed;
         ItemPickupBase.OnPickupAdded += OnPickupCreated;
 
-        MirrorEvents.Destroying += OnIdentityDestroyed;
+        MirrorEvents.Destroying += OnDestroyingIdentity;
 
         InternalEvents.OnRoundWaiting += OnRoundWaiting;
 

LabExtended/Events/Mirror/MirrorAddedObserverEventArgs.cs

@@ -0,0 +1,28 @@
+using LabExtended.API;
+
+using Mirror;
+
+namespace LabExtended.Events.Mirror
+{
+    /// <summary>
+    /// Gets called after a new observer is added to an identity's observers list.
+    /// </summary>
+    public class MirrorAddedObserverEventArgs : MirrorIdentityEventArgs
+    {
+        /// <summary>
+        /// Gets the player who was added. May be null if no instance was created for this connection.
+        /// </summary>
+        public ExPlayer? Observer { get; }
+
+        /// <summary>
+        /// Gets the connection of the player who was added as observer.
+        /// </summary>
+        public NetworkConnectionToClient Connection { get; }
+
+        public MirrorAddedObserverEventArgs(NetworkIdentity identity, ExPlayer? observer, NetworkConnectionToClient connection) : base(identity)
+        {
+            Observer = observer;
+            Connection = connection;
+        }
+    }
+}

LabExtended/Events/Mirror/MirrorAddingObserverEventArgs.cs

@@ -0,0 +1,28 @@
+using LabExtended.API;
+
+using Mirror;
+
+namespace LabExtended.Events.Mirror
+{
+    /// <summary>
+    /// Gets called before a new observer is added to an identity's observers list.
+    /// </summary>
+    public class MirrorAddingObserverEventArgs : MirrorIdentityBooleanEventArgs
+    {
+        /// <summary>
+        /// Gets the player who should be added. May be null if no instance was created for this connection.
+        /// </summary>
+        public ExPlayer? Observer { get; }
+
+        /// <summary>
+        /// Gets the connection of the player to be added as observer.
+        /// </summary>
+        public NetworkConnectionToClient Connection { get; }
+
+        public MirrorAddingObserverEventArgs(NetworkIdentity identity, ExPlayer? observer, NetworkConnectionToClient connection) : base(identity)
+        {
+            Observer = observer;
+            Connection = connection;
+        }
+    }
+}

LabExtended/Events/Mirror/MirrorDestroyedIdentityEventArgs.cs

@@ -0,0 +1,20 @@
+using Mirror;
+
+namespace LabExtended.Events.Mirror
+{
+    /// <summary>
+    /// Gets called before Mirror destroys a network identity.
+    /// </summary>
+    public class MirrorDestroyedIdentityEventArgs : MirrorIdentityEventArgs    
+    {
+        /// <summary>
+        /// Gets the destroy mode.
+        /// </summary>
+        public NetworkServer.DestroyMode Mode { get; }
+
+        public MirrorDestroyedIdentityEventArgs(NetworkIdentity identity, NetworkServer.DestroyMode mode) : base(identity)
+        {
+            Mode = mode;
+        }
+    }
+}

LabExtended/Events/Mirror/MirrorDestroyingIdentityEventArgs.cs

@@ -0,0 +1,20 @@
+using Mirror;
+
+namespace LabExtended.Events.Mirror
+{
+    /// <summary>
+    /// Gets called before Mirror destroys a network identity.
+    /// </summary>
+    public class MirrorDestroyingIdentityEventArgs : MirrorIdentityBooleanEventArgs
+    {
+        /// <summary>
+        /// Gets the destroy mode.
+        /// </summary>
+        public NetworkServer.DestroyMode Mode { get; }
+
+        public MirrorDestroyingIdentityEventArgs(NetworkIdentity identity, NetworkServer.DestroyMode mode) : base(identity)
+        {
+            Mode = mode;
+        }
+    }
+}

LabExtended/Events/Mirror/MirrorIdentityBooleanEventArgs.cs

@@ -0,0 +1,20 @@
+using Mirror;
+
+namespace LabExtended.Events.Mirror
+{
+    /// <summary>
+    /// Base class for Mirror events with a network identity.
+    /// </summary>
+    public abstract class MirrorIdentityBooleanEventArgs : BooleanEventArgs
+    {
+        /// <summary>
+        /// Gets the targeted network identity.
+        /// </summary>
+        public NetworkIdentity Identity { get; }
+
+        public MirrorIdentityBooleanEventArgs(NetworkIdentity identity)
+        {
+            Identity = identity;
+        }
+    }
+} 

LabExtended/Events/Mirror/MirrorIdentityEventArgs.cs

@@ -0,0 +1,20 @@
+using Mirror;
+
+namespace LabExtended.Events.Mirror
+{
+    /// <summary>
+    /// Base class for Mirror events with a network identity.
+    /// </summary>
+    public abstract class MirrorIdentityEventArgs : EventArgs
+    {
+        /// <summary>
+        /// Gets the targeted network identity.
+        /// </summary>
+        public NetworkIdentity Identity { get; }
+
+        public MirrorIdentityEventArgs(NetworkIdentity identity)
+        {
+            Identity = identity;
+        }
+    }
+}

LabExtended/Events/Mirror/MirrorRemovedObserverEventArgs.cs

@@ -0,0 +1,28 @@
+using LabExtended.API;
+
+using Mirror;
+
+namespace LabExtended.Events.Mirror
+{
+    /// <summary>
+    /// Gets called before an observer is removed from an identity's observers list.
+    /// </summary>
+    public class MirrorRemovedObserverEventArgs : MirrorIdentityBooleanEventArgs
+    {
+        /// <summary>
+        /// Gets the player who should be removed. May be null if no instance was created for this connection.
+        /// </summary>
+        public ExPlayer? Observer { get; }
+
+        /// <summary>
+        /// Gets the connection of the player to be removed as observer.
+        /// </summary>
+        public NetworkConnection Connection { get; }
+
+        public MirrorRemovedObserverEventArgs(NetworkIdentity identity, ExPlayer? observer, NetworkConnection connection) : base(identity)
+        {
+            Observer = observer;
+            Connection = connection;
+        }
+    }
+}

LabExtended/Events/Mirror/MirrorRemovingObserverEventArgs.cs

@@ -0,0 +1,28 @@
+using LabExtended.API;
+
+using Mirror;
+
+namespace LabExtended.Events.Mirror
+{
+    /// <summary>
+    /// Gets called before an observer is removed from an identity's observers list.
+    /// </summary>
+    public class MirrorRemovingObserverEventArgs : MirrorIdentityBooleanEventArgs
+    {
+        /// <summary>
+        /// Gets the player who should be removed. May be null if no instance was created for this connection.
+        /// </summary>
+        public ExPlayer? Observer { get; }
+
+        /// <summary>
+        /// Gets the connection of the player to be removed as observer.
+        /// </summary>
+        public NetworkConnection Connection { get; }
+
+        public MirrorRemovingObserverEventArgs(NetworkIdentity identity, ExPlayer? observer, NetworkConnection connection) : base(identity)
+        {
+            Observer = observer;
+            Connection = connection;
+        }
+    }
+}

LabExtended/Events/Mirror/MirrorSendingRpcEventArgs.cs

@@ -0,0 +1,46 @@
+using LabExtended.API;
+
+using Mirror;
+
+namespace LabExtended.Events.Mirror
+{
+    /// <summary>
+    /// Gets called before an RPC is sent to a player.
+    /// </summary>
+    public class MirrorSendingRpcEventArgs : MirrorIdentityBooleanEventArgs
+    {
+        /// <summary>
+        /// Gets the player who will receive the RPC.
+        /// </summary>
+        public ExPlayer Player { get; internal set; }
+
+        /// <summary>
+        /// Gets or sets the writer which contains the data of the RPC.
+        /// </summary>
+        public NetworkWriter Writer { get; set; }
+
+        /// <summary>
+        /// Gets the behaviour sending the RPC.
+        /// </summary>
+        public NetworkBehaviour Behaviour { get; }
+
+        /// <summary>
+        /// Gets the hash of the RPC method name.
+        /// </summary>
+        public int RpcHash { get; }
+
+        /// <summary>
+        /// Gets the full name of the RPC method.
+        /// </summary>
+        public string RpcName { get; }
+
+        public MirrorSendingRpcEventArgs(ExPlayer player, NetworkWriter writer, NetworkBehaviour behaviour, int rpcHash, string rpcName) : base(behaviour.netIdentity)
+        {
+            Player = player;
+            Writer = writer;
+            Behaviour = behaviour;
+            RpcHash = rpcHash;
+            RpcName = rpcName;
+        }
+    }
+}