Skip to content

Commit 1a66fb4

Browse files
update
updating XML API documentation for ConnectionEvent and ConnectionEventData.
1 parent 6e777f9 commit 1a66fb4

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

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

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,54 @@
1010

1111
namespace Unity.Netcode
1212
{
13-
13+
/// <summary>
14+
/// The connection event type set within <see cref="ConnectionEventData"/> to signify the type of connection event notification received.
15+
/// </summary>
16+
/// <remarks>
17+
/// <see cref="ConnectionEventData"/> is returned as a parameter of the <see cref="NetworkManager.OnConnectionEvent"/> event notification.
18+
/// <see cref="ClientConnected"/> and <see cref="ClientDisconnected"/> event types occur on the client-side of the newly connected client and on the server-side. <br />
19+
/// <see cref="PeerConnected"/> and <see cref="PeerDisconnected"/> event types occur on connected clients to notify that a new client (peer) has joined/connected.
20+
/// </remarks>
1421
public enum ConnectionEvent
1522
{
23+
/// <summary>
24+
/// This event is set on the client-side of the newly connected client and on the server-side.<br />
25+
/// </summary>
26+
/// <remarks>
27+
/// On the newly connected client side, the <see cref="ConnectionEventData.ClientId"/> will be the <see cref="NetworkManager.LocalClientId"/>.<br />
28+
/// On the server side, the <see cref="ConnectionEventData.ClientId"/> will be the ID of the client that just connected.
29+
/// </remarks>
1630
ClientConnected,
31+
/// <summary>
32+
/// This event is set on clients that are already connected to the session.
33+
/// </summary>
34+
/// <remarks>
35+
/// The <see cref="ConnectionEventData.ClientId"/> will be the ID of the client that just connected.
36+
/// </remarks>
1737
PeerConnected,
38+
/// <summary>
39+
/// This event is set on the client-side of the client that disconnected client and on the server-side.
40+
/// </summary>
41+
/// <remarks>
42+
/// On the disconnected client side, the <see cref="ConnectionEventData.ClientId"/> will be the <see cref="NetworkManager.LocalClientId"/>.<br />
43+
/// On the server side, this will be the ID of the client that disconnected.
44+
/// </remarks>
1845
ClientDisconnected,
46+
/// <summary>
47+
/// This event is set on clients that are already connected to the session.
48+
/// </summary>
49+
/// <remarks>
50+
/// The <see cref="ConnectionEventData.ClientId"/> will be the ID of the client that just disconnected.
51+
/// </remarks>
1952
PeerDisconnected
2053
}
2154

55+
/// <summary>
56+
/// Returned as a parameter of the <see cref="NetworkManager.OnConnectionEvent"/> event notification.
57+
/// </summary>
58+
/// <remarks>
59+
/// See <see cref="ConnectionEvent"/> for more details on the types of connection events received.
60+
/// </remarks>
2261
public struct ConnectionEventData
2362
{
2463
public ConnectionEvent EventType;

0 commit comments

Comments
 (0)