Implement UpdateFieldType.Enum with ItemFieldFlags as first example

Author: killerwife

WowPacketParser/Enums/ItemFieldFlags.cs

@@ -2,12 +2,11 @@
 
 namespace WowPacketParser.Enums
 {
-    // TODO: use when reading ITEM_FIELD_FLAGS
     [Flags]
     public enum ItemFieldFlags : uint
     {
-        Souldbound   = 0x00000001, // Item is soulbound and cannot be traded
-        Unk1         = 0x00000002, // ?
+        Soulbound    = 0x00000001, // Item is soulbound and cannot be traded
+        Translated   = 0x00000002, // Translates pagetext to lang id in query
         Unlocked     = 0x00000004, // Item had lock but can be opened now
         Wrapped      = 0x00000008, // Item is wrapped and contains another item
         Unk2         = 0x00000010, // ?

WowPacketParser/Enums/UpdateFields.cs

@@ -67,6 +67,7 @@ public enum ItemField
         ITEM_FIELD_ENCHANTMENT_8_3,
         ITEM_FIELD_ENCHANTMENT_9_1,
         ITEM_FIELD_ENCHANTMENT_9_3,
+        [UpdateField(UpdateFieldType.Enum, typeof(ItemFieldFlags))]
         ITEM_FIELD_FLAGS,
         [UpdateField(UpdateFieldType.Guid)]
         ITEM_FIELD_GIFTCREATOR,

WowPacketParser/Enums/Version/UpdateFields.cs

@@ -16,6 +16,7 @@ public class UpdateFieldInfo
         public string Name;
         public int Size;
         public UpdateFieldType Format;
+        public Type? EnumType;
     }
 
     public static class UpdateFields
@@ -64,15 +65,15 @@ private static bool LoadUFDictionariesInto(Dictionary<Type, SortedList<int, Upda
             };
 
             bool loaded = false;
-            foreach (Type enumType in enumTypes)
+            foreach (Type ufEnumType in enumTypes)
             {
                 string vTypeString =
-                    $"WowPacketParserModule.{GetUpdateFieldDictionaryBuildName(build)}.Enums.{enumType.Name}";
+                    $"WowPacketParserModule.{GetUpdateFieldDictionaryBuildName(build)}.Enums.{ufEnumType.Name}";
                 Type vEnumType = asm.GetType(vTypeString);
                 if (vEnumType == null)
                 {
                     vTypeString =
-                        $"WowPacketParser.Enums.Version.{GetUpdateFieldDictionaryBuildName(build)}.{enumType.Name}";
+                        $"WowPacketParser.Enums.Version.{GetUpdateFieldDictionaryBuildName(build)}.{ufEnumType.Name}";
                     vEnumType = Assembly.GetExecutingAssembly().GetType(vTypeString);
                     if (vEnumType == null)
                         continue;   // versions prior to 4.3.0 do not have AreaTriggerField
@@ -86,22 +87,22 @@ private static bool LoadUFDictionariesInto(Dictionary<Type, SortedList<int, Upda
 
                 for (int i = 0; i < vValues.Length; ++i)
                 {
-                    var format = enumType.GetMember(vNames[i])
+                    UpdateFieldAttribute? attribute = (UpdateFieldAttribute)ufEnumType.GetMember(vNames[i])
                         .SelectMany(member => member.GetCustomAttributes(typeof(UpdateFieldAttribute), false))
                         .Where(attribute => ((UpdateFieldAttribute)attribute).Version <= ClientVersion.VersionDefiningBuild)
-                        .OrderByDescending(attribute => ((UpdateFieldAttribute)attribute).Version)
-                        .Select(attribute => ((UpdateFieldAttribute)attribute).UFAttribute)
-                        .DefaultIfEmpty(UpdateFieldType.Default).First();
+                        .OrderByDescending(attribute => ((UpdateFieldAttribute)attribute).Version).FirstOrDefault();;
+                    UpdateFieldType format = attribute?.UFAttribute ?? UpdateFieldType.Default;
+                    Type? enumType = attribute?.EnumType ?? null;
 
-                    result.Add((int)vValues.GetValue(i), new UpdateFieldInfo() { Value = (int)vValues.GetValue(i), Name = vNames[i], Size = 0, Format = format });
+                    result.Add((int)vValues.GetValue(i), new UpdateFieldInfo() { Value = (int)vValues.GetValue(i), Name = vNames[i], Size = 0, Format = format, EnumType = enumType });
                     namesResult.Add(vNames[i], (int)vValues.GetValue(i));
                 }
 
                 for (var i = 0; i < result.Count - 1; ++i)
                     result.Values[i].Size = result.Keys[i + 1] - result.Keys[i];
 
-                dicts.Add(enumType, result);
-                nameToValueDict.Add(enumType, namesResult);
+                dicts.Add(ufEnumType, result);
+                nameToValueDict.Add(ufEnumType, namesResult);
                 loaded = true;
             }
 

WowPacketParser/Parsing/Parsers/UpdateHandler.cs

@@ -1,6 +1,9 @@
+using Google.Protobuf.WellKnownTypes;
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Globalization;
+using System.Xml.Linq;
 using WowPacketParser.Enums;
 using WowPacketParser.Enums.Version;
 using WowPacketParser.Misc;
@@ -349,12 +352,14 @@ private static Dictionary<int, UpdateField> ReadValuesUpdateBlock(Packet packet,
                 int start = i;
                 int size = 1;
                 UpdateFieldType updateFieldType = UpdateFieldType.Default;
+                System.Type? enumType = null;
                 if (fieldInfo != null)
                 {
                     key = fieldInfo.Name;
                     size = fieldInfo.Size;
                     start = fieldInfo.Value;
                     updateFieldType = fieldInfo.Format;
+                    enumType = fieldInfo.EnumType;
                 }
 
                 List<UpdateField> fieldData = new List<UpdateField>();
@@ -529,6 +534,13 @@ private static Dictionary<int, UpdateField> ReadValuesUpdateBlock(Packet packet,
                         }
                         break;
                     }
+                    case UpdateFieldType.Enum:
+                    {
+                        IConvertible enumValue = (IConvertible)System.Enum.ToObject(enumType, fieldData[0].Int32Value);
+                        packet.AddValue(key, Convert.ToInt64(enumValue) + " (" + enumValue.ToString(CultureInfo.InvariantCulture) + ")", index);
+                        updateValues.Ints[key] = fieldData[0].Int32Value;
+                        break;
+                    }
                     default:
                         for (int k = 0; k < fieldData.Count; ++k)
                             if (mask[start + k] && (!isCreating || fieldData[k].UInt32Value != 0))

WowPacketParser/Parsing/UpdateFieldAttributes.cs

@@ -14,6 +14,7 @@ public enum UpdateFieldType
         Float, // Supports variable length
         Bytes,  // Supports variable length
         Short,
+        Enum,
         Custom
     }
 
@@ -32,7 +33,22 @@ public UpdateFieldAttribute(UpdateFieldType attrib, ClientVersionBuild fromVersi
             Version = fromVersion;
         }
 
+        public UpdateFieldAttribute(UpdateFieldType attrib, Type enumType)
+        {
+            UFAttribute = attrib;
+            Version = ClientVersionBuild.Zero;
+            EnumType = enumType;
+        }
+
+        public UpdateFieldAttribute(UpdateFieldType attrib, ClientVersionBuild fromVersion, Type? enumType)
+        {
+            UFAttribute = attrib;
+            Version = fromVersion;
+            EnumType = enumType;
+        }
+
         public UpdateFieldType UFAttribute { get; private set; }
         public ClientVersionBuild Version { get; private set; }
+        public Type? EnumType { get; private set; }
     }
 }