Merge pull request #75 from ManualForArchipelago/skip-ids

Allow items to skip IDs

schemas/Manual.items.schema.json

@@ -94,6 +94,10 @@
                     "type": ["boolean", "integer"],
                     "default": false
                 },
+                "id": {
+                    "description": "(Optional) Skips the item ID forward to the given value.\nThis can be used to provide buffer space for future items.",
+                    "type": "integer"
+                },
                 "_comment": {"$ref": "#/definitions/comment"}
             },
             "required": ["name"]
@@ -107,4 +111,4 @@
             }
         }
     }
-}
+}

schemas/Manual.locations.schema.json

@@ -92,6 +92,10 @@
                     "type": "boolean",
                     "default": false
                 },
+                "id": {
+                    "description": "(Optional) Skips the item ID forward to the given value.\nThis can be used to provide buffer space for future items.",
+                    "type": "integer"
+                },
                 "_comment": {"$ref": "#/definitions/comment"}
             }
         },
@@ -118,4 +122,4 @@
             }
         }
     }
-}
+}

src/Items.py

@@ -23,6 +23,13 @@
 
 # add sequential generated ids to the lists
 for key, val in enumerate(item_table):
+    if "id" in item_table[key]:
+        item_id = item_table[key]["id"]
+        if item_id >= count:
+            count = item_id
+        else:
+            raise ValueError(f"{item_table[key]['name']} has an invalid ID. ID must be at least {count + 1}")
+
     item_table[key]["id"] = count
     item_table[key]["progression"] = val["progression"] if "progression" in val else False
     count += 1

src/Locations.py

@@ -15,6 +15,13 @@
     if "victory" in location_table[key] and location_table[key]["victory"]:
         victory_names.append(location_table[key]["name"])
 
+    if "id" in location_table[key]:
+        item_id = location_table[key]["id"]
+        if item_id >= count:
+            count = item_id
+        else:
+            raise ValueError(f"{location_table[key]['name']} has an invalid ID. ID must be at least {count + 1}")
+
     location_table[key]["id"] = count
 
     if not "region" in location_table[key]: