using System;
namespace PKHeX.Core;
///
/// Exposes flags to indicate if a stat index has been hyper trained.
///
public interface IHyperTrain
{
byte HyperTrainFlags { get; set; }
bool HT_HP { get; set; }
bool HT_ATK { get; set; }
bool HT_DEF { get; set; }
bool HT_SPA { get; set; }
bool HT_SPD { get; set; }
bool HT_SPE { get; set; }
}
public static partial class Extensions
{
///
/// Toggles the Hyper Training flag for a given stat.
///
/// Hyper Trainable object
/// Battle Stat (H/A/B/S/C/D)
/// Final Hyper Training Flag value
public static bool HyperTrainInvert(this IHyperTrain t, int index) => index switch
{
0 => t.HT_HP ^= true,
1 => t.HT_ATK ^= true,
2 => t.HT_DEF ^= true,
3 => t.HT_SPE ^= true,
4 => t.HT_SPA ^= true,
5 => t.HT_SPD ^= true,
_ => false,
};
public static bool IsHyperTrainedAll(this IHyperTrain t) => t.HyperTrainFlags == 0x3F;
public static void HyperTrainClear(this IHyperTrain t) => t.HyperTrainFlags = 0;
public static bool IsHyperTrained(this IHyperTrain t) => t.HyperTrainFlags != 0;
///
/// Gets one of the values based on its index within the array.
///
/// Entity to check.
/// Index to get
public static bool IsHyperTrained(this IHyperTrain t, int index) => index switch
{
0 => t.HT_HP,
1 => t.HT_ATK,
2 => t.HT_DEF,
3 => t.HT_SPE,
4 => t.HT_SPA,
5 => t.HT_SPD,
_ => throw new ArgumentOutOfRangeException(nameof(index)),
};
///
/// Sets to valid values which may best enhance the stats.
///
///
/// History of evolutions present as
/// to use (if already known). Will fetch the current if not provided.
public static void SetSuggestedHyperTrainingData(this PKM pk, EvolutionHistory h, ReadOnlySpan IVs)
{
if (pk is not IHyperTrain t)
return;
if (!pk.IsHyperTrainingAvailable(h))
t.HyperTrainFlags = 0;
else
t.SetSuggestedHyperTrainingData(pk, IVs);
}
///
public static void SetSuggestedHyperTrainingData(this PKM pk, EntityContext c, ReadOnlySpan IVs)
{
if (pk is not IHyperTrain t)
return;
if (!c.IsHyperTrainingAvailable(pk.CurrentLevel))
t.HyperTrainFlags = 0;
else
t.SetSuggestedHyperTrainingData(pk, IVs);
}
private static void SetSuggestedHyperTrainingData(this IHyperTrain t, PKM pk, ReadOnlySpan IVs)
{
t.HT_HP = IVs[0] != 31;
t.HT_ATK = IVs[1] != 31 && IVs[1] > 2;
t.HT_DEF = IVs[2] != 31;
t.HT_SPA = IVs[4] != 31;
t.HT_SPD = IVs[5] != 31;
t.HT_SPE = IsSpeedHyperTrainSuggested(t, IVs);
if (pk is ICombatPower pb)
pb.ResetCP();
}
private static bool IsSpeedHyperTrainSuggested(IHyperTrain t, ReadOnlySpan IVs)
{
// sometimes unusual speed IVs are desirable for competitive reasons
var speed = IVs[3];
if (speed is 31 or <= 2)
return false;
// if IV isn't too high and nothing else was HT'd, it was probably intentional to stay low.
if (speed > 17)
return true;
return t.HT_HP || t.HT_ATK || t.HT_DEF || t.HT_SPA || t.HT_SPD;
}
///
public static void SetSuggestedHyperTrainingData(this PKM pk, ReadOnlySpan IVs)
{
pk.SetSuggestedHyperTrainingData(pk.Context, IVs);
}
///
public static void SetSuggestedHyperTrainingData(this PKM pk)
{
Span ivs = stackalloc int[6];
pk.GetIVs(ivs);
pk.SetSuggestedHyperTrainingData(ivs);
}
///
/// Indicates if Hyper Training is available to be set.
///
/// Entity to train
/// History of evolutions present as
/// True if available, otherwise false.
public static bool IsHyperTrainingAvailable(this IHyperTrain t, EvolutionHistory h) => t switch
{
// Check for game formats where training is unavailable:
PA8 => h.HasVisitedGen7 || h.HasVisitedSWSH || h.HasVisitedBDSP,
_ => true,
};
///
public static bool IsHyperTrainingAvailable(this EntityContext c, int currentLevel)
{
var min = GetHyperTrainMinLevel(c);
return currentLevel <= min;
}
///
public static int GetHyperTrainMinLevel(this EntityContext c) => c switch
{
EntityContext.Gen7 or EntityContext.Gen8 or EntityContext.Gen8b => 100,
EntityContext.Gen9 => 50,
_ => 101,
};
///
/// Gets the minimum level required for Hyper Training an IV.
///
/// Entity to train
/// History of evolutions present as
/// Current context
/// True if available, otherwise false.
public static int GetHyperTrainMinLevel(this IHyperTrain _, EvolutionHistory h, EntityContext current)
{
// HOME 3.0.0+ disallows inbound transfers of Hyper Trained Pokémon below level 100.
// PokeDupeChecker in BD/SP will DprIllegal if < 100, even if it was legitimately trained in S/V+.
if (current == EntityContext.Gen8b)
return 100;
if (h.HasVisitedGen9)
return 50;
return 100;
}
///
/// Entity data
/// History of evolutions present as
public static bool IsHyperTrainingAvailable(this PKM pk, EvolutionHistory h)
{
if (pk is not IHyperTrain t)
return false;
if (!t.IsHyperTrainingAvailable(h))
return false;
// Gated behind level.
var min = t.GetHyperTrainMinLevel(h, pk.Context);
return pk.CurrentLevel >= min;
}
}