mirror of
https://github.com/PokeAPI/pokeapi
synced 2024-09-20 06:01:54 +00:00
Link moves to machines (#211)
* add Machines resource to link TM/HM items to moves * document new Machines resource * fix #198
This commit is contained in:
Sargun Vohra
GitHub
parent
32b28274dc
commit
f8c641716e
5 changed files with 110 additions and 5 deletions
|
|
@ -240,6 +240,13 @@ class LocationAreaResource(ListOrDetailSerialRelation, IncrementingReadOnlyModel
|
|||
list_serializer_class = LocationAreaSummarySerializer
|
||||
|
||||
|
||||
class MachineResource(PokeapiCommonViewset):
|
||||
|
||||
queryset = Machine.objects.all()
|
||||
serializer_class = MachineDetailSerializer
|
||||
list_serializer_class = MachineSummarySerializer
|
||||
|
||||
|
||||
class MoveResource(PokeapiCommonViewset):
|
||||
|
||||
queryset = Move.objects.all()
|
||||
|
|
|
|||
|
|
@ -1354,6 +1354,7 @@ class ItemDetailSerializer(serializers.ModelSerializer):
|
|||
held_by_pokemon = serializers.SerializerMethodField(source='get_held_by_pokemon')
|
||||
baby_trigger_for = serializers.SerializerMethodField(source='get_baby_trigger_for')
|
||||
sprites = serializers.SerializerMethodField('get_item_sprites')
|
||||
machines = serializers.SerializerMethodField('get_item_machines')
|
||||
|
||||
class Meta:
|
||||
model = Item
|
||||
|
|
@ -1371,9 +1372,31 @@ class ItemDetailSerializer(serializers.ModelSerializer):
|
|||
'names',
|
||||
'held_by_pokemon',
|
||||
'sprites',
|
||||
'baby_trigger_for'
|
||||
'baby_trigger_for',
|
||||
'machines',
|
||||
)
|
||||
|
||||
def get_item_machines(self, obj):
|
||||
|
||||
machine_objects = Machine.objects.filter(item=obj)
|
||||
|
||||
machines = []
|
||||
|
||||
for machine_object in machine_objects:
|
||||
|
||||
machine_data = MachineSummarySerializer(
|
||||
machine_object, context=self.context).data
|
||||
|
||||
version_group_data = VersionGroupSummarySerializer(
|
||||
machine_object.version_group, context=self.context).data
|
||||
|
||||
machines.append({
|
||||
'machine': machine_data,
|
||||
'version_group': version_group_data
|
||||
})
|
||||
|
||||
return machines
|
||||
|
||||
def get_item_sprites(self, obj):
|
||||
|
||||
sprites_object = ItemSprites.objects.get(item_id=obj)
|
||||
|
|
@ -1743,7 +1766,7 @@ class TypeDetailSerializer(serializers.ModelSerializer):
|
|||
class MachineDetailSerializer(serializers.ModelSerializer):
|
||||
|
||||
item = ItemSummarySerializer()
|
||||
version_group = VersionSummarySerializer()
|
||||
version_group = VersionGroupSummarySerializer()
|
||||
move = MoveSummarySerializer()
|
||||
|
||||
class Meta:
|
||||
|
|
@ -2006,6 +2029,7 @@ class MoveDetailSerializer(serializers.ModelSerializer):
|
|||
super_contest_effect = SuperContestEffectSummarySerializer()
|
||||
past_values = MoveChangeSerializer(many=True, read_only=True, source="movechange")
|
||||
effect_changes = serializers.SerializerMethodField('get_effect_change_text')
|
||||
machines = serializers.SerializerMethodField('get_move_machines')
|
||||
|
||||
class Meta:
|
||||
model = Move
|
||||
|
|
@ -2030,9 +2054,30 @@ class MoveDetailSerializer(serializers.ModelSerializer):
|
|||
'stat_changes',
|
||||
'super_contest_effect',
|
||||
'target',
|
||||
'type'
|
||||
'type',
|
||||
'machines',
|
||||
)
|
||||
|
||||
def get_move_machines(self, obj):
|
||||
|
||||
machine_objects = Machine.objects.filter(move=obj)
|
||||
|
||||
machines = []
|
||||
|
||||
for machine_object in machine_objects:
|
||||
machine_data = MachineSummarySerializer(
|
||||
machine_object, context=self.context).data
|
||||
|
||||
version_group_data = VersionGroupSummarySerializer(
|
||||
machine_object.version_group, context=self.context).data
|
||||
|
||||
machines.append({
|
||||
'machine': machine_data,
|
||||
'version_group': version_group_data
|
||||
})
|
||||
|
||||
return machines
|
||||
|
||||
def get_combos(self, obj):
|
||||
|
||||
normal_before_objects = ContestCombo.objects.filter(first_move=obj)
|
||||
|
|
|
|||
|
|
@ -38,6 +38,7 @@ router.register(r"item-pocket", ItemPocketResource)
|
|||
router.register(r"language", LanguageResource)
|
||||
router.register(r"location", LocationResource)
|
||||
router.register(r"location-area", LocationAreaResource)
|
||||
router.register(r"machine", MachineResource)
|
||||
router.register(r"move", MoveResource)
|
||||
router.register(r"move-ailment", MoveMetaAilmentResource)
|
||||
router.register(r"move-battle-style", MoveBattleStyleResource)
|
||||
|
|
|
|||
|
|
@ -77,6 +77,12 @@
|
|||
</ul>
|
||||
</li>
|
||||
|
||||
<li class="parent"><a href="#machines-section">Machines</a>
|
||||
<ul>
|
||||
<li><a href="#machines">Machines</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li class="parent"><a href="#moves-section">Moves</a>
|
||||
<ul>
|
||||
<li><a href="#moves">Moves</a></li>
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@
|
|||
<li><a href="#evolution-triggers">Evolution Triggers</a></li>
|
||||
<li><a href="#generations">Generations</a></li>
|
||||
<li><a href="#genders">Genders</a></li>
|
||||
<li><a href="#growth-rates">Growth Rates</a></li>
|
||||
<li><a href="#growth-rates">Growth Rates</a></li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
|
|
@ -37,6 +37,7 @@
|
|||
<li><a href="#languages">Languages</a></li>
|
||||
<li><a href="#locations">Locations</a></li>
|
||||
<li><a href="#location-areas">Location Areas</a></li>
|
||||
<li><a href="#machines">Machines</a></li>
|
||||
<li><a href="#moves">Moves</a></li>
|
||||
<li><a href="#move-ailments">Move Ailments</a></li>
|
||||
<li><a href="#move-battle-styles">Move Battle Styles</a></li>
|
||||
|
|
@ -44,11 +45,11 @@
|
|||
<li><a href="#move-damage-classes">Move Damage Classes</a></li>
|
||||
<li><a href="#move-learn-methods">Move Learn Methods</a></li>
|
||||
<li><a href="#move-targets">Move Targets</a></li>
|
||||
<li><a href="#natures">Natures</a></li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li><a href="#natures">Natures</a></li>
|
||||
<li><a href="#pal-park-areas">Pal Park Areas</a></li>
|
||||
<li><a href="#pokedexes">Pokédexes</a></li>
|
||||
<li><a href="#pokemon">Pokémon</a></li>
|
||||
|
|
@ -965,6 +966,7 @@ An item is an object in the games which the player can pick up, keep in their ba
|
|||
| sprites | A set of sprites used to depict this item in the game | [ItemSprites](#item-sprites) |
|
||||
| held_by_pokemon | A list of Pokémon that might be found in the wild holding this item | list [ItemHolderPokemon](#itemholderpokemon) |
|
||||
| baby_trigger_for | An evolution chain this item requires to produce a bay during mating | [APIResource](#apiresource) ([EvolutionChain](#evolution-chains)) |
|
||||
| machines | A list of the machines related to this item | list [MachineVersionDetail](#machineversiondetail) |
|
||||
|
||||
#### ItemSprites
|
||||
|
||||
|
|
@ -1143,6 +1145,42 @@ Pockets within the players bag used for storing items by category.
|
|||
| categories | A list of item categories that are relevant to this item pocket | list [NamedAPIResource](#namedapiresource) ([ItemCategory](#item-categories)) |
|
||||
| names | The name of this item pocket listed in different languages | list [Name](#resourcename) |
|
||||
|
||||
<h1 id="machines-section">Machines</h1>
|
||||
|
||||
## Machines
|
||||
Machines are the representation of items that teach moves to Pokémon. They vary from version to version, so it is not certain that one specific TM or HM corresponds to a single Machine.
|
||||
|
||||
### GET api/v2/machine/{id}
|
||||
|
||||
###### Example response
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"item": {
|
||||
"name": "tm01",
|
||||
"url": "http://localhost:8000/api/v2/item/305/"
|
||||
},
|
||||
"move": {
|
||||
"name": "mega-punch",
|
||||
"url": "http://localhost:8000/api/v2/move/5/"
|
||||
},
|
||||
"version_group": {
|
||||
"name": "red-blue",
|
||||
"url": "http://localhost:8000/api/v2/version/1/"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
###### Response models
|
||||
|
||||
| Name | Description | Data Type |
|
||||
|:--------------|:---------------------------------------------------|:------------------------------------------------------------------------|
|
||||
| id | The identifier for this machine resource | integer |
|
||||
| item | The TM or HM item that corresponds to this machine | [NamedAPIResource](#namedapiresource) ([Item](#items)) |
|
||||
| move | The move that is taught by this machine | [NamedAPIResource](#namedapiresource) ([Move](#moves)) |
|
||||
| version_group | The version group that this machine applies to | [NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups)) |
|
||||
|
||||
<h1 id="moves-section">Moves</h1>
|
||||
|
||||
## Moves
|
||||
|
|
@ -1267,6 +1305,7 @@ Moves are the skills of Pokémon in battle. In battle, a Pokémon uses one move
|
|||
| effect_entries | The effect of this move listed in different languages | list [VerboseEffect](#verboseeffect) |
|
||||
| effect_changes | The list of previous effects this move has had across version groups of the games | list [AbilityEffectChange](#abilityeffectchange) |
|
||||
| generation | The generation in which this move was introduced | [NamedAPIResource](#namedapiresource) ([Generation](#generations)) |
|
||||
| machines | A list of the machines that teach this move | list [MachineVersionDetail](#machineversiondetail) |
|
||||
| meta | Metadata about this move | [MoveMetaData](#movemetadata) |
|
||||
| names | The name of this move listed in different languages | list [Name](#resourcename) |
|
||||
| past_values | A list of move resource value changes across version groups of the game | list [PastMoveStatValues](#pastmovestatvalues) |
|
||||
|
|
@ -3077,6 +3116,13 @@ Languages for translations of API resource information.
|
|||
| game_index | The internal id of an API resource within game data | integer |
|
||||
| generation | The generation relevent to this game index | [NamedAPIResource](#namedapiresource) ([Generation](#generations)) |
|
||||
|
||||
#### MachineVersionDetail
|
||||
|
||||
| Name | Description | Data Type |
|
||||
|:--------------|:-----------------------------------------------|:------------------------------------------------------------|
|
||||
| machine | The machine that teaches a move from an item | [APIResource](#apiresource) ([Machine](#machines)) |
|
||||
| version_group | The version group of this specific machine | [NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups)) |
|
||||
|
||||
#### <a id="resourcename"></a>Name
|
||||
|
||||
| Name | Description | Data Type |
|
||||
|
|
|
|||
Loading…
Reference in a new issue