From a82d1198eddadb124d9428770d75c6bf6fb87259 Mon Sep 17 00:00:00 2001 From: Azgaar Date: Sun, 8 Jan 2023 03:49:56 -0800 Subject: [PATCH] Updated Data model (markdown) --- Data-model.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Data-model.md b/Data-model.md index e4d2700..612274a 100644 --- a/Data-model.md +++ b/Data-model.md @@ -117,6 +117,7 @@ Cultures (races, language zones) data is stored as an array of objects with stri * `cells`: `number` - number of cells assigned to culture * `rural`: `number` - rural (non-burg) population of cells assigned to culture. In population points * `urban`: `number` - urban (burg) population of cells assigned to culture. In population points +* `lock`: `boolean` - `true` if culture is locked (not affected by regeneration) * `removed`: `boolean` - `true` if culture is removed ## Burgs @@ -169,6 +170,7 @@ States (countries) data is stored as an array of objects with strict element ord * `alert`: `number` - state war alert, see [military forces page](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/Military-Forces) * `military`: `object[]` - list of state regiments, see [military forces page](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/Military-Forces) * `coa`: `object | string` - emblem object, data model is the same as in [Armoria](https://github.com/Azgaar/Armoria) and covered in [API documentation](https://github.com/Azgaar/armoria-api#readme). If emblem is loaded by user, then the value is `custom` and cannot be displayed in Armoria +* `lock`: `boolean` - `true` if state is locked (not affected by regeneration) * `removed`: `boolean` - `true` if state is removed ## Provinces @@ -187,6 +189,7 @@ Provinces data is stored as an array of objects with strict element order. Eleme * `rural`: `number` - rural (non-burg) population of province cells. In population points * `urban`: `number` - urban (burg) population of state province. In population points * `coa`: `object | string` - emblem object, data model is the same as in [Armoria](https://github.com/Azgaar/Armoria) and covered in [API documentation](https://github.com/Azgaar/armoria-api#readme). If emblem is loaded by user, then the value is `custom` and cannot be displayed in Armoria +* `lock`: `boolean` - `true` if province is locked (not affected by regeneration) * `removed`: `boolean` - `true` if province is removed ## Religions @@ -208,6 +211,7 @@ Religions data is stored as an array of objects with strict element order. Eleme * `cells`: `number` - number of cells within the religion * `rural`: `number` - rural (non-burg) population of religion cells. In population points * `urban`: `number` - urban (burg) population of state religion. In population points +* `lock`: `boolean` - `true` if religion is locked (not affected by regeneration) * `removed`: `boolean` - `true` if religion is removed ## Rivers