2017-05-12 16:41:21 +00:00
using System.Collections.Generic ;
2017-12-02 05:23:37 +00:00
using System.Linq ;
2017-05-12 16:41:21 +00:00
namespace PKHeX.Core
{
2017-05-14 21:42:18 +00:00
public static class FrameFinder
2017-05-12 16:41:21 +00:00
{
2017-05-14 19:42:27 +00:00
/// <summary>
/// Checks a <see cref="PIDIV"/> to see if any encounter frames can generate the spread. Requires further filtering against matched Encounter Slots and generation patterns.
/// </summary>
/// <param name="pidiv">Matched <see cref="PIDIV"/> containing <see cref="PIDIV.RNG"/> info and <see cref="PIDIV.OriginSeed"/>.</param>
/// <param name="pk"><see cref="PKM"/> object containing various accessible information required for the encounter.</param>
2017-05-14 21:42:18 +00:00
/// <returns><see cref="IEnumerable{Frame}"/> to yield possible encounter details for further filtering</returns>
2017-06-18 01:37:19 +00:00
public static IEnumerable < Frame > GetFrames ( PIDIV pidiv , PKM pk )
2017-05-12 16:41:21 +00:00
{
2017-11-25 21:53:39 +00:00
if ( pidiv . RNG = = null )
2017-12-02 05:23:37 +00:00
return Enumerable . Empty < Frame > ( ) ;
2017-05-15 06:21:34 +00:00
FrameGenerator info = new FrameGenerator ( pidiv , pk ) ;
if ( info . FrameType = = FrameType . None )
2017-12-02 05:23:37 +00:00
return Enumerable . Empty < Frame > ( ) ;
2017-05-12 16:41:21 +00:00
2017-05-15 06:21:34 +00:00
info . Nature = pk . EncryptionConstant % 25 ;
// gather possible nature determination seeds until a same-nature PID breaks the unrolling
2017-11-30 02:28:20 +00:00
var seeds = pk . Species = = 201 & & pk . FRLG // reversed await case
? SeedInfo . GetSeedsUntilUnownForm ( pidiv , info , pk . AltForm )
: SeedInfo . GetSeedsUntilNature ( pidiv , info ) ;
2017-05-15 06:21:34 +00:00
2018-05-12 15:13:39 +00:00
var frames = pidiv . Type = = PIDType . CuteCharm
? FilterCuteCharm ( seeds , pidiv , info )
2017-06-18 01:37:19 +00:00
: FilterNatureSync ( seeds , pidiv , info ) ;
2017-05-15 06:21:34 +00:00
2017-06-18 01:37:19 +00:00
var refined = RefineFrames ( frames , info ) ;
2017-12-02 05:23:37 +00:00
if ( pk . Gen4 & & pidiv . Type = = PIDType . CuteCharm ) // only permit cute charm successful frames
return refined . Where ( z = > ( z . Lead & ~ LeadRequired . UsesLevelCall ) = = LeadRequired . CuteCharm ) ;
return refined ;
2017-05-15 06:21:34 +00:00
}
2017-06-18 01:37:19 +00:00
private static IEnumerable < Frame > RefineFrames ( IEnumerable < Frame > frames , FrameGenerator info )
2017-05-15 06:21:34 +00:00
{
return info . FrameType = = FrameType . MethodH
2017-06-18 01:37:19 +00:00
? RefineFrames3 ( frames , info )
: RefineFrames4 ( frames , info ) ;
2017-05-15 06:21:34 +00:00
}
2017-05-14 21:42:18 +00:00
2017-06-18 01:37:19 +00:00
private static IEnumerable < Frame > RefineFrames3 ( IEnumerable < Frame > frames , FrameGenerator info )
2017-05-15 06:21:34 +00:00
{
2017-11-26 22:48:55 +00:00
// ESV
// Level
// Nature
// Current Seed of the frame is the Level Calc (frame before nature)
2017-05-15 06:21:34 +00:00
var list = new List < Frame > ( ) ;
foreach ( var f in frames )
2017-05-12 16:41:21 +00:00
{
2017-11-27 00:09:24 +00:00
bool noLead = ! info . AllowLeads & & f . Lead ! = LeadRequired . None ;
if ( noLead )
continue ;
2017-05-15 06:21:34 +00:00
var prev = info . RNG . Prev ( f . Seed ) ; // ESV
var rand = prev > > 16 ;
2017-12-02 00:33:03 +00:00
f . RandESV = rand ;
2017-11-30 07:20:49 +00:00
f . RandLevel = f . Seed > > 16 ;
2017-12-03 15:13:28 +00:00
f . OriginSeed = info . RNG . Prev ( prev ) ;
2017-12-02 01:27:09 +00:00
if ( f . Lead ! = LeadRequired . CuteCharm ) // needs proc checking
yield return f ;
2017-05-15 06:21:34 +00:00
// Generate frames for other slots after the regular slots
2017-11-27 00:09:24 +00:00
if ( info . AllowLeads & & ( f . Lead = = LeadRequired . CuteCharm | | f . Lead = = LeadRequired . None ) )
list . Add ( f ) ;
2017-05-12 16:41:21 +00:00
}
2017-11-27 00:09:24 +00:00
foreach ( var f in list )
{
var leadframes = GenerateLeadSpecificFrames3 ( f , info ) ;
foreach ( var frame in leadframes )
yield return frame ;
}
}
2018-09-15 05:37:47 +00:00
2017-11-27 00:09:24 +00:00
private static IEnumerable < Frame > GenerateLeadSpecificFrames3 ( Frame f , FrameGenerator info )
{
2017-11-26 22:48:55 +00:00
// Check leads -- none in list if leads are not allowed
// Certain leads inject a RNG call
// 3 different rand places
2017-11-27 00:09:24 +00:00
LeadRequired lead ;
var prev0 = f . Seed ; // 0
2018-10-27 15:53:09 +00:00
var prev1 = info . RNG . Prev ( f . Seed ) ; // -1
2017-11-27 00:09:24 +00:00
var prev2 = info . RNG . Prev ( prev1 ) ; // -2
2017-12-02 00:33:03 +00:00
var prev3 = info . RNG . Prev ( prev2 ) ; // -3
2017-11-26 22:48:55 +00:00
2017-11-27 00:09:24 +00:00
// Rand call raw values
var p0 = prev0 > > 16 ;
var p1 = prev1 > > 16 ;
var p2 = prev2 > > 16 ;
2017-11-26 22:48:55 +00:00
2017-11-27 00:09:24 +00:00
// Cute Charm
// -2 ESV
// -1 Level
// 0 CC Proc (Random() % 3 != 0)
// 1 Nature
if ( info . Gendered )
{
bool cc = p0 % 3 ! = 0 ;
if ( f . Lead = = LeadRequired . CuteCharm ) // 100% required for frame base
2017-11-26 22:48:55 +00:00
{
2017-11-27 00:09:24 +00:00
if ( cc )
2017-12-02 00:33:03 +00:00
yield return info . GetFrame ( prev2 , LeadRequired . CuteCharm , p2 , p1 , prev3 ) ;
2017-11-27 00:09:24 +00:00
yield break ;
2017-11-26 22:48:55 +00:00
}
lead = cc ? LeadRequired . CuteCharm : LeadRequired . CuteCharmFail ;
2017-12-02 00:33:03 +00:00
yield return info . GetFrame ( prev2 , lead , p2 , p1 , prev3 ) ;
2017-11-27 00:09:24 +00:00
}
2017-12-02 05:23:37 +00:00
if ( f . Lead = = LeadRequired . CuteCharm )
yield break ;
2017-11-26 22:48:55 +00:00
2017-11-27 00:09:24 +00:00
// Pressure, Hustle, Vital Spirit = Force Maximum Level from slot
// -2 ESV
// -1 Level
// 0 LevelMax proc (Random() & 1)
// 1 Nature
bool max = p0 % 2 = = 1 ;
lead = max ? LeadRequired . PressureHustleSpirit : LeadRequired . PressureHustleSpiritFail ;
2017-12-02 00:33:03 +00:00
yield return info . GetFrame ( prev2 , lead , p2 , p1 , prev3 ) ;
2017-11-27 00:09:24 +00:00
2017-12-02 23:44:44 +00:00
// Keen Eye, Intimidate (Not compatible with Sweet Scent)
2017-11-27 00:09:24 +00:00
// -2 ESV
// -1 Level
// 0 Level Adequate Check !(Random() % 2 == 1) rejects -- rand%2==1 is adequate
// 1 Nature
// Note: if this check fails, the encounter generation routine is aborted.
if ( max ) // same result as above, no need to recalculate
{
lead = LeadRequired . IntimidateKeenEye ;
2017-12-02 00:33:03 +00:00
yield return info . GetFrame ( prev2 , lead , p2 , p1 , prev3 ) ;
2017-11-27 00:09:24 +00:00
}
// Static or Magnet Pull
// -2 SlotProc (Random % 2 == 0)
// -1 ESV (select slot)
// 0 Level
// 1 Nature
bool force = p2 % 2 = = 0 ;
if ( force )
{
// Since a failed proc is indistinguishable from the default frame calls, only generate if it succeeds.
lead = LeadRequired . StaticMagnet ;
2017-12-02 00:33:03 +00:00
yield return info . GetFrame ( prev2 , lead , p1 , p0 , prev3 ) ;
2017-05-15 06:21:34 +00:00
}
}
2017-11-27 00:09:24 +00:00
2017-06-18 01:37:19 +00:00
private static IEnumerable < Frame > RefineFrames4 ( IEnumerable < Frame > frames , FrameGenerator info )
2017-05-15 06:21:34 +00:00
{
var list = new List < Frame > ( ) ;
foreach ( var f in frames )
{
// Current Seed of the frame is the ESV.
var rand = f . Seed > > 16 ;
2017-12-02 00:33:03 +00:00
f . RandESV = rand ;
2017-12-02 05:23:37 +00:00
f . RandLevel = rand ; // unused
2017-12-02 00:33:03 +00:00
f . OriginSeed = info . RNG . Prev ( f . Seed ) ;
yield return f ;
2017-05-15 06:21:34 +00:00
2017-12-02 05:23:37 +00:00
// Create a copy for level; shift ESV and origin back
2017-12-02 06:49:38 +00:00
var esv = f . OriginSeed > > 16 ;
2017-12-02 05:23:37 +00:00
var origin = info . RNG . Prev ( f . OriginSeed ) ;
var withLevel = info . GetFrame ( f . Seed , f . Lead | LeadRequired . UsesLevelCall , esv , f . RandLevel , origin ) ;
yield return withLevel ;
2017-05-15 06:21:34 +00:00
if ( f . Lead ! = LeadRequired . None )
continue ;
// Generate frames for other slots after the regular slots
list . Add ( f ) ;
}
foreach ( var f in list )
{
2017-12-02 05:23:37 +00:00
var leadframes = GenerateLeadSpecificFrames4 ( f , info ) ;
foreach ( var frame in leadframes )
yield return frame ;
}
}
2018-09-15 05:37:47 +00:00
2017-12-02 05:23:37 +00:00
private static IEnumerable < Frame > GenerateLeadSpecificFrames4 ( Frame f , FrameGenerator info )
{
LeadRequired lead ;
var prev0 = f . Seed ; // 0
2018-10-27 15:53:09 +00:00
var prev1 = info . RNG . Prev ( f . Seed ) ; // -1
2017-12-02 05:23:37 +00:00
var prev2 = info . RNG . Prev ( prev1 ) ; // -2
var prev3 = info . RNG . Prev ( prev2 ) ; // -3
2017-05-15 06:21:34 +00:00
2017-12-02 05:23:37 +00:00
// Rand call raw values
var p0 = prev0 > > 16 ;
var p1 = prev1 > > 16 ;
var p2 = prev2 > > 16 ;
2017-05-15 06:21:34 +00:00
2017-12-02 05:23:37 +00:00
// Cute Charm
// -2 ESV
// -1 Level (Optional)
// 0 CC Proc (Random() % 3 != 0)
// 1 Nature
if ( info . Gendered )
{
2017-12-02 23:44:44 +00:00
bool cc = ( info . DPPt ? p0 / 0x5556 : p0 % 3 ) ! = 0 ;
2017-12-02 05:23:37 +00:00
if ( f . Lead = = LeadRequired . CuteCharm ) // 100% required for frame base
{
if ( ! cc ) yield break ;
yield return info . GetFrame ( prev2 , LeadRequired . CuteCharm , p1 , p1 , prev2 ) ;
yield return info . GetFrame ( prev2 , LeadRequired . CuteCharm | LeadRequired . UsesLevelCall , p2 , p1 , prev3 ) ;
yield break ;
}
lead = cc ? LeadRequired . CuteCharm : LeadRequired . CuteCharmFail ;
yield return info . GetFrame ( prev2 , lead , p1 , p1 , prev2 ) ;
yield return info . GetFrame ( prev2 , lead | LeadRequired . UsesLevelCall , p2 , p1 , prev3 ) ;
2017-05-15 06:21:34 +00:00
}
2017-12-02 05:23:37 +00:00
if ( f . Lead = = LeadRequired . CuteCharm )
yield break ;
// Pressure, Hustle, Vital Spirit = Force Maximum Level from slot
// -2 ESV
// -1 Level (Optional)
// 0 LevelMax proc (Random() & 1)
// 1 Nature
2017-12-02 23:44:44 +00:00
bool max = ( info . DPPt ? p0 > > 15 : p0 & 1 ) = = 1 ;
2017-12-02 05:23:37 +00:00
lead = max ? LeadRequired . PressureHustleSpirit : LeadRequired . PressureHustleSpiritFail ;
yield return info . GetFrame ( prev2 , lead , p1 , p1 , prev2 ) ;
yield return info . GetFrame ( prev2 , lead | LeadRequired . UsesLevelCall , p2 , p1 , prev3 ) ;
2017-12-02 23:44:44 +00:00
// Keen Eye, Intimidate (Not compatible with Sweet Scent)
2017-12-02 05:23:37 +00:00
// -2 ESV
// -1 Level (Optional)
// 0 Level Adequate Check !(Random() % 2 == 1) rejects -- rand%2==1 is adequate
// 1 Nature
// Note: if this check fails, the encounter generation routine is aborted.
if ( max ) // same result as above, no need to recalculate
{
lead = LeadRequired . IntimidateKeenEye ;
yield return info . GetFrame ( prev2 , lead , p1 , p1 , prev2 ) ;
yield return info . GetFrame ( prev2 , lead | LeadRequired . UsesLevelCall , p2 , p1 , prev3 ) ;
}
// Static or Magnet Pull
// -2 SlotProc (Random % 2 == 0)
// -1 ESV (select slot)
// 0 Level (Optional)
// 1 Nature
var force1 = ( info . DPPt ? p1 > > 15 : p1 & 1 ) = = 1 ;
lead = force1 ? LeadRequired . StaticMagnet : LeadRequired . StaticMagnetFail ;
yield return info . GetFrame ( prev2 , lead , p0 , p0 , prev3 ) ;
var force2 = ( info . DPPt ? p2 > > 15 : p2 & 1 ) = = 1 ;
lead = ( force2 ? LeadRequired . StaticMagnet : LeadRequired . StaticMagnetFail ) | LeadRequired . UsesLevelCall ;
yield return info . GetFrame ( prev2 , lead , p1 , p0 , prev3 ) ;
2017-05-12 16:41:21 +00:00
}
2017-05-14 19:42:27 +00:00
/// <summary>
/// Filters the input <see cref="SeedInfo"/> according to a Nature Lock frame generation pattern.
/// </summary>
/// <param name="seeds">Seed Information for the frame</param>
/// <param name="pidiv">PIDIV Info for the frame</param>
/// <param name="info">Search Info for the frame</param>
/// <returns>Possible matches to the Nature Lock frame generation pattern</returns>
2017-06-18 01:37:19 +00:00
private static IEnumerable < Frame > FilterNatureSync ( IEnumerable < SeedInfo > seeds , PIDIV pidiv , FrameGenerator info )
2017-05-12 16:41:21 +00:00
{
2017-05-14 19:42:27 +00:00
foreach ( var seed in seeds )
2017-05-12 16:41:21 +00:00
{
2017-05-14 19:42:27 +00:00
var s = seed . Seed ;
2017-11-27 04:07:38 +00:00
if ( info . Safari3 )
{
// successful pokeblock activation
bool result = IsValidPokeBlockNature ( s , info . Nature , out uint blockSeed ) ;
if ( result )
yield return info . GetFrame ( blockSeed , seed . Charm3 ? LeadRequired . CuteCharm : LeadRequired . None ) ;
// if no pokeblocks present (or failed call), fall out of the safari specific code and generate via the other scenarios
}
2017-05-12 16:41:21 +00:00
var rand = s > > 16 ;
2017-05-15 06:21:34 +00:00
bool sync = info . AllowLeads & & ! seed . Charm3 & & ( info . DPPt ? rand > > 15 : rand & 1 ) = = 0 ;
2017-05-14 19:42:27 +00:00
bool reg = ( info . DPPt ? rand / 0xA3E : rand % 25 ) = = info . Nature ;
2017-05-12 16:41:21 +00:00
if ( ! sync & & ! reg ) // doesn't generate nature frame
continue ;
uint prev = pidiv . RNG . Prev ( s ) ;
2017-05-15 06:21:34 +00:00
if ( info . AllowLeads & & reg ) // check for failed sync
2017-05-12 16:41:21 +00:00
{
2017-05-14 19:42:27 +00:00
var failsync = ( info . DPPt ? prev > > 31 : ( prev > > 16 ) & 1 ) ! = 1 ;
2017-05-12 16:41:21 +00:00
if ( failsync )
2017-05-14 21:42:18 +00:00
yield return info . GetFrame ( pidiv . RNG . Prev ( prev ) , LeadRequired . SynchronizeFail ) ;
2017-05-12 16:41:21 +00:00
}
if ( sync )
2017-05-14 21:42:18 +00:00
yield return info . GetFrame ( prev , LeadRequired . Synchronize ) ;
2017-05-12 16:41:21 +00:00
if ( reg )
2017-05-14 21:42:18 +00:00
{
if ( seed . Charm3 )
2018-10-27 15:53:09 +00:00
{
2017-05-14 21:42:18 +00:00
yield return info . GetFrame ( prev , LeadRequired . CuteCharm ) ;
2018-10-27 15:53:09 +00:00
}
2017-05-14 21:42:18 +00:00
else
2017-11-29 04:56:21 +00:00
{
if ( info . Safari3 )
prev = pidiv . RNG . Prev ( prev ) ; // wasted RNG call
2017-05-14 21:42:18 +00:00
yield return info . GetFrame ( prev , LeadRequired . None ) ;
2017-11-29 04:56:21 +00:00
}
2017-05-14 21:42:18 +00:00
}
2017-05-12 16:41:21 +00:00
}
}
2018-09-15 05:37:47 +00:00
2017-11-27 04:07:38 +00:00
private static bool IsValidPokeBlockNature ( uint seed , uint nature , out uint natureOrigin )
{
if ( nature % 6 = = 0 ) // neutral
{
natureOrigin = 0 ;
return false ;
}
// unroll the RNG to a stack of seeds
var stack = new Stack < uint > ( ) ;
for ( uint i = 0 ; i < 25 ; i + + )
2018-10-27 15:53:09 +00:00
{
for ( uint j = 1 + i ; j < 25 ; j + + )
stack . Push ( seed = RNG . LCRNG . Prev ( seed ) ) ;
}
2017-11-27 04:07:38 +00:00
natureOrigin = RNG . LCRNG . Prev ( stack . Peek ( ) ) ;
if ( natureOrigin > > 16 % 100 > = 80 ) // failed proc
return false ;
// init natures
uint [ ] natures = new uint [ 25 ] ;
for ( uint i = 0 ; i < 25 ; i + + )
natures [ i ] = i ;
// shuffle nature list
for ( uint i = 0 ; i < 25 ; i + + )
{
2018-10-27 15:53:09 +00:00
for ( uint j = 1 + i ; j < 25 ; j + + )
{
var s = stack . Pop ( ) ;
if ( ( s > > 16 & 1 ) = = 0 )
continue ; // only swap if 1
2017-11-27 04:07:38 +00:00
2018-10-27 15:53:09 +00:00
var temp = natures [ i ] ;
natures [ i ] = natures [ j ] ;
natures [ j ] = temp ;
}
2017-11-27 04:07:38 +00:00
}
2018-05-12 15:13:39 +00:00
2017-11-27 04:07:38 +00:00
var likes = Pokeblock . GetLikedBlockFlavor ( nature ) ;
// best case scenario is a perfect flavored pokeblock for the nature.
// has liked flavor, and all other non-disliked flavors are present.
// is it possible to skip this step?
for ( int i = 0 ; i < 25 ; i + + )
{
var n = natures [ i ] ;
if ( n = = nature )
break ;
var nl = Pokeblock . GetLikedBlockFlavor ( natures [ i ] ) ;
if ( nl = = likes ) // next random nature likes the same block as the desired nature
return false ; // current nature is chosen instead, fail!
}
// unroll once more to hit the level calc (origin with respect for beginning the nature calcs)
natureOrigin = RNG . LCRNG . Prev ( natureOrigin ) ;
return true ;
}
2017-05-14 19:42:27 +00:00
/// <summary>
/// Filters the input <see cref="SeedInfo"/> according to a Cute Charm frame generation pattern.
/// </summary>
/// <param name="seeds">Seed Information for the frame</param>
/// <param name="pidiv">PIDIV Info for the frame</param>
/// <param name="info">Search Info for the frame</param>
/// <returns>Possible matches to the Cute Charm frame generation pattern</returns>
2017-06-18 01:37:19 +00:00
private static IEnumerable < Frame > FilterCuteCharm ( IEnumerable < SeedInfo > seeds , PIDIV pidiv , FrameGenerator info )
2017-05-12 16:41:21 +00:00
{
2017-05-14 19:42:27 +00:00
foreach ( var seed in seeds )
2017-05-12 16:41:21 +00:00
{
2017-05-14 19:42:27 +00:00
var s = seed . Seed ;
2017-05-12 16:41:21 +00:00
var rand = s > > 16 ;
2017-05-14 19:42:27 +00:00
var nature = info . DPPt ? rand / 0xA3E : rand % 25 ;
if ( nature ! = info . Nature )
continue ;
var prev = pidiv . RNG . Prev ( s ) ;
var proc = prev > > 16 ;
2017-11-26 22:48:55 +00:00
bool charmProc = ( info . DPPt ? proc / 0x5556 : proc % 3 ) ! = 0 ; // 2/3 odds
2017-05-14 19:42:27 +00:00
if ( ! charmProc )
continue ;
2017-05-14 21:42:18 +00:00
yield return info . GetFrame ( prev , LeadRequired . CuteCharm ) ;
2017-05-12 16:41:21 +00:00
}
}
}
}