Refactored encounters schema so HG/SS can work.

Conditions are now condition values; condition groups are conditions.
Types are now terrain.  Slots are first-class things.

Encounters' condition values and slots' conditions have been broken off
into their own tables, as HG/SS has several slots affected by multiple
conditions.

pokedex/data/csv/encounter_condition_groups.csv

@@ -1,5 +0,0 @@
-id,name
-1,Swarm
-2,Time of day
-3,PokéRadar
-4,Gen 3 game in slot 2

pokedex/data/csv/encounter_condition_values.csv

@@ -0,0 +1,14 @@
+id,encounter_condition_id,name
+1,1,During a swarm
+2,2,Morning
+3,2,Day
+4,2,Night
+5,3,Using PokéRadar
+6,4,Ruby
+7,4,Sapphire
+8,4,Emerald
+9,4,Fire Red
+10,4,Leaf Green
+12,1,Not during a swarm
+13,3,Not using PokéRadar
+14,4,No game in slot 3

pokedex/data/csv/encounter_conditions.csv

@@ -1,11 +1,5 @@
-id,encounter_condition_group_id,name
+id,name
-1,1,During a swarm
+1,Swarm
-2,2,Morning
+2,Time of day
-3,2,Day
+3,PokéRadar
-4,2,Night
+4,Gen 3 game in slot 2
-5,3,Using PokéRadar
-6,4,Ruby
-7,4,Sapphire
-8,4,Emerald
-9,4,Fire Red
-10,4,Leaf Green

pokedex/data/csv/encounter_slot_conditions.csv

@@ -0,0 +1,10 @@
+encounter_slot_id,encounter_condition_id
+1,1
+2,2
+4,3
+5,4
+6,3
+27,2
+28,2
+29,2
+30,2

pokedex/data/csv/encounter_slots.csv

@@ -0,0 +1,33 @@
+id,encounter_terrain_id,rarity
+1,1,20
+2,1,10
+3,1,10
+4,1,5
+5,1,4
+6,1,1
+7,2,60
+8,2,30
+9,2,5
+10,2,4
+11,2,1
+12,3,60
+13,3,30
+14,3,5
+15,3,4
+16,3,1
+17,4,60
+18,4,30
+19,4,5
+20,4,4
+21,4,1
+22,5,60
+23,5,30
+24,5,5
+25,5,4
+26,5,1
+27,1,20
+28,1,5
+29,1,4
+30,1,1
+32,6,51
+33,6,49

pokedex/data/csv/encounter_type_slots.csv

@@ -1,33 +0,0 @@
-id,encounter_type_id,encounter_condition_group_id,rarity
-1,1,1,20
-2,1,2,10
-3,1,,10
-4,1,3,5
-5,1,4,4
-6,1,3,1
-7,2,,60
-8,2,,30
-9,2,,5
-10,2,,4
-11,2,,1
-12,3,,60
-13,3,,30
-14,3,,5
-15,3,,4
-16,3,,1
-17,4,,60
-18,4,,30
-19,4,,5
-20,4,,4
-21,4,,1
-22,5,,60
-23,5,,30
-24,5,,5
-25,5,,4
-26,5,,1
-27,1,2,20
-28,1,2,5
-29,1,2,4
-30,1,2,1
-32,6,,51
-33,6,,49

pokedex/db/tables.py

@@ -40,23 +40,23 @@ class EggGroup(TableBase):
     name = Column(Unicode(16), nullable=False)
 
 class Encounter(TableBase):
-    """Rows in this table represent encounters with wild Pokémon.
+    """Rows in this table represent encounters with wild Pokémon.  Bear with
+    me, here.
 
     Within a given area in a given game, encounters are differentiated by the
-    slot they are in and a world condition.
+    "slot" they are in and the state of the game world.
 
-    Groups of slots belong to encounter types; these are what the player is
+    What the player is doing to get an encounter, such as surfing or walking
-    doing to get an encounter, such as surfing or walking through tall grass.
+    through tall grass, is called terrain.  Each terrain has its own set of
+    encounter slots.
 
-    Within an encounter type, slots are defined primarily by rarity.  Each slot
+    Within a terrain, slots are defined primarily by rarity.  Each slot can
-    can also be affected by a world condition; for example, the 20% slot for
+    also be affected by world conditions; for example, the 20% slot for walking
-    walking in tall grass is affected by whether a swarm is in effect in the
+    in tall grass is affected by whether a swarm is in effect in that area.
-    areas.  "There is a swarm" and "there is not a swarm" are conditions, and
+    "Is there a swarm?" is a condition; "there is a swarm" and "there is not a
-    together they make a condition group.  However, since "not a swarm" is a
+    swarm" are the possible values of this condition.
-    base state rather than any sort of new state, it is omitted and instead
-    referred to by a NULL.
 
-    A slot (20% walking in grass) and single world condition (NULL, i.e. no
+    A slot (20% walking in grass) and any appropriate world conditions (no
     swarm) are thus enough to define a specific encounter.
     
     Well, okay, almost: each slot actually appears twice.
@@ -66,57 +66,66 @@ class Encounter(TableBase):
     id = Column(Integer, primary_key=True, nullable=False)
     version_id = Column(Integer, ForeignKey('versions.id'), nullable=False, autoincrement=False)
     location_area_id = Column(Integer, ForeignKey('location_areas.id'), nullable=False, autoincrement=False)
-    encounter_type_slot_id = Column(Integer, ForeignKey('encounter_type_slots.id'), nullable=False, autoincrement=False)
+    encounter_slot_id = Column(Integer, ForeignKey('encounter_slots.id'), nullable=False, autoincrement=False)
-    encounter_condition_id = Column(Integer, ForeignKey('encounter_conditions.id'), nullable=True, autoincrement=False)
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), nullable=False, autoincrement=False)
     min_level = Column(Integer, nullable=False, autoincrement=False)
     max_level = Column(Integer, nullable=False, autoincrement=False)
 
 class EncounterCondition(TableBase):
-    """Rows in this table represent something different about the world that
+    """Rows in this table represent varying conditions in the game world, such
-    can affect what Pokémon are encountered.
+    as time of day.
     """
 
     __tablename__ = 'encounter_conditions'
     id = Column(Integer, primary_key=True, nullable=False)
-    encounter_condition_group_id = Column(Integer, ForeignKey('encounter_condition_groups.id'), primary_key=False, nullable=False, autoincrement=False)
     name = Column(Unicode(64), nullable=False)
 
-class EncounterConditionGroup(TableBase):
+class EncounterConditionValue(TableBase):
-    """Rows in this table represent a group of mutually exclusive conditions,
+    """Rows in this table represent possible states for a condition; for
-    such as morning/day/night.  "Conditions" that are part of the default state
+    example, the state of 'swarm' could be 'swarm' or 'no swarm'.
-    of the world, such as "not during a swarm" or "not using the PokéRadar",
-    are not included in this table and are referred to by NULLs in other
-    tables.
     """
 
-    __tablename__ = 'encounter_condition_groups'
+    __tablename__ = 'encounter_condition_values'
+    id = Column(Integer, primary_key=True, nullable=False)
+    encounter_condition_id = Column(Integer, ForeignKey('encounter_conditions.id'), primary_key=False, nullable=False, autoincrement=False)
+    name = Column(Unicode(64), nullable=False)
+
+class EncounterConditionValueMap(TableBase):
+    """Maps encounters to the specific conditions under which they occur."""
+
+    __tablename__ = 'encounter_condition_value_map'
+    encounter_id = Column(Integer, ForeignKey('encounters.id'), primary_key=True, nullable=False, autoincrement=False)
+    encounter_condition_value_id = Column(Integer, ForeignKey('encounter_condition_values.id'), primary_key=True, nullable=False, autoincrement=False)
+
+class EncounterTerrain(TableBase):
+    """Rows in this table represent ways the player can enter a wild encounter,
+    e.g., surfing, fishing, or walking through tall grass.
+    """
+
+    __tablename__ = 'encounter_terrain'
     id = Column(Integer, primary_key=True, nullable=False)
     name = Column(Unicode(64), nullable=False)
 
-class EncounterType(TableBase):
+class EncounterSlot(TableBase):
-    """Rows in this table represent ways the player can enter a wild encounter;
+    """Rows in this table represent an abstract "slot" within a terrain,
-    i.e. surfing, fishing, or walking through tall grass.
+    associated with both some set of conditions and a rarity.
-    """
-
-    __tablename__ = 'encounter_types'
-    id = Column(Integer, primary_key=True, nullable=False)
-    name = Column(Unicode(64), nullable=False)
-
-class EncounterTypeSlot(TableBase):
-    """Rows in this table represent an abstract "slot" within an encounter
-    type, associated with both a condition group and a rarity.
 
     Note that there are two encounters per slot, so the rarities will only add
     up to 50.
     """
 
-    __tablename__ = 'encounter_type_slots'
+    __tablename__ = 'encounter_slots'
     id = Column(Integer, primary_key=True, nullable=False)
-    encounter_type_id = Column(Integer, ForeignKey('encounter_types.id'), primary_key=False, nullable=False, autoincrement=False)
+    encounter_terrain_id = Column(Integer, ForeignKey('encounter_terrain.id'), primary_key=False, nullable=False, autoincrement=False)
-    encounter_condition_group_id = Column(Integer, ForeignKey('encounter_condition_groups.id'), primary_key=False, nullable=True, autoincrement=False)
     rarity = Column(Integer, nullable=False, autoincrement=False)
 
+class EncounterSlotCondition(TableBase):
+    """Lists all conditions that affect each slot."""
+
+    __tablename__ = 'encounter_slot_conditions'
+    encounter_slot_id = Column(Integer, ForeignKey('encounter_slots.id'), primary_key=True, nullable=False, autoincrement=False)
+    encounter_condition_id = Column(Integer, ForeignKey('encounter_conditions.id'), primary_key=True, nullable=False, autoincrement=False)
+
 class EvolutionChain(TableBase):
     __tablename__ = 'evolution_chains'
     id = Column(Integer, primary_key=True, nullable=False)
@@ -172,7 +181,7 @@ class LocationArea(TableBase):
 class LocationAreaEncounterRate(TableBase):
     __tablename__ = 'location_area_encounter_rates'
     location_area_id = Column(Integer, ForeignKey('location_areas.id'), primary_key=True, nullable=False, autoincrement=False)
-    encounter_type_id = Column(Integer, ForeignKey('encounter_types.id'), primary_key=True, nullable=False, autoincrement=False)
+    encounter_type_id = Column(Integer, ForeignKey('encounter_terrain.id'), primary_key=True, nullable=False, autoincrement=False)
     rate = Column(Integer, nullable=True)
 
 class Machine(TableBase):
@@ -448,16 +457,24 @@ ContestCombo.first = relation(Move, primaryjoin=ContestCombo.first_move_id==Move
 ContestCombo.second = relation(Move, primaryjoin=ContestCombo.second_move_id==Move.id,
                                      backref='contest_combo_second')
 
+Encounter.location_area = relation(LocationArea, backref='encounters')
 Encounter.pokemon = relation(Pokemon, backref='encounters')
 Encounter.version = relation(Version, backref='encounters')
-Encounter.location_area = relation(LocationArea, backref='encounters')
+Encounter.slot = relation(EncounterSlot, backref='encounters')
-Encounter.slot = relation(EncounterTypeSlot, backref='encounters')
-Encounter.condition = relation(EncounterCondition, backref='encounters')
 
-EncounterCondition.group = relation(EncounterConditionGroup,
+EncounterConditionValue.condition = relation(EncounterCondition, backref='values')
-                                    backref='conditions')
 
-EncounterTypeSlot.type = relation(EncounterType, backref='slots')
+Encounter.condition_value_map = relation(EncounterConditionValueMap, backref='encounter')
+Encounter.condition_values = association_proxy('condition_value_map', 'condition_value')
+EncounterConditionValueMap.condition_value = relation(EncounterConditionValue,
+                                                      backref='encounter_map')
+
+EncounterSlot.terrain = relation(EncounterTerrain, backref='slots')
+
+EncounterSlot.condition_map = relation(EncounterSlotCondition, backref='slot')
+EncounterSlot.conditions = association_proxy('condition_map', 'condition')
+EncounterSlotCondition.condition = relation(EncounterCondition,
+                                            backref='slot_map')
 
 EvolutionChain.growth_rate = relation(GrowthRate, backref='evolution_chains')