From f2365c92e08622a661977e987ad4dfdfd648ddd4 Mon Sep 17 00:00:00 2001 From: Deukhoofd Date: Sat, 16 Jan 2021 18:02:25 +0100 Subject: [PATCH] Add additional descriptions to pokemon schema --- pokemon.schema.json | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/pokemon.schema.json b/pokemon.schema.json index f85a2fd..fc22fbb 100644 --- a/pokemon.schema.json +++ b/pokemon.schema.json @@ -28,15 +28,23 @@ "evolutions" ], "properties": { - "species": { "type": "string" }, - "id": { "type": "number" }, + "species": { + "type": "string", + "description": "The internal name of the Pokemon species." + }, + "id": { + "type": "number", + "description": "The numerical pokedex identifier of the species." + }, "genderRatio": { "type": "number", + "description": "The gender ratio of the species. A value of -1 means genderless, a value of 0 means always female, 100 means always male. 50 means 50% male, 50% female, etc.", "minimum": -1, "maximum": 100 }, "growthRate": { "type": "string", + "description": "The growth rate of the species.", "enum": [ "Erratic", "Fast", @@ -48,22 +56,27 @@ }, "baseHappiness": { "type": "integer", + "description": "The base happiness/friendship a species should have when captured.", "minimum": 0, "maximum": 255 }, "catchRate": { "type": "integer", + "description": "The catch rate of the species. 0 means impossible to capture, 255 means a perfect capture every time.", "minimum": 0, "maximum": 255 }, "color": { - "type": "string" + "type": "string", + "description": "The color of the species. No real use in game outside of pokedex purposes." }, "genderDifference": { - "type": "boolean" + "type": "boolean", + "description": "Whether there are different sprites for different genders.." }, "eggGroups": { "type": "array", + "description": "The egg groups the species has for breeding purposes.", "items": { "type": "string", "enum": [ @@ -87,10 +100,12 @@ }, "eggCycles": { "type": "integer", + "description": "The number of egg cycles required for an egg of this species to hatch", "minimum": 0 }, "tags": { "type": "array", + "description": "Additional tags on the species for scripting purposes", "items": { "type": "string" } @@ -116,6 +131,7 @@ "abilities": { "type": "array", "minItems": 1, + "description": "The normal abilities a forme has.", "items": { "type": "string" } @@ -123,6 +139,7 @@ "hiddenAbilities": { "type": "array", "minItems": 0, + "description": "The additional hidden abilities a forme has.", "items": { "type": "string" }