ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Rewrite parts of ClientState (#2065)

Browse source 
- Completely relies on hooks now, instead of the Framework.Update loop
- Support for Logout codes
This commit is contained in:
Haselnussbomber 2024-11-11 17:28:40 +01:00 • committed by GitHub
parent c88e008672
commit c7facaf072
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 120 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

165
Dalamud/Game/ClientState/ClientState.cs
View file

@ -14,6 +14,7 @@ using Dalamud.Logging.Internal;
using Dalamud.Plugin.Services;
using Dalamud.Utility;
using FFXIVClientStructs.FFXIV.Application.Network;
using FFXIVClientStructs.FFXIV.Client.Game;
using FFXIVClientStructs.FFXIV.Client.Game.Event;
using FFXIVClientStructs.FFXIV.Client.UI;
@ -37,16 +38,12 @@ internal sealed class ClientState : IInternalDisposableService, IClientState
private readonly ClientStateAddressResolver address;
private readonly Hook<SetupTerritoryTypeDelegate> setupTerritoryTypeHook;
private readonly Hook<UIModule.Delegates.HandlePacket> uiModuleHandlePacketHook;
[ServiceManager.ServiceDependency]
private readonly Framework framework = Service<Framework>.Get();
private readonly Hook<ProcessPacketPlayerSetupDelegate> processPacketPlayerSetupHook;
private readonly Hook<LogoutCallbackInterface.Delegates.OnLogout> onLogoutHook;
[ServiceManager.ServiceDependency]
private readonly NetworkHandlers networkHandlers = Service<NetworkHandlers>.Get();
private bool lastConditionNone = true;
private bool lastFramePvP;
[ServiceManager.ServiceConstructor]
private unsafe ClientState(TargetSigScanner sigScanner, Dalamud dalamud, GameLifecycle lifecycle)
{
@ -62,18 +59,22 @@ internal sealed class ClientState : IInternalDisposableService, IClientState
this.setupTerritoryTypeHook = Hook<SetupTerritoryTypeDelegate>.FromAddress(this.address.SetupTerritoryType, this.SetupTerritoryTypeDetour);
this.uiModuleHandlePacketHook = Hook<UIModule.Delegates.HandlePacket>.FromAddress((nint)UIModule.StaticVirtualTablePointer->HandlePacket, this.UIModuleHandlePacketDetour);
this.framework.Update += this.FrameworkOnOnUpdateEvent;
this.processPacketPlayerSetupHook = Hook<ProcessPacketPlayerSetupDelegate>.FromAddress(this.address.ProcessPacketPlayerSetup, this.ProcessPacketPlayerSetupDetour);
this.onLogoutHook = Hook<LogoutCallbackInterface.Delegates.OnLogout>.FromAddress((nint)LogoutCallbackInterface.StaticVirtualTablePointer->OnLogout, this.OnLogoutDetour);
this.networkHandlers.CfPop += this.NetworkHandlersOnCfPop;
this.setupTerritoryTypeHook.Enable();
this.uiModuleHandlePacketHook.Enable();
this.processPacketPlayerSetupHook.Enable();
this.onLogoutHook.Enable();
}
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
private unsafe delegate void SetupTerritoryTypeDelegate(EventFramework* eventFramework, ushort terriType);
private unsafe delegate void ProcessPacketPlayerSetupDelegate(nint a1, nint packet);
/// <inheritdoc/>
public event Action<ushort>? TerritoryChanged;
@ -87,7 +88,7 @@ internal sealed class ClientState : IInternalDisposableService, IClientState
public event Action? Login;
/// <inheritdoc/>
public event Action? Logout;
public event IClientState.LogoutDelegate? Logout;
/// <inheritdoc/>
public event Action? EnterPvP;
@ -165,23 +166,46 @@ internal sealed class ClientState : IInternalDisposableService, IClientState
{
this.setupTerritoryTypeHook.Dispose();
this.uiModuleHandlePacketHook.Dispose();
this.framework.Update -= this.FrameworkOnOnUpdateEvent;
this.processPacketPlayerSetupHook.Dispose();
this.onLogoutHook.Dispose();
this.networkHandlers.CfPop -= this.NetworkHandlersOnCfPop;
}
private unsafe void SetupTerritoryTypeDetour(EventFramework* eventFramework, ushort territoryType)
{
Log.Debug("TerritoryType changed: {0}", territoryType);
this.TerritoryType = territoryType;
this.TerritoryChanged?.InvokeSafely(territoryType);
Log.Debug("TerritoryType changed: {0}", territoryType);
var rowRef = LuminaUtils.CreateRef<TerritoryType>(territoryType);
if (rowRef.IsValid)
{
var isPvP = rowRef.Value.IsPvpZone;
if (isPvP != this.IsPvP)
{
this.IsPvP = isPvP;
this.IsPvPExcludingDen = this.IsPvP && this.TerritoryType != 250;
if (this.IsPvP)
{
Log.Debug("EnterPvP");
this.EnterPvP?.InvokeSafely();
}
else
{
Log.Debug("LeavePvP");
this.LeavePvP?.InvokeSafely();
}
}
}
this.setupTerritoryTypeHook.Original(eventFramework, territoryType);
}
private unsafe void UIModuleHandlePacketDetour(UIModule* thisPtr, UIModulePacketType type, uint uintParam, void* packet)
{
this.uiModuleHandlePacketHook!.Original(thisPtr, type, uintParam, packet);
this.uiModuleHandlePacketHook.Original(thisPtr, type, uintParam, packet);
switch (type)
{
@ -226,59 +250,74 @@ internal sealed class ClientState : IInternalDisposableService, IClientState
}
}
private unsafe void ProcessPacketPlayerSetupDetour(nint a1, nint packet)
{
// Call original first, so everything is set up.
this.processPacketPlayerSetupHook.Original(a1, packet);
var gameGui = Service<GameGui>.GetNullable();
try
{
Log.Debug("Login");
this.IsLoggedIn = true;
this.Login?.InvokeSafely();
gameGui?.ResetUiHideState();
this.lifecycle.ResetLogout();
}
catch (Exception ex)
{
Log.Error(ex, "Exception during ProcessPacketPlayerSetupDetour");
}
}
private unsafe void OnLogoutDetour(LogoutCallbackInterface* thisPtr, LogoutCallbackInterface.LogoutParams* logoutParams)
{
var gameGui = Service<GameGui>.GetNullable();
if (logoutParams != null)
{
try
{
var type = logoutParams->Type;
var code = logoutParams->Code;
Log.Debug("Logout: Type {type}, Code {code}", type, code);
this.IsLoggedIn = false;
if (this.Logout is { } callback)
{
foreach (var action in callback.GetInvocationList().Cast<IClientState.LogoutDelegate>())
{
try
{
action(type, code);
}
catch (Exception ex)
{
Log.Error(ex, "Exception during raise of {handler}", action.Method);
}
}
}
gameGui?.ResetUiHideState();
this.lifecycle.SetLogout();
}
catch (Exception ex)
{
Log.Error(ex, "Exception during OnLogoutDetour");
}
}
this.onLogoutHook.Original(thisPtr, logoutParams);
}
private void NetworkHandlersOnCfPop(ContentFinderCondition e)
{
this.CfPop?.InvokeSafely(e);
}
private void FrameworkOnOnUpdateEvent(IFramework framework1)
{
var condition = Service<Conditions.Condition>.GetNullable();
var gameGui = Service<GameGui>.GetNullable();
var data = Service<DataManager>.GetNullable();
if (condition == null || gameGui == null || data == null)
return;
if (condition.Any() && this.lastConditionNone && this.LocalPlayer != null)
{
Log.Debug("Is login");
this.lastConditionNone = false;
this.IsLoggedIn = true;
this.Login?.InvokeSafely();
gameGui.ResetUiHideState();
this.lifecycle.ResetLogout();
}
if (!condition.Any() && this.lastConditionNone == false)
{
Log.Debug("Is logout");
this.lastConditionNone = true;
this.IsLoggedIn = false;
this.Logout?.InvokeSafely();
gameGui.ResetUiHideState();
this.lifecycle.SetLogout();
}
this.IsPvP = GameMain.IsInPvPArea();
this.IsPvPExcludingDen = this.IsPvP && this.TerritoryType != 250;
if (this.IsPvP != this.lastFramePvP)
{
this.lastFramePvP = this.IsPvP;
if (this.IsPvP)
{
this.EnterPvP?.InvokeSafely();
}
else
{
this.LeavePvP?.InvokeSafely();
}
}
}
}
/// <summary>
@ -322,7 +361,7 @@ internal class ClientStatePluginScoped : IInternalDisposableService, IClientStat
public event Action? Login;
/// <inheritdoc/>
public event Action? Logout;
public event IClientState.LogoutDelegate? Logout;
/// <inheritdoc/>
public event Action? EnterPvP;
@ -394,7 +433,7 @@ internal class ClientStatePluginScoped : IInternalDisposableService, IClientStat
private void LoginForward() => this.Login?.Invoke();
private void LogoutForward() => this.Logout?.Invoke();
private void LogoutForward(int type, int code) => this.Logout?.Invoke(type, code);
private void EnterPvPForward() => this.EnterPvP?.Invoke();

7
Dalamud/Game/ClientState/ClientStateAddressResolver.cs
View file

@ -57,6 +57,11 @@ internal sealed class ClientStateAddressResolver : BaseAddressResolver
/// </summary>
public IntPtr SetupTerritoryType { get; private set; }
/// <summary>
/// Gets the address of the method which sets up the player.
/// </summary>
public IntPtr ProcessPacketPlayerSetup { get; private set; }
/// <summary>
/// Gets the address of the method which polls the gamepads for data.
/// Called every frame, even when `Enable Gamepad` is off in the settings.
@ -82,6 +87,8 @@ internal sealed class ClientStateAddressResolver : BaseAddressResolver
this.SetupTerritoryType = sig.ScanText("48 89 5C 24 ?? 48 89 6C 24 ?? 57 48 83 EC 20 0F B7 DA");
this.ProcessPacketPlayerSetup = sig.ScanText("40 53 48 83 EC 20 48 8D 0D ?? ?? ?? ?? 48 8B DA E8 ?? ?? ?? ?? 48 8B D3");
// These resolve to fixed offsets only, without the base address added in, so GetStaticAddressFromSig() can't be used.
// lea rcx, ds:1DB9F74h[rax*4] KeyboardState
// movzx edx, byte ptr [rbx+rsi+1D5E0E0h] KeyboardStateIndexArray

2
Dalamud/Interface/Internal/Windows/SelfTest/AgingSteps/LogoutEventAgingStep.cs
View file

@ -50,7 +50,7 @@ internal class LogoutEventAgingStep : IAgingStep
}
}
private void ClientStateOnOnLogout()
private void ClientStateOnOnLogout(int type, int code)
{
this.hasPassed = true;
}

4
Dalamud/Plugin/Internal/AutoUpdate/AutoUpdateManager.cs
View file

@ -1,4 +1,4 @@
using System.Collections.Generic;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
@ -89,7 +89,7 @@ internal class AutoUpdateManager : IServiceType
t =>
{
t.Result.Login += this.OnLogin;
t.Result.Logout += this.OnLogout;
t.Result.Logout += (int type, int code) => this.OnLogout();
});
Service<Framework>.GetAsync().ContinueWith(t => { t.Result.Update += this.OnUpdate; });

9
Dalamud/Plugin/Services/IClientState.cs
View file

@ -22,6 +22,13 @@ public interface IClientState
/// <param name="level">The level of the corresponding ClassJob.</param>
public delegate void LevelChangeDelegate(uint classJobId, uint level);
/// <summary>
/// A delegate type used for the <see cref="Logout"/> event.
/// </summary>
/// <param name="type">The type of logout.</param>
/// <param name="code">The success/failure code.</param>
public delegate void LogoutDelegate(int type, int code);
/// <summary>
/// Event that gets fired when the current Territory changes.
/// </summary>
@ -46,7 +53,7 @@ public interface IClientState
/// <summary>
/// Event that fires when a character is logging out.
/// </summary>
public event Action Logout;
public event LogoutDelegate Logout;
/// <summary>
/// Event that fires when a character is entering PvP.