gift-pokemon: Document empty encounter_slots

I'm going to record gift-pokemon as having no encounter slot, which I
believe is correct by-and-large (since you always get the same mon).

There are a few randomized gift pokemon which do have some type
of encounter slot (eg. Crystal's Odd Egg). Those aren't tracked (yet).
This commit is contained in:
Jonathan Rubin 2018-04-14 11:30:57 -04:00 committed by Jonathan Rubin
parent 61dfeed80f
commit 8694c8464a
1 changed files with 11 additions and 1 deletions

View File

@ -850,7 +850,17 @@ create_translation_table('encounter_method_prose', EncounterMethod, 'prose',
)
class EncounterSlot(TableBase):
u"""An abstract "slot" within a method, associated with both some set of conditions and a rarity."""
u"""An abstract "slot" within a method, associated with both some set of conditions and a rarity.
"slot" has a very specific meaning:
If during gameplay you know sufficient details about the current game state,
you can predict which slot (and therefore which pokemon) will spawn.
There are currently two reasons that "slot" might be empty:
1) The slot corresponds to a gift pokemon.
2) Red/Blue's Super Rod slots, which don't correspond to in-game slots.
See https://github.com/veekun/pokedex/issues/166#issuecomment-220101455
"""
__tablename__ = 'encounter_slots'
id = Column(Integer, primary_key=True, nullable=False,