diff --git a/Data-model.md b/Data-model.md index 6e227e8..ff1a743 100644 --- a/Data-model.md +++ b/Data-model.md @@ -165,8 +165,25 @@ 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 +* `removed`: `boolean` - `true` if state is removed ## Provinces +* `i`: `number` - province id, always equal to the array index +* `name`: `string` - short (proper) form of the province name +* `formName`: `string` - string form name, used to get province `fullName` +* `fullName`: `string` - full state name. Combination of the proper name and province `formName` +* `color`: `string` - province color in hex (e.g. `#45ff12`) or link to hatching pattern (e.g. `url(#hatch7)`) +* `center`: `number` - cell id of province center (initial cell) +* `pole`: `number[]` - state pole of inaccessibility (visual center) coordinates, see [the concept description](https://blog.mapbox.com/a-new-algorithm-for-finding-a-visual-center-of-a-polygon-7c77e6492fbc?gi=6bd4fcb9ecc1) +* `area`: `number` - province area in pixels +* `burgs`: `number` - id of province capital burg if any +* `burgs`: `number[]` - id of burgs within the province +* `cells`: `number` - number of cells within the province +* `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 +* `removed`: `boolean` - `true` if province is removed + ## Religions ## Rivers ## Routes