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

package/Runtime/Constant/ReturnCode.cs

@@ -1,25 +1,73 @@
 namespace XmobiTea.GN.Constant
 {
+    /// <summary>
+    /// Defines constant return codes used to represent various operation outcomes.
+    /// </summary>
     public class ReturnCode
     {
+        /// <summary>
+        /// Indicates that the provided secret is invalid.
+        /// </summary>
         public const int SecretInvalid = -10;
+
+        /// <summary>
+        /// Indicates that the request was rejected due to exceeding the maximum allowed size.
+        /// </summary>
         public const int MaxSizeRequestReject = -9;
+
+        /// <summary>
+        /// Indicates that the request was rejected due to exceeding the maximum allowed request limit.
+        /// </summary>
         public const int MaxRequestReject = -8;
+
+        /// <summary>
+        /// Indicates that the request was rejected due to exceeding the maximum concurrent users limit.
+        /// </summary>
         public const int MaxCCUReject = -7;
 
+        /// <summary>
+        /// Indicates that the operation is not authorized.
+        /// </summary>
         public const int OperationNotAuthorized = -6;
+
+        /// <summary>
+        /// Indicates that the request contains invalid parameters.
+        /// </summary>
         public const int InvalidRequestParameters = -5;
+
+        /// <summary>
+        /// Indicates that the operation is invalid.
+        /// </summary>
         public const int OperationInvalid = -4;
+
+        /// <summary>
+        /// Indicates an internal server error.
+        /// </summary>
         public const int InternalServerError = -3;
+
+        /// <summary>
+        /// Indicates that the operation is not allowed.
+        /// </summary>
         public const int OperationNotAllow = -2;
+
+        /// <summary>
+        /// Indicates that the operation timed out.
+        /// </summary>
         public const int OperationTimeout = -1;
 
+        /// <summary>
+        /// Indicates an unknown error occurred.
+        /// </summary>
         public const int UnknownError = 0;
 
+        /// <summary>
+        /// Indicates that the operation completed successfully.
+        /// </summary>
         public const int Ok = 1;
 
+        /// <summary>
+        /// Private constructor to prevent instantiation of this utility class.
+        /// </summary>
         private ReturnCode() { }
-
     }
-
 }

package/Runtime/Entity/DataMember.cs

@@ -4,121 +4,339 @@ using XmobiTea.GN.Common;
 
 namespace XmobiTea.GN.Entity
 {
+    /// <summary>
+    /// Enhanced metadata for an object field in the GN system.
+    /// </summary>
     public interface IGNEnhancedObjectFieldMetadata : GNObjectFieldMetadata
     {
+        /// <summary>
+        /// Gets or sets the code associated with the field.
+        /// </summary>
         string code { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether the field is optional.
+        /// </summary>
         bool isOptional { get; set; }
+
+        /// <summary>
+        /// Gets or sets the data type of the field.
+        /// </summary>
         GNFieldDataType gnFieldType { get; set; }
+
+        /// <summary>
+        /// Gets or sets the default value of the field.
+        /// </summary>
         object defaultValue { get; set; }
 
+        /// <summary>
+        /// Gets or sets whether the active condition validation is valid.
+        /// </summary>
         bool activeConditionValid { get; set; }
 
+        /// <summary>
+        /// Gets or sets whether the field must be non-null.
+        /// </summary>
         bool? mustNonNull { get; set; }
+
+        /// <summary>
+        /// Gets or sets the minimum length for the field's value, if applicable.
+        /// </summary>
         int? minLength { get; set; }
+
+        /// <summary>
+        /// Gets or sets the maximum length for the field's value, if applicable.
+        /// </summary>
         int? maxLength { get; set; }
+
+        /// <summary>
+        /// Gets or sets the minimum value for the field, if applicable.
+        /// </summary>
         double? minValue { get; set; }
+
+        /// <summary>
+        /// Gets or sets the maximum value for the field, if applicable.
+        /// </summary>
         double? maxValue { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether the field's value must be an integer.
+        /// </summary>
         bool? mustInt { get; set; }
     }
 
+    /// <summary>
+    /// Implementation of the enhanced metadata for an object field in the GN system.
+    /// </summary>
     public class GNEnhancedObjectFieldMetadata : IGNEnhancedObjectFieldMetadata
     {
+        /// <inheritdoc/>
         public string code { get; set; }
+
+        /// <inheritdoc/>
         public bool isOptional { get; set; }
+
+        /// <inheritdoc/>
         public GNFieldDataType gnFieldType { get; set; }
+
+        /// <inheritdoc/>
         public object defaultValue { get; set; }
+
+        /// <inheritdoc/>
         public bool activeConditionValid { get; set; }
+
+        /// <inheritdoc/>
         public bool? mustNonNull { get; set; }
+
+        /// <inheritdoc/>
         public int? minLength { get; set; }
+
+        /// <inheritdoc/>
         public int? maxLength { get; set; }
+
+        /// <inheritdoc/>
         public double? minValue { get; set; }
+
+        /// <inheritdoc/>
         public double? maxValue { get; set; }
+
+        /// <inheritdoc/>
         public bool? mustInt { get; set; }
 
+        /// <inheritdoc/>
         public string name { get; }
+
+        /// <inheritdoc/>
         public FieldDataType fieldType { get; }
+
+        /// <inheritdoc/>
         public Type cls { get; }
 
+        /// <inheritdoc/>
         public FieldInfo fieldInfo { get; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GNEnhancedObjectFieldMetadata"/> class.
+        /// </summary>
+        /// <param name="name">The name of the field.</param>
+        /// <param name="fieldType">The type of data stored in the field.</param>
+        /// <param name="cls">The class type associated with the field.</param>
+        /// <param name="fieldInfo">The reflection field information for the field.</param>
         public GNEnhancedObjectFieldMetadata(string name, FieldDataType fieldType, Type cls, FieldInfo fieldInfo)
         {
             this.name = name;
             this.fieldType = fieldType;
             this.cls = cls;
-
             this.fieldInfo = fieldInfo;
         }
     }
 
+    /// <summary>
+    /// Enumeration of GN field data types.
+    /// </summary>
     public enum GNFieldDataType
     {
+        /// <summary>
+        /// Represents an undefined or other data type.
+        /// </summary>
         Other = 0,
+
+        /// <summary>
+        /// Represents numeric data types (e.g., int, float, double).
+        /// </summary>
         Number = 1,
+
+        /// <summary>
+        /// Represents string data types.
+        /// </summary>
         String = 2,
+
+        /// <summary>
+        /// Represents boolean data types.
+        /// </summary>
         Boolean = 3,
+
+        /// <summary>
+        /// Represents GNHashtable data types.
+        /// </summary>
         GNHashtable = 4,
-        GNArray = 5,
 
+        /// <summary>
+        /// Represents GNArray data types.
+        /// </summary>
+        GNArray = 5,
     }
 
+    /// <summary>
+    /// Base attribute for data member fields with optional metadata.
+    /// </summary>
     [AttributeUsage(AttributeTargets.Field, Inherited = true, AllowMultiple = false)]
     public class DataMemberAttribute : Attribute
     {
+        /// <summary>
+        /// Gets the field data type, defaults to Other.
+        /// </summary>
         public virtual GNFieldDataType gnFieldType => GNFieldDataType.Other;
 
+        /// <summary>
+        /// Gets or sets the code associated with the field.
+        /// </summary>
         public string code { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether the field is optional. Default is false.
+        /// </summary>
         public bool isOptional { get; set; } = false;
 
+        /// <summary>
+        /// Gets or sets the default value for the field.
+        /// </summary>
         public object defaultValue { get; set; } = null;
     }
 
+    /// <summary>
+    /// Attribute for string data member fields with additional constraints.
+    /// </summary>
     public class StringDataMemberAttribute : DataMemberAttribute
     {
+        /// <summary>
+        /// Overrides the field data type to String.
+        /// </summary>
         public override GNFieldDataType gnFieldType => GNFieldDataType.String;
 
+        /// <summary>
+        /// Gets or sets the default value for the string field.
+        /// </summary>
         public new string defaultValue { get; set; }
 
+        /// <summary>
+        /// Gets or sets whether the string must be non-null. Default is false.
+        /// </summary>
         public bool mustNonNull { get; set; } = false;
+
+        /// <summary>
+        /// Gets or sets the minimum length for the string. Default is -1 (no constraint).
+        /// </summary>
         public int minLength { get; set; } = -1;
+
+        /// <summary>
+        /// Gets or sets the maximum length for the string. Default is -1 (no constraint).
+        /// </summary>
         public int maxLength { get; set; } = -1;
     }
 
+    /// <summary>
+    /// Attribute for boolean data member fields with additional constraints.
+    /// </summary>
     public class BooleanDataMemberAttribute : DataMemberAttribute
     {
+        /// <summary>
+        /// Overrides the field data type to Boolean.
+        /// </summary>
         public override GNFieldDataType gnFieldType => GNFieldDataType.Boolean;
 
+        /// <summary>
+        /// Gets or sets the default value for the boolean field. Default is false.
+        /// </summary>
         public new bool defaultValue { get; set; } = false;
     }
 
+    /// <summary>
+    /// Attribute for GNHashtable data member fields with additional constraints.
+    /// </summary>
     public class GNHashtableDataMemberAttribute : DataMemberAttribute
     {
+        /// <summary>
+        /// Overrides the field data type to GNHashtable.
+        /// </summary>
         public override GNFieldDataType gnFieldType => GNFieldDataType.GNHashtable;
 
+        /// <summary>
+        /// Gets or sets the default value for the GNHashtable field.
+        /// </summary>
         public new GNHashtable defaultValue { get; set; } = null;
+
+        /// <summary>
+        /// Gets or sets whether the GNHashtable must be non-null. Default is false.
+        /// </summary>
         public bool mustNonNull { get; set; } = false;
+
+        /// <summary>
+        /// Gets or sets the minimum length for the GNHashtable. Default is -1 (no constraint).
+        /// </summary>
         public int minLength { get; set; } = -1;
+
+        /// <summary>
+        /// Gets or sets the maximum length for the GNHashtable. Default is -1 (no constraint).
+        /// </summary>
         public int maxLength { get; set; } = -1;
     }
 
+    /// <summary>
+    /// Attribute for GNArray data member fields with additional constraints.
+    /// </summary>
     public class GNArrayDataMemberAttribute : DataMemberAttribute
     {
+        /// <summary>
+        /// Overrides the field data type to GNArray.
+        /// </summary>
         public override GNFieldDataType gnFieldType => GNFieldDataType.GNArray;
 
+        /// <summary>
+        /// Gets or sets the default value for the GNArray field.
+        /// </summary>
         public new GNArray defaultValue { get; set; } = null;
+
+        /// <summary>
+        /// Gets or sets whether the GNArray must be non-null. Default is false.
+        /// </summary>
         public bool mustNonNull { get; set; } = false;
+
+        /// <summary>
+        /// Gets or sets the minimum length for the GNArray. Default is -1 (no constraint).
+        /// </summary>
         public int minLength { get; set; } = -1;
+
+        /// <summary>
+        /// Gets or sets the maximum length for the GNArray. Default is -1 (no constraint).
+        /// </summary>
         public int maxLength { get; set; } = -1;
+
+        /// <summary>
+        /// Gets or sets the type of elements in the GNArray.
+        /// </summary>
         public Type elementCls { get; set; } = null;
     }
 
+    /// <summary>
+    /// Attribute for numeric data member fields with additional constraints.
+    /// </summary>
     public class NumberDataMemberAttribute : DataMemberAttribute
     {
+        /// <summary>
+        /// Overrides the field data type to Number.
+        /// </summary>
         public override GNFieldDataType gnFieldType => GNFieldDataType.Number;
 
-        //public new double defaultValue { get; set; }
+        /// <summary>
+        /// Gets or sets the default value for the numeric field.
+        /// </summary>
+        public new double defaultValue { get; set; }
+
+        /// <summary>
+        /// Gets or sets the minimum value for the numeric field. Default is -1 (no constraint).
+        /// </summary>
         public double minValue { get; set; } = -1;
+
+        /// <summary>
+        /// Gets or sets the maximum value for the numeric field. Default is -1 (no constraint).
+        /// </summary>
         public double maxValue { get; set; } = -1;
+
+        /// <summary>
+        /// Gets or sets whether the numeric field must be an integer. Default is false.
+        /// </summary>
         public bool mustInt { get; set; } = false;
     }
+
 }

package/Runtime/Entity/GNMetadata.cs

@@ -2,26 +2,71 @@
 {
     using System;
 
+    /// <summary>
+    /// Enum representing the various data types for object fields.
+    /// </summary>
     public enum FieldDataType
     {
+        /// <summary>
+        /// Boolean data type.
+        /// </summary>
         Boolean = 0,
+
+        /// <summary>
+        /// Numeric data type.
+        /// </summary>
         Number = 1,
+
+        /// <summary>
+        /// String data type.
+        /// </summary>
         String = 2,
+
+        /// <summary>
+        /// Array data type.
+        /// </summary>
         Array = 3,
+
+        /// <summary>
+        /// Object data type.
+        /// </summary>
         Object = 4,
     }
 
+    /// <summary>
+    /// Metadata describing a field in a GN object.
+    /// </summary>
     public interface GNObjectFieldMetadata
     {
+        /// <summary>
+        /// Gets the name of the field.
+        /// </summary>
         string name { get; }
+
+        /// <summary>
+        /// Gets the type of the field.
+        /// </summary>
         FieldDataType fieldType { get; }
+
+        /// <summary>
+        /// Gets the class type of the field, if applicable.
+        /// </summary>
         Type cls { get; }
     }
 
+    /// <summary>
+    /// Metadata describing a GN object.
+    /// </summary>
     public interface GNObjectMetadata
     {
+        /// <summary>
+        /// Gets the unique identifier for the GN object.
+        /// </summary>
         string id { get; }
+
+        /// <summary>
+        /// Gets an array of field metadata for the GN object.
+        /// </summary>
         GNObjectFieldMetadata[] fields { get; }
     }
-
 }

package/Runtime/Entity/InvalidMember.cs

@@ -3,31 +3,50 @@
     using System.Text;
     using XmobiTea.GN.Constant;
 
+    /// <summary>
+    /// Represents an invalid member with its code and type of invalidation.
+    /// </summary>
     public struct InvalidMember
     {
+        /// <summary>
+        /// Gets the code identifying the invalid member.
+        /// </summary>
         public string code { get; private set; }
+
+        /// <summary>
+        /// Gets the type of invalidation for the member.
+        /// </summary>
         public InvalidMemberType invalidMemberType { get; private set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="InvalidMember"/> struct.
+        /// </summary>
+        /// <param name="code">The code identifying the invalid member.</param>
+        /// <param name="invalidMemberType">The type of invalidation.</param>
         public InvalidMember(string code, InvalidMemberType invalidMemberType)
         {
             this.code = code;
             this.invalidMemberType = invalidMemberType;
         }
 
+        /// <summary>
+        /// Converts the invalid member to a string representation.
+        /// </summary>
+        /// <returns>A string describing the invalid member.</returns>
         public string toString()
         {
             var stringBuilder = new StringBuilder();
-
-            stringBuilder.Append("Code: " + this.code + ", InvalidMemberType " + this.invalidMemberType);
-
+            stringBuilder.Append("Code: " + this.code + ", InvalidMemberType: " + this.invalidMemberType);
             return stringBuilder.ToString();
         }
 
+        /// <summary>
+        /// Overrides the default ToString method.
+        /// </summary>
+        /// <returns>A string describing the invalid member.</returns>
         public override string ToString()
         {
             return this.toString();
         }
-
     }
-
 }