PKHeX/PKHeX.Core/Editing/WurmpleUtil.cs
Kurt f2209ec7fd Add better handling for specific GO transfers
No formarg or bad EC evolution peek -> search for higher species rather than from the bottom.
2024-01-12 18:58:23 -08:00

78 lines
2.6 KiB
C#

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 WurmpleEvolution GetWurmpleEvoVal(uint encryptionConstant)
{
var evoVal = encryptionConstant >> 16;
return (WurmpleEvolution)(evoVal % 10 / 5);
}
/// <summary>
/// Gets the evo chain of Wurmple
/// </summary>
/// <param name="species">Current species, must be evolved from Wurmple.</param>
public static WurmpleEvolution GetWurmpleEvoGroup(ushort species)
{
int wIndex = species - (int)Species.Silcoon;
if ((wIndex & 3) != wIndex) // Wurmple evo, [0,3]
return WurmpleEvolution.None;
return (WurmpleEvolution)(wIndex >> 1); // Silcoon, Cascoon
}
/// <summary>
/// Checks to see if the input species is a Wurmple evolution
/// </summary>
/// <returns>True if Wurmple evolution, false if not</returns>
public static bool IsWurmpleEvo(ushort species) => GetWurmpleEvoGroup(species) != WurmpleEvolution.None;
/// <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(WurmpleEvolution 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)
{
var evoVal = GetWurmpleEvoVal(pk.EncryptionConstant);
var wIndex = GetWurmpleEvoGroup(pk.Species);
return evoVal == wIndex;
}
}
/// <summary>
/// Indicates the evolution of Wurmple
/// </summary>
public enum WurmpleEvolution
{
/// <summary> Invalid value </summary>
None = -1,
/// <summary> Evolves into Silcoon/Beautifly </summary>
Silcoon = 0,
/// <summary> Evolves into Cascoon/Dustox </summary>
Cascoon = 1,
}