JonKazama-Hellion/HellionChat
1
0
Fork 0
Code Issues 1 Pull Requests Actions Releases 28 Activity

- Replace all possible hooks with CS

Browse Source 
- Mark ones that can be replaced soon
- Use Dalamuds ConfigOption for chat color parsing
This commit is contained in:
Infi
2024-05-25 16:50:37 +02:00
parent 8aaaa684a2
commit 0c19772b18
10 changed files with 104 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ChatTwo/GameFunctions/Chat.cs
+44 -71
View File
@@ -14,6 +14,7 @@ using FFXIVClientStructs.FFXIV.Client.System.Framework;
using FFXIVClientStructs.FFXIV.Client.System.String;
using FFXIVClientStructs.FFXIV.Client.UI;
using FFXIVClientStructs.FFXIV.Client.UI.Agent;
using FFXIVClientStructs.FFXIV.Client.UI.Info;
using FFXIVClientStructs.FFXIV.Client.UI.Misc;
using FFXIVClientStructs.FFXIV.Client.UI.Shell;
using FFXIVClientStructs.FFXIV.Component.GUI;
@@ -26,109 +27,103 @@ internal sealed unsafe class Chat : IDisposable
{
// Functions
// TODO Replace with CS in RaptureShellModule
[Signature("E8 ?? ?? ?? ?? 0F B7 44 37 ??", Fallibility = Fallibility.Fallible)]
private readonly delegate* unmanaged<RaptureShellModule*, int, uint, Utf8String*, byte, void> ChangeChatChannel = null!;
// TODO Replace with CS in RaptureShellModule
[Signature("48 89 5C 24 ?? 55 56 57 48 81 EC ?? ?? ?? ?? 48 8B 05 ?? ?? ?? ?? 48 33 C4 48 89 84 24 ?? ?? ?? ?? 48 8B 02", Fallibility = Fallibility.Fallible)]
private readonly delegate* unmanaged<RaptureShellModule*, Utf8String*, Utf8String*, ushort, ulong, ushort, byte, bool> SetChannelTargetTell = null!;
[Signature("E8 ?? ?? ?? ?? 48 8D 4D A0 8B F8")]
private readonly delegate* unmanaged<IntPtr, Utf8String*, IntPtr, uint> GetKeybindNative = null!;
private readonly delegate* unmanaged<nint, Utf8String*, IntPtr, uint> GetKeybindNative = null!;
// TODO Replace with CS in AcquaintanceModule
[Signature("44 8B 89 ?? ?? ?? ?? 4C 8B C1 45 85 C9")]
private readonly delegate* unmanaged<void*, int, IntPtr> GetTellHistory = null!;
private readonly delegate* unmanaged<void*, int, nint> GetTellHistory = null!;
[Signature("E8 ?? ?? ?? ?? 48 8D 4D 50 E8 ?? ?? ?? ?? 48 8B 17")]
private readonly delegate* unmanaged<RaptureLogModule*, ushort, Utf8String*, Utf8String*, ulong, ushort, byte, int, byte, void> PrintTellNative = null!;
[Signature("E8 ?? ?? ?? ?? 48 8D 4C 24 ?? E8 ?? ?? ?? ?? 48 8D 8C 24 ?? ?? ?? ?? E8 ?? ?? ?? ?? B0 01")]
private readonly delegate* unmanaged<IntPtr, ulong, ushort, Utf8String*, Utf8String*, byte, ulong, byte> SendTellNative = null!;
private readonly delegate* unmanaged<nint, ulong, ushort, Utf8String*, Utf8String*, byte, ulong, byte> SendTellNative = null!;
[Signature("E8 ?? ?? ?? ?? F6 43 0A 40")]
private readonly delegate* unmanaged<Framework*, IntPtr> GetNetworkModule = null!;
private readonly delegate* unmanaged<Framework*, nint> GetNetworkModule = null!;
// TODO Replace with CS in InfoProxyCrossworldLinkshell
[Signature("E8 ?? ?? ?? ?? 48 8B C8 E8 ?? ?? ?? ?? 45 8D 46 FB")]
private readonly delegate* unmanaged<IntPtr, uint, Utf8String*> GetCrossLinkshellNameNative = null!;
private readonly delegate* unmanaged<nint, uint, Utf8String*> GetCrossLinkshellNameNative = null!;
// TODO Replace with CS in InfoProxyLinkshell
[Signature("3B 51 10 73 0F 8B C2 48 83 C0 0B")]
private readonly delegate* unmanaged<IntPtr, uint, ulong*> GetLinkshellInfo = null!;
private readonly delegate* unmanaged<nint, uint, ulong*> GetLinkshellInfo = null!;
// TODO Replace with CS in InfoProxyLinkshell
[Signature("E8 ?? ?? ?? ?? 4C 8B C8 44 8D 47 01")]
private readonly delegate* unmanaged<IntPtr, ulong, byte*> GetLinkshellNameNative = null!;
private readonly delegate* unmanaged<nint, ulong, byte*> GetLinkshellNameNative = null!;
// TODO Replace with CS virtual function
[Signature("40 56 41 54 41 55 41 57 48 83 EC 28 48 8B 01", Fallibility = Fallibility.Fallible)]
private readonly delegate* unmanaged<UIModule*, int, ulong> RotateLinkshellHistoryNative;
// TODO Replace with CS virtual function
[Signature("48 89 5C 24 ?? 48 89 6C 24 ?? 48 89 74 24 ?? 57 41 56 41 57 48 83 EC 20 48 8B 01 44 8B F2", Fallibility = Fallibility.Fallible)]
private readonly delegate* unmanaged<UIModule*, int, ulong> RotateCrossLinkshellHistoryNative;
[Signature("48 89 5C 24 ?? 48 89 6C 24 ?? 48 89 74 24 ?? 57 48 83 EC 20 8B F2 48 8D B9")]
private readonly delegate* unmanaged<IntPtr, uint, IntPtr> GetColourInfo = null!;
// TODO Replace with CS version on Utf8String
[Signature("E8 ?? ?? ?? ?? EB 0A 48 8D 4C 24 ?? E8 ?? ?? ?? ?? 48 8D 8D")]
private readonly delegate* unmanaged<Utf8String*, int, IntPtr, void> SanitiseString = null!;
private readonly delegate* unmanaged<Utf8String*, int, nint, void> SanitiseString = null!;
// Hooks
private delegate byte ChatLogRefreshDelegate(IntPtr log, ushort eventId, AtkValue* value);
private delegate byte ChatLogRefreshDelegate(nint log, ushort eventId, AtkValue* value);
private delegate IntPtr ChangeChannelNameDelegate(IntPtr agent);
private delegate nint ChangeChannelNameDelegate(nint agent);
private delegate void ReplyInSelectedChatModeDelegate(AgentInterface* agent);
private delegate byte SetChatLogTellTarget(IntPtr a1, Utf8String* name, Utf8String* a3, ushort world, ulong contentId, ushort a6, byte a7);
private delegate byte SetChatLogTellTarget(nint a1, Utf8String* name, Utf8String* a3, ushort world, ulong contentId, ushort a6, byte a7);
private delegate void EurekaContextMenuTellDelegate(RaptureShellModule* param1, Utf8String* playerName, Utf8String* worldName, ushort world, ulong contentId, ushort param6);
[Signature(
"40 53 56 57 48 81 EC ?? ?? ?? ?? 48 8B 05 ?? ?? ?? ?? 48 33 C4 48 89 84 24 ?? ?? ?? ?? 49 8B F0 8B FA",
DetourName = nameof(ChatLogRefreshDetour)
)]
// Client::UI::AddonChatLog.OnRefresh
[Signature("40 53 56 57 48 81 EC ?? ?? ?? ?? 48 8B 05 ?? ?? ?? ?? 48 33 C4 48 89 84 24 ?? ?? ?? ?? 49 8B F0 8B FA", DetourName = nameof(ChatLogRefreshDetour))]
private Hook<ChatLogRefreshDelegate>? ChatLogRefreshHook { get; init; }
[Signature(
"E8 ?? ?? ?? ?? BA ?? ?? ?? ?? 48 8D 4D B0 48 8B F8 E8 ?? ?? ?? ?? 41 8B D6",
DetourName = nameof(ChangeChannelNameDetour)
)]
// TODO Replace with CS version
[Signature("E8 ?? ?? ?? ?? BA ?? ?? ?? ?? 48 8D 4D B0 48 8B F8 E8 ?? ?? ?? ?? 41 8B D6", DetourName = nameof(ChangeChannelNameDetour))]
private Hook<ChangeChannelNameDelegate>? ChangeChannelNameHook { get; init; }
[Signature(
"48 89 5C 24 ?? 57 48 83 EC 30 8B B9 ?? ?? ?? ?? 48 8B D9 83 FF FE",
DetourName = nameof(ReplyInSelectedChatModeDetour)
)]
// TODO Replace with CS version
[Signature("48 89 5C 24 ?? 57 48 83 EC 30 8B B9 ?? ?? ?? ?? 48 8B D9 83 FF FE", DetourName = nameof(ReplyInSelectedChatModeDetour))]
private Hook<ReplyInSelectedChatModeDelegate>? ReplyInSelectedChatModeHook { get; init; }
[Signature(
"E8 ?? ?? ?? ?? 4C 8B 7C 24 ?? EB 34",
DetourName = nameof(SetChatLogTellTargetDetour)
)]
// TODO Replace with CS version
[Signature("E8 ?? ?? ?? ?? 4C 8B 7C 24 ?? EB 34", DetourName = nameof(SetChatLogTellTargetDetour))]
private Hook<SetChatLogTellTarget>? SetChatLogTellTargetHook { get; init; }
[Signature(
"E8 ?? ?? ?? ?? EB 8A 48 8B 1D",
DetourName = nameof(EurekaContextMenuTell)
)]
// TODO Replace with CS version
[Signature("E8 ?? ?? ?? ?? EB 8A 48 8B 1D", DetourName = nameof(EurekaContextMenuTell))]
private Hook<EurekaContextMenuTellDelegate>? EurekaContextMenuTellHook { get; init; }
// Offsets
#pragma warning disable 0649
// TODO: Replace with CS version under AgentChatLog
[Signature("8B B9 ?? ?? ?? ?? 48 8B D9 83 FF FE 0F 84", Offset = 2)]
private readonly int? ReplyChannelOffset;
// TODO: Replace with CS version under RaptureShellModule
[Signature("89 83 ?? ?? ?? ?? 48 8B 01 83 FE 13 7C 05 41 8B D4 EB 03 83 CA FF FF 90", Offset = 2)]
private readonly int? ShellChannelOffset;
// TODO: Replace with CS version under UiModule
[Signature("4C 8D B6 ?? ?? ?? ?? 41 8B 1E 45 85 E4 74 7A 33 FF 8B EF 66 0F 1F 44 00", Offset = 3)]
private readonly int? LinkshellCycleOffset;
[Signature("BA ?? ?? ?? ?? E8 ?? ?? ?? ?? 48 8B F0 48 85 C0 0F 84 ?? ?? ?? ?? 48 8B 10 33", Offset = 1)]
private readonly uint? LinkshellInfoProxyIdx;
[Signature("BA ?? ?? ?? ?? E8 ?? ?? ?? ?? 48 89 6C 24 ?? 4C 8B E0 48 89 74 24", Offset = 1)]
private readonly uint? CrossLinkshellInfoProxyIdx;
#pragma warning restore 0649
// Pointers
@@ -136,9 +131,6 @@ internal sealed unsafe class Chat : IDisposable
[Signature("48 8D 15 ?? ?? ?? ?? 0F B6 C8 48 8D 05", ScanType = ScanType.StaticAddress)]
private readonly char* CurrentCharacter = null!;
[Signature("48 8D 0D ?? ?? ?? ?? 8B 14 ?? 85 D2 7E ?? 48 8B 0D ?? ?? ?? ?? 48 83 C1 10 E8 ?? ?? ?? ?? 8B 70 ?? 41 8D 4D", ScanType = ScanType.StaticAddress)]
private IntPtr ColourLookup { get; init; }
// Events
internal delegate void ChatActivatedEventDelegate(ChatActivatedArgs args);
@@ -190,10 +182,7 @@ internal sealed unsafe class Chat : IDisposable
internal string? GetLinkshellName(uint idx)
{
if (LinkshellInfoProxyIdx is not { } proxyIdx)
return null;
var infoProxy = Plugin.Functions.GetInfoProxyByIndex(proxyIdx);
var infoProxy = Plugin.Functions.GetInfoProxyByIndex(InfoProxyId.LinkShell);
if (infoProxy == IntPtr.Zero)
return null;
@@ -207,10 +196,7 @@ internal sealed unsafe class Chat : IDisposable
internal string? GetCrossLinkshellName(uint idx)
{
if (CrossLinkshellInfoProxyIdx is not { } proxyIdx)
return null;
var infoProxy = Plugin.Functions.GetInfoProxyByIndex(proxyIdx);
var infoProxy = Plugin.Functions.GetInfoProxyByIndex(InfoProxyId.CrossWorldLinkShell);
if (infoProxy == IntPtr.Zero)
return null;
@@ -249,35 +235,22 @@ internal sealed unsafe class Chat : IDisposable
return func(uiModule, idx);
}
// This function looks up a channel's user-defined colour.
//
// If this function would ever return 0, it returns null instead.
internal uint? GetChannelColour(ChatType type)
// This function looks up a channel's user-defined color.
// If this function ever returns 0, it returns null instead.
internal uint? GetChannelColor(ChatType type)
{
if (GetColourInfo == null || ColourLookup == IntPtr.Zero)
return null;
// Colours are retrieved by looking up their code in a lookup table. Some codes share a colour, so they're lumped into a parent code here.
// Only codes >= 10 (say) have configurable colours.
// After getting the lookup value for the code, it is passed into a function with a handler which returns a pointer.
// This pointer + 32 is the RGB value. This functions returns RGBA with A always max.
var parent = new ChatCode((ushort) type).Parent();
switch (parent)
{
case ChatType.Debug:
case ChatType.Urgent:
case ChatType.Notice:
return type.DefaultColour();
return type.DefaultColor();
}
var framework = (IntPtr) Framework.Instance();
var lookupResult = *(uint*) (ColourLookup + (int) parent * 4);
var info = GetColourInfo(framework + 16, lookupResult);
var rgb = *(uint*) (info + 32) & 0xFFFFFF;
Plugin.GameConfig.TryGet(parent.ToConfigEntry(), out uint color);
var rgb = color & 0xFFFFFF;
if (rgb == 0)
return null;
@@ -750,7 +723,7 @@ internal sealed unsafe class Chat : IDisposable
{
var uC = Utf8String.FromString(c.ToString());
SanitiseString(uC, 0x27F, IntPtr.Zero);
SanitiseString(uC, 0x27F, nint.Zero);
var wasValid = uC->ToString().Length > 0;
uC->Dtor(true);
ChatTwo/GameFunctions/Context.cs
+6 -24
View File
@@ -2,30 +2,23 @@ using ChatTwo.Util;
using Dalamud.Utility.Signatures;
using FFXIVClientStructs.FFXIV.Client.System.Framework;
using FFXIVClientStructs.FFXIV.Client.UI.Agent;
using FFXIVClientStructs.FFXIV.Client.UI.Info;
using FFXIVClientStructs.FFXIV.Component.GUI;
namespace ChatTwo.GameFunctions;
internal sealed unsafe class Context
{
// TODO: Replace with CS version after https://github.com/aers/FFXIVClientStructs/pull/873 got merged
[Signature("E8 ?? ?? ?? ?? E9 ?? ?? ?? ?? 48 8B CB E8 ?? ?? ?? ?? 45 33 C9", Fallibility = Fallibility.Fallible)]
private readonly delegate* unmanaged<IntPtr, ulong, ushort, byte*, byte> InviteToNoviceNetworkNative = null!;
[Signature("E8 ?? ?? ?? ?? EB 35 BA", Fallibility = Fallibility.Fallible)]
private readonly delegate* unmanaged<uint, uint, ulong, uint, byte, byte> TryOnNative = null!;
[Signature("E8 ?? ?? ?? ?? EB 7B 49 8B 06", Fallibility = Fallibility.Fallible)]
private readonly delegate* unmanaged<AgentInterface*, uint, void> LinkItemNative = null!;
[Signature("E8 ?? ?? ?? ?? EB 3F 83 F8 FE", Fallibility = Fallibility.Fallible)]
private readonly delegate* unmanaged<AgentInterface*, ushort, uint, byte, void> ItemComparisonNative = null!;
[Signature("48 89 5C 24 ?? 57 48 83 EC ?? 8B FA B8", Fallibility = Fallibility.Fallible)]
private readonly delegate* unmanaged<IntPtr, uint, void> SearchForRecipesUsingItemNative = null!;
[Signature("E8 ?? ?? ?? ?? EB 45 45 33 C9", Fallibility = Fallibility.Fallible)]
private readonly delegate* unmanaged<void*, uint, byte, void> SearchForItemNative = null!;
private Plugin Plugin { get; }
internal Context(Plugin plugin)
@@ -40,7 +33,7 @@ internal sealed unsafe class Context
return;
// 6.3: 221EFD
var a1 = Plugin.Functions.GetInfoProxyByIndex(0x14);
var a1 = Plugin.Functions.GetInfoProxyByIndex((InfoProxyId) 0x14);
// can specify content id if we have it, but there's no need
fixed (byte* namePtr = name.ToTerminatedBytes()) {
@@ -58,10 +51,7 @@ internal sealed unsafe class Context
internal void TryOn(uint itemId, byte stainId)
{
if (TryOnNative == null)
return;
TryOnNative(0xFF, itemId, stainId, 0, 0);
AgentTryon.TryOn(0xFF, itemId, stainId, 0, 0);
}
internal void LinkItem(uint itemId)
@@ -84,19 +74,11 @@ internal sealed unsafe class Context
internal void SearchForRecipesUsingItem(uint itemId)
{
if (SearchForRecipesUsingItemNative == null)
return;
var a1 = (nint) AgentModule.Instance()->GetAgentByInternalId(AgentId.RecipeProductList);
SearchForRecipesUsingItemNative(a1, itemId);
AgentRecipeProductList.Instance()->SearchForRecipesUsingItem(itemId);
}
internal void SearchForItem(uint itemId)
{
if (SearchForItemNative == null)
return;
var itemFinder = Framework.Instance()->GetUiModule()->GetItemFinderModule();
SearchForItemNative(itemFinder, itemId, 1);
Framework.Instance()->GetUiModule()->GetItemFinderModule()->SearchForItem(itemId, true);
}
}
ChatTwo/GameFunctions/GameFunctions.cs
+2 -2
View File
@@ -60,13 +60,13 @@ internal unsafe class GameFunctions : IDisposable
Marshal.FreeHGlobal(PlaceholderNamePtr);
}
internal nint GetInfoProxyByIndex(uint idx)
internal nint GetInfoProxyByIndex(InfoProxyId proxyId)
{
var infoModule = InfoModule.Instance();
if (infoModule == null)
return nint.Zero;
return (nint) infoModule->GetInfoProxyById(idx);
return (nint) infoModule->GetInfoProxyById(proxyId);
}
internal int GetCurrentChatLogEntryIndex()
ChatTwo/GameFunctions/Party.cs
+5 -3
View File
@@ -2,12 +2,14 @@ using ChatTwo.Util;
using Dalamud.Utility.Signatures;
using FFXIVClientStructs.FFXIV.Client.System.Framework;
using FFXIVClientStructs.FFXIV.Client.UI.Agent;
using FFXIVClientStructs.FFXIV.Client.UI.Info;
using FFXIVClientStructs.FFXIV.Component.GUI;
namespace ChatTwo.GameFunctions;
internal sealed unsafe class Party
{
// TODO: Replace all hooks with CS after https://github.com/aers/FFXIVClientStructs/pull/872 got merged
[Signature("E8 ?? ?? ?? ?? 33 C0 EB 51", Fallibility = Fallibility.Fallible)]
private readonly delegate* unmanaged<IntPtr, ulong, byte*, ushort, byte> InviteToPartyNative = null!;
@@ -37,7 +39,7 @@ internal sealed unsafe class Party
return;
// 6.11: 214A55
var a1 = Plugin.Functions.GetInfoProxyByIndex(2);
var a1 = Plugin.Functions.GetInfoProxyByIndex(InfoProxyId.PartyInvite);
// this only works if target is on the same world
fixed (byte* namePtr = name.ToTerminatedBytes()) {
@@ -51,7 +53,7 @@ internal sealed unsafe class Party
return;
// 6.11: 214A55
var a1 = Plugin.Functions.GetInfoProxyByIndex(2);
var a1 = Plugin.Functions.GetInfoProxyByIndex(InfoProxyId.PartyInvite);
// third param is world, but it requires a specific world
// if they're not on that world, it will fail
@@ -67,7 +69,7 @@ internal sealed unsafe class Party
return;
// 6.11: 214A55
var a1 = Plugin.Functions.GetInfoProxyByIndex(2);
var a1 = Plugin.Functions.GetInfoProxyByIndex(InfoProxyId.PartyInvite);
// third param is world, but it requires a specific world
// if they're not on that world, it will fail