Very simple items table and wild held item data. #10

[zzz-pokedex.git] / pokedex / db / tables.py

diff --git a/pokedex/db/tables.py b/pokedex/db/tables.py
index 28ca373..4d542e9 100644 (file)
--- a/pokedex/db/tables.py
+++ b/pokedex/db/tables.py
@@ -1,3 +1,5 @@
+# encoding: utf8
+

 from sqlalchemy import Column, ForeignKey, MetaData, Table
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import backref, relation
 from sqlalchemy import Column, ForeignKey, MetaData, Table
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import backref, relation


@@ -28,6 +30,28 @@ class EggGroup(TableBase):
     name = Column(Unicode(16), nullable=False)
 
 class Encounter(TableBase):
     name = Column(Unicode(16), nullable=False)
 
 class Encounter(TableBase):

+    """Rows in this table represent encounters with wild Pokémon.
+
+    Within a given area in a given game, encounters are differentiated by the
+    slot they are in and a world condition.
+
+    Groups of slots belong to encounter types; these are what the player is
+    doing to get an encounter, such as surfing or walking through tall grass.
+
+    Within an encounter type, slots are defined primarily by rarity.  Each slot
+    can also be affected by a world condition; for example, the 20% slot for
+    walking in tall grass is affected by whether a swarm is in effect in the
+    areas.  "There is a swarm" and "there is not a swarm" are conditions, and
+    together they make a condition group.  However, since "not a swarm" is a
+    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
+    swarm) are thus enough to define a specific encounter.
+    
+    Well, okay, almost: each slot actually appears twice.
+    """
+

     __tablename__ = 'encounters'
     id = Column(Integer, primary_key=True, nullable=False)
     version_id = Column(Integer, ForeignKey('versions.id'), nullable=False, autoincrement=False)
     __tablename__ = 'encounters'
     id = Column(Integer, primary_key=True, nullable=False)
     version_id = Column(Integer, ForeignKey('versions.id'), nullable=False, autoincrement=False)


@@ -39,22 +63,44 @@ class Encounter(TableBase):
     max_level = Column(Integer, nullable=False, autoincrement=False)
 
 class EncounterCondition(TableBase):
     max_level = Column(Integer, nullable=False, autoincrement=False)
 
 class EncounterCondition(TableBase):

+    """Rows in this table represent something different about the world that
+    can affect what Pokémon are encountered.
+    """
+

     __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):
     __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):

+    """Rows in this table represent a group of mutually exclusive conditions,
+    such as morning/day/night.  "Conditions" that are part of the default state
+    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'
     id = Column(Integer, primary_key=True, nullable=False)
     name = Column(Unicode(64), nullable=False)
 
 class EncounterType(TableBase):
     __tablename__ = 'encounter_condition_groups'
     id = Column(Integer, primary_key=True, nullable=False)
     name = Column(Unicode(64), nullable=False)
 
 class EncounterType(TableBase):

+    """Rows in this table represent ways the player can enter a wild encounter;
+    i.e. surfing, fishing, or walking through tall grass.
+    """
+

     __tablename__ = 'encounter_types'
     id = Column(Integer, primary_key=True, nullable=False)
     name = Column(Unicode(64), nullable=False)
 
 class EncounterTypeSlot(TableBase):
     __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'
     id = Column(Integer, primary_key=True, nullable=False)
     encounter_type_id = Column(Integer, ForeignKey('encounter_types.id'), primary_key=False, nullable=False, autoincrement=False)
     __tablename__ = 'encounter_type_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)


@@ -86,6 +132,11 @@ class GrowthRate(TableBase):
     name = Column(Unicode(16), nullable=False)
     formula = Column(Unicode(255), nullable=False)
 
     name = Column(Unicode(16), nullable=False)
     formula = Column(Unicode(255), nullable=False)
 

+class Item(TableBase):
+    __tablename__ = 'items'
+    id = Column(Integer, primary_key=True, nullable=False)
+    name = Column(Unicode(16), nullable=False)
+

 class Language(TableBase):
     __tablename__ = 'languages'
     id = Column(Integer, primary_key=True, nullable=False)
 class Language(TableBase):
     __tablename__ = 'languages'
     id = Column(Integer, primary_key=True, nullable=False)


@@ -130,10 +181,18 @@ class Move(TableBase):
     effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False)
     effect_chance = Column(Integer)
     contest_type = Column(Unicode(8), nullable=False)
     effect_id = Column(Integer, ForeignKey('move_effects.id'), nullable=False)
     effect_chance = Column(Integer)
     contest_type = Column(Unicode(8), nullable=False)

-    contest_effect_id = Column(Integer, ForeignKey('contest_effects.id'), nullable=False)
+    contest_effect_id = Column(Integer, ForeignKey('contest_effects.id'), nullable=True)

     super_contest_effect_id = Column(Integer, nullable=False)
 
 class Pokemon(TableBase):
     super_contest_effect_id = Column(Integer, nullable=False)
 
 class Pokemon(TableBase):

+    """The core to this whole mess.
+
+    Note that I use both 'forme' and 'form' in both code and the database.  I
+    only use 'forme' when specifically referring to Pokémon that have multiple
+    distinct species as forms—i.e., different stats or movesets.  'Form' is a
+    more general term referring to any variation within a species, including
+    purely cosmetic forms like Unown.
+    """

     __tablename__ = 'pokemon'
     id = Column(Integer, primary_key=True, nullable=False)
     name = Column(Unicode(20), nullable=False)
     __tablename__ = 'pokemon'
     id = Column(Integer, primary_key=True, nullable=False)
     name = Column(Unicode(20), nullable=False)


@@ -159,6 +218,37 @@ class Pokemon(TableBase):
     has_gen4_fem_sprite = Column(Boolean, nullable=False)
     has_gen4_fem_back_sprite = Column(Boolean, nullable=False)
 
     has_gen4_fem_sprite = Column(Boolean, nullable=False)
     has_gen4_fem_back_sprite = Column(Boolean, nullable=False)
 

+    ### Stuff to handle alternate Pokémon forms
+
+    @property
+    def national_id(self):
+        """Returns the National Pokédex number for this Pokémon.  Use this
+        instead of the id directly; alternate formes may make the id incorrect.
+        """
+
+        if self.forme_base_pokemon_id:
+            return self.forme_base_pokemon_id
+        return self.id
+
+    @property
+    def full_name(self):
+        """Returns the name of this Pokémon, including its Forme, if any."""
+
+        if self.forme_name:
+            return "%s %s" % (self.forme_name.capitalize(), self.name)
+        return self.name
+
+    @property
+    def normal_form(self):
+        """Returns the normal form for this Pokémon; i.e., this will return
+        regular Deoxys when called on any Deoxys form.
+        """
+
+        if self.forme_base_pokemon:
+            return self.forme_base_pokemon
+
+        return self
+

 class PokemonAbility(TableBase):
     __tablename__ = 'pokemon_abilities'
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
 class PokemonAbility(TableBase):
     __tablename__ = 'pokemon_abilities'
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)


@@ -182,6 +272,24 @@ class PokemonFlavorText(TableBase):
     version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, nullable=False, autoincrement=False)
     flavor_text = Column(Unicode(255), nullable=False)
 
     version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, nullable=False, autoincrement=False)
     flavor_text = Column(Unicode(255), nullable=False)
 

+class PokemonFormGroup(TableBase):
+    __tablename__ = 'pokemon_form_groups'
+    pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
+    description = Column(Unicode(512), nullable=False)
+
+class PokemonFormSprite(TableBase):
+    __tablename__ = 'pokemon_form_sprites'
+    id = Column(Integer, primary_key=True, nullable=False)
+    pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
+    name = Column(Unicode(16), nullable=True)
+
+class PokemonItem(TableBase):
+    __tablename__ = 'pokemon_items'
+    pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
+    version_id = Column(Integer, ForeignKey('versions.id'), primary_key=True, nullable=False, autoincrement=False)
+    item_id = Column(Integer, ForeignKey('items.id'), primary_key=True, nullable=False, autoincrement=False)
+    rarity = Column(Integer, nullable=False)
+

 class PokemonName(TableBase):
     __tablename__ = 'pokemon_names'
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)
 class PokemonName(TableBase):
     __tablename__ = 'pokemon_names'
     pokemon_id = Column(Integer, ForeignKey('pokemon.id'), primary_key=True, nullable=False, autoincrement=False)


@@ -255,6 +363,9 @@ LocationArea.location = relation(Location, backref='areas')
 Pokemon.abilities = relation(Ability, secondary=PokemonAbility.__table__,
                                       order_by=PokemonAbility.slot,
                                       backref='pokemon')
 Pokemon.abilities = relation(Ability, secondary=PokemonAbility.__table__,
                                       order_by=PokemonAbility.slot,
                                       backref='pokemon')

+Pokemon.formes = relation(Pokemon, primaryjoin=Pokemon.id==Pokemon.forme_base_pokemon_id,
+                                               backref=backref('forme_base_pokemon',
+                                                               remote_side=[Pokemon.id]))

 Pokemon.dex_numbers = relation(PokemonDexNumber, backref='pokemon')
 Pokemon.egg_groups = relation(EggGroup, secondary=PokemonEggGroup.__table__,
                                         order_by=PokemonEggGroup.egg_group_id,
 Pokemon.dex_numbers = relation(PokemonDexNumber, backref='pokemon')
 Pokemon.egg_groups = relation(EggGroup, secondary=PokemonEggGroup.__table__,
                                         order_by=PokemonEggGroup.egg_group_id,


@@ -266,6 +377,7 @@ Pokemon.evolution_children = relation(Pokemon, primaryjoin=Pokemon.id==Pokemon.e
                                                                remote_side=[Pokemon.id]))
 Pokemon.flavor_text = relation(PokemonFlavorText, backref='pokemon')
 Pokemon.foreign_names = relation(PokemonName, backref='pokemon')
                                                                remote_side=[Pokemon.id]))
 Pokemon.flavor_text = relation(PokemonFlavorText, backref='pokemon')
 Pokemon.foreign_names = relation(PokemonName, backref='pokemon')

+Pokemon.items = relation(PokemonItem)

 Pokemon.generation = relation(Generation, backref='pokemon')
 Pokemon.shape = relation(PokemonShape, backref='pokemon')
 Pokemon.stats = relation(PokemonStat, backref='pokemon')
 Pokemon.generation = relation(Generation, backref='pokemon')
 Pokemon.shape = relation(PokemonShape, backref='pokemon')
 Pokemon.stats = relation(PokemonStat, backref='pokemon')


@@ -275,6 +387,13 @@ PokemonDexNumber.generation = relation(Generation)
 
 PokemonFlavorText.version = relation(Version)
 
 
 PokemonFlavorText.version = relation(Version)
 

+PokemonItem.item = relation(Item, backref='pokemon')
+PokemonItem.version = relation(Version)
+
+PokemonFormGroup.pokemon = relation(Pokemon, backref=backref('form_group',
+                                                             uselist=False))
+PokemonFormSprite.pokemon = relation(Pokemon, backref='form_sprites')
+

 PokemonName.language = relation(Language)
 
 PokemonStat.stat = relation(Stat)
 PokemonName.language = relation(Language)
 
 PokemonStat.stat = relation(Stat)