Merge branch 'main' into cn

Author: Loskh

CExporter/Exporter.cs

@@ -48,6 +48,13 @@ public static Type[] GetHavokTypes() {
 
         return definedTypes.Where(t => t.FullName!.StartsWith(HavokNamespacePrefix) && !t.FullName.EndsWith("VirtualTable") && t.GetCustomAttribute<CExporterIgnoreAttribute>() == null).ToArray();
     }
+
+    public static Type GetBestMatchFromSize(int size) => size switch {
+        < 9 => typeof(byte),
+        < 17 => typeof(ushort),
+        < 33 => typeof(uint),
+        _ => typeof(ulong)
+    };
 }
 
 internal class CExporterUnionCompare : IEqualityComparer<CExporterUnionAttribute> {

CExporter/ExporterStatics.cs

@@ -73,11 +73,6 @@ public static bool IsFieldInType(this Type type, FieldInfo field) {
         return type.GetFields(ExporterStatics.BindingFlags).Any(f => f.Name == name && f.FieldType == field.FieldType) || type.GetFields(ExporterStatics.BindingFlags).Any(f => f.Name == field.Name && f.FieldType == field.FieldType);
     }
 
-    public static bool IsDirectBase(this FieldInfo field) {
-        var bases = field.DeclaringType?.GetInheritsTypes() ?? [];
-        return bases.Any(b => field.FieldType == b && field.Name == (b.Name == field.DeclaringType?.Name ? b.Name + "Base" : b.Name)) || field.GetCustomAttribute<CExporterBaseTypeAttribute>() != null;
-    }
-
     public static string FixTypeName(this Type type, bool shouldLower = true) {
         using var builderPooled = StringBuilderPool.Get(500);
         var builder = builderPooled.Builder;
@@ -211,8 +206,6 @@ public static string SanitizeName(this Type type) {
         return builder.ToString();
     }
 
-    public static string FullSanitizeName(this Type type) => type.FixTypeName();
-
     public static int PackSize(this Type type) {
         if (type.GetCustomAttribute<FixedSizeArrayAttribute>() != null) return 1; // FixedSizeArrayAttribute is always packed to 1 as the generated struct gets generated with Pack = 1
         if (!type.IsStruct()) return type.SizeOf();
@@ -223,7 +216,7 @@ public static int PackSize(this Type type) {
     }
 
     public static bool IsInStructList(this Type type, List<ProcessedStruct> structs) {
-        var name = type.FullSanitizeName();
+        var name = type.FixTypeName();
         foreach (var str in structs) {
             if (str.StructTypeName == name) return true;
         }
@@ -256,6 +249,15 @@ public static int GetFieldOffsetSequential(this FieldInfo info) {
         }
         throw new Exception("Field not found");
     }
+
+    public static bool IsDirectBase(this FieldInfo field) {
+        var bases = field.DeclaringType?.GetInheritsTypes() ?? [];
+        return bases.Any(b => field.FieldType == b && field.Name == (b.Name == field.DeclaringType?.Name ? b.Name + "Base" : b.Name)) || field.GetCustomAttribute<CExporterBaseTypeAttribute>() != null;
+    }
+
+    public static bool IsBitArray(this FieldInfo type) {
+        return type.GetCustomAttributes().Any(t => t.GetType().Name.Contains("BitFieldAttribute`1"));
+    }
 }
 public static class Extensions {
     public static void WriteFile(this FileInfo file, string content) {

CExporter/Extensions.cs

@@ -44,12 +44,12 @@ public partial struct ClientSelectData {
 [Flags]
 public enum ClientSelectDataConfigFlags : ushort {
     None = 0,
-    HideHead = 0x01,
-    HideWeapon = 0x02,
-    HideLegacyMark = 0x04,
-    // ? = 0x08,
-    StoreNewItemsInArmouryChest = 0x10,
-    StoreCraftedItemsInInventory = 0x20,
-    CloseVisor = 0x40,
-    HideVieraEars = 0x80
+    HideHead = 1 << 0,
+    HideWeapon = 1 << 1,
+    HideLegacyMark = 1 << 2,
+    // ? = 1 << 3,
+    StoreNewItemsInArmouryChest = 1 << 4,
+    StoreCraftedItemsInInventory = 1 << 5,
+    CloseVisor = 1 << 6,
+    HideVieraEars = 1 << 7,
 }

FFXIVClientStructs/FFXIV/Application/Network/WorkDefinitions/ClientSelectData.cs

@@ -7,7 +7,6 @@ namespace FFXIVClientStructs.FFXIV.Application.Network.WorkDefinitions;
 [StructLayout(LayoutKind.Explicit, Size = 0x10)]
 public partial struct DailyQuestWork {
     [FieldOffset(0x08)] public ushort QuestId;
+    [BitField<bool>(nameof(IsCompleted), 0)]
     [FieldOffset(0x0A)] public byte Flags;
-
-    public bool IsCompleted => (Flags & 1) != 0;
 }

FFXIVClientStructs/FFXIV/Application/Network/WorkDefinitions/DailyQuestWork.cs

@@ -8,10 +8,9 @@ namespace FFXIVClientStructs.FFXIV.Application.Network.WorkDefinitions;
 public partial struct LeveWork {
     [FieldOffset(0x08)] public ushort LeveId;
     [FieldOffset(0x0A)] public byte Sequence;
+    [BitField<bool>(nameof(IsHidden), 14)]
+    [BitField<bool>(nameof(IsPriority), 15)]
     [FieldOffset(0x0C)] public ushort Flags;
     [FieldOffset(0x0E)] public ushort LeveSeed;
     [FieldOffset(0x10)] public byte ClearClass;
-
-    public bool IsHidden => (Flags & 0x4000) != 0;
-    public bool IsPriority => (Flags & 0x8000) != 0;
 }

FFXIVClientStructs/FFXIV/Application/Network/WorkDefinitions/LeveWork.cs

@@ -8,11 +8,10 @@ namespace FFXIVClientStructs.FFXIV.Application.Network.WorkDefinitions;
 public unsafe partial struct QuestWork {
     [FieldOffset(0x08)] public ushort QuestId;
     [FieldOffset(0x0A)] public byte Sequence;
+    [BitField<bool>(nameof(IsPriority), 0)]
+    [BitField<int>(nameof(RewardItemArrayIndex), 1, 2)]
+    [BitField<bool>(nameof(IsHidden), 3)]
     [FieldOffset(0x0B)] public byte Flags;
     [FieldOffset(0x0C), FixedSizeArray] internal FixedSizeArray6<byte> _variables;
     [FieldOffset(0x12)] public byte AcceptClassJob;
-
-    public int RewardItemArrayIndex => Flags >> 1 & 3;
-    public bool IsHidden => (Flags & 8) != 0;
-    public bool IsPriority => (Flags & 1) != 0;
 }

FFXIVClientStructs/FFXIV/Application/Network/WorkDefinitions/QuestWork.cs

@@ -49,8 +49,9 @@ public partial struct TargetEffects {
     /// <summary>
     /// Global result of a single action. Used in combination with target data: a list of GameObjectId's and sets of Effect's.
     /// </summary>
+    [GenerateInterop]
     [StructLayout(LayoutKind.Explicit, Size = 0x28)]
-    public struct Header {
+    public partial struct Header {
         [FieldOffset(0x00)] public GameObjectId AnimationTargetId; // 'primary' target of the action; animation is played on this object
         [FieldOffset(0x08)] public uint ActionId;
         [FieldOffset(0x0C)] public uint GlobalSequence; // unique id of the action, monotonously increasing as the server is running
@@ -61,11 +62,16 @@ public struct Header {
         [FieldOffset(0x1C)] public ushort SpellId;
         [FieldOffset(0x1E)] public byte AnimationVariation;
         [FieldOffset(0x1F)] public byte ActionType;
+        [BitField<bool>(nameof(ShowInLog), 0)]
+        [BitField<bool>(nameof(ForceAnimationLock), 1)]
         [FieldOffset(0x20)] public byte Flags;
         [FieldOffset(0x21)] public byte NumTargets;
 
-        public bool ShowInLog => (Flags & 1) != 0; // if this flag is set, the message will be printed to the action log when processing the action
-        public bool ForceAnimationLock => (Flags & 2) != 0; // if this flag is set, the animation lock is applied to caster even though SourceSequence == 0
+        /// <remarks> If this flag is set, the message will be printed to the action log when processing the action. </remarks>
+        public partial bool ShowInLog { get; set; }
+
+        /// <remarks> If this flag is set, the animation lock is applied to caster even though <c>SourceSequence == 0</c>. </remarks>
+        public partial bool ForceAnimationLock { get; set; }
     }
 
     /// <summary>

FFXIVClientStructs/FFXIV/Client/Game/Character/ActionEffectHandler.cs

@@ -12,11 +12,7 @@ namespace FFXIVClientStructs.FFXIV.Client.Game.Character;
 [VirtualTable("48 8D 05 ?? ?? ?? ?? 48 89 07 48 8D 8F ?? ?? ?? ?? 48 8D 05 ?? ?? ?? ?? 48 89 87 ?? ?? ?? ?? E8 ?? ?? ?? ?? 48 8D 8F ?? ?? ?? ?? 33 ED 48 8D 05 ?? ?? ?? ??", 3)]
 public unsafe partial struct Character {
     [FieldOffset(0x600)] public MovementStateOptions MovementState;
-    /// <summary>
-    /// <code>
-    /// 0b0010_0000 [0x20] = <see cref="IsSwimming"/>
-    /// </code>
-    /// </summary>
+    [BitField<bool>(nameof(IsSwimming), 5)] // found in Client::Game::Event::EventSceneModuleUsualImpl.IsSwimming
     [FieldOffset(0x628)] public byte Flags628;
 
     [FieldOffset(0x630)] public EmoteController EmoteController;
@@ -28,7 +24,7 @@ public unsafe partial struct Character {
     [FieldOffset(0xA30)] public TimelineContainer Timeline;
     [FieldOffset(0xD80)] public LookAtContainer LookAt;
 
-    // 0x01 = OffhandDrawn
+    [BitField<bool>(nameof(IsOffhandDrawn), 0)]
     [FieldOffset(0x1980)] public byte WeaponFlags;
     [FieldOffset(0x1988)] public VfxContainer Vfx;
 
@@ -38,15 +34,16 @@ public unsafe partial struct Character {
     // 0x1AA8: start of some substructure
     [FieldOffset(0x1B28)] public ModelContainer ModelContainer;
 
-    // 0x01 = PartyMember
-    // 0x02 = AllianceMember
-    // 0x04 = Friend
+    [BitField<bool>(nameof(IsPartyMember), 0)]
+    [BitField<bool>(nameof(IsAllianceMember), 1)]
+    [BitField<bool>(nameof(IsFriend), 2)]
     [FieldOffset(0x1CE2)] public byte RelationFlags;
 
     // 0x40 = All attacks will be cancelled, character is doing the the 'winded' emote, used in e.g. 'Strange Bedfellows' and 'Combat Evolved' when quest expects an item to be used on the character
     [FieldOffset(0x1CE8)] public byte ActorControlFlags;
 
     [FieldOffset(0x21E0)] public Balloon Balloon;
+    [FieldOffset(0x2260)] public NpcYellBalloon YellBalloon;
 
     [FieldOffset(0x22E8)] public float Alpha;
 
@@ -85,15 +82,13 @@ public unsafe partial struct Character {
     [FieldOffset(0x2365)] public byte ModeParam; // Different purpose depending on mode. See CharacterModes for more info.
     [FieldOffset(0x2366)] public byte GMRank;
 
-    public bool IsSwimming => (Flags628 & 0x20) != 0; // found in Client::Game::Event::EventSceneModuleUsualImpl.IsSwimming
-    public bool IsWeaponDrawn => (Timeline.Flags3 & 0x40) != 0;
-    public bool IsOffhandDrawn => (WeaponFlags & 0x1) != 0;
-    public bool InCombat => (CharacterData.Flags & 0x2) != 0;
-    public bool IsHostile => (CharacterData.Flags & 0x1) != 0;
-    public bool IsCasting => GetCastInfo() != null && GetCastInfo()->IsCasting;
-    public bool IsPartyMember => (RelationFlags & 0x1) != 0;
-    public bool IsAllianceMember => (RelationFlags & 0x2) != 0;
-    public bool IsFriend => (RelationFlags & 0x4) != 0;
+    /// <remarks> See <see cref="Sound.SoundVolumeCategory"/>. </remarks>
+    [FieldOffset(0x2369)] public byte SoundVolumeCategory;
+    [FieldOffset(0x236A)] public byte SoundVolumeCategoryOverride;
+    [FieldOffset(0x236B)] private byte SoundFlags; // 0x40 = SoundVolumeCategory determined
+
+    public bool IsWeaponDrawn => Timeline.IsWeaponDrawn;
+    public bool IsCasting => VirtualTable != null && GetCastInfo() is var info && info != null && info->IsCasting;
 
     /// <summary>
     /// Gets the (hard) target ID for this character. If this character is the LocalPlayer, this will instead read the

FFXIVClientStructs/FFXIV/Client/Game/Character/Character.cs

@@ -28,8 +28,8 @@ public unsafe partial struct CharacterData {
     [FieldOffset(0x30)] public byte OnlineStatus;
     [FieldOffset(0x31)] public byte Battalion; // used for determining friend/enemy state
 
-    // 0x01 = IsHostile
-    // 0x02 = InCombat
+    [BitField<bool>(nameof(IsHostile), 0)]
+    [BitField<bool>(nameof(InCombat), 1)]
     [FieldOffset(0x34)] public byte Flags;
 
     /// <summary>