mirror of
https://github.com/xivdev/Penumbra.git
synced 2025-12-12 10:17:22 +01:00
338 lines
No EOL
14 KiB
C#
338 lines
No EOL
14 KiB
C#
using System;
|
|
using System.Runtime.InteropServices;
|
|
using Dalamud.Hooking;
|
|
using Dalamud.Utility.Signatures;
|
|
using Penumbra.Collections;
|
|
using Penumbra.GameData.Enums;
|
|
using Penumbra.String;
|
|
using Penumbra.String.Classes;
|
|
using GameObject = FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject;
|
|
|
|
namespace Penumbra.Interop.Resolver;
|
|
|
|
public unsafe partial class PathResolver
|
|
{
|
|
public class AnimationState
|
|
{
|
|
private readonly DrawObjectState _drawObjectState;
|
|
|
|
private ResolveData _animationLoadData = ResolveData.Invalid;
|
|
private ResolveData _characterSoundData = ResolveData.Invalid;
|
|
|
|
public AnimationState( DrawObjectState drawObjectState )
|
|
{
|
|
_drawObjectState = drawObjectState;
|
|
SignatureHelper.Initialise( this );
|
|
}
|
|
|
|
public bool HandleFiles( ResourceType type, Utf8GamePath _, out ResolveData resolveData )
|
|
{
|
|
switch( type )
|
|
{
|
|
case ResourceType.Scd:
|
|
if( _characterSoundData.Valid )
|
|
{
|
|
resolveData = _characterSoundData;
|
|
return true;
|
|
}
|
|
|
|
if( _animationLoadData.Valid )
|
|
{
|
|
resolveData = _animationLoadData;
|
|
return true;
|
|
}
|
|
|
|
break;
|
|
case ResourceType.Tmb:
|
|
case ResourceType.Pap:
|
|
case ResourceType.Avfx:
|
|
case ResourceType.Atex:
|
|
if( _animationLoadData.Valid )
|
|
{
|
|
resolveData = _animationLoadData;
|
|
return true;
|
|
}
|
|
|
|
break;
|
|
}
|
|
|
|
resolveData = ResolveData.Invalid;
|
|
return false;
|
|
}
|
|
|
|
public void Enable()
|
|
{
|
|
_loadTimelineResourcesHook.Enable();
|
|
_characterBaseLoadAnimationHook.Enable();
|
|
_loadSomePapHook.Enable();
|
|
_someActionLoadHook.Enable();
|
|
_loadCharacterSoundHook.Enable();
|
|
_loadCharacterVfxHook.Enable();
|
|
_loadAreaVfxHook.Enable();
|
|
|
|
//_loadSomeAvfxHook.Enable();
|
|
//_someOtherAvfxHook.Enable();
|
|
}
|
|
|
|
public void Disable()
|
|
{
|
|
_loadTimelineResourcesHook.Disable();
|
|
_characterBaseLoadAnimationHook.Disable();
|
|
_loadSomePapHook.Disable();
|
|
_someActionLoadHook.Disable();
|
|
_loadCharacterSoundHook.Disable();
|
|
_loadCharacterVfxHook.Disable();
|
|
_loadAreaVfxHook.Disable();
|
|
|
|
//_loadSomeAvfxHook.Disable();
|
|
//_someOtherAvfxHook.Disable();
|
|
}
|
|
|
|
public void Dispose()
|
|
{
|
|
_loadTimelineResourcesHook.Dispose();
|
|
_characterBaseLoadAnimationHook.Dispose();
|
|
_loadSomePapHook.Dispose();
|
|
_someActionLoadHook.Dispose();
|
|
_loadCharacterSoundHook.Dispose();
|
|
_loadCharacterVfxHook.Dispose();
|
|
_loadAreaVfxHook.Dispose();
|
|
|
|
//_loadSomeAvfxHook.Dispose();
|
|
//_someOtherAvfxHook.Dispose();
|
|
}
|
|
|
|
// Characters load some of their voice lines or whatever with this function.
|
|
private delegate IntPtr LoadCharacterSound( IntPtr character, int unk1, int unk2, IntPtr unk3, ulong unk4, int unk5, int unk6, ulong unk7 );
|
|
|
|
[Signature( "4C 89 4C 24 ?? 55 57 41 56", DetourName = nameof( LoadCharacterSoundDetour ) )]
|
|
private readonly Hook< LoadCharacterSound > _loadCharacterSoundHook = null!;
|
|
|
|
private IntPtr LoadCharacterSoundDetour( IntPtr character, int unk1, int unk2, IntPtr unk3, ulong unk4, int unk5, int unk6, ulong unk7 )
|
|
{
|
|
var last = _characterSoundData;
|
|
_characterSoundData = IdentifyCollection( ( GameObject* )character, true );
|
|
var ret = _loadCharacterSoundHook.Original( character, unk1, unk2, unk3, unk4, unk5, unk6, unk7 );
|
|
_characterSoundData = last;
|
|
return ret;
|
|
}
|
|
|
|
// The timeline object loads the requested .tmb and .pap files. The .tmb files load the respective .avfx files.
|
|
// We can obtain the associated game object from the timelines 28'th vfunc and use that to apply the correct collection.
|
|
private delegate ulong LoadTimelineResourcesDelegate( IntPtr timeline );
|
|
|
|
[Signature( "E8 ?? ?? ?? ?? 83 7F ?? ?? 75 ?? 0F B6 87", DetourName = nameof( LoadTimelineResourcesDetour ) )]
|
|
private readonly Hook< LoadTimelineResourcesDelegate > _loadTimelineResourcesHook = null!;
|
|
|
|
private ulong LoadTimelineResourcesDetour( IntPtr timeline )
|
|
{
|
|
TimingManager.StartTimer( TimingType.TimelineResources );
|
|
ulong ret;
|
|
var old = _animationLoadData;
|
|
try
|
|
{
|
|
if( timeline != IntPtr.Zero )
|
|
{
|
|
var getGameObjectIdx = ( ( delegate* unmanaged< IntPtr, int >** )timeline )[ 0 ][ 28 ];
|
|
var idx = getGameObjectIdx( timeline );
|
|
if( idx >= 0 && idx < Dalamud.Objects.Length )
|
|
{
|
|
var obj = Dalamud.Objects[ idx ];
|
|
_animationLoadData = obj != null ? IdentifyCollection( ( GameObject* )obj.Address, true ) : ResolveData.Invalid;
|
|
}
|
|
else
|
|
{
|
|
_animationLoadData = ResolveData.Invalid;
|
|
}
|
|
}
|
|
}
|
|
finally
|
|
{
|
|
ret = _loadTimelineResourcesHook.Original( timeline );
|
|
}
|
|
|
|
_animationLoadData = old;
|
|
|
|
TimingManager.StopTimer( TimingType.TimelineResources );
|
|
return ret;
|
|
}
|
|
|
|
// Probably used when the base idle animation gets loaded.
|
|
// Make it aware of the correct collection to load the correct pap files.
|
|
private delegate void CharacterBaseNoArgumentDelegate( IntPtr drawBase );
|
|
|
|
[Signature( "E8 ?? ?? ?? ?? BA ?? ?? ?? ?? 48 8B CF 44 8B C2 E8 ?? ?? ?? ?? 48 8B 05",
|
|
DetourName = nameof( CharacterBaseLoadAnimationDetour ) )]
|
|
private readonly Hook< CharacterBaseNoArgumentDelegate > _characterBaseLoadAnimationHook = null!;
|
|
|
|
private void CharacterBaseLoadAnimationDetour( IntPtr drawObject )
|
|
{
|
|
var last = _animationLoadData;
|
|
_animationLoadData = _drawObjectState.LastCreatedCollection.Valid
|
|
? _drawObjectState.LastCreatedCollection
|
|
: FindParent( drawObject, out var collection ) != null
|
|
? collection
|
|
: Penumbra.CollectionManager.Default.ToResolveData();
|
|
_characterBaseLoadAnimationHook.Original( drawObject );
|
|
_animationLoadData = last;
|
|
}
|
|
|
|
// Unknown what exactly this is but it seems to load a bunch of paps.
|
|
private delegate void LoadSomePap( IntPtr a1, int a2, IntPtr a3, int a4 );
|
|
|
|
[Signature( "48 89 5C 24 ?? 48 89 6C 24 ?? 48 89 74 24 ?? 57 41 56 41 57 48 83 EC ?? 41 8B D9 89 51",
|
|
DetourName = nameof( LoadSomePapDetour ) )]
|
|
private readonly Hook< LoadSomePap > _loadSomePapHook = null!;
|
|
|
|
private void LoadSomePapDetour( IntPtr a1, int a2, IntPtr a3, int a4 )
|
|
{
|
|
var timelinePtr = a1 + 0x50;
|
|
var last = _animationLoadData;
|
|
if( timelinePtr != IntPtr.Zero )
|
|
{
|
|
var actorIdx = ( int )( *( *( ulong** )timelinePtr + 1 ) >> 3 );
|
|
if( actorIdx >= 0 && actorIdx < Dalamud.Objects.Length )
|
|
{
|
|
_animationLoadData = IdentifyCollection( ( GameObject* )( Dalamud.Objects[ actorIdx ]?.Address ?? IntPtr.Zero ), true );
|
|
}
|
|
}
|
|
|
|
_loadSomePapHook.Original( a1, a2, a3, a4 );
|
|
_animationLoadData = last;
|
|
}
|
|
|
|
// Seems to load character actions when zoning or changing class, maybe.
|
|
[Signature( "E8 ?? ?? ?? ?? C6 83 ?? ?? ?? ?? ?? 8B 8E", DetourName = nameof( SomeActionLoadDetour ) )]
|
|
private readonly Hook< CharacterBaseNoArgumentDelegate > _someActionLoadHook = null!;
|
|
|
|
private void SomeActionLoadDetour( IntPtr gameObject )
|
|
{
|
|
var last = _animationLoadData;
|
|
_animationLoadData = IdentifyCollection( ( GameObject* )gameObject, true );
|
|
_someActionLoadHook.Original( gameObject );
|
|
_animationLoadData = last;
|
|
}
|
|
|
|
[StructLayout( LayoutKind.Explicit )]
|
|
private struct VfxParams
|
|
{
|
|
[FieldOffset( 0x118 )]
|
|
public uint GameObjectId;
|
|
|
|
[FieldOffset( 0x11C )]
|
|
public byte GameObjectType;
|
|
|
|
[FieldOffset( 0xD0 )]
|
|
public ushort TargetCount;
|
|
|
|
[FieldOffset( 0x120 )]
|
|
public fixed ulong Target[16];
|
|
}
|
|
|
|
private delegate IntPtr LoadCharacterVfxDelegate( byte* vfxPath, VfxParams* vfxParams, byte unk1, byte unk2, float unk3, int unk4 );
|
|
|
|
[Signature( "E8 ?? ?? ?? ?? 48 8B F8 48 8D 93", DetourName = nameof( LoadCharacterVfxDetour ) )]
|
|
private readonly Hook< LoadCharacterVfxDelegate > _loadCharacterVfxHook = null!;
|
|
|
|
private global::Dalamud.Game.ClientState.Objects.Types.GameObject? GetOwnedObject( uint id )
|
|
{
|
|
var owner = Dalamud.Objects.SearchById( id );
|
|
if( owner == null )
|
|
{
|
|
return null;
|
|
}
|
|
|
|
var idx = ( ( GameObject* )owner.Address )->ObjectIndex;
|
|
return Dalamud.Objects[ idx + 1 ];
|
|
}
|
|
|
|
private IntPtr LoadCharacterVfxDetour( byte* vfxPath, VfxParams* vfxParams, byte unk1, byte unk2, float unk3, int unk4 )
|
|
{
|
|
TimingManager.StartTimer( TimingType.LoadCharacterVfx );
|
|
var last = _animationLoadData;
|
|
if( vfxParams != null && vfxParams->GameObjectId != unchecked( ( uint )-1 ) )
|
|
{
|
|
var obj = vfxParams->GameObjectType switch
|
|
{
|
|
0 => Dalamud.Objects.SearchById( vfxParams->GameObjectId ),
|
|
2 => Dalamud.Objects[ ( int )vfxParams->GameObjectId ],
|
|
4 => GetOwnedObject( vfxParams->GameObjectId ),
|
|
_ => null,
|
|
};
|
|
_animationLoadData = obj != null
|
|
? IdentifyCollection( ( GameObject* )obj.Address, true )
|
|
: ResolveData.Invalid;
|
|
}
|
|
else
|
|
{
|
|
_animationLoadData = ResolveData.Invalid;
|
|
}
|
|
var ret = _loadCharacterVfxHook.Original( vfxPath, vfxParams, unk1, unk2, unk3, unk4 );
|
|
#if DEBUG
|
|
var path = new ByteString( vfxPath );
|
|
Penumbra.Log.Verbose(
|
|
$"Load Character VFX: {path} {vfxParams->GameObjectId:X} {vfxParams->TargetCount} {unk1} {unk2} {unk3} {unk4} -> {ret:X} {_animationLoadData.ModCollection.Name} {_animationLoadData.AssociatedGameObject} {last.ModCollection.Name} {last.AssociatedGameObject}" );
|
|
#endif
|
|
_animationLoadData = last;
|
|
TimingManager.StopTimer( TimingType.LoadCharacterVfx );
|
|
return ret;
|
|
}
|
|
|
|
private delegate IntPtr LoadAreaVfxDelegate( uint vfxId, float* pos, GameObject* caster, float unk1, float unk2, byte unk3 );
|
|
|
|
[Signature( "48 8B C4 53 55 56 57 41 56 48 81 EC", DetourName = nameof( LoadAreaVfxDetour ) )]
|
|
private readonly Hook< LoadAreaVfxDelegate > _loadAreaVfxHook = null!;
|
|
|
|
private IntPtr LoadAreaVfxDetour( uint vfxId, float* pos, GameObject* caster, float unk1, float unk2, byte unk3 )
|
|
{
|
|
TimingManager.StartTimer( TimingType.LoadAreaVfx );
|
|
var last = _animationLoadData;
|
|
if( caster != null )
|
|
{
|
|
_animationLoadData = IdentifyCollection( caster, true );
|
|
}
|
|
else
|
|
{
|
|
_animationLoadData = ResolveData.Invalid;
|
|
}
|
|
|
|
var ret = _loadAreaVfxHook.Original( vfxId, pos, caster, unk1, unk2, unk3 );
|
|
#if DEBUG
|
|
Penumbra.Log.Verbose(
|
|
$"Load Area VFX: {vfxId}, {pos[ 0 ]} {pos[ 1 ]} {pos[ 2 ]} {( caster != null ? new ByteString( caster->GetName() ).ToString() : "Unknown" )} {unk1} {unk2} {unk3} -> {ret:X} {_animationLoadData.ModCollection.Name} {_animationLoadData.AssociatedGameObject} {last.ModCollection.Name} {last.AssociatedGameObject}" );
|
|
#endif
|
|
_animationLoadData = last;
|
|
TimingManager.StopTimer( TimingType.LoadAreaVfx );
|
|
return ret;
|
|
}
|
|
|
|
|
|
// ========== Those hooks seem to be superseded by LoadCharacterVfx =========
|
|
|
|
// public delegate ulong LoadSomeAvfx( uint a1, IntPtr gameObject, IntPtr gameObject2, float unk1, IntPtr unk2, IntPtr unk3 );
|
|
//
|
|
// [Signature( "E8 ?? ?? ?? ?? 45 0F B6 F7", DetourName = nameof( LoadSomeAvfxDetour ) )]
|
|
// private readonly Hook<LoadSomeAvfx> _loadSomeAvfxHook = null!;
|
|
//
|
|
// private ulong LoadSomeAvfxDetour( uint a1, IntPtr gameObject, IntPtr gameObject2, float unk1, IntPtr unk2, IntPtr unk3 )
|
|
// {
|
|
// var last = _animationLoadData;
|
|
// _animationLoadData = IdentifyCollection( ( GameObject* )gameObject, true );
|
|
// var ret = _loadSomeAvfxHook.Original( a1, gameObject, gameObject2, unk1, unk2, unk3 );
|
|
// _animationLoadData = last;
|
|
// return ret;
|
|
// }
|
|
//
|
|
// [Signature( "E8 ?? ?? ?? ?? 44 84 A3", DetourName = nameof( SomeOtherAvfxDetour ) )]
|
|
// private readonly Hook<CharacterBaseNoArgumentDelegate> _someOtherAvfxHook = null!;
|
|
//
|
|
// private void SomeOtherAvfxDetour( IntPtr unk )
|
|
// {
|
|
// var last = _animationLoadData;
|
|
// var gameObject = ( GameObject* )( unk - 0x8D0 );
|
|
// _animationLoadData = IdentifyCollection( gameObject, true );
|
|
// _someOtherAvfxHook.Original( unk );
|
|
// _animationLoadData = last;
|
|
// }
|
|
}
|
|
} |