PKHeX/PKHeX.Core/PKM/Interfaces/ITechRecord.cs

57 lines
1.5 KiB
C#
Raw Normal View History

2022-08-21 08:39:16 +00:00
using System;
namespace PKHeX.Core;
2022-08-21 08:39:16 +00:00
/// <summary>
/// Exposes info about the Technical Machine / Technical Record (TR) compatibility and history of use.
2022-08-21 08:39:16 +00:00
/// </summary>
public interface ITechRecord
{
2022-08-21 08:39:16 +00:00
/// <summary>
/// Rules for permitting the given record.
2022-08-21 08:39:16 +00:00
/// </summary>
public IPermitRecord Permit { get; }
2022-08-21 08:39:16 +00:00
/// <summary>
/// Indicates if the TR has been previously used on this entity to learn the move.
/// </summary>
/// <param name="index">TR index</param>
/// <returns>True if learned</returns>
bool GetMoveRecordFlag(int index);
2022-08-21 08:39:16 +00:00
/// <summary>
/// Sets the flag indicating that the TR has been learned.
/// </summary>
/// <param name="index">TR index</param>
/// <param name="value">True if learned</param>
void SetMoveRecordFlag(int index, bool value = true);
2022-08-21 08:39:16 +00:00
/// <summary>
/// Indicates if any move has been learned via TR.
/// </summary>
bool GetMoveRecordFlagAny();
}
public interface IPermitRecord
{
/// <summary>
/// Individual accessed indexes indicate if they can be learned.
/// </summary>
bool IsRecordPermitted(int index);
/// <summary>
/// Individual accessed move IDs that a given record remembers.
/// </summary>
ReadOnlySpan<ushort> RecordPermitIndexes { get; }
/// <summary>
/// Maximum count of record flags that are available.
/// </summary>
int RecordCountTotal { get; }
/// <summary>
/// Maximum count of record flags that are used.
/// </summary>
int RecordCountUsed { get; }
}