chore: Adding quick comment explaining player ID (#816)

SamuelBellomo · web-flow · commit fd5b1dd7da48 · 2023-04-12T16:15:10.000Z
* Update ConnectionMethod.cs

* Update Assets/Scripts/ConnectionManagement/ConnectionMethod.cs
diff --git a/Assets/Scripts/ConnectionManagement/ConnectionMethod.cs b/Assets/Scripts/ConnectionManagement/ConnectionMethod.cs
@@ -66,6 +66,13 @@ protected void SetConnectionPayload(string playerId, string playerName)
             m_ConnectionManager.NetworkManager.NetworkConfig.ConnectionData = payloadBytes;
         }
 
+        /// Using authentication, this makes sure your session is associated with your account and not your device. This means you could reconnect 
+        /// from a different device for example. A playerId is also a bit more permanent than player prefs. In a browser for example, 
+        /// player prefs can be cleared as easily as cookies.
+        /// The forked flow here is for debug purposes and to make UGS optional in Boss Room. This way you can study the sample without 
+        /// setting up a UGS account. It's recommended to investigate your own initialization and IsSigned flows to see if you need 
+        /// those checks on your own and react accordingly. We offer here the option for offline access for debug purposes, but in your own game you
+        /// might want to show an error popup and ask your player to connect to the internet.
         protected string GetPlayerId()
         {
             if (Services.Core.UnityServices.State != ServicesInitializationState.Initialized)

Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,13 @@ protected void SetConnectionPayload(string playerId, string playerName)`
`66`	`66`	`m_ConnectionManager.NetworkManager.NetworkConfig.ConnectionData = payloadBytes;`
`67`	`67`	`}`
`68`	`68`
	`69`	`+ /// Using authentication, this makes sure your session is associated with your account and not your device. This means you could reconnect`
	`70`	`+ /// from a different device for example. A playerId is also a bit more permanent than player prefs. In a browser for example,`
	`71`	`+ /// player prefs can be cleared as easily as cookies.`
	`72`	`+ /// The forked flow here is for debug purposes and to make UGS optional in Boss Room. This way you can study the sample without`
	`73`	`+ /// setting up a UGS account. It's recommended to investigate your own initialization and IsSigned flows to see if you need`
	`74`	`+ /// those checks on your own and react accordingly. We offer here the option for offline access for debug purposes, but in your own game you`
	`75`	`+ /// might want to show an error popup and ask your player to connect to the internet.`
`69`	`76`	`protected string GetPlayerId()`
`70`	`77`	`{`
`71`	`78`	`if (Services.Core.UnityServices.State != ServicesInitializationState.Initialized)`