ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2026-02-13 11:27:42 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add support for Titles to IUnlockState

Browse source
This commit is contained in:
Haselnussbomber 2026-01-30 12:28:05 +01:00 • committed by Blair
parent 907b585b75
commit 1ba18e54bf
2 changed files with 58 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

48
Dalamud/Game/UnlockState/UnlockState.cs
View file

@ -50,6 +50,7 @@ internal unsafe class UnlockState : IInternalDisposableService, IUnlockState
private readonly ConcurrentDictionary<Type, HashSet<uint>> cachedUnlockedRowIds = [];
private readonly Hook<SetAchievementCompletedDelegate> setAchievementCompletedHook;
private readonly Hook<SetTitleUnlockedDelegate> setTitleUnlockedHook;
[ServiceManager.ServiceConstructor]
private UnlockState()
@ -62,17 +63,27 @@ internal unsafe class UnlockState : IInternalDisposableService, IUnlockState
this.sigScanner.ScanText("81 FA ?? ?? ?? ?? 0F 87 ?? ?? ?? ?? 53"),
this.SetAchievementCompletedDetour);
this.setTitleUnlockedHook = Hook<SetTitleUnlockedDelegate>.FromAddress(
this.sigScanner.ScanText("B8 ?? ?? ?? ?? 66 3B D0 73 ?? 44 0F B7 C2 49 C1 E8 ?? 4C 03 C1 0F B7 C2 83 E0 ?? 41 0F B6 48 ?? 0F AB C1"),
this.SetTitleUnlockedDetour);
this.setAchievementCompletedHook.Enable();
this.setTitleUnlockedHook.Enable();
}
private delegate void SetAchievementCompletedDelegate(CSAchievement* thisPtr, uint id);
private delegate void SetTitleUnlockedDelegate(TitleList* thisPtr, ushort id);
/// <inheritdoc/>
public event IUnlockState.UnlockDelegate Unlock;
/// <inheritdoc/>
public bool IsAchievementListLoaded => CSAchievement.Instance()->IsLoaded();
/// <inheritdoc/>
public bool IsTitleListLoaded => UIState.Instance()->TitleList.DataReceived;
private bool IsLoaded => PlayerState.Instance()->IsLoaded;
/// <inheritdoc/>
@ -448,6 +459,19 @@ internal unsafe class UnlockState : IInternalDisposableService, IUnlockState
return PlayerState.Instance()->IsSecretRecipeBookUnlocked(row.RowId);
}
/// <inheritdoc/>
public bool IsTitleUnlocked(Title row)
{
// Only check for login state here as individual Titles
// may be flagged as complete when you unlock them, regardless
// of whether the full Titles list was loaded or not.
if (!this.IsLoaded)
return false;
return UIState.Instance()->TitleList.IsTitleUnlocked((ushort)row.RowId);
}
/// <inheritdoc/>
public bool IsTraitUnlocked(Trait row)
{
@ -608,6 +632,9 @@ internal unsafe class UnlockState : IInternalDisposableService, IUnlockState
if (rowRef.TryGetValue<SecretRecipeBook>(out var secretRecipeBookRow))
return this.IsSecretRecipeBookUnlocked(secretRecipeBookRow);
if (rowRef.TryGetValue<Title>(out var titleRow))
return this.IsTitleUnlocked(titleRow);
if (rowRef.TryGetValue<Trait>(out var traitRow))
return this.IsTraitUnlocked(traitRow);
@ -667,14 +694,24 @@ internal unsafe class UnlockState : IInternalDisposableService, IUnlockState
this.RaiseUnlockSafely((RowRef)LuminaUtils.CreateRef<AchievementSheet>(id));
}
private void SetTitleUnlockedDetour(TitleList* thisPtr, ushort id)
{
this.setTitleUnlockedHook.Original(thisPtr, id);
if (!this.IsLoaded)
return;
this.RaiseUnlockSafely((RowRef)LuminaUtils.CreateRef<Title>(id));
}
private void Update()
{
if (!this.IsLoaded)
return;
Log.Verbose("Checking for new unlocks...");
// Do not check for Achievements here!
// Do not check for Achievements or Titles here!
this.UpdateUnlocksForSheet<ActionSheet>();
this.UpdateUnlocksForSheet<AetherCurrent>();
@ -736,7 +773,6 @@ internal unsafe class UnlockState : IInternalDisposableService, IUnlockState
// - EmjCostume
// Probably not happening, because it requires fetching data from server:
// - Titles
// - Bozjan Field Notes
// - Support/Phantom Jobs, which require to be in Occult Crescent, because it checks the jobs level for != 0
}
@ -806,6 +842,9 @@ internal class UnlockStatePluginScoped : IInternalDisposableService, IUnlockStat
/// <inheritdoc/>
public bool IsAchievementListLoaded => this.unlockStateService.IsAchievementListLoaded;
/// <inheritdoc/>
public bool IsTitleListLoaded => this.unlockStateService.IsTitleListLoaded;
/// <inheritdoc/>
public bool IsAchievementComplete(AchievementSheet row) => this.unlockStateService.IsAchievementComplete(row);
@ -932,6 +971,9 @@ internal class UnlockStatePluginScoped : IInternalDisposableService, IUnlockStat
/// <inheritdoc/>
public bool IsSecretRecipeBookUnlocked(SecretRecipeBook row) => this.unlockStateService.IsSecretRecipeBookUnlocked(row);
/// <inheritdoc/>
public bool IsTitleUnlocked(Title row) => this.unlockStateService.IsTitleUnlocked(row);
/// <inheritdoc/>
public bool IsTraitUnlocked(Trait row) => this.unlockStateService.IsTraitUnlocked(row);

13
Dalamud/Plugin/Services/IUnlockState.cs
View file

@ -26,6 +26,11 @@ public interface IUnlockState : IDalamudService
/// </summary>
bool IsAchievementListLoaded { get; }
/// <summary>
/// Gets a value indicating whether the full Titles list was received.
/// </summary>
bool IsTitleListLoaded { get; }
/// <summary>
/// Determines whether the specified Achievement is completed.<br/>
/// Requires that the player requested the Achievements list (can be chcked with <see cref="IsAchievementListLoaded"/>).
@ -322,6 +327,14 @@ public interface IUnlockState : IDalamudService
/// <returns><see langword="true"/> if unlocked; otherwise, <see langword="false"/>.</returns>
bool IsSecretRecipeBookUnlocked(SecretRecipeBook row);
/// <summary>
/// Determines whether the specified Title is unlocked.<br/>
/// Requires that the player requested the Titles list (can be chcked with <see cref="IsTitleListLoaded"/>).
/// </summary>
/// <param name="row">The Title row to check.</param>
/// <returns><see langword="true"/> if unlocked; otherwise, <see langword="false"/>.</returns>
bool IsTitleUnlocked(Title row);
/// <summary>
/// Determines whether the specified Trait is unlocked.
/// </summary>