PKHeX/PKHeX.Core/Legality/Encounters/EncounterTrade/EncounterTrade.cs

288 lines
10 KiB
C#
Raw Normal View History

using System;
using System.Collections.Generic;
using System.Linq;
namespace PKHeX.Core
{
/// <summary>
/// Trade Encounter data
/// </summary>
/// <remarks>
/// Trade data is fixed level in all cases except for the first few generations of games.
/// </remarks>
public abstract class EncounterTrade : IEncounterable, IMoveset, ILocation, IVersionSet
{
2020-12-22 01:05:05 +00:00
public int Species { get; init; }
public int Form { get; init; }
public int Level { get; init; }
public virtual int LevelMin => Level;
public int LevelMax => 100;
2020-12-22 01:05:05 +00:00
public IReadOnlyList<int> Moves { get; init; } = Array.Empty<int>();
public abstract int Generation { get; }
2020-12-22 01:05:05 +00:00
public int CurrentLevel { get; init; } = -1;
public int Location { get; init; }
public int Ability { get; init; }
public int Gender { get; init; } = -1;
public Nature Nature = Nature.Random;
2020-12-22 01:05:05 +00:00
public Shiny Shiny { get; init; } = Shiny.Never;
public int Ball { get; init; } = 4;
2020-12-22 01:05:05 +00:00
public int TID { get; internal set; }
public int SID { get; internal set; }
public int OTGender { get; init; } = -1;
public GameVersion Version { get; set; } = GameVersion.Any;
2020-12-22 01:05:05 +00:00
public IReadOnlyList<int> IVs { get; init; } = Array.Empty<int>();
public int FlawlessIVCount { get; init; }
Gen 1 move analysis improvement. Adapted the valid moves to take into account that move deleter and move reminder do not exits in generation 1 (#1037) * Fix getMoves with min level, when SkipWhile and TakeWhile is used together the index i in TakeWhile is calculated from the enumerator that results of the SkipWhile function, not the index of the initial array, those giving an incorrect index to check Levels array in the TakeWhile * Fix getMoves when levelmin or levelmax is above max level in the levels array, TakeWhile and SkipWhile return empty list if the while goes beyond the last element of the array * Include player hatched egg in the list of possible encounters for parseMoves only if the pokemon was an egg Also change the valur of WasEgg for gen1,2,3 pokemon if the encounter analyzed is not an egg add the non egg encounters to the list instead of checking the non-egg encounter inside parseMovesWasEggPreRelearn * Fix for gen3 egg encounters Remove non-egg encounters without special moves if there is an egg encounter because egg encounter already cover every possible move combination Do not add daycare egg encounter for gen3 unhatched egg if there is another encounter, that means is an event or gift egg, not a daycare egg Remove duplicate encounters * Gift egg should not allow inherited moves even it they dont have special moves Those gift eggs are hatched only with the species base moves * Added getEncounterMoves functions, to be used for generation 1 encounters to find what moves have a pokemon at the moment of being caught because there is no move reminder in generation 1 * Added GBEncounterData, structure for refactor the tuples used in generation 1 and 2 encounters * Add LevelMin and LevelMax to IEncounterable to get the encounter moves by the min level of the generation 1 EncounterLink Add iGeneration to difference generation 1 and generation 2 encounters for GB Era pokemon * Mark generation in gen 1 and 2 encounters There is no need to mark the generation in gen 3 to 7 encounters because in that generations it match the pokemon generation number * Add min level for generation 1 moves in getMoves functions Add function to return the default moves for a GB encounters, for generation 1 games that included both moves from level up table and level 1 moves from personal table Fix getMoves with min level when the moves list is empty, like Raichu generation 1 * Add maxSpecies to getBaseSpecies function for gen1 pokemon with a gen2 egg encounter Refactor VC Encounter changing Tuples for GBData class * Fixed for gen 2 Checks Also do not search for generation1 encounter if the gen2 pokemon have met location from crystal * Fix VC wild encounters, should be stored as array or else other verifyEncounter functions wont work * Add generation 1 parse moves function including default moves * Clean-up get encounters * Verify empty moves for generation 1 encounters, in generation 1 does not exits move deleter That means when a move slot have been used by a level up move or a TM/HM/Tutor move it cant be empty again Does not apply if generation 2 tradeback is allowed, in generation 2 there is a move deleter * Added two edge cases for pokemon that learn in red/blue and yellow different moves at the same level, this combinations can not exits until a later level when they learn again one of the levels in the other game, only happen for flareon and vaporeon * Check incompatible moves between evolution species, it is for species that learn a move in a level as an evolved species and a move at a upper level as a preevolution Also added most edge cases for the min slots used for generation 1 games, i think every weird combination is already covered * Fix gen 1 eevee and evolutions move checks * Cleanup * Move the code to change valid moves for generation 1 to a function * Fix getMoveMinLevelGBEncounter * getUsedMoveSlots, removed wild Butterfree edge case, it is not possible * Filter the min level of the encounter by the possible games the pokemon could be originated, yellow pikachu and kadabra can be detected
2017-04-09 00:17:20 +00:00
public bool EggEncounter => false;
2020-12-22 01:05:05 +00:00
public int EggLocation { get; init; }
public bool EvolveOnTrade { get; init; }
2018-11-11 05:07:31 +00:00
public int TID7
{
set
{
TID = (ushort) value;
SID = value >> 16;
}
}
private const string _name = "In-game Trade";
public string Name => _name;
public string LongName => _name;
2020-12-22 01:05:05 +00:00
public bool IsNicknamed { get; init; } = true;
public IReadOnlyList<string> Nicknames { get; internal set; } = Array.Empty<string>();
public IReadOnlyList<string> TrainerNames { get; internal set; } = Array.Empty<string>();
public string GetNickname(int language) => (uint)language < Nicknames.Count ? Nicknames[language] : string.Empty;
public string GetOT(int language) => (uint)language < TrainerNames.Count ? TrainerNames[language] : string.Empty;
public bool HasNickname => Nicknames.Count != 0 && IsNicknamed;
public bool HasTrainerName => TrainerNames.Count != 0;
private static int GetDefaultMetLocation(int generation)
{
return generation switch
{
1 => 0,
2 => Locations.LinkTrade2NPC,
3 => Locations.LinkTrade3NPC,
4 => Locations.LinkTrade4NPC,
5 => Locations.LinkTrade5NPC,
6 => Locations.LinkTrade6NPC,
7 => Locations.LinkTrade6NPC, // 7 is same as 6
8 => Locations.LinkTrade6NPC, // 8 is same as 6
_ => throw new IndexOutOfRangeException(nameof(generation)),
};
}
public PKM ConvertToPKM(ITrainerInfo sav) => ConvertToPKM(sav, EncounterCriteria.Unrestricted);
public PKM ConvertToPKM(ITrainerInfo sav, EncounterCriteria criteria)
{
var pk = PKMConverter.GetBlank(Generation, Version);
sav.ApplyTo(pk);
ApplyDetails(sav, criteria, pk);
2019-11-16 01:34:18 +00:00
return pk;
}
protected virtual void ApplyDetails(ITrainerInfo sav, EncounterCriteria criteria, PKM pk)
2019-11-16 01:34:18 +00:00
{
var version = this.GetCompatibleVersion((GameVersion)sav.Game);
int lang = (int)Language.GetSafeLanguage(Generation, (LanguageID)sav.Language);
int level = CurrentLevel > 0 ? CurrentLevel : LevelMin;
if (level == 0)
level = Math.Max(1, LevelMin);
int species = Species;
if (EvolveOnTrade)
species++;
pk.EncryptionConstant = Util.Rand32();
pk.Species = species;
pk.Form = Form;
pk.Language = lang;
pk.OT_Name = pk.Format == 1 ? StringConverter12.G1TradeOTStr : HasTrainerName ? GetOT(lang) : sav.OT;
pk.OT_Gender = HasTrainerName ? Math.Max(0, OTGender) : sav.Gender;
pk.SetNickname(HasNickname ? GetNickname(lang) : string.Empty);
pk.CurrentLevel = level;
2019-11-16 01:34:18 +00:00
pk.Version = (int) version;
pk.TID = TID;
pk.SID = SID;
pk.Ball = Ball;
pk.OT_Friendship = pk.PersonalInfo.BaseFriendship;
SetPINGA(pk, criteria);
SetMoves(pk, version, level);
var time = DateTime.Now;
if (pk.Format != 2 || version == GameVersion.C)
{
var location = Location != 0 ? Location : GetDefaultMetLocation(Generation);
SetMetData(pk, level, location, time);
}
else
{
pk.OT_Gender = 0;
}
2019-11-16 01:34:18 +00:00
if (EggLocation != 0)
SetEggMetData(pk, time);
UpdateEdgeCase(pk);
if (pk.Format < 6)
2019-11-16 01:34:18 +00:00
return;
sav.ApplyHandlingTrainerInfo(pk, force: true);
pk.SetRandomEC();
if (pk is PK6 pk6)
pk6.SetRandomMemory6();
}
protected virtual void SetPINGA(PKM pk, EncounterCriteria criteria)
{
2020-06-21 23:16:34 +00:00
var pi = pk.PersonalInfo;
int gender = criteria.GetGender(Gender, pi);
int nature = (int)criteria.GetNature(Nature);
int ability = criteria.GetAbilityFromNumber(Ability, pi);
PIDGenerator.SetRandomWildPID(pk, Generation, nature, ability, gender);
pk.Nature = pk.StatNature = nature;
pk.Gender = gender;
pk.RefreshAbility(ability);
SetIVs(pk);
}
protected void SetIVs(PKM pk)
{
if (IVs.Count != 0)
pk.SetRandomIVs(IVs, 0);
else
pk.SetRandomIVs(flawless: 3);
}
private void SetMoves(PKM pk, GameVersion version, int level)
{
var moves = Moves.Count != 0 ? Moves : MoveLevelUp.GetEncounterMoves(pk, level, version);
if (pk.Format == 1 && moves.All(z => z == 0))
moves = ((PersonalInfoG1)PersonalTable.RB[Species]).Moves;
pk.SetMoves(moves);
pk.SetMaximumPPCurrent(moves);
}
private void SetEggMetData(PKM pk, DateTime time)
{
pk.Egg_Location = EggLocation;
pk.EggMetDate = time;
}
private static void SetMetData(PKM pk, int level, int location, DateTime time)
{
pk.Met_Level = level;
pk.Met_Location = location;
pk.MetDate = time;
}
private void UpdateEdgeCase(PKM pkm)
{
switch (Generation)
{
2019-06-01 17:22:49 +00:00
case 3 when Species == (int)Core.Species.Jynx && pkm.Version == (int) GameVersion.LG && pkm.Language == (int) LanguageID.Italian:
// Italian LG Jynx untranslated from English name
2019-06-01 17:22:49 +00:00
pkm.OT_Name = GetOT((int)LanguageID.English);
pkm.SetNickname(GetNickname((int)LanguageID.English));
break;
2019-06-01 17:22:49 +00:00
case 4 when Version == GameVersion.DPPt && Species == (int)Core.Species.Magikarp: // Meister Magikarp
// Has German Language ID for all except German origin, which is English
pkm.Language = (int)(pkm.Language == (int)LanguageID.German ? LanguageID.English : LanguageID.German);
break;
case 4 when Version == GameVersion.DPPt && (pkm.Version == (int)GameVersion.D || pkm.Version == (int)GameVersion.P):
// DP English origin are Japanese lang
2019-06-01 17:22:49 +00:00
pkm.Language = (int)LanguageID.Japanese;
break;
2019-06-01 17:22:49 +00:00
case 4 when Version == GameVersion.HGSS && Species == (int)Core.Species.Pikachu: // Pikachu
// Has English Language ID for all except English origin, which is French
pkm.Language = (int)(pkm.Language == (int)LanguageID.English ? LanguageID.French : LanguageID.English);
break;
2019-06-01 17:22:49 +00:00
case 5 when Version == GameVersion.BW && pkm.Language == (int)LanguageID.Japanese:
// Trades for JPN games have language ID of 0, not 1.
pkm.Language = 0;
break;
}
}
public virtual bool IsMatch(PKM pkm, DexLevel evo)
{
if (IVs.Count != 0)
{
2019-05-15 19:07:48 +00:00
if (!Legal.GetIsFixedIVSequenceValidSkipRand(IVs, pkm))
return false;
}
2019-11-16 01:34:18 +00:00
if (!IsMatchNatureGenderShiny(pkm))
return false;
if (TID != pkm.TID)
return false;
if (SID != pkm.SID)
return false;
if (!IsMatchLevel(pkm, evo))
2019-11-16 01:34:18 +00:00
return false;
if (CurrentLevel != -1 && CurrentLevel > pkm.CurrentLevel)
return false;
if (Form != evo.Form && !FormInfo.IsFormChangeable(Species, Form, pkm.Form, pkm.Format))
2019-11-16 01:34:18 +00:00
return false;
if (OTGender != -1 && OTGender != pkm.OT_Gender)
return false;
if (EggLocation != pkm.Egg_Location)
return false;
// if (z.Ability == 4 ^ pkm.AbilityNumber == 4) // defer to Ability
// continue;
2019-11-16 01:34:18 +00:00
if (!Version.Contains((GameVersion)pkm.Version))
return false;
return true;
}
private bool IsMatchLevel(PKM pkm, DexLevel evo)
2019-11-16 01:34:18 +00:00
{
if (!pkm.HasOriginalMetLocation)
return evo.Level >= Level;
var loc = Location != 0 ? Location : GetDefaultMetLocation(Generation);
if (loc != pkm.Met_Location)
return false;
if (pkm.Format < 5)
return evo.Level >= Level;
return pkm.Met_Level == Level;
2019-11-16 01:34:18 +00:00
}
2019-11-16 01:34:18 +00:00
protected virtual bool IsMatchNatureGenderShiny(PKM pkm)
{
if (!Shiny.IsValid(pkm))
return false;
2019-11-16 01:34:18 +00:00
if (Gender != -1 && Gender != pkm.Gender)
return false;
2019-11-16 01:34:18 +00:00
if (Nature != Nature.Random && pkm.Nature != (int)Nature)
return false;
return true;
}
}
}