Adds descriptions to each property in the encounters schema

This commit is contained in:
Deukhoofd 2021-01-16 15:23:33 +01:00
parent 2d88f4cddc
commit 190d63a6c0
Signed by: Deukhoofd
GPG Key ID: F63E044490819F6F
1 changed files with 17 additions and 8 deletions

View File

@ -23,36 +23,45 @@
], ],
"properties": { "properties": {
"species": { "species": {
"type": "string" "type": "string",
"description": "The species that may be encountered"
}, },
"time": { "time": {
"type": "array", "type": "array",
"items": { "items": {
"enum": ["morning", "day", "evening", "night"] "enum": ["morning", "day", "evening", "night"]
} },
"description": "The time the encounter may occur."
}, },
"type": { "type": {
"enum": ["grass", "oldrod", "goodrod", "superrod", "surf"] "enum": ["grass", "oldrod", "goodrod", "superrod", "surf"],
"description": "The method with which the encounter occurs."
}, },
"chance": { "chance": {
"type": "integer" "type": "integer",
"description": "The weight of the encounter chance, relative to the total weight of valid encounters."
}, },
"minimumLevel": { "minimumLevel": {
"type": "integer" "type": "integer",
"description": "The lowest possible level the encounter may have."
}, },
"maximumlvl": { "maximumlvl": {
"type": "integer" "type": "integer",
"description": "The highest possible level the encounter may have."
}, },
"formes": { "formes": {
"type": "array", "type": "array",
"description": "An optional definition to chance which formes may be encountered. If not given defaults to default forme.",
"items": { "items": {
"type": "object", "type": "object",
"properties": { "properties": {
"forme": { "forme": {
"type": "string" "type": "string",
"description": "The forme name that may be encountered"
}, },
"chance": { "chance": {
"type": "integer" "type": "integer",
"description": "The weight of the forme chance, relative to the total weight of valid formes."
} }
} }
} }