Update xmldoc

le lenny goes here
This commit is contained in:
Kurt
2018-07-11 19:19:19 -07:00
parent e4e5018aa7
commit d20706dd70
3 changed files with 188 additions and 13 deletions

View File

@@ -13,6 +13,7 @@ public static class GameUtil
/// <summary>
/// List of possible <see cref="GameVersion"/> values a <see cref="PKM.Version"/> can have.
/// </summary>
/// <remarks>Ordered roughly by most recent games first.</remarks>
public static readonly GameVersion[] GameVersions = ((GameVersion[])Enum.GetValues(typeof(GameVersion))).Where(z => z < RB && z > 0).Reverse().ToArray();
/// <summary>
@@ -211,8 +212,10 @@ public static bool Contains(this GameVersion g1, GameVersion g2)
return g2 == SN || g2 == MN;
case USUM:
return g2 == US || g2 == UM;
case GG:
return g2 == GP || g2 == GE;
case Gen7:
return SM.Contains(g2) || USUM.Contains(g2);
return SM.Contains(g2) || USUM.Contains(g2) || GG.Contains(g2);
default: return false;
}

View File

@@ -5,20 +5,192 @@
/// </summary>
public enum GameVersion
{
// Indicators
#region Indicators
Invalid = -2,
Any = -1,
Unknown = 0,
#endregion
// Version IDs, also stored in PKM structure
/*Gen3*/ S = 1, R = 2, E = 3, FR = 4, LG = 5, CXD = 15,
/*Gen4*/ D = 10, P = 11, Pt = 12, HG = 7, SS = 8,
/*Gen5*/ W = 20, B = 21, W2 = 22, B2 = 23,
/*Gen6*/ X = 24, Y = 25, AS = 26, OR = 27,
/*Gen7*/ SN = 30, MN = 31, US = 32, UM = 33,
/* GO */ GO = 34,
/* VC1*/ RD = 35, GN = 36, BU = 37, YW = 38, // GN = Blue for international release
/* VC2*/ GD = 39, SV = 40, C = 41, // Crystal is unused
#region Gen3
/// <summary>
/// Sapphire (GBA)
/// </summary>
S = 1,
/// <summary>
/// Ruby (GBA)
/// </summary>
R = 2,
/// <summary>
/// Emerald (GBA)
/// </summary>
E = 3,
/// <summary>
/// FireRed (GBA)
/// </summary>
FR = 4,
/// <summary>
/// LeafGreen (GBA)
/// </summary>
LG = 5,
/// <summary>
/// Colosseum/XD (GameCube)
/// </summary>
CXD = 15,
#endregion
#region Gen4
/// <summary>
/// Diamond (NDS)
/// </summary>
D = 10,
/// <summary>
/// Pearl (NDS)
/// </summary>
P = 11,
/// <summary>
/// Platinum (NDS)
/// </summary>
Pt = 12,
/// <summary>
/// Heart Gold (NDS)
/// </summary>
HG = 7,
/// <summary>
/// Soul Silver (NDS)
/// </summary>
SS = 8,
#endregion
#region Gen5
/// <summary>
/// White (NDS)
/// </summary>
W = 20,
/// <summary>
/// Black (NDS)
/// </summary>
B = 21,
/// <summary>
/// White 2 (NDS)
/// </summary>
W2 = 22,
/// <summary>
/// Black 2 (NDS)
/// </summary>
B2 = 23,
#endregion
#region Gen6
/// <summary>
/// X (3DS)
/// </summary>
X = 24,
/// <summary>
/// Y (3DS)
/// </summary>
Y = 25,
/// <summary>
/// Alpha Sapphire (3DS)
/// </summary>
AS = 26,
/// <summary>
/// Omega Ruby (3DS)
/// </summary>
OR = 27,
#endregion
#region Gen7
/// <summary>
/// Sun (3DS)
/// </summary>
SN = 30,
/// <summary>
/// Moon (3DS)
/// </summary>
MN = 31,
/// <summary>
/// Ultra Sun (3DS)
/// </summary>
US = 32,
/// <summary>
/// Ultra Moon (3DS)
/// </summary>
UM = 33,
#endregion
/// <summary>
/// Pokémon GO (Unused)
/// </summary>
GO = 34,
#region Virtual Console (3DS) Gen1
/// <summary>
/// Red (3DS Virtual Console)
/// </summary>
RD = 35,
/// <summary>
/// Green[JP]/Blue[INT] (3DS Virtual Console)
/// </summary>
GN = 36,
/// <summary>
/// Blue[JP] (3DS Virtual Console)
/// </summary>
BU = 37,
/// <summary>
/// Yellow [JP] (3DS Virtual Console)
/// </summary>
YW = 38,
#endregion
#region Virtual Console (3DS) Gen2
/// <summary>
/// Gold (3DS Virtual Console)
/// </summary>
GD = 39,
/// <summary>
/// Silver (3DS Virtual Console)
/// </summary>
SV = 40,
/// <summary>
/// Crystal (3DS Virtual Console)
/// </summary>
C = 41,
#endregion
#region Nintendo Switch
/// <summary>
/// Let's Go Pikachu (NX)
/// </summary>
GP = 42,
/// <summary>
/// Lets Go Eevee (NX)
/// </summary>
GE = 43,
#endregion
// Not actually stored values, but assigned as properties.
@@ -29,7 +201,7 @@ public enum GameVersion
/*SAV4*/ DP, DPPt, HGSS, BATREV,
/*SAV5*/ BW, B2W2,
/*SAV6*/ XY, ORASDEMO, ORAS,
/*SAV7*/ SM, USUM,
/*SAV7*/ SM, USUM, GG,
// Extra Game Groupings (Generation)
Gen1, Gen2, Gen3, Gen4, Gen5, Gen6, Gen7,

View File

@@ -537,7 +537,7 @@ public static uint GetWurmpleEvoVal(uint EC)
/// </summary>
/// <param name="evoVal">Wurmple Evolution Value</param>
/// <remarks>0 = Silcoon, 1 = Cascoon</remarks>
/// <returns>Encryption Constan</returns>
/// <returns>Encryption Constant</returns>
public static uint GetWurmpleEC(int evoVal)
{
uint EC;