Skip to content

Commit 2f454c0

Browse files
Document UseEncryption and UseWebSockets
1 parent 8e13483 commit 2f454c0

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

com.unity.netcode.gameobjects/Runtime/Transports/UTP/UnityTransport.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ private enum State
164164
[SerializeField]
165165
private bool m_UseWebSockets = false;
166166

167+
/// <summary>Whether to use WebSockets as the protocol of communication. Default is UDP.</summary>
167168
public bool UseWebSockets
168169
{
169170
get => m_UseWebSockets;
@@ -176,6 +177,11 @@ public bool UseWebSockets
176177
[Tooltip("Per default the client/server communication will not be encrypted. Select true to enable DTLS for UDP and TLS for Websocket.")]
177178
[SerializeField]
178179
private bool m_UseEncryption = false;
180+
181+
/// <summary>
182+
/// Whether to use encryption (default is false). Note that unless using Unity Relay, encryption requires
183+
/// providing certificate information with <see cref="SetClientSecrets"/> and <see cref="SetServerSecrets"/>.
184+
/// </summary>
179185
public bool UseEncryption
180186
{
181187
get => m_UseEncryption;

0 commit comments

Comments
 (0)