PKHeX/PKHeX.Core/MysteryGifts/MysteryGift.cs
Kurt 99005d8fc0 Refactoring
more discards & simplifications
2018-05-12 12:28:48 -07:00

160 lines
6.6 KiB
C#

using System;
using System.Linq;
namespace PKHeX.Core
{
/// <summary>
/// Mystery Gift Template File
/// </summary>
public abstract class MysteryGift : IEncounterable, IMoveset, IGeneration, ILocation
{
/// <summary>
/// Determines whether or not the given length of bytes is valid for a mystery gift.
/// </summary>
/// <param name="len">Length, in bytes, of the data of which to determine validity.</param>
/// <returns>A boolean indicating whether or not the given length is valid for a mystery gift.</returns>
public static bool IsMysteryGift(long len)
{
return new[] { WC6.SizeFull, WC6.Size, PGF.Size, PGT.Size, PCD.Size }.Contains((int)len);
}
/// <summary>
/// Converts the given data to a <see cref="MysteryGift"/>.
/// </summary>
/// <param name="data">Raw data of the mystery gift.</param>
/// <param name="ext">Extension of the file from which the <paramref name="data"/> was retrieved.</param>
/// <returns>An instance of <see cref="MysteryGift"/> representing the given data, or null if <paramref name="data"/> or <paramref name="ext"/> is invalid.</returns>
/// <remarks>This overload differs from <see cref="GetMysteryGift(byte[])"/> by checking the <paramref name="data"/>/<paramref name="ext"/> combo for validity. If either is invalid, a null reference is returned.</remarks>
public static MysteryGift GetMysteryGift(byte[] data, string ext)
{
if (ext == null)
return GetMysteryGift(data);
switch (data.Length)
{
case WC7.SizeFull when ext == ".wc7full":
case WC7.Size when ext == ".wc7":
return new WC7(data);
case WC6.SizeFull when ext == ".wc6full":
case WC6.Size when ext == ".wc6":
return new WC6(data);
case PGF.Size when ext == ".pgf":
return new PGF(data);
case PGT.Size when ext == ".pgt":
return new PGT(data);
case PCD.Size when ext == ".pcd" || ext == ".wc4":
return new PCD(data);
}
return null;
}
/// <summary>
/// Converts the given data to a <see cref="MysteryGift"/>.
/// </summary>
/// <param name="data">Raw data of the mystery gift.</param>
/// <returns>An instance of <see cref="MysteryGift"/> representing the given data, or null if <paramref name="data"/> is invalid.</returns>
public static MysteryGift GetMysteryGift(byte[] data)
{
switch (data.Length)
{
case WC6.SizeFull:
// Check WC7 size collision
if (data[0x205] == 0) // 3 * 0x46 for gen6, now only 2.
return new WC7(data);
return new WC6(data);
case WC6.Size:
// Check year for WC7 size collision
if (BitConverter.ToUInt32(data, 0x4C) / 10000 < 2000)
return new WC7(data);
return new WC6(data);
case PGF.Size: return new PGF(data);
case PGT.Size: return new PGT(data);
case PCD.Size: return new PCD(data);
default: return null;
}
}
public string Extension => GetType().Name.ToLower();
public string FileName => $"{CardHeader}.{Extension}";
public byte[] Data { get; set; }
public abstract PKM ConvertToPKM(ITrainerInfo SAV);
public abstract int Format { get; }
/// <summary>
/// Creates a deep copy of the <see cref="MysteryGift"/> object data.
/// </summary>
/// <returns></returns>
public MysteryGift Clone()
{
byte[] data = (byte[])Data.Clone();
return GetMysteryGift(data);
}
/// <summary>
/// Gets a friendly name for the underlying <see cref="MysteryGift"/> type.
/// </summary>
public string Type => GetType().Name;
/// <summary>
/// Gets a friendly name for the underlying <see cref="MysteryGift"/> type for the <see cref="IEncounterable"/> interface.
/// </summary>
public string Name => $"Event Gift ({Type})";
// Properties
public virtual int Species { get => -1; set { } }
public abstract bool GiftUsed { get; set; }
public abstract string CardTitle { get; set; }
public abstract int CardID { get; set; }
public abstract bool IsItem { get; set; }
public abstract int ItemID { get; set; }
public abstract bool IsPokémon { get; set; }
public virtual int Quantity { get => 1; set { } }
public virtual bool Empty => Data.All(z => z == 0);
public virtual bool IsBP { get => false; set { } }
public virtual int BP { get => 0; set { } }
public virtual bool IsBean { get => false; set { } }
public virtual int Bean { get => 0; set { } }
public virtual int BeanCount { get => 0; set { } }
public virtual string CardHeader => (CardID > 0 ? $"Card #: {CardID:0000}" : "N/A") + $" - {CardTitle.Replace('\u3000',' ').Trim()}";
public override int GetHashCode()
{
int hash = 17;
foreach (var b in Data)
hash = hash*31 + b;
return hash;
}
// Search Properties
public virtual int[] Moves { get => new int[4]; set { } }
public virtual int[] RelearnMoves { get => new int[4]; set { } }
public virtual bool IsShiny => false;
public virtual bool IsEgg { get => false; set { } }
public virtual int HeldItem { get => -1; set { } }
public virtual object Content => this;
public abstract int Gender { get; set; }
public abstract int Form { get; set; }
public abstract int TID { get; set; }
public abstract int SID { get; set; }
public abstract string OT_Name { get; set; }
public abstract int Location { get; set; }
public abstract int Level { get; set; }
public int LevelMin => Level;
public int LevelMax => Level;
public abstract int Ball { get; set; }
public bool Gen7 => Format == 7;
public bool Gen6 => Format == 6;
public bool Gen5 => Format == 5;
public bool Gen4 => Format == 4;
public bool Gen3 => Format == 3;
public virtual bool EggEncounter => IsEgg;
public int Generation { get => Format; set {} }
public abstract int EggLocation { get; set; }
}
}