From 190d63a6c04be4c3edf88c33c638144fb09dfe28 Mon Sep 17 00:00:00 2001 From: Deukhoofd Date: Sat, 16 Jan 2021 15:23:33 +0100 Subject: [PATCH] Adds descriptions to each property in the encounters schema --- encounters.schema.json | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/encounters.schema.json b/encounters.schema.json index 1523ea4..e2bb541 100644 --- a/encounters.schema.json +++ b/encounters.schema.json @@ -23,36 +23,45 @@ ], "properties": { "species": { - "type": "string" + "type": "string", + "description": "The species that may be encountered" }, "time": { "type": "array", "items": { "enum": ["morning", "day", "evening", "night"] - } + }, + "description": "The time the encounter may occur." }, "type": { - "enum": ["grass", "oldrod", "goodrod", "superrod", "surf"] + "enum": ["grass", "oldrod", "goodrod", "superrod", "surf"], + "description": "The method with which the encounter occurs." }, "chance": { - "type": "integer" + "type": "integer", + "description": "The weight of the encounter chance, relative to the total weight of valid encounters." }, "minimumLevel": { - "type": "integer" + "type": "integer", + "description": "The lowest possible level the encounter may have." }, "maximumlvl": { - "type": "integer" + "type": "integer", + "description": "The highest possible level the encounter may have." }, "formes": { "type": "array", + "description": "An optional definition to chance which formes may be encountered. If not given defaults to default forme.", "items": { "type": "object", "properties": { "forme": { - "type": "string" + "type": "string", + "description": "The forme name that may be encountered" }, "chance": { - "type": "integer" + "type": "integer", + "description": "The weight of the forme chance, relative to the total weight of valid formes." } } }