Merge remote-tracking branch 'upstream/main'

Author: AtmoOmen

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

@@ -68,10 +68,10 @@ public partial struct Header {
         [FieldOffset(0x21)] public byte NumTargets;
 
         /// <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; }
+        public partial bool ShowInLog { readonly 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; }
+        public partial bool ForceAnimationLock { readonly get; set; }
     }
 
     /// <summary>

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

@@ -1,4 +1,5 @@
 using FFXIVClientStructs.FFXIV.Client.Game.Control;
+using FFXIVClientStructs.FFXIV.Client.Game.Control.MoveControl;
 using FFXIVClientStructs.FFXIV.Client.Game.Object;
 
 namespace FFXIVClientStructs.FFXIV.Client.Game.Character;
@@ -11,10 +12,7 @@ namespace FFXIVClientStructs.FFXIV.Client.Game.Character;
 [StructLayout(LayoutKind.Explicit, Size = 0x2370)]
 [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, 87)]
 public unsafe partial struct Character {
-    [FieldOffset(0x600)] public MovementStateOptions MovementState;
-    [BitField<bool>(nameof(IsSwimming), 5)] // found in Client::Game::Event::EventSceneModuleUsualImpl.IsSwimming
-    [FieldOffset(0x628)] public byte Flags628;
-
+    [FieldOffset(0x1F0)] public MoveController MoveController;
     [FieldOffset(0x630)] public EmoteController EmoteController;
     [FieldOffset(0x670)] public MountContainer Mount;
     [FieldOffset(0x6D8)] public CompanionContainer CompanionData;
@@ -91,6 +89,15 @@ public unsafe partial struct Character {
     [FieldOffset(0x236A)] public byte SoundVolumeCategoryOverride;
     [FieldOffset(0x236B)] private byte SoundFlags; // 0x40 = SoundVolumeCategory determined
 
+    [FieldOffset(0x600), Obsolete("Moved to MoveController.MovementState")] public MovementStateOptions MovementState;
+    [FieldOffset(0x628), Obsolete] public byte Flags628;
+
+    [Obsolete("Moved to MoveController.IsSwimming")]
+    public bool IsSwimming {
+        get => MoveController.IsSwimming;
+        set => MoveController.IsSwimming = value;
+    }
+
     public bool IsWeaponDrawn => Timeline.IsWeaponDrawn;
     public bool IsCasting => VirtualTable != null && GetCastInfo() is var info && info != null && info->IsCasting;
 
@@ -179,6 +186,7 @@ public unsafe partial struct Character {
     public partial ForayInfo* GetForayInfo();
 }
 
+// TODO: move to FFXIVClientStructs.FFXIV.Client.Game.Control.MoveControl
 public enum MovementStateOptions : byte {
     Normal = 0,
     Flying = 1,

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

@@ -91,10 +91,11 @@ public enum EquipmentSlot : uint {
         LFinger = 9,
     }
 
+    // TODO: do we rename MainHand to Main and OffHand to Sub?
     public enum WeaponSlot : uint {
-        MainHand = 0,
-        OffHand = 1,
-        Unk = 2, // TODO: CraftTool?
+        MainHand = 0, // WEAPON_SLOT_MAIN
+        OffHand = 1, // WEAPON_SLOT_SUB
+        System = 2, // WEAPON_SLOT_SYSTEM - used for crafter's tool
     }
 }
 

FFXIVClientStructs/FFXIV/Client/Game/Control/MoveControl/MoveController.cs

@@ -0,0 +1,14 @@
+using FFXIVClientStructs.FFXIV.Client.Game.Character;
+
+namespace FFXIVClientStructs.FFXIV.Client.Game.Control.MoveControl;
+
+// Client::Game::Control::MoveControl::MoveController
+[GenerateInterop]
+[StructLayout(LayoutKind.Explicit, Size = 0x440)]
+public unsafe partial struct MoveController {
+    [FieldOffset(0x3E0)] public BattleChara* OwnerObject;
+
+    [FieldOffset(0x410)] public MovementStateOptions MovementState;
+    [BitField<bool>(nameof(IsSwimming), 5)] // found in Client::Game::Event::EventSceneModuleUsualImpl.IsSwimming
+    [FieldOffset(0x438)] private byte Flags438;
+}

FFXIVClientStructs/FFXIV/Client/Game/Event/Director.cs

@@ -15,7 +15,8 @@ public unsafe partial struct Director {
     [FieldOffset(0x2E0)] public uint ContentId;
     [FieldOffset(0x2E4)] public byte ContentFlags; // 1 = Tourism (Explorer Mode)
     [FieldOffset(0x2E8)] public byte Sequence;
-    [FieldOffset(0x2EA), FixedSizeArray] internal FixedSizeArray10<byte> _unionData; // I8A-I8J, UI8A-UI8J, Branch etc.
+    [FieldOffset(0x2E9)] public byte Unknown2E9; // Set in EventFramework.SetDirectorData
+    [FieldOffset(0x2EA), FixedSizeArray] internal FixedSizeArray12<byte> _unionData; // I8A-I8J, UI8A-UI8J, Branch etc.
     [FieldOffset(0x2F8)] public Utf8String Title;
     [FieldOffset(0x360)] public Utf8String Objective; // name based on the Lua function "SetDirectorObjective"
     [FieldOffset(0x3C8)] public Utf8String ReliefText;

FFXIVClientStructs/FFXIV/Client/Game/Event/EventFramework.cs

@@ -43,6 +43,9 @@ public unsafe partial struct EventFramework {
     [FieldOffset(0x4478)] public StdList<QueuedActionTimelineCallback> QueuedActionTimelineCallbacks;
 
     [FieldOffset(0x45D8)] public DailyQuestMap DailyQuests;
+    [FieldOffset(0x45E8)] public Utf8String DailySelectTitle; // Addon#102442 for SelectIconString
+    [FieldOffset(0x4650)] public Utf8String DailySelectSubTitle; // Addon#102443 for SelectIconString
+    [FieldOffset(0x46B8)] public Utf8String DailySelectAllowance; // formatted Addon#102444 for SelectIconString
 
     [FieldOffset(0x476A), FixedSizeArray] internal FixedSizeArray8<Festival> _festivals; // copied from PlayerState, used by GPose (maybe more) to check if Fan Festival frames/stamps should be displayed
 
@@ -118,6 +121,19 @@ public void MaterializeItem(InventoryItem* itemSlot, MaterializeEntryId entryId)
     [MemberFunction("40 53 57 48 83 EC ?? 48 8B 05 ?? ?? ?? ?? 48 33 C4 48 89 44 24 ?? 41 8B F9")]
     public partial void ProcessDirectorUpdate(EventId eventId, uint category, uint arg1, uint arg2, uint arg3, uint arg4, uint arg5, uint arg6);
 
+    /// <summary>
+    /// Finds one or more <see cref="Director"/>(s) in <see cref="DirectorModule.DirectorList"/>
+    /// with a matching <paramref name="eventId"/>, and sets the data to the values provided
+    /// before calling <see cref="Director"/>.SetSequence and <see cref="Director"/>.Synchronize.
+    /// </summary>
+    /// <param name="eventId"><see cref="EventId"/> to look for in <see cref="DirectorModule.DirectorList"/>.</param>
+    /// <param name="sequence">Value to set in <see cref="Director.Sequence"/>.</param>
+    /// <param name="unknown">Value to set in <see cref="Director.Unknown2E9"/></param>
+    /// <param name="unionDataBuffer">Buffer that will be copied to <see cref="Director.UnionData"/>.</param>
+    /// <param name="length">The number of bytes that will be copied from <paramref name="unionDataBuffer"/>. The game always provides a value of 12, but it supports other values.</param>
+    [MemberFunction("89 54 24 10 48 89 4C 24 ?? 53 56 57 41 55 41 57 48 83 EC 30 48 8B 99")]
+    public partial void SetDirectorData(EventId eventId, byte sequence, byte unknown, byte* unionDataBuffer, ulong length);
+
     private T* GetInstanceContentDirector<T>(InstanceContentType instanceContentType) where T : unmanaged {
         var instanceDirector = GetInstanceContentDirector();
         if (instanceDirector == null || instanceDirector->InstanceContentType != instanceContentType)

FFXIVClientStructs/FFXIV/Client/Game/Event/EventState.cs

@@ -7,7 +7,7 @@ namespace FFXIVClientStructs.FFXIV.Client.Game.Event;
 public struct EventState {
     [FieldOffset(0x08)] public EventId EventId;
     [FieldOffset(0x10)] public GameObjectId ObjectId;
-    [FieldOffset(0x18)] private byte Unk18;
+    [FieldOffset(0x18)] public byte CurrentEvent;
     [FieldOffset(0x1C)] private int Unk1C;
     [FieldOffset(0x20)] private byte Unk20;
     [FieldOffset(0x24)] public int OccupiedConditionId;

FFXIVClientStructs/FFXIV/Client/Game/Object/GameObject.cs

@@ -294,7 +294,7 @@ public partial struct ObjectType : IEquatable<ObjectType>, IComparable<ObjectTyp
     [FieldOffset(0x00)] public uint Value;
 
     /// <remarks> Only valid if <see cref="GameObject.ObjectKind"/> is <see cref="ObjectKind.BattleNpc"/> and <see cref="GameObject.BattleNpcSubKind"/> is <see cref="BattleNpcSubKind.Pet"/>. </remarks>
-    public partial byte PetMirageId { get; set; }
+    public partial byte PetMirageId { readonly get; set; }
 
     public static implicit operator uint(ObjectType ot) => ot.Value;
     public static unsafe implicit operator ObjectType(uint ot) => *(ObjectType*)&ot;

FFXIVClientStructs/FFXIV/Client/Game/WKS/WKSManager.cs

@@ -115,6 +115,8 @@ public partial struct WKSJobState {
 
         [FieldOffset(0x110), FixedSizeArray] internal FixedSizeArray3<WKSMasterMissionState> _masterMissions;
 
+        [FieldOffset(0x140)] public ushort BonusMasterMissionUnitId;
+
         [FieldOffset(0x108), Obsolete("Wrongly documented field as this is most likely a timestamp", true)] public uint CriticalMissionData;
     }
 
@@ -147,6 +149,8 @@ public partial struct WKSState {
         [FieldOffset(0xE46), Obsolete("Use CurrentMission.CollectedTotal")] public ushort CollectedTotal;
         [FieldOffset(0xE48), Obsolete("Use CurrentMission.CollectedIndividual")] public byte CollectedIndividual;
 
+        [FieldOffset(0xE70)] public byte ConsecutiveGoldCount;
+
         [FieldOffset(0xE74)] public uint FishingBait;
 
         [FieldOffset(0xE81), FixedSizeArray(isBitArray: true, bitCount: 1704)] internal FixedSizeArray213<byte> _missionCompletionFlags;

FFXIVClientStructs/FFXIV/Client/Game/WKS/WKSMissionModule.cs

@@ -20,7 +20,7 @@ public unsafe partial struct MissionState {
         /// <remarks> RowId of WKSMissionUnit sheet. </remarks>
         [FieldOffset(0x00)] public ushort MissionUnitRowId;
 
-        [FieldOffset(0x0C)] public ushort Score;
+        [FieldOffset(0x0C)] public ushort Score; // TODO: uint
 
         [FieldOffset(0x10)] public MissionRank Rank;
         [FieldOffset(0x14)] private byte Unk14; // bool? status?