Restore and deprecate RequireOwnership in favor of RpcInvokePermission

Author: xmanning

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

@@ -1441,6 +1441,7 @@ private void ProcessNetworkBehaviour(TypeDefinition typeDefinition, string[] ass
                     }
 
                     var invokePermission = RpcInvokePermission.Anyone;
+
                     foreach (var attrField in rpcAttribute.Fields)
                     {
                         switch (attrField.Name)
@@ -1537,6 +1538,7 @@ private void ProcessNetworkBehaviour(TypeDefinition typeDefinition, string[] ass
         private CustomAttribute CheckAndGetRpcAttribute(MethodDefinition methodDefinition)
         {
             CustomAttribute rpcAttribute = null;
+
             foreach (var customAttribute in methodDefinition.CustomAttributes)
             {
                 var customAttributeType_FullName = customAttribute.AttributeType.FullName;
@@ -1620,6 +1622,30 @@ private CustomAttribute CheckAndGetRpcAttribute(MethodDefinition methodDefinitio
 
                 return null;
             }
+
+            bool hasRequireOwnership = false, hasInvokePermission = false;
+
+            foreach (var argument in rpcAttribute.Fields)
+            {
+                switch (argument.Name)
+                {
+                    case k_ServerRpcAttribute_RequireOwnership:
+                        hasRequireOwnership = true;
+                        break;
+                    case k_RpcAttribute_InvokePermission:
+                        hasInvokePermission = true;
+                        break;
+                    default:
+                        break;
+                }
+            }
+
+            if (hasRequireOwnership && hasInvokePermission)
+            {
+                m_Diagnostics.AddError("Rpc attribute cannot declare both RequireOwnership and InvokePermission!");
+                return null;
+            }
+
             // Checks for IsSerializable are moved to later as the check is now done by dynamically seeing if any valid
             // serializer OR extension method exists for it.
             return rpcAttribute;
@@ -2366,6 +2392,7 @@ private void InjectWriteAndCallBlocks(MethodDefinition methodDefinition, CustomA
                             m_Diagnostics.AddError($"{nameof(RpcAttribute)} contains field {field} which is not present in {nameof(RpcAttribute.RpcAttributeParams)}.");
                         }
                     }
+
                     instructions.Add(processor.Create(OpCodes.Ldloc, rpcAttributeParamsIdx));
 
                     // defaultTarget

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

@@ -330,13 +330,14 @@ internal FastBufferWriter __beginSendRpc(uint rpcMethodId, RpcParams rpcParams,
             {   
                 throw new RpcException("The NetworkBehaviour must be spawned before calling this method.");
             }
-            if (attributeParams.InvokePermission == RpcInvokePermission.Owner && !IsOwner)
-            {
-                throw new RpcException("This RPC can only be sent by its owner.");
-            } else if (attributeParams.InvokePermission == RpcInvokePermission.Server && !IsServer)
+            else if (attributeParams.InvokePermission == RpcInvokePermission.Server && !IsServer)
             {
                 throw new RpcException("This RPC can only be sent by the server.");
             }
+            else if ((attributeParams.RequireOwnership || attributeParams.InvokePermission == RpcInvokePermission.Owner) && !IsOwner)
+            {
+                throw new RpcException("This RPC can only be sent by its owner.");
+            }
             return new FastBufferWriter(k_RpcMessageDefaultSize, Allocator.Temp, k_RpcMessageMaximumSize);
         }
 

com.unity.netcode.gameobjects/Runtime/Messaging/RpcAttributes.cs

@@ -67,6 +67,8 @@ public struct RpcAttributeParams
             /// When true, allows the RPC target to be overridden at runtime
             /// </summary>
             public bool AllowTargetOverride;
+
+            public bool RequireOwnership;
         }
 
         // Must match the fields in RemoteAttributeParams
@@ -80,6 +82,15 @@ public struct RpcAttributeParams
         /// </summary>
         public RpcInvokePermission InvokePermission;
 
+        /// <summary>
+        /// When true, only the owner of the object can execute this RPC
+        /// </summary>
+        /// <remarks>
+        /// Deprecated in favor of <see cref="RpcInvokePermission"/>.
+        /// </remarks>
+        [Obsolete]
+        public bool RequireOwnership;
+
         /// <summary>
         /// When true, local execution of the RPC is deferred until the next network tick
         /// </summary>
@@ -116,7 +127,7 @@ public class ServerRpcAttribute : RpcAttribute
         /// When true, only the owner of the NetworkObject can invoke this ServerRpc.
         /// This property overrides the base RpcAttribute.RequireOwnership.
         /// </summary>
-        public bool RequireOwnership;
+        public new bool RequireOwnership;
 
         /// <summary>
         /// Initializes a new instance of ServerRpcAttribute that targets the server
@@ -139,7 +150,7 @@ public class ClientRpcAttribute : RpcAttribute
         /// </summary>
         public ClientRpcAttribute() : base(SendTo.NotServer)
         {
-
+            InvokePermission = RpcInvokePermission.Server;
         }
     }
 }