mirror of
https://github.com/xivdev/Penumbra.git
synced 2025-12-15 05:04:15 +01:00
Extract Strings to separate submodule.
This commit is contained in:
Ottermandias
parent
bc901f3ff6
commit
35baba18bf
75 changed files with 751 additions and 1657 deletions
352
Penumbra.GameData/Actors/ActorManager.cs
Normal file
352
Penumbra.GameData/Actors/ActorManager.cs
Normal file
|
|
@ -0,0 +1,352 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using System.Globalization;
|
||||
using System.Linq;
|
||||
using Dalamud.Data;
|
||||
using Dalamud.Game.ClientState;
|
||||
using Dalamud.Game.ClientState.Objects;
|
||||
using Dalamud.Game.ClientState.Objects.Enums;
|
||||
using Dalamud.Game.ClientState.Objects.Types;
|
||||
using Dalamud.Utility;
|
||||
using Lumina.Excel.GeneratedSheets;
|
||||
using Newtonsoft.Json.Linq;
|
||||
using Penumbra.String;
|
||||
|
||||
namespace Penumbra.GameData.Actors;
|
||||
|
||||
public class ActorManager
|
||||
{
|
||||
private readonly ObjectTable _objects;
|
||||
private readonly ClientState _clientState;
|
||||
|
||||
public readonly IReadOnlyDictionary< ushort, string > Worlds;
|
||||
public readonly IReadOnlyDictionary< uint, string > Mounts;
|
||||
public readonly IReadOnlyDictionary< uint, string > Companions;
|
||||
public readonly IReadOnlyDictionary< uint, string > BNpcs;
|
||||
public readonly IReadOnlyDictionary< uint, string > ENpcs;
|
||||
|
||||
public IEnumerable< KeyValuePair< ushort, string > > AllWorlds
|
||||
=> Worlds.OrderBy( kvp => kvp.Key ).Prepend( new KeyValuePair< ushort, string >( ushort.MaxValue, "Any World" ) );
|
||||
|
||||
private readonly Func< ushort, short > _toParentIdx;
|
||||
|
||||
public ActorManager( ObjectTable objects, ClientState state, DataManager gameData, Func< ushort, short > toParentIdx )
|
||||
{
|
||||
_objects = objects;
|
||||
_clientState = state;
|
||||
Worlds = gameData.GetExcelSheet< World >()!
|
||||
.Where( w => w.IsPublic && !w.Name.RawData.IsEmpty )
|
||||
.ToDictionary( w => ( ushort )w.RowId, w => w.Name.ToString() );
|
||||
|
||||
Mounts = gameData.GetExcelSheet< Mount >()!
|
||||
.Where( m => m.Singular.RawData.Length > 0 && m.Order >= 0 )
|
||||
.ToDictionary( m => m.RowId, m => CultureInfo.InvariantCulture.TextInfo.ToTitleCase( m.Singular.ToDalamudString().ToString() ) );
|
||||
Companions = gameData.GetExcelSheet< Companion >()!
|
||||
.Where( c => c.Singular.RawData.Length > 0 && c.Order < ushort.MaxValue )
|
||||
.ToDictionary( c => c.RowId, c => CultureInfo.InvariantCulture.TextInfo.ToTitleCase( c.Singular.ToDalamudString().ToString() ) );
|
||||
|
||||
BNpcs = gameData.GetExcelSheet< BNpcName >()!
|
||||
.Where( n => n.Singular.RawData.Length > 0 )
|
||||
.ToDictionary( n => n.RowId, n => CultureInfo.InvariantCulture.TextInfo.ToTitleCase( n.Singular.ToDalamudString().ToString() ) );
|
||||
|
||||
ENpcs = gameData.GetExcelSheet< ENpcResident >()!
|
||||
.Where( e => e.Singular.RawData.Length > 0 )
|
||||
.ToDictionary( e => e.RowId, e => CultureInfo.InvariantCulture.TextInfo.ToTitleCase( e.Singular.ToDalamudString().ToString() ) );
|
||||
|
||||
_toParentIdx = toParentIdx;
|
||||
|
||||
ActorIdentifier.Manager = this;
|
||||
}
|
||||
|
||||
public ActorIdentifier FromJson( JObject data )
|
||||
{
|
||||
var type = data[ nameof( ActorIdentifier.Type ) ]?.Value< IdentifierType >() ?? IdentifierType.Invalid;
|
||||
switch( type )
|
||||
{
|
||||
case IdentifierType.Player:
|
||||
{
|
||||
var name = ByteString.FromStringUnsafe( data[ nameof( ActorIdentifier.PlayerName ) ]?.Value< string >(), false );
|
||||
var homeWorld = data[ nameof( ActorIdentifier.HomeWorld ) ]?.Value< ushort >() ?? 0;
|
||||
return CreatePlayer( name, homeWorld );
|
||||
}
|
||||
case IdentifierType.Owned:
|
||||
{
|
||||
var name = ByteString.FromStringUnsafe( data[ nameof( ActorIdentifier.PlayerName ) ]?.Value< string >(), false );
|
||||
var homeWorld = data[ nameof( ActorIdentifier.HomeWorld ) ]?.Value< ushort >() ?? 0;
|
||||
var kind = data[ nameof( ActorIdentifier.Kind ) ]?.Value< ObjectKind >() ?? ObjectKind.CardStand;
|
||||
var dataId = data[ nameof( ActorIdentifier.DataId ) ]?.Value< uint >() ?? 0;
|
||||
return CreateOwned( name, homeWorld, kind, dataId );
|
||||
}
|
||||
case IdentifierType.Special:
|
||||
{
|
||||
var special = data[ nameof( ActorIdentifier.Special ) ]?.Value< SpecialActor >() ?? 0;
|
||||
return CreateSpecial( special );
|
||||
}
|
||||
case IdentifierType.Npc:
|
||||
{
|
||||
var index = data[ nameof( ActorIdentifier.Index ) ]?.Value< ushort >() ?? 0;
|
||||
var kind = data[ nameof( ActorIdentifier.Kind ) ]?.Value< ObjectKind >() ?? ObjectKind.CardStand;
|
||||
var dataId = data[ nameof( ActorIdentifier.DataId ) ]?.Value< uint >() ?? 0;
|
||||
return CreateNpc( kind, index, dataId );
|
||||
}
|
||||
case IdentifierType.Invalid:
|
||||
default:
|
||||
return ActorIdentifier.Invalid;
|
||||
}
|
||||
}
|
||||
|
||||
public string ToString( ActorIdentifier id )
|
||||
{
|
||||
return id.Type switch
|
||||
{
|
||||
IdentifierType.Player => id.HomeWorld != _clientState.LocalPlayer?.HomeWorld.Id
|
||||
? $"{id.PlayerName} ({Worlds[ id.HomeWorld ]})"
|
||||
: id.PlayerName.ToString(),
|
||||
IdentifierType.Owned => id.HomeWorld != _clientState.LocalPlayer?.HomeWorld.Id
|
||||
? $"{id.PlayerName} ({Worlds[ id.HomeWorld ]})'s {ToName( id.Kind, id.DataId )}"
|
||||
: $"{id.PlayerName}s {ToName( id.Kind, id.DataId )}",
|
||||
IdentifierType.Special => ToName( id.Special ),
|
||||
IdentifierType.Npc =>
|
||||
id.Index == ushort.MaxValue
|
||||
? ToName( id.Kind, id.DataId )
|
||||
: $"{ToName( id.Kind, id.DataId )} at {id.Index}",
|
||||
_ => "Invalid",
|
||||
};
|
||||
}
|
||||
|
||||
public static string ToName( SpecialActor actor )
|
||||
=> actor switch
|
||||
{
|
||||
SpecialActor.CharacterScreen => "Character Screen Actor",
|
||||
SpecialActor.ExamineScreen => "Examine Screen Actor",
|
||||
SpecialActor.FittingRoom => "Fitting Room Actor",
|
||||
SpecialActor.DyePreview => "Dye Preview Actor",
|
||||
SpecialActor.Portrait => "Portrait Actor",
|
||||
_ => "Invalid",
|
||||
};
|
||||
|
||||
public string ToName( ObjectKind kind, uint dataId )
|
||||
=> TryGetName( kind, dataId, out var ret ) ? ret : "Invalid";
|
||||
|
||||
public bool TryGetName( ObjectKind kind, uint dataId, [NotNullWhen( true )] out string? name )
|
||||
{
|
||||
name = null;
|
||||
return kind switch
|
||||
{
|
||||
ObjectKind.MountType => Mounts.TryGetValue( dataId, out name ),
|
||||
ObjectKind.Companion => Companions.TryGetValue( dataId, out name ),
|
||||
ObjectKind.BattleNpc => BNpcs.TryGetValue( dataId, out name ),
|
||||
ObjectKind.EventNpc => ENpcs.TryGetValue( dataId, out name ),
|
||||
_ => false,
|
||||
};
|
||||
}
|
||||
|
||||
public unsafe ActorIdentifier FromObject( FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject* actor )
|
||||
{
|
||||
if( actor == null )
|
||||
{
|
||||
return ActorIdentifier.Invalid;
|
||||
}
|
||||
|
||||
var idx = actor->ObjectIndex;
|
||||
if( idx is >= ( ushort )SpecialActor.CutsceneStart and < ( ushort )SpecialActor.CutsceneEnd )
|
||||
{
|
||||
var parentIdx = _toParentIdx( idx );
|
||||
if( parentIdx >= 0 )
|
||||
{
|
||||
return FromObject( ( FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject* )_objects.GetObjectAddress( parentIdx ) );
|
||||
}
|
||||
}
|
||||
else if( idx is >= ( ushort )SpecialActor.CharacterScreen and <= ( ushort )SpecialActor.Portrait )
|
||||
{
|
||||
return CreateSpecial( ( SpecialActor )idx );
|
||||
}
|
||||
|
||||
switch( ( ObjectKind )actor->ObjectKind )
|
||||
{
|
||||
case ObjectKind.Player:
|
||||
{
|
||||
var name = new ByteString( actor->Name );
|
||||
var homeWorld = ( ( FFXIVClientStructs.FFXIV.Client.Game.Character.Character* )actor )->HomeWorld;
|
||||
return CreatePlayer( name, homeWorld );
|
||||
}
|
||||
case ObjectKind.BattleNpc:
|
||||
{
|
||||
var ownerId = actor->OwnerID;
|
||||
if( ownerId != 0xE0000000 )
|
||||
{
|
||||
var owner = ( FFXIVClientStructs.FFXIV.Client.Game.Character.Character* )( _objects.SearchById( ownerId )?.Address ?? IntPtr.Zero );
|
||||
if( owner == null )
|
||||
{
|
||||
return ActorIdentifier.Invalid;
|
||||
}
|
||||
|
||||
var name = new ByteString( owner->GameObject.Name );
|
||||
var homeWorld = owner->HomeWorld;
|
||||
return CreateOwned( name, homeWorld, ObjectKind.BattleNpc, ( ( FFXIVClientStructs.FFXIV.Client.Game.Character.Character* )actor )->NameID );
|
||||
}
|
||||
|
||||
return CreateNpc( ObjectKind.BattleNpc, actor->ObjectIndex, ( ( FFXIVClientStructs.FFXIV.Client.Game.Character.Character* )actor )->NameID );
|
||||
}
|
||||
case ObjectKind.EventNpc: return CreateNpc( ObjectKind.EventNpc, actor->ObjectIndex, actor->DataID );
|
||||
case ObjectKind.MountType:
|
||||
case ObjectKind.Companion:
|
||||
{
|
||||
if( actor->ObjectIndex % 2 == 0 )
|
||||
{
|
||||
return ActorIdentifier.Invalid;
|
||||
}
|
||||
|
||||
var owner = ( FFXIVClientStructs.FFXIV.Client.Game.Character.Character* )_objects.GetObjectAddress( actor->ObjectIndex - 1 );
|
||||
if( owner == null )
|
||||
{
|
||||
return ActorIdentifier.Invalid;
|
||||
}
|
||||
|
||||
var dataId = GetCompanionId( actor, &owner->GameObject );
|
||||
return CreateOwned( new ByteString( owner->GameObject.Name ), owner->HomeWorld, ( ObjectKind )actor->ObjectKind, dataId );
|
||||
}
|
||||
default: return ActorIdentifier.Invalid;
|
||||
}
|
||||
}
|
||||
|
||||
private unsafe uint GetCompanionId( FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject* actor, FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject* owner )
|
||||
{
|
||||
return ( ObjectKind )actor->ObjectKind switch
|
||||
{
|
||||
ObjectKind.MountType => *( ushort* )( ( byte* )owner + 0x668 ),
|
||||
ObjectKind.Companion => *( ushort* )( ( byte* )actor + 0x1AAC ),
|
||||
_ => actor->DataID,
|
||||
};
|
||||
}
|
||||
|
||||
public unsafe ActorIdentifier FromObject( GameObject? actor )
|
||||
=> FromObject( ( FFXIVClientStructs.FFXIV.Client.Game.Object.GameObject* )( actor?.Address ?? IntPtr.Zero ) );
|
||||
|
||||
|
||||
public ActorIdentifier CreatePlayer( ByteString name, ushort homeWorld )
|
||||
{
|
||||
if( !VerifyWorld( homeWorld ) || !VerifyPlayerName( name ) )
|
||||
{
|
||||
return ActorIdentifier.Invalid;
|
||||
}
|
||||
|
||||
return new ActorIdentifier( IdentifierType.Player, ObjectKind.Player, homeWorld, 0, name );
|
||||
}
|
||||
|
||||
public ActorIdentifier CreateSpecial( SpecialActor actor )
|
||||
{
|
||||
if( !VerifySpecial( actor ) )
|
||||
{
|
||||
return ActorIdentifier.Invalid;
|
||||
}
|
||||
|
||||
return new ActorIdentifier( IdentifierType.Special, ObjectKind.Player, ( ushort )actor, 0, ByteString.Empty );
|
||||
}
|
||||
|
||||
public ActorIdentifier CreateNpc( ObjectKind kind, ushort index = ushort.MaxValue, uint data = uint.MaxValue )
|
||||
{
|
||||
if( !VerifyIndex( index ) || !VerifyNpcData( kind, data ) )
|
||||
{
|
||||
return ActorIdentifier.Invalid;
|
||||
}
|
||||
|
||||
return new ActorIdentifier( IdentifierType.Npc, kind, index, data, ByteString.Empty );
|
||||
}
|
||||
|
||||
public ActorIdentifier CreateOwned( ByteString ownerName, ushort homeWorld, ObjectKind kind, uint dataId )
|
||||
{
|
||||
if( !VerifyWorld( homeWorld ) || !VerifyPlayerName( ownerName ) || !VerifyOwnedData( kind, dataId ) )
|
||||
{
|
||||
return ActorIdentifier.Invalid;
|
||||
}
|
||||
|
||||
return new ActorIdentifier( IdentifierType.Owned, kind, homeWorld, dataId, ownerName );
|
||||
}
|
||||
|
||||
|
||||
/// <summary> Checks SE naming rules. </summary>
|
||||
private static bool VerifyPlayerName( ByteString name )
|
||||
{
|
||||
// Total no more than 20 characters + space.
|
||||
if( name.Length is < 5 or > 21 )
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
var split = name.Split( ( byte )' ' );
|
||||
|
||||
// Forename and surname, no more spaces.
|
||||
if( split.Count != 2 )
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
static bool CheckNamePart( ByteString part )
|
||||
{
|
||||
// Each name part at least 2 and at most 15 characters.
|
||||
if( part.Length is < 2 or > 15 )
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
// Each part starting with capitalized letter.
|
||||
if( part[ 0 ] is < ( byte )'A' or > ( byte )'Z' )
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
// Every other symbol needs to be lowercase letter, hyphen or apostrophe.
|
||||
if( part.Skip( 1 ).Any( c => c != ( byte )'\'' && c != ( byte )'-' && c is < ( byte )'a' or > ( byte )'z' ) )
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
var hyphens = part.Split( ( byte )'-' );
|
||||
// Apostrophes can not be used in succession, after or before apostrophes.
|
||||
return !hyphens.Any( p => p.Length == 0 || p[ 0 ] == ( byte )'\'' || p.Last() == ( byte )'\'' );
|
||||
}
|
||||
|
||||
return CheckNamePart( split[ 0 ] ) && CheckNamePart( split[ 1 ] );
|
||||
}
|
||||
|
||||
/// <summary> Checks if the world is a valid public world or ushort.MaxValue (any world). </summary>
|
||||
private bool VerifyWorld( ushort worldId )
|
||||
=> Worlds.ContainsKey( worldId );
|
||||
|
||||
/// <summary> Verify that the enum value is a specific actor and return the name if it is. </summary>
|
||||
private static bool VerifySpecial( SpecialActor actor )
|
||||
=> actor is >= SpecialActor.CharacterScreen and <= SpecialActor.Portrait;
|
||||
|
||||
/// <summary> Verify that the object index is a valid index for an NPC. </summary>
|
||||
private static bool VerifyIndex( ushort index )
|
||||
{
|
||||
return index switch
|
||||
{
|
||||
< 200 => index % 2 == 0,
|
||||
> ( ushort )SpecialActor.Portrait => index < 426,
|
||||
_ => false,
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary> Verify that the object kind is a valid owned object, and the corresponding data Id. </summary>
|
||||
private bool VerifyOwnedData( ObjectKind kind, uint dataId )
|
||||
{
|
||||
return kind switch
|
||||
{
|
||||
ObjectKind.MountType => Mounts.ContainsKey( dataId ),
|
||||
ObjectKind.Companion => Companions.ContainsKey( dataId ),
|
||||
ObjectKind.BattleNpc => BNpcs.ContainsKey( dataId ),
|
||||
_ => false,
|
||||
};
|
||||
}
|
||||
|
||||
private bool VerifyNpcData( ObjectKind kind, uint dataId )
|
||||
=> kind switch
|
||||
{
|
||||
ObjectKind.BattleNpc => BNpcs.ContainsKey( dataId ),
|
||||
ObjectKind.EventNpc => ENpcs.ContainsKey( dataId ),
|
||||
_ => false,
|
||||
};
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue