RpcAttributes corrections

Author: michalChrobot

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

@@ -24,12 +24,29 @@ public enum RpcDelivery
     [AttributeUsage(AttributeTargets.Method)]
     public class RpcAttribute : Attribute
     {
-        // Must match the set of parameters below
+        /// <summary>
+        /// Parameters that define the behavior of an RPC attribute
+        /// </summary>
         public struct RpcAttributeParams
         {
+            /// <summary>
+            /// Specifies the delivery method for the RPC
+            /// </summary>
             public RpcDelivery Delivery;
+
+            /// <summary>
+            /// When true, only the owner of the object can execute this RPC
+            /// </summary>
             public bool RequireOwnership;
+
+            /// <summary>
+            /// When true, local execution of the RPC is deferred until the next network tick
+            /// </summary>
             public bool DeferLocal;
+
+            /// <summary>
+            /// When true, allows the RPC target to be overridden at runtime
+            /// </summary>
             public bool AllowTargetOverride;
         }
 
@@ -38,10 +55,26 @@ public struct RpcAttributeParams
         /// Type of RPC delivery method
         /// </summary>
         public RpcDelivery Delivery = RpcDelivery.Reliable;
+
+        /// <summary>
+        /// When true, only the owner of the object can execute this RPC
+        /// </summary>
         public bool RequireOwnership;
+
+        /// <summary>
+        /// When true, local execution of the RPC is deferred until the next network tick
+        /// </summary>
         public bool DeferLocal;
+
+        /// <summary>
+        /// When true, allows the RPC target to be overridden at runtime
+        /// </summary>
         public bool AllowTargetOverride;
 
+        /// <summary>
+        /// Initializes a new instance of the RpcAttribute with the specified target
+        /// </summary>
+        /// <param name="target">The target for this RPC</param>
         public RpcAttribute(SendTo target)
         {
         }
@@ -60,8 +93,15 @@ private RpcAttribute()
     [AttributeUsage(AttributeTargets.Method)]
     public class ServerRpcAttribute : RpcAttribute
     {
+        /// <summary>
+        /// When true, only the owner of the NetworkObject can invoke this ServerRpc.
+        /// This property overrides the base RpcAttribute.RequireOwnership.
+        /// </summary>
         public new bool RequireOwnership;
 
+        /// <summary>
+        /// Initializes a new instance of ServerRpcAttribute that targets the server
+        /// </summary>
         public ServerRpcAttribute() : base(SendTo.Server)
         {
 
@@ -75,6 +115,9 @@ public ServerRpcAttribute() : base(SendTo.Server)
     [AttributeUsage(AttributeTargets.Method)]
     public class ClientRpcAttribute : RpcAttribute
     {
+        /// <summary>
+        /// Initializes a new instance of ClientRpcAttribute that targets all clients except the server
+        /// </summary>
         public ClientRpcAttribute() : base(SendTo.NotServer)
         {
 

pvpExceptions.json

@@ -45,18 +45,6 @@
           "Unity.Netcode.CustomMessagingManager.HandleNamedMessageDelegate: missing <param name=\"messagePayload\">",
           "Unity.Netcode.GenerateSerializationForGenericParameterAttribute: .ctor(int): undocumented",
           "Unity.Netcode.GenerateSerializationForTypeAttribute: .ctor(Type): undocumented",
-          "Unity.Netcode.RpcAttribute: RequireOwnership: undocumented",
-          "Unity.Netcode.RpcAttribute: DeferLocal: undocumented",
-          "Unity.Netcode.RpcAttribute: AllowTargetOverride: undocumented",
-          "Unity.Netcode.RpcAttribute: .ctor(SendTo): undocumented",
-          "Unity.Netcode.RpcAttribute.RpcAttributeParams: undocumented",
-          "Unity.Netcode.RpcAttribute.RpcAttributeParams: Delivery: undocumented",
-          "Unity.Netcode.RpcAttribute.RpcAttributeParams: RequireOwnership: undocumented",
-          "Unity.Netcode.RpcAttribute.RpcAttributeParams: DeferLocal: undocumented",
-          "Unity.Netcode.RpcAttribute.RpcAttributeParams: AllowTargetOverride: undocumented",
-          "Unity.Netcode.ServerRpcAttribute: RequireOwnership: undocumented",
-          "Unity.Netcode.ServerRpcAttribute: .ctor(): undocumented",
-          "Unity.Netcode.ClientRpcAttribute: .ctor(): undocumented",
           "Unity.Netcode.StaleDataHandling: undocumented",
           "Unity.Netcode.StaleDataHandling: Ignore: undocumented",
           "Unity.Netcode.StaleDataHandling: Reanticipate: undocumented",