PKHeX/PKHeX.Core/Moves/MoveInfo.cs

using System;
using static PKHeX.Core.Move;
using static PKHeX.Core.EntityContext;

namespace PKHeX.Core;

/// <summary>
/// Overall information about Moves
/// </summary>
public static class MoveInfo
{
    /// <summary>
    /// Gets the base PP of a move ID depending on the <see cref="context"/>.
    /// </summary>
    /// <param name="context">Game context</param>
    /// <param name="move">Move ID</param>
    /// <returns>Amount of PP the move has by default (no PP Ups).</returns>
    public static byte GetPP(EntityContext context, ushort move)
    {
        var table = GetPPTable(context);
        if (move >= table.Length)
            return 0;
        return table[move];
    }

    /// <summary>
    /// Gets the move PP table for the <see cref="context"/>.
    /// </summary>
    public static ReadOnlySpan<byte> GetPPTable(EntityContext context) => context switch
    {
        Gen1 => MoveInfo1.MovePP_RBY,
        Gen2 => MoveInfo2.MovePP_GSC,
        Gen3 => MoveInfo3.MovePP_RS,
        Gen4 => MoveInfo4.MovePP_DP,
        Gen5 => MoveInfo5.MovePP_BW,
        Gen6 => MoveInfo6.MovePP,
        Gen7 => MoveInfo7.MovePP_SM,
        Gen8 => MoveInfo8.MovePP_SWSH,
        Gen9 => MoveInfo9.MovePP_SV,

        Gen7b => MoveInfo7b.MovePP_GG,
        Gen8a => MoveInfo8a.MovePP_LA,
        Gen8b => MoveInfo8.MovePP_SWSH,
        _ => throw new ArgumentOutOfRangeException(nameof(context)),
    };

    /// <summary>
    /// Gets a collection that can be used to check if a move cannot be used in battle.
    /// </summary>
    public static ReadOnlySpan<byte> GetDummiedMovesHashSet(EntityContext context) => context switch
    {
        Gen8 => MoveInfo8.DummiedMoves,
        Gen8a => MoveInfo8a.DummiedMoves,
        Gen8b => MoveInfo8b.DummiedMoves,
        Gen9 => MoveInfo9.DummiedMoves,
        _ => [],
    };

    /// <summary>
    /// Checks if the move is a Z-move.
    /// </summary>
    public static bool IsMoveZ(ushort move) => move switch
    {
        >= (int)BreakneckBlitzP      and <= (int)Catastropika        => true, // [622-658]
        >= (int)SinisterArrowRaid    and <= (int)GenesisSupernova    => true, // [695-703]
           (int)TenMVoltThunderbolt                                  => true, // [719]
        >= (int)LightThatBurnstheSky and <= (int)ClangorousSoulblaze => true, // [723-728]
        _ => false,
    };

    private const uint DynamaxMoveCount = (int)MaxSteelspike - (int)MaxFlare + 1;
    private const uint TorqueMoveCount = (int)MagicalTorque - (int)BlazingTorque + 1;

    /// <summary>
    /// Checks if the move is a Dynamax-only move.
    /// </summary>
    public static bool IsMoveDynamax(ushort move) => move - (uint)MaxFlare < DynamaxMoveCount;

    /// <summary>
    /// Checks if the move can be known by anything in any context.
    /// </summary>
    /// <remarks> Assumes the move ID is within [0,max]. </remarks>
    public static bool IsMoveKnowable(ushort move) => !IsMoveZ(move) && !IsMoveDynamax(move) && !IsMoveTorque(move);

    /// <summary>
    /// Checks if the move is a Starmobile-only move.
    /// </summary>
    public static bool IsMoveTorque(ushort move) => move - (uint)BlazingTorque < TorqueMoveCount;

    /// <summary>
    /// Checks if the <see cref="move"/> is unable to be used in battle.
    /// </summary>
    public static bool IsDummiedMove(PKM pk, ushort move)
    {
        var context = pk.Context;
        var hashSet = GetDummiedMovesHashSet(context);
        return IsDummiedMove(hashSet, move);
    }

    /// <summary>
    /// Checks if the move at the requested <see cref="index"/> is unable to be used in battle.
    /// </summary>
    public static bool IsDummiedMove(PKM pk, int index)
    {
        var context = pk.Context;
        var hashSet = GetDummiedMovesHashSet(context);
        if (hashSet.Length == 0)
            return false;
        var move = pk.GetMove(index);
        return IsDummiedMove(hashSet, move);
    }

    private static bool IsDummiedMove(ReadOnlySpan<byte> bitSet, ushort move)
    {
        var offset = move >> 3;
        if (offset >= bitSet.Length)
            return false;

        var bit = move & 7;
        if ((bitSet[offset] & (1 << bit)) != 0)
            return true;
        return false;
    }

    /// <summary>
    /// Checks if any Move in the currently known moves is an unusable move (yellow triangle).
    /// </summary>
    public static bool IsDummiedMoveAny(PKM pk)
    {
        var bitSet = GetDummiedMovesHashSet(pk.Context);
        if (bitSet.Length == 0)
            return false;

        for (int i = 0; i < 4; i++)
        {
            var move = pk.GetMove(i);
            if (IsDummiedMove(bitSet, move))
                return true;
        }
        return false;
    }

    /// <summary>
    /// Checks if Sketch can obtain the <see cref="move"/> in the requested <see cref="context"/>
    /// </summary>
    /// <param name="move">Move ID</param>
    /// <param name="context">Generation to check</param>
    /// <returns>True if the move can be sketched, false if not possible.</returns>
    public static bool IsSketchValid(ushort move, EntityContext context)
    {
        if (move > GetMaxMoveID(context))
            return false;
        if (!IsSketchPossible(move))
            return false;
        if (!IsSketchPossible(move, context))
            return false;
        return true;
    }

    /// <summary>
    /// Checks if the move can be sketched in any game.
    /// </summary>
    /// <param name="move">Sketched move</param>
    private static bool IsSketchPossible(ushort move) => move switch
    {
        // Can't Sketch
        (int)Struggle => false,
        (int)Chatter => false,

        // Unreleased
        (int)LightofRuin => false,

        _ => IsMoveKnowable(move),
    };

    /// <summary>
    /// Checks if the move can be sketched in a specific game context. Pre-check with <see cref="IsSketchPossible(ushort)"/>.
    /// </summary>
    /// <param name="move">Sketched move</param>
    /// <param name="context">Context currently present in</param>
    private static bool IsSketchPossible(ushort move, EntityContext context) => context switch
    {
        Gen6 when move is (int)ThousandArrows or (int)ThousandWaves => false,
        Gen8b when IsDummiedMove(MoveInfo8b.DummiedMoves, move) => false,
        Gen9 when IsDummiedMove(MoveInfo9.DummiedMoves, move) || DisallowSketch9.Contains(move) => false,
        _ => true,
    };

    /// <summary>
    /// Moves that cannot be sketched in <see cref="Gen9"/>.
    /// </summary>
    private static ReadOnlySpan<ushort> DisallowSketch9 =>
    [
        (ushort)DarkVoid,
        (ushort)HyperspaceFury,
      //(ushort)BreakneckBlitzP, // 3.0.0 has this move set, but this move is disallowed with our other checks
        (ushort)RevivalBlessing,
        (ushort)BlazingTorque, // Revavroom
        (ushort)WickedTorque, // Revavroom
        (ushort)NoxiousTorque, // Revavroom
        (ushort)CombatTorque, // Revavroom
        (ushort)MagicalTorque, // Revavroom
        (ushort)TeraStarstorm,
    ];

    private static int GetMaxMoveID(EntityContext context) => context switch
    {
        Gen1 => Legal.MaxMoveID_1,
        Gen2 => Legal.MaxMoveID_2,
        Gen3 => Legal.MaxMoveID_3,
        Gen4 => Legal.MaxMoveID_4,
        Gen5 => Legal.MaxMoveID_5,
        Gen6 => Legal.MaxMoveID_6_AO,
        Gen7 => Legal.MaxMoveID_7_USUM,
        Gen7b => Legal.MaxMoveID_7b,
        Gen8 => Legal.MaxMoveID_8a,
        Gen8a => Legal.MaxMoveID_8a,
        Gen8b => Legal.MaxMoveID_8b,
        Gen9 => Legal.MaxMoveID_9,
        _ => -1,
    };

    public static byte GetType(ushort move, EntityContext context) => context switch
    {
        Gen1 => GetType(move, MoveInfo1.MoveType_RBY), // Bite, Gust, Karate Chop, Sand Attack
        >= Gen2 and <= Gen5 => GetType(move, MoveInfo5.MoveType_BW), // Charm, Moonlight, Sweet Kiss
        _ => GetType(move, MoveInfo9.MoveType_SV),
    };

    private static byte GetType(ushort move, ReadOnlySpan<byte> types)
    {
        if (move >= types.Length)
            return 0;
        return types[move];
    }

    public static bool IsAnyFromGeneration(byte generation, ReadOnlySpan<MoveResult> moves)
    {
        foreach (var move in moves)
        {
            if (move.Generation == generation)
                return true;
        }
        return false;
    }
}