feat: expose network behaviour type name internally (#1057)

* feat: expose the name of the network behaviour without runtime alloc

* Added test to verify that the name is exposed correctly

* removed unnecessary using

* code review feedback

* fixed bad comment

Author: becksebenius-unity

com.unity.netcode.gameobjects/Editor/CodeGen/NetworkBehaviourILPP.cs

@@ -592,6 +592,27 @@ private void ProcessNetworkBehaviour(TypeDefinition typeDefinition, string[] ass
                 instructions.Reverse();
                 instructions.ForEach(instruction => processor.Body.Instructions.Insert(0, instruction));
             }
+
+            // override NetworkBehaviour.__getTypeName() method to return concrete type
+            {
+                var baseType = typeDefinition.BaseType.Resolve();
+                var baseGetTypeNameMethod = baseType.Methods.First(p => p.Name.Equals(nameof(NetworkBehaviour.__getTypeName)));
+
+                var newGetTypeNameMethod = new MethodDefinition(
+                    nameof(NetworkBehaviour.__getTypeName),
+                    (baseGetTypeNameMethod.Attributes & ~MethodAttributes.NewSlot) | MethodAttributes.ReuseSlot,
+                    baseGetTypeNameMethod.ReturnType)
+                {
+                    ImplAttributes = baseGetTypeNameMethod.ImplAttributes,
+                    SemanticsAttributes = baseGetTypeNameMethod.SemanticsAttributes
+                };
+
+                var processor = newGetTypeNameMethod.Body.GetILProcessor();
+                processor.Body.Instructions.Add(processor.Create(OpCodes.Ldstr, typeDefinition.Name));
+                processor.Body.Instructions.Add(processor.Create(OpCodes.Ret));
+
+                typeDefinition.Methods.Add(newGetTypeNameMethod);
+            }
         }
 
         private CustomAttribute CheckAndGetRpcAttribute(MethodDefinition methodDefinition)

com.unity.netcode.gameobjects/Runtime/Core/NetworkBehaviour.cs

@@ -35,13 +35,18 @@ private static void SetUpdateStage<T>(ref T param) where T : IHasUpdateStage
             }
         }
 
+#pragma warning disable IDE1006 // disable naming rule violation check
+        // NetworkBehaviourILPP will override this in derived classes to return the name of the concrete type
+        internal virtual string __getTypeName() => nameof(NetworkBehaviour);
+#pragma warning restore IDE1006 // restore naming rule violation check
+
 #pragma warning disable 414 // disable assigned but its value is never used
 #pragma warning disable IDE1006 // disable naming rule violation check
         [NonSerialized]
         // RuntimeAccessModifiersILPP will make this `protected`
         internal __RpcExecStage __rpc_exec_stage = __RpcExecStage.None;
 #pragma warning restore 414 // restore assigned but its value is never used
-#pragma warning restore IDE1006 // restore naming rule violation
+#pragma warning restore IDE1006 // restore naming rule violation check
 
 #pragma warning disable IDE1006 // disable naming rule violation check
         // RuntimeAccessModifiersILPP will make this `protected`

com.unity.netcode.gameobjects/Tests/Editor/NetworkBehaviourTests.cs

@@ -46,6 +46,15 @@ public void AccessNetworkObjectTest()
             Object.DestroyImmediate(gameObject);
         }
 
+        [Test]
+        public void GetNetworkBehaviourNameTest()
+        {
+            var gameObject = new GameObject(nameof(GetNetworkBehaviourNameTest));
+            var networkBehaviour = gameObject.AddComponent<EmptyNetworkBehaviour>();
+
+            Assert.AreEqual(nameof(EmptyNetworkBehaviour), networkBehaviour.__getTypeName());
+        }
+
         public class EmptyNetworkBehaviour : NetworkBehaviour
         {