com.xmobitea.changx.gn-unity 2.0.3 → 2.4.0

package/Runtime/Common/GNHashtable.cs.meta

@@ -1,11 +1,11 @@
-fileFormatVersion: 2
-guid: b12e8b46be45df044adf765876a2dc79
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: b12e8b46be45df044adf765876a2dc79
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Common/IGNData.cs

@@ -1,11 +1,20 @@
-namespace XmobiTea.GN.Common
-{
-    public interface IGNData
-    {
-        object toData();
-
-        string toString();
-
-    }
-
-}
+namespace XmobiTea.GN.Common
+{
+    /// <summary>
+    /// Interface defining the structure for GNData objects.
+    /// </summary>
+    public interface IGNData
+    {
+        /// <summary>
+        /// Converts the current GNData object into a serializable data format.
+        /// </summary>
+        /// <returns>A serializable representation of the GNData object.</returns>
+        object toData();
+
+        /// <summary>
+        /// Converts the current GNData object into a string representation.
+        /// </summary>
+        /// <returns>A string representation of the GNData object.</returns>
+        string toString();
+    }
+}

package/Runtime/Common/IGNData.cs.meta

@@ -1,11 +1,11 @@
-fileFormatVersion: 2
-guid: 5274c9bb50388574d9fbb33cc2c152ec
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 5274c9bb50388574d9fbb33cc2c152ec
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Common.meta

@@ -1,8 +1,8 @@
-fileFormatVersion: 2
-guid: b7214dcb9e233e54b977c23f3c78b4e2
-folderAsset: yes
-DefaultImporter:
-  externalObjects: {}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: b7214dcb9e233e54b977c23f3c78b4e2
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Config/GNServerSettings.cs

@@ -2,25 +2,53 @@
 {
     using UnityEngine;
 
+    /// <summary>
+    /// Enum for specifying the peer socket version.
+    /// </summary>
     public enum PeerSocketVersion
     {
+        /// <summary>
+        /// Socket.IO version 2 with protocol v2.
+        /// </summary>
         V2_v2 = 0,
+
+        /// <summary>
+        /// Socket.IO version 2 with protocol v3.
+        /// </summary>
         V2_v3 = 1,
-        V3 = 2,
 
+        /// <summary>
+        /// Socket.IO version 3.
+        /// </summary>
+        V3 = 2,
     }
 
+    /// <summary>
+    /// Enum for specifying the HTTP request type.
+    /// </summary>
     public enum HttpRequestType
     {
+        /// <summary>
+        /// UnityWebRequest for HTTP requests.
+        /// </summary>
         UnityWebRequest = 0,
 
 #if UNITY_USING_BEST_HTTP
+        /// <summary>
+        /// BestHTTP library for HTTP requests.
+        /// </summary>
         HTTPRequest = 1,
 #endif
 
+        /// <summary>
+        /// HttpWebRequest for HTTP requests.
+        /// </summary>
         HttpWebRequest = 2,
     }
 
+    /// <summary>
+    /// GN Server settings configuration.
+    /// </summary>
     //[CreateAssetMenu(fileName = GNServerSettings.ResourcesPath, menuName = "GN/GNServerSettings", order = 1)]
     public class GNServerSettings : ScriptableObject
     {
@@ -71,96 +99,112 @@
         [SerializeField]
         private GN.Logger.LogType logType = GN.Logger.LogType.All;
 
-        public string getServerAddress()
-        {
-            return this.serverAddress;
-        }
-
-        public int getServerPort()
-        {
-            return this.serverPort;
-        }
-
-        public bool isUseSsl()
-        {
-            return this.useSsl;
-        }
-
-
-        public bool isUseSocket()
-        {
-            return this.useSocket;
-        }
-
-        public bool isUseHttp()
-        {
-            return this.useHttp;
-        }
-
-        public int getSendRate()
-        {
-            return this.sendRate;
-        }
-
-        public int getReconnectDelay()
-        {
-            return this.reconnectDelay;
-        }
-
-        public float getPingInterval()
-        {
-            return this.pingInterval;
-        }
-
-        public float getPingTimeout()
-        {
-            return this.pingTimeout;
-        }
-
-        public string getAdminSecretKey()
-        {
-            return this.adminSecretKey;
-        }
-
-        public string getServerSecretKey()
-        {
-            return this.serverSecretKey;
-        }
-
-        public string getClientSecretKey()
-        {
-            return this.clientSecretKey;
-        }
-
-        public PeerSocketVersion getPeerSocketVersion()
-        {
-            return this.peerSocketVersion;
-        }
-
-        public HttpRequestType getHttpRequestType()
-        {
-            return this.httpRequestType;
-        }
-
-        public GN.Logger.LogType getLogType()
-        {
-            return this.logType;
-        }
-
-       
-        public string getSocketUrl()
-        {
-            if (this.serverPort < 0) return string.Format((this.useSsl ? "https" : "http") + "://{0}", this.serverAddress);
-            else return string.Format((this.useSsl ? "https" : "http") + "://{0}:{1}", this.serverAddress, this.serverPort);
-        }
-
-        public string getHttpUrl()
-        {
-            if (this.serverPort < 0) return string.Format((this.useSsl ? "https" : "http") + "://{0}", this.serverAddress);
-            else return string.Format((this.useSsl ? "https" : "http") + "://{0}:{1}", this.serverAddress, this.serverPort);
-        }
-
+        /// <summary>
+        /// Gets the server address.
+        /// </summary>
+        /// <returns>The server address.</returns>
+        public string getServerAddress() => this.serverAddress;
+
+        /// <summary>
+        /// Gets the server port.
+        /// </summary>
+        /// <returns>The server port.</returns>
+        public int getServerPort() => this.serverPort;
+
+        /// <summary>
+        /// Indicates whether SSL is used.
+        /// </summary>
+        /// <returns>True if SSL is used; otherwise, false.</returns>
+        public bool isUseSsl() => this.useSsl;
+
+        /// <summary>
+        /// Indicates whether socket communication is enabled.
+        /// </summary>
+        /// <returns>True if socket is used; otherwise, false.</returns>
+        public bool isUseSocket() => this.useSocket;
+
+        /// <summary>
+        /// Indicates whether HTTP communication is enabled.
+        /// </summary>
+        /// <returns>True if HTTP is used; otherwise, false.</returns>
+        public bool isUseHttp() => this.useHttp;
+
+        /// <summary>
+        /// Gets the message send rate.
+        /// </summary>
+        /// <returns>The send rate.</returns>
+        public int getSendRate() => this.sendRate;
+
+        /// <summary>
+        /// Gets the reconnect delay in milliseconds.
+        /// </summary>
+        /// <returns>The reconnect delay.</returns>
+        public int getReconnectDelay() => this.reconnectDelay;
+
+        /// <summary>
+        /// Gets the ping interval in milliseconds.
+        /// </summary>
+        /// <returns>The ping interval.</returns>
+        public float getPingInterval() => this.pingInterval;
+
+        /// <summary>
+        /// Gets the ping timeout in milliseconds.
+        /// </summary>
+        /// <returns>The ping timeout.</returns>
+        public float getPingTimeout() => this.pingTimeout;
+
+        /// <summary>
+        /// Gets the admin secret key.
+        /// </summary>
+        /// <returns>The admin secret key.</returns>
+        public string getAdminSecretKey() => this.adminSecretKey;
+
+        /// <summary>
+        /// Gets the server secret key.
+        /// </summary>
+        /// <returns>The server secret key.</returns>
+        public string getServerSecretKey() => this.serverSecretKey;
+
+        /// <summary>
+        /// Gets the client secret key.
+        /// </summary>
+        /// <returns>The client secret key.</returns>
+        public string getClientSecretKey() => this.clientSecretKey;
+
+        /// <summary>
+        /// Gets the peer socket version.
+        /// </summary>
+        /// <returns>The peer socket version.</returns>
+        public PeerSocketVersion getPeerSocketVersion() => this.peerSocketVersion;
+
+        /// <summary>
+        /// Gets the HTTP request type.
+        /// </summary>
+        /// <returns>The HTTP request type.</returns>
+        public HttpRequestType getHttpRequestType() => this.httpRequestType;
+
+        /// <summary>
+        /// Gets the log type.
+        /// </summary>
+        /// <returns>The log type.</returns>
+        public GN.Logger.LogType getLogType() => this.logType;
+
+        /// <summary>
+        /// Constructs the socket URL.
+        /// </summary>
+        /// <returns>The socket URL.</returns>
+        public string getSocketUrl() =>
+            this.serverPort < 0
+                ? $"{(this.useSsl ? "https" : "http")}://{this.serverAddress}"
+                : $"{(this.useSsl ? "https" : "http")}://{this.serverAddress}:{this.serverPort}";
+
+        /// <summary>
+        /// Constructs the HTTP URL.
+        /// </summary>
+        /// <returns>The HTTP URL.</returns>
+        public string getHttpUrl() =>
+            this.serverPort < 0
+                ? $"{(this.useSsl ? "https" : "http")}://{this.serverAddress}"
+                : $"{(this.useSsl ? "https" : "http")}://{this.serverAddress}:{this.serverPort}";
     }
-
 }
-

package/Runtime/Config/GNServerSettings.cs.meta

@@ -1,11 +1,11 @@
-fileFormatVersion: 2
-guid: 1f5a0d671baecc84a96081fada3dd9e4
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 1f5a0d671baecc84a96081fada3dd9e4
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Config.meta

@@ -1,8 +1,8 @@
-fileFormatVersion: 2
-guid: ffaf78f72b4123b4aa40cc27bc08417f
-folderAsset: yes
-DefaultImporter:
-  externalObjects: {}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: ffaf78f72b4123b4aa40cc27bc08417f
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Constant/Commands.cs

@@ -1,30 +1,93 @@
 namespace XmobiTea.GN.Constant
 {
-	public class Commands
-	{
-		public const string USER_AGENT = "User-Agent";
+    /// <summary>
+    /// Holds constant values used throughout the GN networking system.
+    /// </summary>
+    public class Commands
+    {
+        /// <summary>
+        /// HTTP header key for specifying the user agent.
+        /// </summary>
+        public const string USER_AGENT = "User-Agent";
 
-		public const string CONTENT_TYPE = "Content-Type";
-		public const string CONTENT_LENGTH = "Content-Length";
-		public const string APPLICATION_JSON = "application/json";
-		public const string APPLICATION_MSGPACK = "application/msgpack";
+        /// <summary>
+        /// HTTP header key for specifying the content type.
+        /// </summary>
+        public const string CONTENT_TYPE = "Content-Type";
 
-		public const string RequestAuthTokenCmd = "a";
-		public const string RequestSecretCmd = "s";
+        /// <summary>
+        /// HTTP header key for specifying the content length.
+        /// </summary>
+        public const string CONTENT_LENGTH = "Content-Length";
 
-		public const string RequestCmd_MsgPack = "r";
-		public const string ResponseCmd_MsgPack = "r";
-		public const string EventCmd_MsgPack = "e";
+        /// <summary>
+        /// MIME type for JSON content.
+        /// </summary>
+        public const string APPLICATION_JSON = "application/json";
 
-		public const string RequestCmd_Json = "t";
-		public const string ResponseCmd_Json = "t";
-		public const string EventCmd_Json = "y";
+        /// <summary>
+        /// MIME type for MsgPack content.
+        /// </summary>
+        public const string APPLICATION_MSGPACK = "application/msgpack";
 
-		public const string Data = "d";
-		public const string File = "f";
+        /// <summary>
+        /// Key for the authentication token in requests.
+        /// </summary>
+        public const string RequestAuthTokenCmd = "a";
 
-		private Commands() { }
+        /// <summary>
+        /// Key for the secret key in requests.
+        /// </summary>
+        public const string RequestSecretCmd = "s";
 
-	}
+        /// <summary>
+        /// Key for the gameId key in requests.
+        /// </summary>
+        public const string RequestGameIdCmd = "g";
 
+        /// <summary>
+        /// Key for MsgPack request commands.
+        /// </summary>
+        public const string RequestCmd_MsgPack = "r";
+
+        /// <summary>
+        /// Key for MsgPack response commands.
+        /// </summary>
+        public const string ResponseCmd_MsgPack = "r";
+
+        /// <summary>
+        /// Key for MsgPack event commands.
+        /// </summary>
+        public const string EventCmd_MsgPack = "e";
+
+        /// <summary>
+        /// Key for JSON request commands.
+        /// </summary>
+        public const string RequestCmd_Json = "t";
+
+        /// <summary>
+        /// Key for JSON response commands.
+        /// </summary>
+        public const string ResponseCmd_Json = "t";
+
+        /// <summary>
+        /// Key for JSON event commands.
+        /// </summary>
+        public const string EventCmd_Json = "y";
+
+        /// <summary>
+        /// General key for data fields.
+        /// </summary>
+        public const string Data = "d";
+
+        /// <summary>
+        /// Key for file fields.
+        /// </summary>
+        public const string File = "f";
+
+        /// <summary>
+        /// Private constructor to prevent instantiation of this utility class.
+        /// </summary>
+        private Commands() { }
+    }
 }

package/Runtime/Constant/Commands.cs.meta

@@ -1,11 +1,11 @@
-fileFormatVersion: 2
-guid: ceac771235ac3ad43b6c9eb215cf1b7d
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: ceac771235ac3ad43b6c9eb215cf1b7d
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Constant/EnumType/FriendStatus.cs

@@ -1,12 +1,12 @@
-namespace XmobiTea.GN.Constant
-{
-    public enum FriendStatus
-    {
-        Friend = 1,
-        WaitingAccept = 2,
-        SentRequestAndWaitingAccept = 3,
-        NotFriend = 4,
-
-    }
-
-}
+namespace XmobiTea.GN.Constant
+{
+    public enum FriendStatus
+    {
+        Friend = 1,
+        WaitingAccept = 2,
+        SentRequestAndWaitingAccept = 3,
+        NotFriend = 4,
+
+    }
+
+}

package/Runtime/Constant/EnumType/FriendStatus.cs.meta

@@ -1,11 +1,11 @@
-fileFormatVersion: 2
-guid: 2c9ae4fd7faaae7488a70ea9a538f38c
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 2c9ae4fd7faaae7488a70ea9a538f38c
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Constant/EnumType/GoogleLoginType.cs

@@ -1,10 +1,10 @@
 namespace XmobiTea.GN.Constant
 {
-	public enum GoogleLoginType
-	{
-		AccessToken = 1,
-		IdToken = 2,
+    public enum GoogleLoginType
+    {
+        AccessToken = 1,
+        IdToken = 2,
 
-	}
+    }
 
 }

package/Runtime/Constant/EnumType/GoogleLoginType.cs.meta

@@ -1,11 +1,11 @@
-fileFormatVersion: 2
-guid: 4576809c05f4d1642889f463afce2d0b
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 4576809c05f4d1642889f463afce2d0b
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Constant/EnumType/GroupStatus.cs

@@ -1,12 +1,12 @@
 namespace XmobiTea.GN.Constant
 {
-	public enum GroupStatus
-	{
-		Member = 1,
-		WaitingAccept = 2,
-		SentRequestAndWaitingAccept = 3,
-		NotMember = 4,
+    public enum GroupStatus
+    {
+        Member = 1,
+        WaitingAccept = 2,
+        SentRequestAndWaitingAccept = 3,
+        NotMember = 4,
 
-	}
+    }
 
 }