mirror of
https://github.com/kwsch/PKHeX
synced 2024-11-27 06:20:25 +00:00
Add more xmldoc
This commit is contained in:
parent
2f2512b09c
commit
1a343c3b21
7 changed files with 27 additions and 2 deletions
|
@ -1,7 +1,7 @@
|
||||||
namespace PKHeX.Core
|
namespace PKHeX.Core
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Ability ID
|
/// Ability IDs for the corresponding English ability name.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public enum Ability
|
public enum Ability
|
||||||
{
|
{
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
namespace PKHeX.Core
|
namespace PKHeX.Core
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Ball IDs for the corresponding English ball name.
|
||||||
|
/// </summary>
|
||||||
public enum Ball
|
public enum Ball
|
||||||
{
|
{
|
||||||
None = 0,
|
None = 0,
|
||||||
|
@ -39,6 +42,11 @@ namespace PKHeX.Core
|
||||||
|
|
||||||
public static partial class Extensions
|
public static partial class Extensions
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Checks if the <see cref="ball"/> is an Apricorn Ball (HG/SS)
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="ball">Ball ID</param>
|
||||||
|
/// <returns>True if Apricorn, false if not.</returns>
|
||||||
public static bool IsApricornBall(this Ball ball) => Ball.Fast <= ball && ball <= Ball.Moon;
|
public static bool IsApricornBall(this Ball ball) => Ball.Fast <= ball && ball <= Ball.Moon;
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -1,5 +1,9 @@
|
||||||
namespace PKHeX.Core
|
namespace PKHeX.Core
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Gender a <see cref="PKM"/> can have
|
||||||
|
/// </summary>
|
||||||
|
/// <remarks><see cref="Random"/> provided to function for Encounter template values</remarks>
|
||||||
public enum Gender : byte
|
public enum Gender : byte
|
||||||
{
|
{
|
||||||
Male = 0,
|
Male = 0,
|
||||||
|
|
|
@ -2,6 +2,9 @@
|
||||||
|
|
||||||
namespace PKHeX.Core
|
namespace PKHeX.Core
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// String providing interface with minimal support for game strings.
|
||||||
|
/// </summary>
|
||||||
public interface IBasicStrings
|
public interface IBasicStrings
|
||||||
{
|
{
|
||||||
IReadOnlyList<string> Species { get; }
|
IReadOnlyList<string> Species { get; }
|
||||||
|
@ -10,6 +13,10 @@ namespace PKHeX.Core
|
||||||
IReadOnlyList<string> Ability { get; }
|
IReadOnlyList<string> Ability { get; }
|
||||||
IReadOnlyList<string> Types { get; }
|
IReadOnlyList<string> Types { get; }
|
||||||
IReadOnlyList<string> Natures { get; }
|
IReadOnlyList<string> Natures { get; }
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Name an Egg has when obtained on this language.
|
||||||
|
/// </summary>
|
||||||
string EggName { get; }
|
string EggName { get; }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
namespace PKHeX.Core
|
namespace PKHeX.Core
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// Elemental type a move has; additionally, types a <see cref="PKM"/> can have.
|
||||||
|
/// </summary>
|
||||||
public enum MoveType
|
public enum MoveType
|
||||||
{
|
{
|
||||||
Any = -1,
|
Any = -1,
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
namespace PKHeX.Core
|
namespace PKHeX.Core
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// 3DS Console Region Identifiers
|
||||||
|
/// </summary>
|
||||||
public enum RegionID : byte
|
public enum RegionID : byte
|
||||||
{
|
{
|
||||||
None = 0,
|
None = 0,
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
namespace PKHeX.Core
|
namespace PKHeX.Core
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Species IDs
|
/// Species IDs for the corresponding English species name.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public enum Species : ushort
|
public enum Species : ushort
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in a new issue