From 7e18d270c67e5df20b124f0d8efae52c819199d6 Mon Sep 17 00:00:00 2001
From: Fexty <bogofogo1@gmail.com>
Date: Mon, 29 Apr 2024 13:07:23 +0200
Subject: [PATCH] EffectEmitter class (wrapper around uMhEpv)

---
 Assets/Common/AddressRecords.json             | 10 ++
 SharpPluginLoader.Core/EffectEmitter.cs       | 98 +++++++++++++++++++
 .../SharpPluginLoader.Core.csproj             |  3 +
 .../mhw-cs-plugin-loader.vcxproj              |  1 +
 .../mhw-cs-plugin-loader.vcxproj.filters      |  3 +
 5 files changed, 115 insertions(+)
 create mode 100644 SharpPluginLoader.Core/EffectEmitter.cs

diff --git a/Assets/Common/AddressRecords.json b/Assets/Common/AddressRecords.json
index 7a2eef1..cb24b6d 100644
--- a/Assets/Common/AddressRecords.json
+++ b/Assets/Common/AddressRecords.json
@@ -423,5 +423,15 @@
         "Name": "MtDti:Init",
         "Pattern": "48 89 5c 24 08 57 48 83 ec 20 81 61 30 00 00 80 1f",
         "Offset": 0
+    },
+    {
+        "Name": "EffectEmitter:SetEpv",
+        "Pattern": "48 8b d9 ff 90 c8 00 00 00 48 8b 8b 60 02 00 00 48 3b cf",
+        "Offset": -16
+    },
+    {
+        "Name": "EffectEmitter:SetConstraintModel",
+        "Pattern": "48 8b 81 70 02 00 00 48 8b f2 48 8b d9 48 3b c2 74 1e",
+        "Offset": -15
     }
 ]
\ No newline at end of file
diff --git a/SharpPluginLoader.Core/EffectEmitter.cs b/SharpPluginLoader.Core/EffectEmitter.cs
new file mode 100644
index 0000000..b126abf
--- /dev/null
+++ b/SharpPluginLoader.Core/EffectEmitter.cs
@@ -0,0 +1,98 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using SharpPluginLoader.Core.Memory;
+using SharpPluginLoader.Core.Models;
+using SharpPluginLoader.Core.Resources;
+
+namespace SharpPluginLoader.Core;
+
+/// <summary>
+/// Represents an instance of uMhEpv. This class has the capability to
+/// emit effects
+/// </summary>
+public class EffectEmitter : Unit
+{
+    public EffectEmitter(nint instance) : base(instance) { }
+    public EffectEmitter() { }
+
+    /// <summary>
+    /// The EPV that this effect emitter is using. Updating this value
+    /// will automatically call <see cref="Kill"/> and update the <see cref="Epvsp"/> property.
+    /// </summary>
+    public unsafe EffectProvider? EffectProvider
+    {
+        get => GetObject<EffectProvider>(0x260);
+        set => SetEpvFunc.Invoke(Instance, value?.Instance ?? 0);
+    }
+
+    /// <summary>
+    /// The model that this effect emitter is constrained to.
+    /// </summary>
+    public unsafe Model? ConstraintModel
+    {
+        get => GetObject<Model>(0x270);
+        set => SetConstraintModelFunc.Invoke(Instance, value?.Instance ?? 0);
+    }
+
+    /// <summary>
+    /// The EPV Group Id that this effect emitter is using.
+    /// </summary>
+    public ref int GroupId => ref GetRef<int>(0x268);
+
+    /// <summary>
+    /// The EPV Element Id that this effect emitter is using.
+    /// </summary>
+    public ref int ElementId => ref GetRef<int>(0x26C);
+
+    /// <summary>
+    /// Whether this effect emitter is playing. Do not modify this value,
+    /// use the <see cref="Start"/> and <see cref="Finish"/> methods instead.
+    /// </summary>
+    public bool IsPlaying => GetRef<bool>(0x370);
+
+    /// <summary>
+    /// How the effect referenced by this emitter is played.
+    /// Mostly unknown, 2 means the effect is looped infinitely.
+    /// </summary>
+    public ref int PlayType => ref GetRef<int>(0x374);
+
+    /// <summary>
+    /// The interval between each effect emission, if the effect is looped.
+    /// (See <see cref="PlayType"/>)
+    /// </summary>
+    public ref float Interval => ref GetRef<float>(0x378);
+
+    /// <summary>
+    /// The EPVSP that this effect emitter is using. This is populated
+    /// automatically when you set the EPV. (<see cref="EffectProvider"/>)
+    /// </summary>
+    public Resource? Epvsp => GetObject<Resource>(0xA00);
+
+    /// <summary>
+    /// Starts the emitter.
+    /// </summary>
+    public unsafe void Start() => StartFunction.Invoke(Instance);
+
+    /// <summary>
+    /// Ends the emitter.
+    /// </summary>
+    public unsafe void Finish() => FinishFunction.Invoke(Instance);
+
+    /// <summary>
+    /// Kills the emitter and all effects associated with it immediately.
+    /// </summary>
+    public unsafe void Kill() => KillFunction.Invoke(Instance);
+
+
+    private NativeAction<nint> StartFunction => new(GetVirtualFunction(38));
+    private NativeAction<nint> FinishFunction => new(GetVirtualFunction(37));
+    private NativeAction<nint> KillFunction => new(GetVirtualFunction(25));
+
+    private static readonly NativeAction<nint, nint> SetEpvFunc
+        = new(AddressRepository.Get("EffectEmitter:SetEpv"));
+    private static readonly NativeAction<nint, nint> SetConstraintModelFunc
+        = new(AddressRepository.Get("EffectEmitter:SetConstraintModel"));
+}
diff --git a/SharpPluginLoader.Core/SharpPluginLoader.Core.csproj b/SharpPluginLoader.Core/SharpPluginLoader.Core.csproj
index 9eb909b..958a166 100644
--- a/SharpPluginLoader.Core/SharpPluginLoader.Core.csproj
+++ b/SharpPluginLoader.Core/SharpPluginLoader.Core.csproj
@@ -139,4 +139,7 @@
 	<ItemGroup>
 	  <NativeLibs Remove="UnitManager.cs" />
 	</ItemGroup>
+	<ItemGroup>
+	  <NativeLibs Remove="EffectEmitter.cs" />
+	</ItemGroup>
 </Project>
diff --git a/mhw-cs-plugin-loader/mhw-cs-plugin-loader.vcxproj b/mhw-cs-plugin-loader/mhw-cs-plugin-loader.vcxproj
index 91451cf..42a8b4b 100644
--- a/mhw-cs-plugin-loader/mhw-cs-plugin-loader.vcxproj
+++ b/mhw-cs-plugin-loader/mhw-cs-plugin-loader.vcxproj
@@ -217,6 +217,7 @@
     <ClInclude Include="Timeline.h" />
   </ItemGroup>
   <ItemGroup>
+    <None Include="..\Assets\Common\AddressRecords.json" />
     <None Include="..\README.md" />
     <None Include="..\vcpkg.json" />
     <None Include=".clang-tidy" />
diff --git a/mhw-cs-plugin-loader/mhw-cs-plugin-loader.vcxproj.filters b/mhw-cs-plugin-loader/mhw-cs-plugin-loader.vcxproj.filters
index 83b6a10..296310a 100644
--- a/mhw-cs-plugin-loader/mhw-cs-plugin-loader.vcxproj.filters
+++ b/mhw-cs-plugin-loader/mhw-cs-plugin-loader.vcxproj.filters
@@ -242,5 +242,8 @@
     <None Include="Shaders\LineRenderingGS.hlsl">
       <Filter>Resource Files\Shaders</Filter>
     </None>
+    <None Include="..\Assets\Common\AddressRecords.json">
+      <Filter>Resource Files</Filter>
+    </None>
   </ItemGroup>
 </Project>
\ No newline at end of file