com.xmobitea.changx.gn-unity 2.0.2 → 2.3.0

package/Runtime/Logger/GNDebug.cs

@@ -2,48 +2,91 @@ 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;
+        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/Networking/AuthenticateStatus.cs

@@ -1,35 +1,57 @@
 namespace XmobiTea.GN.Networking
 {
+    /// <summary>
+    /// Represents the authentication status of a user.
+    /// </summary>
     public class AuthenticateStatus
     {
-        private string authToken;
-        private string userId;
+        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;
         }
 
-        //public bool isLoginAndValid()
-        //{
-        //    return string.IsNullOrEmpty(this.authToken) && (authTokenTsExpire == -1 || GNNetwork.getServerTimestamp() < authTokenTsExpire);
-        //}
+        // 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/Handler/IServerEventHandler.cs

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

package/Runtime/Networking/Handler/OnCharacterPlayerFriendUpdateEventHandler.cs

@@ -7,26 +7,55 @@
     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/OnCharacterPlayerGroupUpdateEventHandler.cs

@@ -7,27 +7,48 @@
     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/OnGamePlayerFriendUpdateEventHandler.cs

@@ -7,26 +7,48 @@
     using XmobiTea.GN.Entity.Models;
     using XmobiTea.GN.Helper;
 
+    /// <summary>
+    /// Represents the data structure for updating a player's friend list in the game.
+    /// </summary>
     public class GamePlayerFriendUpdate
     {
+        /// <summary>
+        /// The character ID (optional).
+        /// </summary>
         [StringDataMember(code = GNParameterCode.CharacterId, isOptional = true)]
         public string? characterId;
 
+        /// <summary>
+        /// A list of player friends associated with the game player.
+        /// </summary>
         [GNArrayDataMember(code = GNParameterCode.PlayerFriends, elementCls = typeof(GenericModels.FriendItem))]
         public List<GenericModels.FriendItem> playerFriends;
     }
 
+    /// <summary>
+    /// Handles the "OnGamePlayerFriendUpdate" event.
+    /// </summary>
     public class OnGamePlayerFriendUpdateEventHandler : IServerEventHandler
     {
+        /// <summary>
+        /// Event triggered when a game player's friend list is updated.
+        /// </summary>
         public static Action<GamePlayerFriendUpdate> onUpdate;
 
+        /// <summary>
+        /// Gets the event code associated with this handler.
+        /// </summary>
+        /// <returns>The event code for "OnGamePlayerFriendUpdate".</returns>
         public int getEventCode() => EventCode.OnGamePlayerFriendUpdate;
 
+        /// <summary>
+        /// Handles the "OnGamePlayerFriendUpdate" operation event.
+        /// Deserializes the event parameters and invokes the update action.
+        /// </summary>
+        /// <param name="operationEvent">The operation event containing the parameters for the friend update.</param>
         public void handle(OperationEvent operationEvent)
         {
             OnGamePlayerFriendUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GamePlayerFriendUpdate>(operationEvent.getParameters()));
         }
-
     }
-
 }

package/Runtime/Networking/Handler/OnGamePlayerGroupUpdateEventHandler.cs

@@ -7,26 +7,48 @@
     using XmobiTea.GN.Entity.Models;
     using XmobiTea.GN.Helper;
 
+    /// <summary>
+    /// Represents the data structure for updating a player's group list in the game.
+    /// </summary>
     public class GamePlayerGroupUpdate
     {
+        /// <summary>
+        /// The character ID (optional).
+        /// </summary>
         [StringDataMember(code = GNParameterCode.CharacterId, isOptional = true)]
         public string? characterId;
 
+        /// <summary>
+        /// A list of player groups associated with the game player.
+        /// </summary>
         [GNArrayDataMember(code = GNParameterCode.PlayerGroups, elementCls = typeof(GenericModels.GroupItem))]
         public List<GenericModels.GroupItem> playerGroups;
     }
 
+    /// <summary>
+    /// Handles the "OnGamePlayerGroupUpdate" event.
+    /// </summary>
     public class OnGamePlayerGroupUpdateEventHandler : IServerEventHandler
     {
+        /// <summary>
+        /// Event triggered when a game player's group list is updated.
+        /// </summary>
         public static Action<GamePlayerGroupUpdate> onUpdate;
 
+        /// <summary>
+        /// Gets the event code associated with this handler.
+        /// </summary>
+        /// <returns>The event code for "OnGamePlayerGroupUpdate".</returns>
         public int getEventCode() => EventCode.OnGamePlayerGroupUpdate;
 
+        /// <summary>
+        /// Handles the "OnGamePlayerGroupUpdate" 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)
         {
             OnGamePlayerGroupUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GamePlayerGroupUpdate>(operationEvent.getParameters()));
         }
-
     }
-
 }

package/Runtime/Networking/Handler/OnGroupMemberUpdateEventHandler.cs

@@ -7,23 +7,42 @@
     using XmobiTea.GN.Entity.Models;
     using XmobiTea.GN.Helper;
 
+    /// <summary>
+    /// Represents the data structure for updating group members.
+    /// </summary>
     public class GroupMemberUpdate
     {
+        /// <summary>
+        /// A list of members associated with the group.
+        /// </summary>
         [GNArrayDataMember(code = GNParameterCode.Members, elementCls = typeof(GenericModels.FriendItem))]
         public List<GenericModels.MemberItem> members;
     }
 
+    /// <summary>
+    /// Handles the "OnGroupMemberUpdate" event.
+    /// </summary>
     public class OnGroupMemberUpdateEventHandler : IServerEventHandler
     {
+        /// <summary>
+        /// Event triggered when group members are updated.
+        /// </summary>
         public static Action<GroupMemberUpdate> onUpdate;
 
+        /// <summary>
+        /// Gets the event code associated with this handler.
+        /// </summary>
+        /// <returns>The event code for "OnGroupMemberUpdate".</returns>
         public int getEventCode() => EventCode.OnGroupMemberUpdate;
 
+        /// <summary>
+        /// Handles the "OnGroupMemberUpdate" operation event.
+        /// Deserializes the event parameters and invokes the update action.
+        /// </summary>
+        /// <param name="operationEvent">The operation event containing the parameters for the group member update.</param>
         public void handle(OperationEvent operationEvent)
         {
             OnGroupMemberUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GroupMemberUpdate>(operationEvent.getParameters()));
         }
-
     }
-
 }

package/Runtime/Networking/Handler/OnGroupMessageUpdateEventHandler.cs

@@ -7,23 +7,41 @@
     using XmobiTea.GN.Entity.Models;
     using XmobiTea.GN.Helper;
 
+    /// <summary>
+    /// Represents an update for group messages.
+    /// </summary>
     public class GroupMessageUpdate
     {
+        /// <summary>
+        /// A list of updated group messages.
+        /// </summary>
         [GNArrayDataMember(code = GNParameterCode.GroupMessages, elementCls = typeof(GroupModels.GroupMessageResponseData))]
         public List<GroupModels.GroupMessageResponseData> groupMessages;
     }
 
+    /// <summary>
+    /// Event handler for handling updates to group messages.
+    /// </summary>
     public class OnGroupMessageUpdateEventHandler : IServerEventHandler
     {
+        /// <summary>
+        /// An action to be invoked when a group message update occurs.
+        /// </summary>
         public static Action<GroupMessageUpdate> onUpdate;
 
+        /// <summary>
+        /// Gets the event code associated with the group message update.
+        /// </summary>
+        /// <returns>The event code for group message updates.</returns>
         public int getEventCode() => EventCode.OnGroupMessageUpdate;
 
+        /// <summary>
+        /// Handles the group message update event.
+        /// </summary>
+        /// <param name="operationEvent">The operation event containing the update data.</param>
         public void handle(OperationEvent operationEvent)
         {
             OnGroupMessageUpdateEventHandler.onUpdate?.Invoke(ConverterService.deserializeObject<GroupMessageUpdate>(operationEvent.getParameters()));
         }
-
     }
-
 }