Merge pull request #80 from randovania/feature/schema

Improve schema documentation
randovania · Dec 13, 2023 · 1046cbd · 1046cbd
2 parents 6fa1ddf + 35dde9c
commit 1046cbd
Showing 1 changed file with 17 additions and 9 deletions.
diff --git a/src/open_prime_rando/echoes/schema.json b/src/open_prime_rando/echoes/schema.json
@@ -137,35 +137,40 @@
                         }
                     },
                     "default": {},
+                    "description": "Change the default state of this area's layers.",
                     "$comment": "The list of layers is replaced in runtime with the existing layers of each specific area."
                 },
                 "low_memory_mode": {
                     "type": "boolean",
                     "default": false,
-                    "$comment": "Some areas are riding the memory/object limit. Certain patches will account for these limitations if this flag is set."
+                    "description": "Some areas are riding the memory/object limit. Certain patches will account for these limitations if this flag is set."
                 },
                 "new_name": {
                     "type": ["string", "null"],
                     "default": null,
-                    "$comment": "If set, rename the area to this value"
+                    "description": "If set, rename the area to this value"
                 },
                 "elevators": {
                     "type": "array",
                     "items": {
                         "type": "object",
                         "properties": {
                             "instance_id": {
-                                "type": "integer"
+                                "type": "integer",
+                                "description": "The instance id of the WorldTeleporter object to be updated."
                             },
                             "target_assets": {
-                                "$ref": "#/$defs/area_identifier"
+                                "$ref": "#/$defs/area_identifier",
+                                "description": ""
                             },
                             "target_strg": {
                                 "type": ["integer", "null"],
-                                "default": null
+                                "default": null,
+                                "description": "The STRG of the Scan that unlocks the elevator. If set, it's updated with `target_name`."
                             },
                             "target_name": {
-                                "type": "string"
+                                "type": "string",
+                                "description": "The name of the destination of this connects to. Used by `target_strg`."
                             }
                         },
                         "required": [
@@ -175,7 +180,8 @@
                         ],
                         "additionalProperties": false
                     },
-                    "default": []
+                    "default": [],
+                    "description": "Change where WorldTeleporters in this Area connect to"
                 }
             },
             "additionalProperties": false
@@ -239,10 +245,12 @@
             "type": "object",
             "properties": {
                 "world_asset_id": {
-                    "type": "integer"
+                    "type": "integer",
+                    "description": "Asset ID of a MLVL"
                 },
                 "area_asset_id": {
-                    "type": "integer"
+                    "type": "integer",
+                    "description": "Asset ID of a MREA"
                 }
             }
         },