Merge pull request #1414 from Haselnussbomber/wks-events

Add WKSMechaEventModule

Author: pohky

FFXIVClientStructs/FFXIV/Client/Game/Fate/FateContext.cs

@@ -1,4 +1,5 @@
 using System.Numerics;
+using FFXIVClientStructs.FFXIV.Client.Game.UI;
 using FFXIVClientStructs.FFXIV.Client.System.String;
 
 namespace FFXIVClientStructs.FFXIV.Client.Game.Fate;
@@ -78,10 +79,11 @@ public struct FateObjective {
     [StructLayout(LayoutKind.Explicit, Size = 0xD0)]
     public struct FateMapMarker {
         [FieldOffset(0x10)] public Utf8String Name;
-        [FieldOffset(0x88)] public uint IconId;
-        [FieldOffset(0x94)] public Vector3 Position;
-        [FieldOffset(0xA0)] public float Radius;
-        [FieldOffset(0xBA)] public ushort TerritoryId;
+        [FieldOffset(0x78)] public MapMarkerData MapMarkerData;
+        [FieldOffset(0x88), Obsolete("Use MapMarkerData.IconId")] public uint IconId;
+        [FieldOffset(0x94), Obsolete("Use MapMarkerData.Position")] public Vector3 Position;
+        [FieldOffset(0xA0), Obsolete("Use MapMarkerData.Radius")] public float Radius;
+        [FieldOffset(0xBA), Obsolete("Use MapMarkerData.TerritoryTypeId")] public ushort TerritoryId;
     }
 }
 

FFXIVClientStructs/FFXIV/Client/Game/UI/Map.cs

@@ -48,9 +48,10 @@ public unsafe partial struct MapMarkerData {
     [FieldOffset(0x08)] public Utf8String* TooltipString;
     [FieldOffset(0x10)] public uint IconId;
 
-    [FieldOffset(0x1C)] public float X;
-    [FieldOffset(0x20)] public float Y;
-    [FieldOffset(0x24)] public float Z;
+    [FieldOffset(0x1C)] public global::System.Numerics.Vector3 Position;
+    [FieldOffset(0x1C), Obsolete("Use Position.X")] public float X;
+    [FieldOffset(0x20), Obsolete("Use Position.Y")] public float Y;
+    [FieldOffset(0x24), Obsolete("Use Position.Z")] public float Z;
     [FieldOffset(0x28)] public float Radius;
 
     [FieldOffset(0x30)] public uint MapId;
@@ -63,6 +64,7 @@ public unsafe partial struct MapMarkerData {
     [FieldOffset(0x44)] public ushort DataId;
     [FieldOffset(0x46)] public byte MarkerType;
     [FieldOffset(0x47)] public sbyte EventState;
+    [FieldOffset(0x48)] public byte Flags; // & 1 == IsHidden?
 
     [MemberFunction("E8 ?? ?? ?? ?? 48 8B 53 ?? 8B 86")]
     public partial MapMarkerData* SetData(

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

@@ -14,22 +14,29 @@ public unsafe partial struct WKSManager {
 
     [FieldOffset(0x18)] public ushort TerritoryId;
 
+    /// <remarks> RowId of WKSDevGrade sheet. </remarks>
     [FieldOffset(0x4A)] public ushort DevGrade;
 
+    /// <remarks> For Hub upgrades. RowId of WKSFateControl sheet. </remarks>
+    [FieldOffset(0x50)] public ushort CurrentFateControlRowId;
+    /// <remarks> For Hub upgrades. Id of Fate in FateManager. </remarks>
+    [FieldOffset(0x52)] public ushort CurrentFateId;
+
+    /// <remarks> RowId of WKSMissionUnit sheet. </remarks>
     [FieldOffset(0xC60)] public ushort CurrentMissionUnitRowId;
 
     [FieldOffset(0xC9C)] public uint FishingBait;
 
     [FieldOffset(0xDB0)] private void* UnkStructDB0; // size: 0x3A8
     [FieldOffset(0xDB8)] private void* UnkStructDB8; // size: 0x1D0
-    [FieldOffset(0xDC0)] private void* UnkStructDC0; // size: 0xA110
+    [FieldOffset(0xDC0)] public WKSMechaEventModule* MechaEventModule;
     [FieldOffset(0xDC8)] private void* UnkStructDC8; // size: 0x10
     [FieldOffset(0xDD0)] private void* UnkStructDD0; // size: 0x90
-    [FieldOffset(0xDD8)] private void* UnkStructDD8; // size: 0x2D8
+    [FieldOffset(0xDD8)] private void* UnkStructDD8; // size: 0x2D8 - EmergencyInfo (Red Alert)
     [FieldOffset(0xDE0)] private void* UnkStructDE0; // size: 0x198
     [FieldOffset(0xDE8)] private void* UnkStructDE8; // size: 0x328
     [FieldOffset(0xDF0)] private void* UnkStructDF0; // size: 0x18
-    [FieldOffset(0xDF8)] public WKSResearch* Research;
+    [FieldOffset(0xDF8)] public WKSResearch* Research; // TODO: add suffix "Module" at some point
     [FieldOffset(0xE00)] private void* UnkStructE00; // size: 0x40
 
     [FieldOffset(0xE08)] public StdVector<Pointer<WKSModuleBase>> Modules;

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

@@ -0,0 +1,43 @@
+namespace FFXIVClientStructs.FFXIV.Client.Game.WKS;
+
+[GenerateInterop]
+[StructLayout(LayoutKind.Explicit, Size = 0x5060)]
+public unsafe partial struct WKSMechaEvent {
+    [FieldOffset(0x0000)] private WKSMechaEventStageHandlerBase StageHandler1;
+    [FieldOffset(0x0010)] private WKSMechaEventStageHandlerBase StageHandler2;
+    [FieldOffset(0x0020)] private WKSMechaEventStageHandlerBase StageHandler3;
+    [FieldOffset(0x0030)] private WKSMechaEventStageHandlerBase StageHandler4;
+    [FieldOffset(0x0040)] private WKSMechaEventStageHandlerBase StageHandler5;
+    [FieldOffset(0x0050)] private WKSMechaEventStageHandlerBase StageHandler6;
+    [FieldOffset(0x0060)] private WKSMechaEventStageHandlerBase StageHandler7;
+
+    [FieldOffset(0x3850)] public StdVector<Pointer<WKSMechaEventMapMarker>> MapMarkerPtrs;
+    [FieldOffset(0x3868), FixedSizeArray] internal FixedSizeArray30<WKSMechaEventMapMarker> _mapMarkers;
+
+    [FieldOffset(0x5000)] public uint YesNoAddonId;
+    [FieldOffset(0x5004)] public uint YesNoShown;
+    [FieldOffset(0x5008)] public WKSMechaEventStageHandlerBase* CurrentStateHandler;
+    [FieldOffset(0x5010), CExporterExcel("WKSMechaEventData")] public nint WKSMechaEventDataRowPtr;
+    [FieldOffset(0x5018)] public uint WKSMechaEventDataRowId;
+    [FieldOffset(0x501C)] public WKSMechaEventFlag Flags;
+    [FieldOffset(0x5020)] public int EventStartTimestamp;
+    [FieldOffset(0x5024)] public int EventEndTimestamp;
+    [FieldOffset(0x5028)] public int PilotRegistrationStartTimestamp;
+    [FieldOffset(0x502C)] public int PilotRegistrationEndTimestamp;
+    [FieldOffset(0x5030)] public int TeleportStartTimestamp;
+
+    [FieldOffset(0x5044)] public int EventProgress;
+    [FieldOffset(0x5048)] public int EventProgressMax;
+    [FieldOffset(0x504C)] public int Contribution;
+
+    [FieldOffset(0x5054)] public int PersonalProgress;
+    [FieldOffset(0x5058)] public int PersonalProgressMax;
+    [FieldOffset(0x505C)] public bool EnabledAutoTargeting; // currently only true for WKSMechaEventDataRowId == 1
+}
+
+[Flags]
+public enum WKSMechaEventFlag : uint {
+    // Each stage of the event has a flag
+
+    IsEventActive = 1 << 7
+}

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

@@ -0,0 +1,23 @@
+using FFXIVClientStructs.FFXIV.Client.Game.UI;
+using FFXIVClientStructs.FFXIV.Client.System.String;
+
+namespace FFXIVClientStructs.FFXIV.Client.Game.WKS;
+
+[StructLayout(LayoutKind.Explicit, Size = 0xC8)]
+public struct WKSMechaEventMapMarker {
+    [FieldOffset(0x00)] public Utf8String Name;
+    [FieldOffset(0x68)] public MapMarkerData MapMarkerData;
+    [FieldOffset(0xB8)] public uint WKSMechaEventDataRowId;
+    [FieldOffset(0xBC)] public uint LayoutId;
+    [FieldOffset(0xC0)] public uint Icon;
+    /// <remarks>
+    /// Type 1 = Icon 60493<br/>
+    /// Type 2 = Icon 63889<br/>
+    /// Type 3 + 4 = Icon 60492<br/>
+    /// Type 5 = Icon 63884
+    /// </remarks>
+    [FieldOffset(0xC4)] public byte Type;
+    [FieldOffset(0xC5)] public byte Flags;
+    [FieldOffset(0xC6)] public byte MapMarkerDataFlags;
+    [FieldOffset(0xC7)] public byte UnkC7;
+}

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

@@ -0,0 +1,20 @@
+namespace FFXIVClientStructs.FFXIV.Client.Game.WKS;
+
+// Client::Game::WKS::WKSMechaEventModule
+//   Client::Game::WKS::WKSModuleBase
+// MechaEvent
+[GenerateInterop]
+[Inherits<WKSModuleBase>]
+[StructLayout(LayoutKind.Explicit, Size = 0xA110)]
+public unsafe partial struct WKSMechaEventModule {
+    [FieldOffset(0x30), FixedSizeArray] internal FixedSizeArray2<WKSMechaEvent> _events;
+    [FieldOffset(0xA0F0)] public WKSMechaEvent* CurrentEvent;
+
+    [FieldOffset(0xA104)] public WKSEventModuleFlag Flags;
+}
+
+[Flags]
+public enum WKSEventModuleFlag : uint {
+    HasCurrentEvent = 1 << 0,
+    IsJoined = 1 << 7,
+}

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

@@ -0,0 +1,10 @@
+namespace FFXIVClientStructs.FFXIV.Client.Game.WKS;
+
+[GenerateInterop(isInherited: true)]
+[StructLayout(LayoutKind.Explicit, Size = 0x10)]
+public unsafe partial struct WKSMechaEventStageHandlerBase {
+    [FieldOffset(0x08)] public WKSMechaEvent* OwnerEvent;
+
+    [VirtualFunction(4)]
+    public partial int GetStageIndex();
+}

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

@@ -7,8 +7,8 @@ public unsafe partial struct WKSModuleBase {
     [VirtualFunction(0)]
     public partial WKSModuleBase* Dtor(byte freeFlags);
 
-    // [VirtualFunction(1)]
-    // public partial bool SetData(int a2, int a3, int a4, int a5, int a6, int a7); // ?
+    [VirtualFunction(1)]
+    public partial bool SetIntData(int a2, int a3, int a4, int a5, int a6, int a7);
 
     [VirtualFunction(2)]
     public partial bool ProcessPacket(byte* packet);

ida/data.yml

@@ -1288,7 +1288,7 @@ classes:
       - ea: 0x142952168
         pointer: true
     funcs:
-#fail       0x1415B6400: HasInstance
+      0x14164CAC0: HasInstance
       0x14164CAE0: GetInstance
 #fail       0x1415B6430: ctor
 #fail       0x1415B64E0: Dtor
@@ -1910,13 +1910,15 @@ classes:
       0x140D0F430: GetInstance
       0x140D0F440: Load
       0x140D0F8C0: Update
+      0x140D10370: IsFunctionUnlocked
       0x140D10450: AddModule
       0x140D105F0: RemoveModule
   Client::Game::WKS::WKSModuleBase:
     vtbls:
       - ea: 0x1422915E0
     vfuncs:
       0: Dtor
+      1: SetIntData
       2: ProcessPacket
   Client::Game::WKS::WKSResearch: # Cosmic Research Information
     vtbls:
@@ -1935,6 +1937,56 @@ classes:
       0x14199C5A0: GetRatePercentage
       0x14199C850: GetUnlockedStage
       0x14199CD20: GetClassJobLevel
+  Client::Game::WKS::WKSMechaEventModule: # Mecha Events
+    vtbls:
+      - ea: 0x142291620
+        base: Client::Game::WKS::WKSModuleBase
+    funcs:
+      0x14194EED0: ctor
+      0x141951DB0: PrintLogMessage<int>
+  Client::Game::WKS::WKSMechaEvent:
+    funcs:
+      0x1419A0EC0: Initialize
+      0x1419A1590: Finalizer
+      0x1419A2100: IsPilotRegistrationTimeframeOpen
+      0x1419A2140: IsTeleportTimeframeOpen
+      0x1419A2190: GetEventProgressPercentage
+  Client::Game::WKS::WKSMechaEventStageHandlerBase:
+    vtbls:
+      - ea: 0x1422DA330
+    vfuncs:
+      0: SetOwnerEvent
+      4: GetStageIndex
+    funcs:
+      0x141B2F790: ctor
+  Client::Game::WKS::WKSMechaEventStageHandler1:
+    vtbls:
+      - ea: 0x1422DA380
+        base: Client::Game::WKS::WKSMechaEventStageHandlerBase
+  Client::Game::WKS::WKSMechaEventStageHandler2:
+    vtbls:
+      - ea: 0x1422DA3D0
+        base: Client::Game::WKS::WKSMechaEventStageHandlerBase
+  Client::Game::WKS::WKSMechaEventStageHandler3:
+    vtbls:
+      - ea: 0x1422DA420
+        base: Client::Game::WKS::WKSMechaEventStageHandlerBase
+  Client::Game::WKS::WKSMechaEventStageHandler4:
+    vtbls:
+      - ea: 0x1422DA470
+        base: Client::Game::WKS::WKSMechaEventStageHandlerBase
+  Client::Game::WKS::WKSMechaEventStageHandler5:
+    vtbls:
+      - ea: 0x1422DA4C0
+        base: Client::Game::WKS::WKSMechaEventStageHandlerBase
+  Client::Game::WKS::WKSMechaEventStageHandler6:
+    vtbls:
+      - ea: 0x1422DA510
+        base: Client::Game::WKS::WKSMechaEventStageHandlerBase
+  Client::Game::WKS::WKSMechaEventStageHandler7:
+    vtbls:
+      - ea: 0x1422DA560
+        base: Client::Game::WKS::WKSMechaEventStageHandlerBase
   Client::System::String::Utf8String:
     funcs:
       0x14005A330: ctor  # empty string ctor
@@ -2421,6 +2473,7 @@ classes:
     funcs:
       0x140C6A350: SetCondition
       0x140C6A3D0: ReadPacket
+      0x140C6A490: HasPermission
       0x140C6A610: HasPermissionCondition
       0x140C6A790: GetPermissionLogMessage
       0x140C6A820: GetConditionLogMessage
@@ -13523,6 +13576,7 @@ classes:
     funcs:
       0x1417315E0: ctor
       0x141731C40: Dtor
+      0x141738D70: ShowScreenImage
   Client::Game::Event::EventSceneModule::UISkipListener:
     vtbls:
       - ea: 0x1421B1928