Skip to content

Commit 6e84ac0

Browse files
committed
corrected all 151-1 PVP APIs marked
1 parent ec8041d commit 6e84ac0

File tree

8 files changed

+37
-21
lines changed

8 files changed

+37
-21
lines changed

com.unity.netcode.gameobjects/Runtime/Connection/NetworkConnectionManager.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
namespace Unity.Netcode
1212
{
1313
/// <summary>
14-
/// The connection event type set within <see cref="ConnectionEventData"/> to signify the type of connection event notification received.
14+
/// The connection event type set within <see cref="ConnectionEventData"/> to signify the type of connection event notification received.
1515
/// </summary>
1616
/// <remarks>
1717
/// <see cref="ConnectionEventData"/> is returned as a parameter of the <see cref="NetworkManager.OnConnectionEvent"/> event notification.
@@ -60,6 +60,9 @@ public enum ConnectionEvent
6060
/// </remarks>
6161
public struct ConnectionEventData
6262
{
63+
/// <summary>
64+
/// The type of connection event that occurred
65+
/// </summary>
6366
public ConnectionEvent EventType;
6467

6568
/// <summary>

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,15 @@
66

77
namespace Unity.Netcode
88
{
9+
/// <summary>
10+
/// Exception thrown when an RPC (Remote Procedure Call) encounters an error during execution
11+
/// </summary>
912
public class RpcException : Exception
1013
{
14+
/// <summary>
15+
/// Initializes a new instance of the RpcException class with a specified error message
16+
/// </summary>
17+
/// <param name="message">The message that describes the error</param>
1118
public RpcException(string message) : base(message)
1219
{
1320

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ public class NetworkManager : MonoBehaviour, INetworkUpdateSystem
4444

4545
#pragma warning restore IDE1006 // restore naming rule violation check
4646

47+
/// <summary>
48+
/// Processes network-related updates for a specific update stage in the frame
49+
/// </summary>
50+
/// <param name="updateStage">The current network update stage being processed</param>
4751
public void NetworkUpdate(NetworkUpdateStage updateStage)
4852
{
4953
switch (updateStage)
@@ -294,6 +298,10 @@ public event Action OnTransportFailure
294298
remove => ConnectionManager.OnTransportFailure -= value;
295299
}
296300

301+
/// <summary>
302+
/// Delegate for handling network state reanticipation events
303+
/// </summary>
304+
/// <param name="lastRoundTripTime">The most recent round-trip time measurement in seconds between client and server</param>
297305
public delegate void ReanticipateDelegate(double lastRoundTripTime);
298306

299307
/// <summary>

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,7 @@ private GlobalObjectId GetGlobalId()
385385
/// Delegate type for checking visibility
386386
/// </summary>
387387
/// <param name="clientId">The clientId to check visibility for</param>
388+
/// <returns>True if the object should be visible to the specified client, false otherwise</returns>
388389
public delegate bool VisibilityDelegate(ulong clientId);
389390

390391
/// <summary>
@@ -396,6 +397,7 @@ private GlobalObjectId GetGlobalId()
396397
/// Delegate type for checking spawn options
397398
/// </summary>
398399
/// <param name="clientId">The clientId to check spawn options for</param>
400+
/// <returns>True if the object should be spawned for the specified client, false otherwise</returns>
399401
public delegate bool SpawnDelegate(ulong clientId);
400402

401403
/// <summary>
@@ -1556,6 +1558,11 @@ internal ushort GetNetworkBehaviourOrderIndex(NetworkBehaviour instance)
15561558
return 0;
15571559
}
15581560

1561+
/// <summary>
1562+
/// Gets a NetworkBehaviour component at the specified index in this object's NetworkBehaviour list
1563+
/// </summary>
1564+
/// <param name="index">The zero-based index of the NetworkBehaviour to retrieve</param>
1565+
/// <returns>The NetworkBehaviour at the specified index, or null if the index is out of bounds</returns>
15591566
public NetworkBehaviour GetNetworkBehaviourAtOrderIndex(ushort index)
15601567
{
15611568
if (index >= ChildNetworkBehaviours.Count)

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,10 @@ public class GenerateSerializationForGenericParameterAttribute : Attribute
7474
{
7575
internal int ParameterIndex;
7676

77+
/// <summary>
78+
/// Initializes a new instance of the attribute
79+
/// </summary>
80+
/// <param name="parameterIndex">The zero-based index of the generic parameter that should be serialized</param>
7781
public GenerateSerializationForGenericParameterAttribute(int parameterIndex)
7882
{
7983
ParameterIndex = parameterIndex;

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ public class GenerateSerializationForTypeAttribute : Attribute
1818
{
1919
internal Type Type;
2020

21+
/// <summary>
22+
/// Initializes a new instance of the attribute
23+
/// </summary>
24+
/// <param name="type">The type that should have serialization code generated for it</param>
2125
public GenerateSerializationForTypeAttribute(Type type)
2226
{
2327
Type = type;

com.unity.netcode.gameobjects/Runtime/NetworkVariable/Collections/NetworkList.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ public NetworkList(IEnumerable<T> values = default,
4949
}
5050
}
5151

52+
/// <summary>
53+
/// Finalizer that ensures proper cleanup of network list resources
54+
/// </summary>
5255
~NetworkList()
5356
{
5457
Dispose();

pvpExceptions.json

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,6 @@
1212
},
1313
"PVP-151-1": {
1414
"errors": [
15-
"Unity.Netcode.NetworkConfig: Prefabs: undocumented",
16-
17-
"Unity.Netcode.ConnectionEventData: EventType: undocumented",
18-
19-
"Unity.Netcode.RpcException: undocumented",
20-
"Unity.Netcode.RpcException: .ctor(string): undocumented",
21-
22-
"Unity.Netcode.NetworkManager: void NetworkUpdate(NetworkUpdateStage): undocumented",
23-
"Unity.Netcode.NetworkManager.ReanticipateDelegate: undocumented",
24-
25-
"Unity.Netcode.NetworkObject: NetworkBehaviour GetNetworkBehaviourAtOrderIndex(ushort): undocumented",
26-
"Unity.Netcode.NetworkObject.VisibilityDelegate: missing <returns>",
27-
"Unity.Netcode.NetworkObject.SpawnDelegate: missing <returns>",
28-
29-
"Unity.Netcode.GenerateSerializationForGenericParameterAttribute: .ctor(int): undocumented",
30-
31-
"Unity.Netcode.GenerateSerializationForTypeAttribute: .ctor(Type): undocumented",
32-
33-
"Unity.Netcode.NetworkList<T>: void Finalize(): undocumented",
34-
3515
"Unity.Netcode.TestHelpers.Runtime.ObjectNameIdentifier: undocumented",
3616
"Unity.Netcode.TestHelpers.Runtime.ObjectNameIdentifier: void OnNetworkSpawn(): undocumented",
3717
"Unity.Netcode.TestHelpers.Runtime.ObjectNameIdentifier: void RegisterAndLabelNetworkObject(): undocumented",

0 commit comments

Comments
 (0)