mirror of
https://github.com/PokeAPI/pokeapi
synced 2024-11-22 11:23:13 +00:00
Merge branch 'docs' of https://github.com/zaneadix/pokeapi into docs
This commit is contained in:
Adickes
commit
a2afb12289
4 changed files with 796 additions and 13 deletions
|
|
@ -89,7 +89,7 @@ TEMPLATE_DIRS = (
|
|||
DATABASES = {
|
||||
'default': {
|
||||
'ENGINE': 'django.db.backends.postgresql_psycopg2',
|
||||
'NAME': 'pokeapi_co_db',
|
||||
'NAME': 'pokeapi_test',
|
||||
'USER': 'root',
|
||||
'PASSWORD': 'pokeapi',
|
||||
'HOST': 'localhost',
|
||||
|
|
|
|||
760
pokemon_v2/README.md
Normal file
760
pokemon_v2/README.md
Normal file
|
|
@ -0,0 +1,760 @@
|
|||
# Pokeapi V2 API Reference
|
||||
|
||||
|
||||
|
||||
## Abilities
|
||||
```
|
||||
api/v2/ability/{id or name}
|
||||
```
|
||||
Abilities provide passive effects for pokemon in battle or overworld. Pokemon can have only one ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail.
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this ability resource | integer
|
||||
name | The name for this ability resource | string
|
||||
is_main_series | Whether or not this ability originated in the main series of the video games | boolean
|
||||
generation | The generation this ability originated in | [APIResource](#apiresource) ([Generation](#generations))
|
||||
names | The name of this ability listed in different languages | [[Name](#resourcename)]
|
||||
effect_entries | The effect of this ability listed in different languages | [[VerboseEffect](#verboseeffect)]
|
||||
effect_changes | The list of previous effects this ability has had across version groups of the games | [[AbilityEffectChange](#abilityeffectchange)]
|
||||
flavor_text_entries | The flavor text of this ability listed in different languages | [VersionSpecificFlavorText] TODO
|
||||
pokemon | A list of pokemon that could potentially have this ability | [[AbilityPokemonMap](#abilitypokemonmap)]
|
||||
|
||||
#### AbilityEffectChange
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
effect_entries | The previous effect of this ability listed in different languages | [Effect]
|
||||
version_group | The version group in which the previous effect of this ability originated | [APIResource](#apiresource) ([VersionGroup](#versiongroup))
|
||||
|
||||
#### AbilityPokemonMap
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
is_hidden | Whether or not this a hidden ability for the referenced pokemon | boolean
|
||||
slot | Pokemon have 3 ability 'slots' which hold references to possible abilities they could have. This is the slot of this ability for the referenced pokemon. | integer
|
||||
pokemon | The pokemon this ability could belong to | [APIResource](#apiresource) ([Pokemon](#pokemon))
|
||||
|
||||
|
||||
|
||||
## Berries
|
||||
```
|
||||
api/v2/berry/{id or name}
|
||||
```
|
||||
Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by pokemon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail.
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this berry resource | integer
|
||||
name | The name for this berry resource | string
|
||||
growth_time | TODO | integer
|
||||
max_harvest | TODO | integer
|
||||
natural_gift_power | The strength of this powers natural gift | integer
|
||||
size | The size of this berry | integer
|
||||
smoothness | The smoothness rating of this berry | integer
|
||||
soil_dryness | TODO | integer
|
||||
firmness | The firmness of this berry | [APIResource](#apiresource) ([BerryFirmness](#berryfirmnesses))
|
||||
flavors | A list of references to each flavor a berry can have and the potency of each of those flavors in regard to this berry | [[BerryFlavorMap](#berryflavormap)]
|
||||
item | Berries are actually items. This is a reference to the item specific data for this berry. | [APIResource](#apiresource) ([Item](#items))
|
||||
natural_gift_type | A reference to the elemental type of a this berry TODO | [APIResource](#apiresource) ([Type](#types))
|
||||
|
||||
#### BerryFlavorMap
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
potency | How powerful the referenced flavor is for this berry | integer
|
||||
flavor | The referenced berry flavor | [APIResource](#apiresource) ([BerryFlavor](#berryflavors))
|
||||
|
||||
|
||||
|
||||
## Berry Firmnesses
|
||||
```
|
||||
api/v2/berry-firmness/{id or name}
|
||||
```
|
||||
TODO. Absolutely no idea what firmness does for a berry. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail.
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this berry firmness resource | integer
|
||||
name | The name for this berry firmness resource | string
|
||||
berries | A list of the berries with this firmness | [[APIResource](#apiresource) ([Berry](#berries))]
|
||||
names | The name of this berry firmness listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
|
||||
|
||||
## Berry Flavors
|
||||
```
|
||||
api/v2/berry-flavor/{id or name}
|
||||
```
|
||||
Flavors determine whether a pokemon will benefit or suffer from eating a berry based on their [nature](#natures). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail.
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this berry flavor resource | integer
|
||||
name | The name for this berry flavor resource | string
|
||||
berries | A list of the berries with this flavor | [[APIResource](#apiresource) ([Berry](#berries))]
|
||||
contest_type | TODO | [APIResource](#apiresource) ([ContestType](#contesttypes))
|
||||
names | The name of this berry flavor listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
|
||||
|
||||
## Characteristics
|
||||
```
|
||||
api/v2/characteristic/{id}
|
||||
```
|
||||
Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail.
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this characteristic resource | integer
|
||||
gene_modulo | The remainder of the highest stat divided by 5 TODO | integer
|
||||
possible_values | The possible values of the highest stat that would result in a pokemon recieving this characteristic when divided by the gene modulo | [integer]
|
||||
descriptions | The descriptions of this characteristic listed in different languages | [[Description](#description)]
|
||||
|
||||
|
||||
|
||||
## Contest Types
|
||||
```
|
||||
api/v2/contest-type/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this contest type resource | integer
|
||||
name | The name for this contest type resource | string
|
||||
berry_flavor | TODO | [APIResource](#apiresource) ([BerryFlavor](#berryflavors))
|
||||
names | The name of this contest type listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
|
||||
|
||||
## Contest Effects
|
||||
```
|
||||
api/v2/contest-effect/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this contest type resource | integer
|
||||
appeal | The level of appeal this effect has TODO | string
|
||||
jam | TODO | integer
|
||||
effect_entries | The result of this contest effect listed in different languages | [[Effect](#effect)]
|
||||
flavor_text_entries | The flavor text of this contest effect listed in different languages | [[FlavorText](#flavortext)]
|
||||
|
||||
|
||||
|
||||
## Egg Groups
|
||||
```
|
||||
api/v2/egg-group/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this egg group resource | integer
|
||||
name | The name for this egg group resource | string
|
||||
names | The name of this egg group listed in different languages | [[Name](#resourcename)]
|
||||
pokemon_species | A list of all pokemon species that are categorized under this egg group | [APIResource](#apiresource) ([PokemonSpecies](#pokemonspecies))
|
||||
|
||||
|
||||
|
||||
## Encounter Methods
|
||||
```
|
||||
api/v2/encounter-method/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this encounter method resource | integer
|
||||
name | The name for this encounter method resource | string
|
||||
order | The order index of this encounter method within the main game series data | integer
|
||||
names | The name of this encounter method listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
|
||||
|
||||
## Encounter Conditions
|
||||
```
|
||||
api/v2/encounter-condition/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this encounter condition resource | integer
|
||||
name | The name for this encounter condition resource | string
|
||||
names | The name of this encounter method listed in different languages | [[Name](#resourcename)]
|
||||
values | A list of possible values for this encounter condition | [[APIReference](#apireference) ([EncounterConditionValue](#encounterconditionvalue))]
|
||||
|
||||
|
||||
|
||||
## Encounter Condition Values TODO
|
||||
```
|
||||
api/v2/encounter-condition-value/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this encounter condition value resource | integer
|
||||
name | The name for this encounter condition value resource | string
|
||||
condition | The condition this encounter condition value pertains to | [[APIReference](#apireference)]
|
||||
names | The name of this encounter method listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
|
||||
|
||||
## Evolution Chains
|
||||
```
|
||||
api/v2/evolution-chain/{id}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this evolution chain resource | integer
|
||||
baby_trigger_item | The item that a pokemon would be holding when mating that would trigger the egg hatching a baby pokemon rather than a basic pokemon | [APIReference](#apireference)
|
||||
chain | The base chain link object. Each link contains evolution details for a pokemon in the chain. Each link references the next pokemon in the natural evolution order. | [ChainLink](#chainlink)
|
||||
|
||||
#### Chain Link
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
is_baby | Whether or not this link is for a baby pokemon. This would only ever be true on the base link. | boolean
|
||||
species | The pokemon species at this point in the evolution chain | [APIReference](#apireference)
|
||||
evolution_details | All details regarding the specific details of the referenced pokemon species evolution | [APIReference](#apireference) ([EvolutionDetail](#evolutiondetail))
|
||||
evolves_to | A List of chain objects. | [ChainLink](#chainlink)
|
||||
|
||||
#### Evolution Detail
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
item | The item required to cause evolution this into pokemon species | [APIReference](#apireference) ([Item](#item))
|
||||
trigger | The type of event that triggers evolution into this pokemon species | [APIReference](#apireference) ([EvolutionTrigger](#evolutiontrigger))
|
||||
gender | The gender the evolving pokemon species must be in order to evolve into this pokemon species | [APIReference](#apireference) ([Gender](#gender))
|
||||
held_item | The item the evolving pokemon species must be holding during the evolution trigger event to evolve into this pokemon species | [APIReference](#apireference) ([Item](#item))
|
||||
known_move | The move that must be known by the evolving pokemon species during the evolution trigger event in order to evolve into this pokemon species | [APIReference](#apireference) ([Move](#move))
|
||||
known_move_type | The evolving pokemon species must know a move with this type during the evolution trigger event in order to evolve into this pokemon species | [APIReference](#apireference) ([Type](#type))
|
||||
location | The location the evolution must be triggered at. | [APIReference](#apireference) ([Location](#location))
|
||||
min_level | The minimum required level of the evolving pokemon species to evolve into this pokemon species | integer
|
||||
min_hapiness | The minimum required level of happiness the evolving pokemon species to evolve into this pokemon species | integer
|
||||
min_beauty | The minimum required level of beauty the evolving pokemon species to evolve into this pokemon species | integer
|
||||
min_affection | The minimum required level of affection the evolving pokemon species to evolve into this pokemon species | integer
|
||||
needs_overworld_rain | Whether or not it must be raining in the overworld to cause evolution this pokemon species | boolean
|
||||
party_species | The pokemon species that must be in the players party in order for the evolving pokemon species to evolve into this pokemon species | [APIReference](#apireference) ([PokemonSpecies](#pokemonspecies))
|
||||
party_type | The player must have a pokemon of this type in their party during the evolution trigger event in order for the evolving pokemon species to evolve into this pokemon species | [APIReference](#apireference) ([Type](#type))
|
||||
relative_physical_stats | The required relation between the Pokémon's Attack and Defense stats. 1 means Attack > Defense. 0 means Attack = Defense. -1 means Attack < Defense. | integer
|
||||
time_of_day | The required time of day. Day or night. | string
|
||||
trade_species | Pokemon species for which this one must be traded. | [APIReference](#apireference) ([Pokemon Species](#pokemonspecies))
|
||||
turn_upside_down | Whether or not the 3DS needs to be turned upside-down as this Pokémon levels up. | boolean
|
||||
|
||||
|
||||
## Encounter Triggers
|
||||
```
|
||||
api/v2/evolution-trigger/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this evolution trigger resource | integer
|
||||
name | The name for this evolution trigger resource | string
|
||||
names | The name of this evolution trigger listed in different languages | [[Name](#resourcename)]
|
||||
pokemon_species | A list of pokemon species that result from this evolution trigger | [[APIReference](#apireference) ([PokemonSpecies](#pokemonspecies))]
|
||||
|
||||
|
||||
## Generations
|
||||
```
|
||||
api/v2/generation/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this generation resource | integer
|
||||
name | The name for this generation resource | string
|
||||
abilities | A list of abilities that were introduced in this generation | [[APIReference](#apireference) ([Ability](#ability))]
|
||||
names | The name of this generation listed in different languages | [[Name](#resourcename)]
|
||||
main_region | The main region travelled in this generation | [APIReference](#apireference) ([Region](#region))
|
||||
moves | A list of moves that were introduced in this generation | [[APIReference](#apireference) ([Move](#move))]
|
||||
pokemon_species | A list of pokemon species that were introduced in this generation | [[APIReference](#apireference) ([PokemonSpecies](#pokemonspecies))]
|
||||
types | A list of types that were introduced in this generation | [[APIReference](#apireference) ([Type](#type))]
|
||||
version_groups | A list of version groups that were introduced in this generation | [[APIReference](#apireference) ([VersionGroup](#versiongroup))]
|
||||
|
||||
|
||||
## Gender
|
||||
```
|
||||
api/v2/gender/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this gender resource | integer
|
||||
name | The name for this gender resource | string
|
||||
pokemon_species_details | A list of pokemon species that can be this gender and how likely it is that they will be | [([PokemonSpeciesGenderChance](#pokemonspeciesgendermap)]
|
||||
required_for_evolution | A list of pokemon species that required this gender in order for a pokemon to evolve into them | [[APIReference](#apireference) ([PokemonSpecies](#pokemonspecies))]
|
||||
|
||||
|
||||
#### PokemonSpeciesGenderChance
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
rate | The chance of this Pokémon being female, in eighths; or -1 for genderless | integer
|
||||
pokemon_species | A pokemon species that can be the referenced gender | [APIReference](#apireference) ([PokemonSpecies](#pokemonspecies))
|
||||
|
||||
|
||||
## Growth Rates
|
||||
```
|
||||
api/v2/growth-rate/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this gender resource | integer
|
||||
name | The name for this gender resource | string
|
||||
formula | The formula used to calculate the rate at which the pokemon species gains level | string
|
||||
descriptions | The descriptions of this characteristic listed in different languages | [[Description](#description)]
|
||||
levels | A list of levels and the amount of experienced needed to atain them based on this growth rate | [[GrowthRateExperienceLevel](#growthrateexperiencelevel)]
|
||||
pokemon_species | A list of pokemon species that gain levels at this growth rate | [[APIReference](#apireference) ([PokemonSpecies](#pokemonspecies))]
|
||||
|
||||
#### GrowthRateExperienceLevel
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
level | The level gained | integer
|
||||
experience | The amount of experience required to reach the referenced level | integer
|
||||
|
||||
|
||||
## Items
|
||||
```
|
||||
api/v2/item/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this item resource | integer
|
||||
name | The name for this item resource | string
|
||||
cost | The price of this item in stores | integer
|
||||
fling_power | The power of the move Fling when used with this item. | integer
|
||||
fling_effect | The effect of the move Fling when used with this item | [ItemFlingEffect](#itemflingeffect)
|
||||
attributes | A list of attributes this item has | [[APIReference](#apireference) ([ItemAttribute](#itemattribute))]
|
||||
category | The category of items this item falls into | [ItemCategory](#itemcategory)
|
||||
effect_entries | The effect of this ability listed in different languages | [[VerboseEffect](#verboseeffect)]
|
||||
flavor_text_entries | The flavor text of this ability listed in different languages | [VersionSpecificFlavorText] TODO
|
||||
game_indices | A list of game indices relevent to this item by generation | [[GenerationGameIndex](#generationgameindex)]
|
||||
names | The name of this item listed in different languages | [[Name](#resourcename)]
|
||||
held_by_pokemon | A list of pokemon that might be found in the wild holding this item | [[APIReference](#apireference) ([Pokemon](#pokemon))]
|
||||
baby_trigger_for | An evolution chain this item requires to produce a bay during mating | [[APIReference](#apireference) ([Evolution Chain](#evolutionchain))]
|
||||
|
||||
|
||||
## Item Fling Effects
|
||||
```
|
||||
api/v2/item-fling-effect/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this fling effect resource | integer
|
||||
name | The name for this fling effect resource | string
|
||||
effect_entries | The result of this fling effect listed in different languages | [[Effect](#effect)]
|
||||
items | A list of items that have this fling effect | [[Item](#item)]
|
||||
|
||||
|
||||
## Item Categories
|
||||
```
|
||||
api/v2/item-category/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this item category resource | integer
|
||||
name | The name for this item category resource | string
|
||||
items | A list of items that fall into this category | [[Item](#item)]
|
||||
names | The name of this item category listed in different languages | [[Name](#resourcename)]
|
||||
pocket | The pocket items in this category would be put in | [[APIReference](#apireference) ([ItemPocket](#itempocket))]
|
||||
|
||||
|
||||
## Item Pockets
|
||||
```
|
||||
api/v2/item-pocket/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this item pocket resource | integer
|
||||
name | The name for this item pocket resource | string
|
||||
categories | A list of item categories that are relevent to this item pocket | [[ItemCategory](#itemcategory)]
|
||||
names | The name of this item category listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
|
||||
## Languages
|
||||
```
|
||||
api/v2/language/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this item pocket resource | integer
|
||||
name | The name for this item pocket resource | string
|
||||
official | Whether or not the games are published in this language | boolean
|
||||
is639 | The two-letter code of the country where this language is spoken. Note that it is not unique. | string
|
||||
iso3166 | The two-letter code of the language. Note that it is not unique. | string
|
||||
names | The name of this language listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
|
||||
## Locations
|
||||
```
|
||||
api/v2/location/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this location resource | integer
|
||||
name | The name for this location resource | string
|
||||
region | The region this location can be found in | [APIReference](#apireference) ([Region](#regions))
|
||||
names | The name of this language listed in different languages | [[Name](#resourcename)]
|
||||
game_indices | A list of game indices relevent to this location by generation | [[GenerationGameIndex](#generationgameindex)]
|
||||
areas | Areas that can be found within this location | [APIReference](#apireference) ([LocationArea](#locationareas))
|
||||
|
||||
|
||||
## Location Areas
|
||||
```
|
||||
api/v2/location-area/{id}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this location resource | integer
|
||||
name | The name for this location resource | string
|
||||
game_index | The internal id of an api resource within game data | integer
|
||||
encounter_method_rates | A list of methods in which pokemon may be encountered in this area and how likely the method will occur depending on the version of the game | [[EncounterMethodRate](#encountermethodrate)]
|
||||
location | The region this location can be found in | [APIReference](#apireference) ([Region](#regions))
|
||||
names | The name of this location area listed in different languages | [[Name](#resourcename)]
|
||||
pokemon_encounters | A list of pokemon that can be encountered in this area along with version specific details about the encounter | [PokemonEncounter](#pokemonencounter)
|
||||
|
||||
#### PokemonEncounter
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
pokemon | The pokemon being encountered | [APIReference](#apireference) ([Pokemon](#pokemon))
|
||||
version_group_details | A list of version groups and encounters with the referenced pokemon that might happen | [[VersionGroupEncounterDetail](#versiongroupencounterdetail)]
|
||||
|
||||
#### VersionGroupEncounterDetail
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
version | The game version this encounter happens in | [APIReference](#apireference) ([Version](#versions))
|
||||
max_chance | The total percentage of all encounter potential | integer
|
||||
encounter_details | A list of encounters and their specifics | [[Encounter](#encounters)]
|
||||
|
||||
|
||||
## Moves
|
||||
```
|
||||
api/v2/move/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this location resource | integer
|
||||
name | The name for this location resource | string
|
||||
accuracy | The percent value of how likely this move is to be successful | integer
|
||||
effect_chance | The percent value of how likely it is this moves effect will take effect | integer
|
||||
pp | Power points. The number of times this move can be used | integer
|
||||
priority | A value between -8 and 8. Sets the order in which moves are executed during battle. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Priority) for greater detail. | integer
|
||||
power | The base power of this move with a value of 0 if it does not have a base power | integer
|
||||
contest_combos | A detail of normal and super contest combos that require this move | [[ContestComboSets](#contestcombosets)]
|
||||
contest_type | The type of appeal this move gives a pokemon when used in a contest | [APIReference](#apireference) ([ContestType](#contesttypes))
|
||||
contest_effect | The effect the move has when used in a contest | [APIReference](#apireference) ([ContestEffect](#contesteffects))
|
||||
damage_class | The type of damage the move inflicts on the target, e.g. physical | [APIReference](#apireference) ([MoveDamageClass](#movedamageclasses))
|
||||
effect_entries | The effect of this move listed in different languages | [[VerboseEffect](#verboseeffect)]
|
||||
effect_changes | The list of previous effects this move has had across version groups of the games | [[AbilityEffectChange](#abilityeffectchange)]
|
||||
generation | The generation in which this move was introduced | [APIReference](#apireference) ([Generation](#generations))
|
||||
meta | Meta data about this move | [MoveMetaData](#movemetadata)
|
||||
names | The name of this location area listed in different languages | [[Name](#resourcename)]
|
||||
past_values | A list of move resource value changes across ersion groups of the game | [PastMoveStatValues](#pastmovestatvalues)
|
||||
stat_changes | A list of stats this moves effects and how much it effects them | [[MoveStatChange](#movestatchange)]
|
||||
contest_effect | The effect the move has when used in a super contest | [APIReference](#apireference) ([ContestEffect](#contesteffects))
|
||||
target | The type of target that will recieve the effects of the attack | [MoveTarget](#movetargets)
|
||||
type | The elemental type of this move | [Type](#types)
|
||||
|
||||
#### ContestComboSets
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
normal | A detail of moves this move can be used before or after, granting additional appeal points in contests | [[ContestComboDetail](#contestcombodetail)]
|
||||
super | A detail of moves this move can be used before or after, granting additional appeal points in super contests | [[ContestComboDetail](#contestcombodetail)]
|
||||
|
||||
#### ContestComboDetail
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
use_before | A list of moves to use before this move | [[APIReference](#apireference) ([Move](#moves))]
|
||||
use_after | A list of moves to use after this move | [[APIReference](#apireference) ([Move](#moves))]
|
||||
|
||||
#### MoveMetaData
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
ailment | The status ailment this move inflicts on its target | [APIReference](#apireference) [MoveAilment](#contestcombodetail)
|
||||
category | The category of move this move falls under, e.g. damage or ailment | [APIReference](#apireference) ([Move](#moves))
|
||||
min_hits | The minimum number of times this move hits. Null if it always only hits once. | integer
|
||||
max_hits | The maximum number of times this move hits. Null if it always only hits once. | integer
|
||||
min_turns | The minimum number of turns this move continues to take effect. Null if it always only lasts one turn. | integer
|
||||
max_turns | The maximum number of turns this move continues to take effect. Null if it always only lasts one turn. | integer
|
||||
drain | HP drain (if positive) or Recoil damage (if negative), in percent of damage done | integer
|
||||
healing | The amount of hp gained by the attacking pokemon, in percent of it's maximum HP | integer
|
||||
crit_rate | Critical hit rate bonus | integer
|
||||
ailment_chance | The likelyhood this attack will cause an ailment | integer
|
||||
flinch_chance | The likelyhood this attack will cause the target pokemon to flinch | integer
|
||||
stat_chance | The likelyhood this attack will cause a stat change in the target pokemon | integer
|
||||
|
||||
#### MoveStatChange
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
change | The amount of change | integer
|
||||
stat | The stat being affected | [APIReference](#apireference) [Stat](#stats)
|
||||
|
||||
#### PastMoveStatValues
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
accuracy | The percent value of how likely this move is to be successful | integer
|
||||
effect_chance | The percent value of how likely it is this moves effect will take effect | integer
|
||||
power | The base power of this move with a value of 0 if it does not have a base power | integer
|
||||
pp | Power points. The number of times this move can be used | integer
|
||||
effect_entries | The effect of this move listed in different languages | [[VerboseEffect](#verboseeffect)]
|
||||
type | The elemental type of this move | [Type](#types)
|
||||
version group | The version group in which these move stat values were in effect | [Type](#types)
|
||||
|
||||
|
||||
## Move Ailments
|
||||
```
|
||||
api/v2/move-ailment/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this move ailment resource | integer
|
||||
name | The name for this move ailment resource | string
|
||||
moves | A list of moves that cause this ailment | [[APIReference](#apireference) ([Move](#moves))]
|
||||
names | The name of this move ailment listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
|
||||
## Move Battle Style
|
||||
```
|
||||
api/v2/move-battle-style/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this move battle style resource | integer
|
||||
name | The name for this move battle style resource | string
|
||||
names | The name of this move battle style listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
|
||||
## Move Category
|
||||
```
|
||||
api/v2/move-category/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this move category resource | integer
|
||||
name | The name for this move category resource | string
|
||||
moves | A list of moves that fall into this category | [[APIReference](#apireference) ([Move](#moves))]
|
||||
descriptions | The description of this move ailment listed in different languages | [[Description](#description)]
|
||||
|
||||
|
||||
## Move Damage Class
|
||||
```
|
||||
api/v2/move-damage-class/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this move damage class resource | integer
|
||||
name | The name for this move damage class resource | string
|
||||
descriptions | The description of this move damage class listed in different languages | [[Description](#description)]
|
||||
moves | A list of moves that fall into this damage class | [[APIReference](#apireference) ([Move](#moves))]
|
||||
names | The name of this move damage class listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
|
||||
## Move Learn Mathod
|
||||
```
|
||||
api/v2/move-learn-method/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this move learn method resource | integer
|
||||
name | The name for this move learn method resource | string
|
||||
descriptions | The description of this move learn method listed in different languages | [[Description](#description)]
|
||||
names | The name of this move learn method listed in different languages | [[Name](#resourcename)]
|
||||
version_groups | A list of version groups where moves can be learned through this method | [[APIReference](#apireference) ([VersionGroup](#versiongroup))]
|
||||
|
||||
|
||||
## Move Target
|
||||
```
|
||||
api/v2/move-target/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this move target resource | integer
|
||||
name | The name for this move target resource | string
|
||||
descriptions | The description of this move target listed in different languages | [[Description](#description)]
|
||||
moves | A list of moves that that are directed at this target | [[APIReference](#apireference) ([Move](#moves))]
|
||||
names | The name of this move target listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
|
||||
## Nature
|
||||
```
|
||||
api/v2/nature/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this nature resource | integer
|
||||
name | The name for this nature resource | string
|
||||
decreased_stat | The stat decreased by 10% in pokemon with this nature | [APIReference](#apireference) ([Stat](#stats)
|
||||
increased_stat | The stat increased by 10% in pokemon with this nature | [APIReference](#apireference) ([Stat](#stats)
|
||||
hates_flavor | The flavor hated by pokemon with this nature | [APIReference](#apireference) ([BerryFlavor](#berryflavors)
|
||||
likes_flavor | The flavor liked by pokemon with this nature | [APIReference](#apireference) ([BerryFlavor](#berryflavors)
|
||||
pokeathlon_stat_changes | A list of pokeathlon stats this nature effects and how much it effects them | [[NatureStatChange](#naturestatchange)]
|
||||
move_battle_style_preferences | A list of battle styles and how likely a pokemon with this nature is to use them in the Battle Palace or Battle Tent. | [[MoveBattleStylePreference](#movebattlestylepreference)]
|
||||
names | The name of this nature listed in different languages | [[Name](#resourcename)]
|
||||
|
||||
#### NatureStatChange
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
change | The amount of change | integer
|
||||
stat | The stat being affected | [APIReference](#apireference) ([PokeathlonStat](#pokeathlonstats))
|
||||
|
||||
#### MoveBattleStylePreference
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
low_hp_preference | Chance of using the move, in percent, if HP is under one half | integer
|
||||
high_hp_preference | Chance of using the move, in percent, if HP is over one half | integer
|
||||
move_battle_style | The move battle style | [APIReference](#apireference) ([MoveBattleStyle](#movebattlestyles))
|
||||
|
||||
|
||||
## PalParkArea
|
||||
```
|
||||
api/v2/pal-park-area/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this pal park area resource | integer
|
||||
name | The name for this pal park area resource | string
|
||||
names | The name of this pal park area listed in different languages | [[Name](#resourcename)]
|
||||
pokemon_encounters | A list of pokemon encountered in thi pal park area along with details | [PalParkEncounter](#palparkencounter)
|
||||
|
||||
#### PalParkEncounter
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
base_score | The base score given to the player when this pokemon is caught during a pal park run | integer
|
||||
rate | The base rate for encountering this pokemon in this pal park area | integer
|
||||
pokemon_species | The pokemon species being encountered | [APIResource](#apiresource) ([PokemonSpecies](#pokemonspecies))
|
||||
|
||||
|
||||
## Pokedex
|
||||
```
|
||||
api/v2/pokedex/{id or name}
|
||||
```
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
id | The identifier for this pokedex resource | integer
|
||||
name | The name for this pokedex resource | string
|
||||
|
||||
|
||||
|
||||
## Common Models
|
||||
|
||||
#### APIResource
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
name | The name of the referenced resource | string
|
||||
url | The url of the referenced resource | string
|
||||
|
||||
|
||||
#### Description
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
description | The localized description for an api resource in a specific language | string
|
||||
language | The language this name is in | [APIResource](#apiresource) ([Language](#languages))
|
||||
|
||||
|
||||
#### Effect
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
effect | The localized effect text for an api resource in a specific language | string
|
||||
language | The language this effect is in | [APIResource](#apiresource) ([Language](#language))
|
||||
|
||||
|
||||
#### Encounter
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
min_level | The lowest level the pokemon could be encountered at | integer
|
||||
max_level | The highest level the pokemon could be encountered at | integer
|
||||
condition_values | A list of condition values that must be in effect for this encounter to occur | [[APIResource](#apiresource) ([EncounterConditionValue](#encounterconditionvalue))]
|
||||
chance | percent chance that this encounter will occur | integer
|
||||
method | The method by which this encounter happens | [APIResource](#apiresource) ([EncounterMethod](#encountermethod))
|
||||
|
||||
|
||||
#### FlavorText
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
flavor_text | The localized name for an api resource in a specific language | string
|
||||
language | The language this name is in | [APIResource](#apiresource) ([Language](#language))
|
||||
|
||||
|
||||
#### GenerationGameIndex
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
game_index | The internal id of an api resource within game data | integer
|
||||
generation | The generation relevent to this game index | [APIResource](#apiresource) ([Generation](#generation))
|
||||
|
||||
|
||||
#### <a name="resourcename"></a>Name
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
name | The localized name for an api resource in a specific language | string
|
||||
language | The language this name is in | [APIResource](#apiresource) ([Language](#language))
|
||||
|
||||
|
||||
#### VerboseEffect
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
effect | The localized effect text for an api resource in a specific language | string
|
||||
short_effect | The localized effect text in brief | string
|
||||
language | The language this effect is in | [APIResource](#apiresource) ([Language](#language))
|
||||
|
||||
|
||||
#### VersionGameIndex
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
game_index | The internal id of an api resource within game data | integer
|
||||
version | The version relevent to this game index | [APIResource](#apiresource) ([Version](#version))
|
||||
|
||||
|
||||
#### VersionSpecificFlavorText TODO
|
||||
|
||||
Name | Description | Data Type
|
||||
---- | ----------- | ---------
|
||||
flavor_text | The localized name for an api resource in a specific language | string
|
||||
language | The language this name is in | [APIResource](#apiresource) ([Language](#language))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -964,13 +964,13 @@ class AbilityEffectTextSerializer(serializers.ModelSerializer):
|
|||
|
||||
class AbilityFlavorTextSerializer(serializers.ModelSerializer):
|
||||
|
||||
text = serializers.CharField(source="flavor_text")
|
||||
flavor_text = serializers.CharField()
|
||||
language = LanguageSummarySerializer()
|
||||
version_group = VersionGroupSummarySerializer()
|
||||
|
||||
class Meta:
|
||||
model = AbilityFlavorText
|
||||
fields = ('text', 'version_group', 'language')
|
||||
fields = ('flavor_text', 'language', 'version_group')
|
||||
|
||||
|
||||
class AbilityChangeEffectTextSerializer(serializers.ModelSerializer):
|
||||
|
|
@ -1005,9 +1005,10 @@ class AbilityDetailSerializer(serializers.ModelSerializer):
|
|||
|
||||
effect_entries = AbilityEffectTextSerializer(many=True, read_only=True, source="abilityeffecttext")
|
||||
flavor_text_entries = AbilityFlavorTextSerializer(many=True, read_only=True, source="abilityflavortext")
|
||||
# flavor_text_entries = serializers.SerializerMethodField('get_flavor_text')
|
||||
names = AbilityNameSerializer(many=True, read_only=True, source="abilityname")
|
||||
generation = GenerationSummarySerializer()
|
||||
changes = AbilityChangeSerializer(many=True, read_only=True, source="abilitychange")
|
||||
effect_changes = AbilityChangeSerializer(many=True, read_only=True, source="abilitychange")
|
||||
pokemon = serializers.SerializerMethodField('get_ability_pokemon')
|
||||
|
||||
class Meta:
|
||||
|
|
@ -1018,10 +1019,10 @@ class AbilityDetailSerializer(serializers.ModelSerializer):
|
|||
'is_main_series',
|
||||
'generation',
|
||||
'names',
|
||||
'effect_entries',
|
||||
'effect_entries',
|
||||
'effect_changes',
|
||||
'flavor_text_entries',
|
||||
'pokemon',
|
||||
'changes'
|
||||
)
|
||||
|
||||
def get_ability_pokemon(self, obj):
|
||||
|
|
@ -1036,6 +1037,28 @@ class AbilityDetailSerializer(serializers.ModelSerializer):
|
|||
|
||||
return pokemon
|
||||
|
||||
# def get_flavor_text(self, obj):
|
||||
|
||||
# version_objects = VersionGroup.objects.all()
|
||||
# version_data = VersionGroupSummarySerializer(version_objects, many=True, context=self.context).data
|
||||
|
||||
# flavor_texts = AbilityFlavorText.objects.filter(ability=obj)
|
||||
# group_ids = flavor_texts.values('flavor').distinct()
|
||||
# entries = []
|
||||
|
||||
# for group_id in group_ids:
|
||||
# id = group_id['version_group']
|
||||
# texts = flavor_texts.filter(version_group=id)
|
||||
|
||||
# detail = OrderedDict()
|
||||
# detail['version_group'] = version_data[id-1]
|
||||
# detail['entries'] = AbilityFlavorTextSerializer(texts, many=True, context=self.context).data
|
||||
# entries.append(detail)
|
||||
|
||||
# return entries
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
######################
|
||||
|
|
@ -2677,7 +2700,7 @@ class EvolutionChainDetailSerializer(serializers.ModelSerializer):
|
|||
|
||||
entry['is_baby'] = species['is_baby']
|
||||
entry['species'] = summary_data[index]
|
||||
if evolution_data: entry['evolution_details'] = evolution_data
|
||||
entry['evolution_details'] = evolution_data or None
|
||||
entry['evolves_to'] = []
|
||||
|
||||
# Keep track of previous entries for complex chaining
|
||||
|
|
|
|||
|
|
@ -2364,7 +2364,7 @@ class APITests(APIData, APITestCase):
|
|||
self.assertEqual(response.data['effect_entries'][0]['language']['name'], ability_effect_text.language.name)
|
||||
self.assertEqual(response.data['effect_entries'][0]['language']['url'], '{}{}/language/{}/'.format(test_host, api_v2, ability_effect_text.language.pk))
|
||||
# flavor text params
|
||||
self.assertEqual(response.data['flavor_text_entries'][0]['text'], ability_flavor_text.flavor_text)
|
||||
self.assertEqual(response.data['flavor_text_entries'][0]['flavor_text'], ability_flavor_text.flavor_text)
|
||||
self.assertEqual(response.data['flavor_text_entries'][0]['version_group']['name'], ability_flavor_text.version_group.name)
|
||||
self.assertEqual(response.data['flavor_text_entries'][0]['language']['name'], ability_flavor_text.language.name)
|
||||
self.assertEqual(response.data['flavor_text_entries'][0]['language']['url'], '{}{}/language/{}/'.format(test_host, api_v2, ability_flavor_text.language.pk))
|
||||
|
|
@ -2372,11 +2372,11 @@ class APITests(APIData, APITestCase):
|
|||
self.assertEqual(response.data['generation']['name'], ability.generation.name)
|
||||
self.assertEqual(response.data['generation']['url'], '{}{}/generation/{}/'.format(test_host, api_v2, ability.generation.pk))
|
||||
# change params
|
||||
self.assertEqual(response.data['changes'][0]['version_group']['name'], ability_change.version_group.name)
|
||||
self.assertEqual(response.data['changes'][0]['version_group']['url'], '{}{}/version-group/{}/'.format(test_host, api_v2, ability_change.version_group.pk))
|
||||
self.assertEqual(response.data['changes'][0]['effect_entries'][0]['effect'], ability_change_effect_text.effect)
|
||||
self.assertEqual(response.data['changes'][0]['effect_entries'][0]['language']['name'], ability_change_effect_text.language.name)
|
||||
self.assertEqual(response.data['changes'][0]['effect_entries'][0]['language']['url'], '{}{}/language/{}/'.format(test_host, api_v2, ability_change_effect_text.language.pk))
|
||||
self.assertEqual(response.data['effect_changes'][0]['version_group']['name'], ability_change.version_group.name)
|
||||
self.assertEqual(response.data['effect_changes'][0]['version_group']['url'], '{}{}/version-group/{}/'.format(test_host, api_v2, ability_change.version_group.pk))
|
||||
self.assertEqual(response.data['effect_changes'][0]['effect_entries'][0]['effect'], ability_change_effect_text.effect)
|
||||
self.assertEqual(response.data['effect_changes'][0]['effect_entries'][0]['language']['name'], ability_change_effect_text.language.name)
|
||||
self.assertEqual(response.data['effect_changes'][0]['effect_entries'][0]['language']['url'], '{}{}/language/{}/'.format(test_host, api_v2, ability_change_effect_text.language.pk))
|
||||
# pokemon params
|
||||
self.assertEqual(response.data['pokemon'][0]['is_hidden'], pokemon_ability.is_hidden)
|
||||
self.assertEqual(response.data['pokemon'][0]['slot'], pokemon_ability.slot)
|
||||
|
|
|
|||
Loading…
Reference in a new issue