PKHeX/PKHeX.Core/Editing/WurmpleUtil.cs

namespace PKHeX.Core;

/// <summary>
/// Indicates or coerces values pertaining to <see cref="Species.Wurmple"/> and its branched evolutions.
/// </summary>
public static class WurmpleUtil
{
    /// <summary>
    /// Gets the Wurmple Evolution Value for a given <see cref="PKM.EncryptionConstant"/>
    /// </summary>
    /// <param name="encryptionConstant">Encryption Constant</param>
    /// <returns>Wurmple Evolution Value</returns>
    public static uint GetWurmpleEvoVal(uint encryptionConstant)
    {
        var evoVal = encryptionConstant >> 16;
        return evoVal % 10 / 5;
    }

    /// <summary>
    /// Gets the evo chain of Wurmple
    /// </summary>
    /// <param name="species">Current species</param>
    /// <returns>-1 if not a Wurmple Evo, 0 if Silcoon chain, 1 if Cascoon chain</returns>
    public static int GetWurmpleEvoGroup(int species)
    {
        int wIndex = species - (int)Species.Silcoon;
        if ((wIndex & 3) != wIndex) // Wurmple evo, [0,3]
            return -1;
        return wIndex >> 1; // Silcoon, Cascoon
    }

    /// <summary>
    /// Gets the Wurmple <see cref="PKM.EncryptionConstant"/> for a given Evolution Value
    /// </summary>
    /// <param name="evoVal">Wurmple Evolution Value</param>
    /// <remarks>0 = Silcoon, 1 = Cascoon</remarks>
    /// <returns>Encryption Constant</returns>
    public static uint GetWurmpleEncryptionConstant(int evoVal)
    {
        uint result;
        var rnd = Util.Rand;
        do result = rnd.Rand32();
        while (evoVal != GetWurmpleEvoVal(result));
        return result;
    }

    /// <summary>
    /// Checks to see if the input <see cref="pk"/>, with species being that of Wurmple's evo chain, is valid.
    /// </summary>
    /// <param name="pk">Pokémon data</param>
    /// <returns>True if valid, false if invalid</returns>
    public static bool IsWurmpleEvoValid(PKM pk)
    {
        uint evoVal = GetWurmpleEvoVal(pk.EncryptionConstant);
        int wIndex = GetWurmpleEvoGroup(pk.Species);
        return evoVal == wIndex;
    }
}