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

package/Runtime/Helper/ParseGNHelper.cs.meta

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

package/Runtime/Helper.meta

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

package/Runtime/Logger/GNDebug.cs

@@ -1,49 +1,92 @@
-namespace XmobiTea.GN.Logger
-{
-    using System;
-
-    public enum LogType
-    {
-        Off,
-        Exception,
-        Error,
-        Warning,
-        All,
-    }
-
-    internal class GNDebug
-    {
-        private static LogType _logType;
-        public static LogType logType
-        {
-            get => _logType;
-            set => _logType = value;
-        }
-
-        public static void log(object message)
-        {
-            if (_logType >= LogType.All)
-                UnityEngine.Debug.Log(message);
-        }
-
-        public static void logException(Exception exception)
-        {
-            if (_logType >= LogType.Exception)
-                UnityEngine.Debug.LogException(exception);
-        }
-
-        public static void logWarning(object message)
-        {
-            if (_logType >= LogType.Warning)
-                UnityEngine.Debug.LogWarning(message);
-        }
-
-        public static void logError(object message)
-        {
-            if (_logType >= LogType.Error)
-                UnityEngine.Debug.LogError(message);
-        }
-
-    }
-
-}
+namespace XmobiTea.GN.Logger
+{
+    using System;
+
+    /// <summary>
+    /// Enum defining different log levels for GNDebug.
+    /// </summary>
+    public enum LogType
+    {
+        /// <summary>
+        /// No logging.
+        /// </summary>
+        Off,
+
+        /// <summary>
+        /// Logs exceptions only.
+        /// </summary>
+        Exception,
+
+        /// <summary>
+        /// Logs errors and exceptions.
+        /// </summary>
+        Error,
+
+        /// <summary>
+        /// Logs warnings, errors, and exceptions.
+        /// </summary>
+        Warning,
+
+        /// <summary>
+        /// Logs all messages, including general logs, warnings, errors, and exceptions.
+        /// </summary>
+        All,
+    }
+
+    /// <summary>
+    /// Utility class for handling logging in the GN framework.
+    /// </summary>
+    internal class GNDebug
+    {
+        private static LogType _logType; // Current log level.
+
+        /// <summary>
+        /// Gets or sets the current log level for GNDebug.
+        /// </summary>
+        public static LogType logType
+        {
+            get => _logType;
+            set => _logType = value;
+        }
+
+        /// <summary>
+        /// Logs a general message if the log level includes general logs.
+        /// </summary>
+        /// <param name="message">The message to log.</param>
+        public static void log(object message)
+        {
+            if (_logType >= LogType.All)
+                UnityEngine.Debug.Log(message);
+        }
+
+        /// <summary>
+        /// Logs an exception if the log level includes exceptions.
+        /// </summary>
+        /// <param name="exception">The exception to log.</param>
+        public static void logException(Exception exception)
+        {
+            if (_logType >= LogType.Exception)
+                UnityEngine.Debug.LogException(exception);
+        }
+
+        /// <summary>
+        /// Logs a warning message if the log level includes warnings.
+        /// </summary>
+        /// <param name="message">The warning message to log.</param>
+        public static void logWarning(object message)
+        {
+            if (_logType >= LogType.Warning)
+                UnityEngine.Debug.LogWarning(message);
+        }
+
+        /// <summary>
+        /// Logs an error message if the log level includes errors.
+        /// </summary>
+        /// <param name="message">The error message to log.</param>
+        public static void logError(object message)
+        {
+            if (_logType >= LogType.Error)
+                UnityEngine.Debug.LogError(message);
+        }
+    }
+}

package/Runtime/Logger/GNDebug.cs.meta

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

package/Runtime/Logger.meta

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

package/Runtime/Networking/AuthenticateStatus.cs

@@ -1,35 +1,57 @@
-namespace XmobiTea.GN.Networking
-{
-    public class AuthenticateStatus
-    {
-        private string authToken;
-        private string userId;
-
-        public string getAuthToken()
-        {
-            return this.authToken;
-        }
-
-        internal void setAuthToken(string authToken)
-        {
-            this.authToken = authToken;
-        }
-
-        //public bool isLoginAndValid()
-        //{
-        //    return string.IsNullOrEmpty(this.authToken) && (authTokenTsExpire == -1 || GNNetwork.getServerTimestamp() < authTokenTsExpire);
-        //}
-
-        public string getUserId()
-        {
-            return this.userId;
-        }
-
-        internal void setUserId(string userId)
-        {
-            this.userId = userId;
-        }
-
-    }
-
-}
+namespace XmobiTea.GN.Networking
+{
+    /// <summary>
+    /// Represents the authentication status of a user.
+    /// </summary>
+    public class AuthenticateStatus
+    {
+        private string authToken; // Stores the authentication token.
+        private string userId;    // Stores the user ID.
+
+        /// <summary>
+        /// Gets the authentication token.
+        /// </summary>
+        /// <returns>The current authentication token.</returns>
+        public string getAuthToken()
+        {
+            return this.authToken;
+        }
+
+        /// <summary>
+        /// Sets the authentication token.
+        /// </summary>
+        /// <param name="authToken">The authentication token to set.</param>
+        internal void setAuthToken(string authToken)
+        {
+            this.authToken = authToken;
+        }
+
+        // Uncomment this method if needed in the future to validate login and token expiry.
+        // /// <summary>
+        // /// Checks if the user is logged in and the authentication token is valid.
+        // /// </summary>
+        // /// <returns>True if logged in and valid, otherwise false.</returns>
+        // public bool isLoginAndValid()
+        // {
+        //     return string.IsNullOrEmpty(this.authToken) && (authTokenTsExpire == -1 || GNNetwork.getServerTimestamp() < authTokenTsExpire);
+        // }
+
+        /// <summary>
+        /// Gets the user ID.
+        /// </summary>
+        /// <returns>The current user ID.</returns>
+        public string getUserId()
+        {
+            return this.userId;
+        }
+
+        /// <summary>
+        /// Sets the user ID.
+        /// </summary>
+        /// <param name="userId">The user ID to set.</param>
+        internal void setUserId(string userId)
+        {
+            this.userId = userId;
+        }
+    }
+}

package/Runtime/Networking/AuthenticateStatus.cs.meta

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

package/Runtime/Networking/Handler/IServerEventHandler.cs

@@ -1,25 +1,25 @@
-namespace XmobiTea.GN.Networking
-{
-    using XmobiTea.GN.Entity;
-
-    /// <summary>
-    /// The interface, some class want handler event need implement IServerEventHandler
-    /// </summary>
-    public interface IServerEventHandler
-    {
-        /// <summary>
-        /// Get the event code, the event code should be store in EventCode file
-        /// </summary>
-        /// <returns></returns>
-        int getEventCode();
-
-        /// <summary>
-        /// handle function
-        /// How to handle this operation
-        /// </summary>
-        /// <param name="operationEvent">the operation event need handle</param>
-        void handle(OperationEvent operationEvent);
-
-    }
-
-}
+namespace XmobiTea.GN.Networking
+{
+    using XmobiTea.GN.Entity;
+
+    /// <summary>
+    /// Defines an interface for handling server events. 
+    /// Classes that implement this interface must define how to handle specific events.
+    /// </summary>
+    public interface IServerEventHandler
+    {
+        /// <summary>
+        /// Gets the event code associated with the handler. 
+        /// The event codes should be defined in the EventCode file.
+        /// </summary>
+        /// <returns>An integer representing the event code.</returns>
+        int getEventCode();
+
+        /// <summary>
+        /// Handles the specified operation event.
+        /// This method defines how to process the provided event.
+        /// </summary>
+        /// <param name="operationEvent">The operation event that needs to be handled.</param>
+        void handle(OperationEvent operationEvent);
+    }
+}

package/Runtime/Networking/Handler/IServerEventHandler.cs.meta

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

package/Runtime/Networking/Handler/OnCharacterPlayerFriendUpdateEventHandler.cs

@@ -1,32 +1,61 @@
-namespace XmobiTea.GN.Networking
-{
-    using System;
-    using System.Collections.Generic;
-    using XmobiTea.GN.Constant;
-    using XmobiTea.GN.Entity;
-    using XmobiTea.GN.Entity.Models;
-    using XmobiTea.GN.Helper;
-
-    public class CharacterPlayerFriendUpdate
-    {
-        [StringDataMember(code = GNParameterCode.CharacterId)]
-        public string characterId;
-
-        [GNArrayDataMember(code = GNParameterCode.PlayerFriends, elementCls = typeof(GenericModels.FriendItem))]
-        public List<GenericModels.FriendItem> playerFriends;
-    }
-
-    public class OnCharacterPlayerFriendUpdateEventHandler : IServerEventHandler
-    {
-        public static Action<CharacterPlayerFriendUpdate> onUpdate;
-
-        public int getEventCode() => EventCode.OnCharacterPlayerFriendUpdate;
-
-        public void handle(OperationEvent operationEvent)
-        {
-            OnCharacterPlayerFriendUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<CharacterPlayerFriendUpdate>(operationEvent.getParameters()));
-        }
-
-    }
-
-}
+namespace XmobiTea.GN.Networking
+{
+    using System;
+    using System.Collections.Generic;
+    using XmobiTea.GN.Constant;
+    using XmobiTea.GN.Entity;
+    using XmobiTea.GN.Entity.Models;
+    using XmobiTea.GN.Helper;
+
+    /// <summary>
+    /// Represents the data structure for updating a character's player friend list.
+    /// </summary>
+    public class CharacterPlayerFriendUpdate
+    {
+        /// <summary>
+        /// The character ID.
+        /// </summary>
+        [StringDataMember(code = GNParameterCode.CharacterId)]
+        public string characterId;
+
+        /// <summary>
+        /// A list of player friends associated with the character.
+        /// </summary>
+        [GNArrayDataMember(code = GNParameterCode.PlayerFriends, elementCls = typeof(GenericModels.FriendItem))]
+        public List<GenericModels.FriendItem> playerFriends;
+    }
+
+    /// <summary>
+    /// Handles the "OnCharacterPlayerFriendUpdate" event.
+    /// This handler processes the event and triggers the corresponding update logic.
+    /// </summary>
+    public class OnCharacterPlayerFriendUpdateEventHandler : IServerEventHandler
+    {
+        /// <summary>
+        /// Event triggered when a character's player friend list is updated.
+        /// Subscribing to this action allows handling the update logic.
+        /// </summary>
+        public static Action<CharacterPlayerFriendUpdate> onUpdate;
+
+        /// <summary>
+        /// Gets the event code associated with this handler.
+        /// </summary>
+        /// <returns>
+        /// The event code for "OnCharacterPlayerFriendUpdate".
+        /// </returns>
+        public int getEventCode() => EventCode.OnCharacterPlayerFriendUpdate;
+
+        /// <summary>
+        /// Handles the "OnCharacterPlayerFriendUpdate" operation event.
+        /// This method deserializes the event parameters and invokes the update action.
+        /// </summary>
+        /// <param name="operationEvent">
+        /// The operation event containing the parameters for the character player friend update.
+        /// </param>
+        public void handle(OperationEvent operationEvent)
+        {
+            // Deserialize the event parameters and invoke the onUpdate action.
+            OnCharacterPlayerFriendUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<CharacterPlayerFriendUpdate>(operationEvent.getParameters()));
+        }
+    }
+}

package/Runtime/Networking/Handler/OnCharacterPlayerFriendUpdateEventHandler.cs.meta

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

package/Runtime/Networking/Handler/OnCharacterPlayerGroupUpdateEventHandler.cs

@@ -1,33 +1,54 @@
-namespace XmobiTea.GN.Networking
-{
-    using System;
-    using System.Collections.Generic;
-    using XmobiTea.GN.Constant;
-    using XmobiTea.GN.Entity;
-    using XmobiTea.GN.Entity.Models;
-    using XmobiTea.GN.Helper;
-
-    public class CharacterPlayerGroupUpdate
-    {
-        [StringDataMember(code = GNParameterCode.CharacterId)]
-        public string characterId;
-
-        [GNArrayDataMember(code = GNParameterCode.PlayerGroups, elementCls = typeof(GenericModels.GroupItem))]
-        public List<GenericModels.GroupItem> playerGroups;
-
-    }
-
-    public class OnCharacterPlayerGroupUpdateEventHandler : IServerEventHandler
-    {
-        public static Action<CharacterPlayerGroupUpdate> onUpdate;
-
-        public int getEventCode() => EventCode.OnCharacterPlayerGroupUpdate;
-
-        public void handle(OperationEvent operationEvent)
-        {
-            OnCharacterPlayerGroupUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<CharacterPlayerGroupUpdate>(operationEvent.getParameters()));
-        }
-
-    }
-
-}
+namespace XmobiTea.GN.Networking
+{
+    using System;
+    using System.Collections.Generic;
+    using XmobiTea.GN.Constant;
+    using XmobiTea.GN.Entity;
+    using XmobiTea.GN.Entity.Models;
+    using XmobiTea.GN.Helper;
+
+    /// <summary>
+    /// Represents the data structure for updating a character's player group list.
+    /// </summary>
+    public class CharacterPlayerGroupUpdate
+    {
+        /// <summary>
+        /// The character ID.
+        /// </summary>
+        [StringDataMember(code = GNParameterCode.CharacterId)]
+        public string characterId;
+
+        /// <summary>
+        /// A list of player groups associated with the character.
+        /// </summary>
+        [GNArrayDataMember(code = GNParameterCode.PlayerGroups, elementCls = typeof(GenericModels.GroupItem))]
+        public List<GenericModels.GroupItem> playerGroups;
+    }
+
+    /// <summary>
+    /// Handles the "OnCharacterPlayerGroupUpdate" event.
+    /// </summary>
+    public class OnCharacterPlayerGroupUpdateEventHandler : IServerEventHandler
+    {
+        /// <summary>
+        /// Event triggered when a character's player group list is updated.
+        /// </summary>
+        public static Action<CharacterPlayerGroupUpdate> onUpdate;
+
+        /// <summary>
+        /// Gets the event code associated with this handler.
+        /// </summary>
+        /// <returns>The event code for "OnCharacterPlayerGroupUpdate".</returns>
+        public int getEventCode() => EventCode.OnCharacterPlayerGroupUpdate;
+
+        /// <summary>
+        /// Handles the "OnCharacterPlayerGroupUpdate" operation event.
+        /// Deserializes the event parameters and invokes the update action.
+        /// </summary>
+        /// <param name="operationEvent">The operation event containing the parameters for the group update.</param>
+        public void handle(OperationEvent operationEvent)
+        {
+            OnCharacterPlayerGroupUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<CharacterPlayerGroupUpdate>(operationEvent.getParameters()));
+        }
+    }
+}

package/Runtime/Networking/Handler/OnCharacterPlayerGroupUpdateEventHandler.cs.meta

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