Xmldoc updates

This commit is contained in:
Kurt 2021-04-17 13:07:28 -07:00
parent 8b180c3122
commit 8e52d2fddb
3 changed files with 57 additions and 7 deletions

View File

@ -3,61 +3,97 @@
namespace PKHeX.Core
{
/// <summary>
/// Egg Moveset Building Order for Generation 2
/// </summary>
public enum EggSource2 : byte
{
None,
/// <summary> Initial moveset for the egg's level. </summary>
Base,
/// <summary> Egg move inherited from the Father. </summary>
FatherEgg,
/// <summary> Technical Machine move inherited from the Father. </summary>
FatherTM,
/// <summary> Level Up move inherited from a parent. </summary>
ParentLevelUp,
/// <summary> Tutor move (Elemental Beam) inherited from a parent. </summary>
Tutor,
Max,
}
/// <summary>
/// Egg Moveset Building Order for Generation 3 &amp; 4
/// </summary>
public enum EggSource34 : byte
{
None,
/// <summary> Initial moveset for the egg's level. </summary>
Base,
/// <summary> Egg move inherited from the Father. </summary>
FatherEgg,
/// <summary> Technical Machine move inherited from the Father. </summary>
FatherTM,
/// <summary> Level Up move inherited from a parent. </summary>
ParentLevelUp,
Max,
/// <summary> Special Move applied at the end if certain conditions are satisfied. </summary>
VoltTackle,
}
/// <summary>
/// Egg Moveset Building Order for Generation 5
/// </summary>
public enum EggSource5 : byte
{
None,
/// <summary> Initial moveset for the egg's level. </summary>
Base,
/// <summary> Egg move inherited from the Father. </summary>
FatherEgg,
/// <summary> Technical Machine move inherited from the Father. </summary>
ParentLevelUp,
FatherTM, // after level up, unlike Gen3/4!
/// <summary> Technical Machine move inherited from the Father. </summary>
/// <remarks> After level up, unlike Gen3/4! </remarks>
FatherTM,
Max,
/// <summary> Special Move applied at the end if certain conditions are satisfied. </summary>
VoltTackle,
}
/// <summary>
/// Egg Moveset Building Order for Generation 6+
/// </summary>
public enum EggSource6 : byte
{
None,
/// <summary> Initial moveset for the egg's level. </summary>
Base,
/// <summary> Level Up move inherited from a parent. </summary>
ParentLevelUp,
/// <summary> Egg move inherited from a parent. </summary>
ParentEgg,
Max,
/// <summary> Special Move applied at the end if certain conditions are satisfied. </summary>
VoltTackle,
}
/// <summary>
/// Utility logic for converting a <see cref="MoveBreed"/> move result into a user friendly string.
/// </summary>
public static class EggSourceUtil
{
#pragma warning disable RCS1224 // Make method an extension method.
public static string GetSource(object parse, int gen, int index)
#pragma warning restore RCS1224 // Make method an extension method.
/// <summary>
/// Unboxes the parse result and returns a user friendly string for the move result.
/// </summary>
public static string GetSource(object parse, int generation, int index)
{
static string GetLine<T>(T[] arr, Func<T, string> act, int i)
{
@ -66,7 +102,7 @@ static string GetLine<T>(T[] arr, Func<T, string> act, int i)
return act(arr[i]);
}
return gen switch
return generation switch
{
2 => GetLine((EggSource2[]) parse, GetSource, index),
3 or 4 => GetLine((EggSource34[])parse, GetSource, index),

View File

@ -1,9 +1,23 @@
namespace PKHeX.Core
{
/// <summary>
/// Setting to conditionally update PKM properties when importing to a save file.
/// </summary>
public enum PKMImportSetting
{
/// <summary>
/// Use whatever the global setting is.
/// </summary>
UseDefault,
/// <summary>
/// Always update the PKM properties to match the save file.
/// </summary>
Update,
/// <summary>
/// Never update the PKM properties to match the save file.
/// </summary>
Skip,
}
}
}

View File

@ -5,7 +5,7 @@ namespace PKHeX.Core
/// <summary>
/// Flags describing special attributes for a <see cref="PKM"/> based on its origin from the parent <see cref="SaveFile"/>.
/// </summary>
/// <remarks>If <see cref="None"/>, then it's a nonspecial slot.</remarks>
/// <remarks>If <see cref="None"/>, then it's not a special slot.</remarks>
[Flags]
public enum StorageSlotFlag
{