Continuing work on the IPC

ArmatureChanged.Type.Rebound -> Updated
IsPendingProfileRebind is now being set instead of calling RebuildBoneTemplateBinding and that function is called as a part of rebind process (not always though, pending rewrite)
Profiles can no longer be toggled in the UI while editor is active
ProfileChanged is no longer used in IPC, instead we are fully relying on armature events
Added warnings to legacy IPC messages to not use it
This commit is contained in:
RisaDev
2024-03-24 23:45:28 +03:00
parent 3a74a50e39
commit 6777f9db6e
9 changed files with 72 additions and 68 deletions

View File

@@ -25,7 +25,7 @@ using Penumbra.GameData.Interop;
namespace CustomizePlus.Api.Compatibility;
[Obsolete("Will be removed in the next release")]
[Obsolete("Will be removed in the near future, do not use this IPC")]
public class CustomizePlusLegacyIpc : IDisposable
{
private readonly IObjectTable _objectTable;
@@ -73,7 +73,7 @@ public class CustomizePlusLegacyIpc : IDisposable
InitializeProviders();
_profileChangedEvent.Subscribe(OnProfileChange, ProfileChanged.Priority.CustomizePlusIpc);
_profileChangedEvent.Subscribe(OnProfileChange, ProfileChanged.Priority.CustomizePlusLegacyIpc);
_armatureChangedEvent.Subscribe(OnArmatureChanged, ArmatureChanged.Priority.CustomizePlusIpc);
}
@@ -109,10 +109,10 @@ public class CustomizePlusLegacyIpc : IDisposable
return;
if (type == ArmatureChanged.Type.Created ||
type == ArmatureChanged.Type.Rebound)
type == ArmatureChanged.Type.Updated)
{
if(armature.Profile == null)
_logger.Warning("Armature created/rebound and profile is null");
_logger.Warning("[LEGACY IPC DO NOT USE] Armature created/rebound and profile is null");
OnProfileUpdate(armature.Profile);
return;
@@ -127,7 +127,7 @@ public class CustomizePlusLegacyIpc : IDisposable
private void InitializeProviders()
{
_logger.Debug("Initializing legacy Customize+ IPC providers.");
_logger.Debug("[LEGACY IPC DO NOT USE] Initializing legacy Customize+ IPC providers.");
try
{
ProviderGetApiVersion = _pluginInterface.GetIpcProvider<(int, int)>(ProviderApiVersionLabel);
@@ -135,7 +135,7 @@ public class CustomizePlusLegacyIpc : IDisposable
}
catch (Exception ex)
{
_logger.Error($"Error registering legacy Customize+ IPC provider for {ProviderApiVersionLabel}: {ex}");
_logger.Error($"[LEGACY IPC DO NOT USE] Error registering legacy Customize+ IPC provider for {ProviderApiVersionLabel}: {ex}");
}
try
@@ -146,7 +146,7 @@ public class CustomizePlusLegacyIpc : IDisposable
}
catch (Exception ex)
{
_logger.Error($"Error registering legacy Customize+ IPC provider for {GetProfileFromCharacterLabel}: {ex}");
_logger.Error($"[LEGACY IPC DO NOT USE] Error registering legacy Customize+ IPC provider for {GetProfileFromCharacterLabel}: {ex}");
}
try
@@ -157,7 +157,7 @@ public class CustomizePlusLegacyIpc : IDisposable
}
catch (Exception ex)
{
_logger.Error($"Error registering legacy Customize+ IPC provider for {SetProfileToCharacterLabel}: {ex}");
_logger.Error($"[LEGACY IPC DO NOT USE] Error registering legacy Customize+ IPC provider for {SetProfileToCharacterLabel}: {ex}");
}
try
@@ -168,7 +168,7 @@ public class CustomizePlusLegacyIpc : IDisposable
}
catch (Exception ex)
{
_logger.Error($"Error registering legacy Customize+ IPC provider for {RevertCharacterLabel}: {ex}");
_logger.Error($"[LEGACY IPC DO NOT USE] Error registering legacy Customize+ IPC provider for {RevertCharacterLabel}: {ex}");
}
try
@@ -177,7 +177,7 @@ public class CustomizePlusLegacyIpc : IDisposable
}
catch (Exception ex)
{
_logger.Error($"Error registering legacy Customize+ IPC provider for {OnProfileUpdateLabel}: {ex}");
_logger.Error($"[LEGACY IPC DO NOT USE] Error registering legacy Customize+ IPC provider for {OnProfileUpdateLabel}: {ex}");
}
}
@@ -192,7 +192,7 @@ public class CustomizePlusLegacyIpc : IDisposable
private void OnProfileUpdate(Profile? profile)
{
_logger.Debug($"Sending local player update message: {(profile != null ? profile.ToString() : "no profile")}");
_logger.Debug($"[LEGACY IPC DO NOT USE] Sending local player update message: {(profile != null ? profile.ToString() : "no profile")}");
var convertedProfile = profile != null ? GetVersion3Profile(profile) : null;
@@ -246,7 +246,7 @@ public class CustomizePlusLegacyIpc : IDisposable
}
catch (Exception ex)
{
_logger.Warning($"Unable to set body profile. Character: {character?.Name}, exception: {ex}, debug data: {GetBase64String(profileJson)}");
_logger.Warning($"[LEGACY IPC DO NOT USE] Unable to set body profile. Character: {character?.Name}, exception: {ex}, debug data: {GetBase64String(profileJson)}");
}
}

View File

@@ -270,27 +270,6 @@ public partial class CustomizePlusIpc
}
//warn: limitation - ignores default profiles but why you would use default profile on your own character
private void OnProfileChange(ProfileChanged.Type type, Profile? profile, object? arg3)
{
if (type != ProfileChanged.Type.AddedTemplate &&
type != ProfileChanged.Type.RemovedTemplate &&
type != ProfileChanged.Type.MovedTemplate &&
type != ProfileChanged.Type.ChangedTemplate &&
type != ProfileChanged.Type.Toggled)
return;
if (profile == null ||
!profile.Enabled || //profile = null event will be sent from OnArmatureChanged
profile.CharacterName.Text != _gameObjectService.GetCurrentPlayerName())
return;
Character? localPlayerCharacter = (Character?)_gameObjectService.GetDalamudGameObjectFromActor(_gameObjectService.GetLocalPlayerActor());
if (localPlayerCharacter == null)
return;
OnProfileUpdateInternal(localPlayerCharacter, profile);
}
private void OnArmatureChanged(ArmatureChanged.Type type, Armature armature, object? arg3)
{
string currentPlayerName = _gameObjectService.GetCurrentPlayerName();
@@ -302,13 +281,34 @@ public partial class CustomizePlusIpc
if (localPlayerCharacter == null)
return;
if (type == ArmatureChanged.Type.Created || //todo: might create second call after OnProfileChange?
type == ArmatureChanged.Type.Rebound)
if (type == ArmatureChanged.Type.Created ||
type == ArmatureChanged.Type.Updated)
{
if (armature.Profile == null)
_logger.Warning("Armature created/rebound and profile is null");
_logger.Fatal("INTEGRITY ERROR: Armature created/rebound and profile is null");
OnProfileUpdateInternal(localPlayerCharacter, armature.Profile);
(Profile? activeProfile, Profile? oldProfile) = (null, null);
if (type == ArmatureChanged.Type.Created)
(activeProfile, oldProfile) = ((Profile?)arg3, null);
else
(activeProfile, oldProfile) = ((Profile?, Profile?))arg3;
if (activeProfile != null)
{
if (activeProfile == _profileManager.DefaultProfile)
return; //default profiles are not allowed to be sent
if (activeProfile.ProfileType == ProfileType.Editor)
{
if (activeProfile == oldProfile) //ignore any changes while player is in editor
return;
OnProfileUpdateInternal(localPlayerCharacter, null); //send empty profile when player enters editor
return;
}
}
OnProfileUpdateInternal(localPlayerCharacter, activeProfile);
return;
}

View File

@@ -18,7 +18,6 @@ public partial class CustomizePlusIpc : IDisposable
private readonly ProfileManager _profileManager;
private readonly GameObjectService _gameObjectService;
private readonly ProfileChanged _profileChangedEvent;
private readonly ArmatureChanged _armatureChangedEvent;
/// <summary>
@@ -32,8 +31,7 @@ public partial class CustomizePlusIpc : IDisposable
HookingService hookingService,
ProfileManager profileManager,
GameObjectService gameObjectService,
ArmatureChanged armatureChangedEvent,
ProfileChanged profileChangedEvent)
ArmatureChanged armatureChangedEvent)
{
_pluginInterface = pluginInterface;
_logger = logger;
@@ -41,19 +39,15 @@ public partial class CustomizePlusIpc : IDisposable
_profileManager = profileManager;
_gameObjectService = gameObjectService;
_profileChangedEvent = profileChangedEvent;
_armatureChangedEvent = armatureChangedEvent;
EzIPC.Init(this, "CustomizePlus");
_profileChangedEvent.Subscribe(OnProfileChange, ProfileChanged.Priority.CustomizePlusIpc);
_armatureChangedEvent.Subscribe(OnArmatureChanged, ArmatureChanged.Priority.CustomizePlusIpc);
}
public void Dispose()
{
_profileChangedEvent.Unsubscribe(OnProfileChange);
_armatureChangedEvent.Unsubscribe(OnArmatureChanged);
}
}